Kiuwan REST
Kiuwan is a static analysis cloud service to measure, analyze and verify the quality of the code of your applications portfolios, providing, immediately, essential results and reports of the analyzed code. Kiuwan analyzes more than a dozen technologies. The REST API is the primary way that data are retrieved from Kiuwan.
89 subscribers
39 endpoints
The in-depth APIMemo review for this API hasn't been published yet —
the data below comes straight from the public marketplace listing.
Kiuwan REST endpoints
| Method | Endpoint | Description |
|---|---|---|
| Results of analysis | ||
| GET |
Get last application analysis /apps/{appName} |
Retrieves last application results for a given application name. |
| GET |
List application defects /apps/{appName}/defects |
List application defects for the indicated application. |
| GET |
List applications /apps/list |
List applications for the authenticated user. If you indicate a public account name, you will get the public application of that account. |
| GET |
Get specific application analysis /apps/analysis/{analysis-code} |
Get a specific analysis result by analysis code |
| GET |
List all analysis codes for an application /apps/{applicationname}/analyses |
List all analysis codes for an application |
| GET |
List defects of a specific analysis /apps/analysis/{analysiscode}/defects |
List defects of a specific analysis providing the analysis code |
| GET |
Get comparison of the defects found in two different analysis /apps/analysis/{code}/defects/compare/{previouscode} |
Get the net number of new and removed defects and violated rules after comparing 2 given analyses |
| GET |
Get the list of new defects in a comparison /apps/analysis/{code}/defects/compare/{previouscode}/new |
Get the list of new defects introduced in an application comparing with a previous analysis |
| GET |
List files with metric values and defects of the latest analysis /apps/{appname}/files |
List files with metric values and defects of the latest analysis for the named application |
| GET |
Get the list of removed defects in a comparison /apps/analysis/{code}/defects/compare/{previouscode}/removed |
Get the list of removed defects in an analysis comparing with a previous analysis |
| GET |
Get analysis global metrics /metrics?code={analysiscode} |
Get the global metrics for an specified analysis code |
| GET |
List files with metric values and defects for a specific analysis /apps/analysis/{analysiscode}/files |
List files with metric values and defects for a specific analysis |
| Deliveries | ||
| GET |
Get information of a delivery /apps/{applicationname}/deliveries?changeRequest={changerequest}&label={label} |
Obtains the information of delivery for the authenticated user. You can indicate the change request and the label of the delivery to retrieve its information. Note: If there are… |
| GET |
Get information of a delivery by code /deliveries/{code} |
Obtains the information of delivery for the authenticated user indicating the code of the delivery. |
| GET |
Get files with defects for audit checkpoint /audits/checkpoints/violatedrules/files?application={application}&deliveryCode={deliverycode}&ruleCode={rulecode}&checkpoint={checkpoint} |
Obtains the list of files with defects that do not pass a checkpoint. |
| GET |
Get the defects of a file for audit checkpoint /audits/checkpoints/violatedrules/files/defects?application={application}&deliveryCode={deliverycode}&ruleCode={rulecode}&checkpoint={checkpoint}&file={file} |
Obtains the list of defects for a file that do not pass a checkpoint. |
| GET |
List deliveries /apps/{applicationname}/deliveries |
list all deliveries for a given application |
| Action plans | ||
| GET |
List action plans /actionPlans?application={application} |
List action plans of an application for the authenticated user. |
| GET |
Get action plan progress summary /actionPlan?application={application}&name={name} |
Obtains the current and the past main metrics and indicators of an application for an action plan. If there are more than one action plans with the same name, this endpoint… |
| GET |
Get all defects in action plan /actionPlan/defects/all?application={application}&name={name} |
Obtains all defects included in an action plan. If there are more than one action plans with the same name, this endpoint returns the most recent action plan's information. |
| GET |
Get pending defects in action plan /actionPlan/defects/pending?application={application}&name={name}&analysisLabel={analysislabel} |
Obtains the pending defects of an action plan compared with a concrete analysis. If there are more than one action plans with the same name, this endpoint returns the most recent… |
| GET |
Get removed defects from action plan /actionPlan/defects/removed?application={application}&name={name}&analysisLabel={analysislabel} |
Obtains the removed defects of an action plan compared with a concrete analysis. If there are more than one action plans with the same name, this endpoint returns the most recent… |
| Rule documentation | ||
| GET |
Get rule's documentation /doc/rule?application={application}&modelId={modelid}&code={code} |
Obtains the documentation of a rule. |
| Portfolio | ||
| GET |
Get portfolio definitions /portfolios |
Obtains the portfolio definitions of an account. |
| POST |
Save portfolio definitions /portfolios |
Creates or update portfolio definitions for an account. See the payload example below |
| Violated rules | ||
| GET |
Get violated rules of an analysis /violatedrules?application={application}&analysisCode={analysiscode} |
Obtains the list of violated rules of an analysis for the authenticated user. |
| GET |
Get files of a violated rule /violatedrules/files?application={application}&analysisCode={analysiscode}&ruleCode={rulecode} |
Obtains the list of files where the violated rule affects. |
| GET |
Get defects of file /violatedrules/files/defects?application={application}&analysisCode={analysiscode}&ruleCode={rulecode}&file={file} |
Obtains the list of defects in a file for a concrete violated rule. |
| Management | ||
| DELETE |
Delete user group /userGroups/{name} |
Delete an existing user group in an account |
| POST |
Modify user /users/{username} |
Modifies an existing user information, admin privileges and portfolio and application permissions |
| POST |
Create user /users |
Create a user in an account and assigns roles to specified portfolios and applications. You can assign admin privileges as well. See payload example below |
| POST |
Create application /applications |
Creates an application in an account |
| DELETE |
Delete user /users/{username} |
Deletes an existing user in an account |
| GET |
List users /users |
List all existing users in an account |
| POST |
Modify application /applications/{appname} |
Modify an existing application in an account. It can even change the name |
| POST |
Create user group /userGroups |
Creates a named user group with existing users in an account. It assigns admin privileges and permissions on portfolios and individual applications |
| POST |
Modify user groups /userGroups/{name} |
Modify existing user group members and grant or revoke admin privileges and permissions on portfolios and applications |
| GET |
List user groups /userGroups |
List all user groups, and their members, from an account |
| Test connection | ||
| GET |
Test Connection /info |
Endpoint to test the connection with Kiuwan. OK when it returns the username and the organization |
Kiuwan REST pricing
| Plan | Price | Rate limit | Quotas |
|---|---|---|---|
| BASIC | Free | — |
|
