security-governance

Trigger security scan

Plan: Business or higher

Starts a security scan for the project's latest commit and returns a scan_id.

post/v1/projects/{project_id}/security-scans

Path parameters

project_idstring required

Project ID

Project ID

Response

OK

messagestring

Human-readable status message

scan_idstring required

Scan invocation ID. Poll GET /v1/projects/{project_id}/security-scans/{scan_id} for status (running | completed | failed) and findings.

statusstring required

One of: started, running, completed. More values may be added; clients must tolerate unknown values.

Example response

{
  "message": "Security scan started.",
  "scan_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": "started"
}

Changes