POST/v1/finding/project/{uuid}/analyze

Triggers Vulnerability Analysis on a specific project

Requires permission VULNERABILITY_ANALYSIS

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter
uuidstringrequired
The UUID of the project to analyze

4 status codes
200Token to be used for checking analysis progress
projectUuidstringrequired
UUID of the project the BOM was uploaded for
tokenstringrequired
Token used to check task progress
401Unauthorized
403Access to the requested project is forbidden
detailstringrequired
Human-readable explanation specific to this occurrence of the problem
instancestringoptional
Reference URI that identifies the specific occurrence of the problem
statusintegerrequired
HTTP status code generated by the origin server for this occurrence of the problem
titlestringrequired
Short, human-readable summary of the problem type
typestringoptional
A URI reference that identifies the problem type
404The project could not be found

Error handling

A 401 is returned: Unauthorized. A 403 is returned: Access to the requested project is forbidden. A 404 is returned: The project could not be found.