Scan API

Project Scan

Request

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.

Security

bearerAuth

Path

projectIdinteger, (int64)required

ID of the project

Example:1

Query

fullRescanboolean

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

Bodyapplication/json

property name*stringadditional property

curl -i -X POST \
  'https://codeinsightapi.redocly.app/_mock/swagger/scanResource/projectScan/1?fullRescan=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "property1": "string",
    "property2": "string"
  }'

Responses

OK