Scan API

Project Scan

Initiates a scan for a given project, specified by the projectId. Returns the taskId corresponding to the scan task. The taskId can be used to check the scan status. Only Project Admin and Analyst can invoke a scan of a project.

Request
path Parameters
projectId
required
integer <int32>

ID of the project

Example: E.g. 1
query Parameters
fullRescan
boolean

Irrespective of codebase changes, pass value as true to perform a full scan of the codebase

Example: fullRescan=E.g. false | default: false
header Parameters
Authorization
required
string
Default:

Bearer JWT Token

Example: E.g. Bearer JWT_TOKEN
Responses
200

OK

400

Bad request: The project Id entered was not found

409

Conflict: Project is already in queue or already being scanned

503

Service Unavailable

post/scanResource/projectScan/{projectId}
Response samples
application/json
0
0