API v1 reference

97 operations. Platform build 0.1.0. Base URL: https://<your DVSentry host>/v1.

Using the API

Send a token as Authorization: Bearer dvs_pat_…. For CI, create an organization service account and give its token only the scopes listed below that the job needs. A token reaches the same data its user or service account may see; scopes narrow that, they never widen it.

Request and response bodies are JSON. Errors are {"detail": "…"}, some with a stable code. A resource in another organization answers 404, never 403.

Versioning and deprecation

Every path on this page is under /v1 and answers with DVSentry-API-Version: 1.
Within v1 changes are additive only: new operations, new optional fields and parameters, new response fields and new enum values. Clients must ignore fields they do not know.
Anything removed or changed incompatibly is first marked deprecated here and answers with Deprecation and Sunset headers (and a Link to its successor) for at least 180 days. After the sunset date it answers 410 Gone.
Paths without /v1 serve the web app. They still work, but carry no stability promise.

Command-line client

Download dvsentry.py, a single Python 3.9+ file with no dependencies, for CI systems such as Jenkins, CircleCI, Azure Pipelines, Bitbucket Pipelines or Buildkite. Run python3 dvsentry.py --help.

Scope `any token`

GET `/v1/auth/me`

Parameter	In	Required	Type
`authorization`	header	no	`string \| null`

Responses: 200 UserRead, 422 HTTPValidationError

Scope `org:read`

GET `/v1/organizations`

List Organizations

Parameter	In	Required	Type
`authorization`	header	no	`string \| null`

Responses: 200 OrganizationRead[], 422 HTTPValidationError

GET `/v1/scanner-capabilities`

Scanner Capabilities

Parameter	In	Required	Type
`authorization`	header	no	`string \| null`

Responses: 200, 422 HTTPValidationError

Scope `repositories:read`

GET `/v1/repositories`

List Repositories

Parameter	In	Required	Type
`limit`	query	no	`integer`
`offset`	query	no	`integer`
`authorization`	header	no	`string \| null`

Responses: 200 RepositoryPage, 422 HTTPValidationError

GET `/v1/repositories/{repository_id}/automation-runs`

List Automation Runs

Parameter	In	Required	Type
`repository_id`	path	yes	`string (uuid)`
`source`	query	no	`string \| null`
`limit`	query	no	`integer`
`authorization`	header	no	`string \| null`

Responses: 200 RepositoryAutomationRunRead[], 422 HTTPValidationError

GET `/v1/repositories/{repository_id}/baselines`

List Baselines

Parameter	In	Required	Type
`repository_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Responses: 200 RepositoryBaselineRead[], 422 HTTPValidationError

GET `/v1/repositories/{repository_id}/infrastructure-surface`

Get Repository Infrastructure Surface

Parameter	In	Required	Type
`repository_id`	path	yes	`string (uuid)`
`git_ref`	query	no	`string \| null`
`include_non_production`	query	no	`boolean`
`authorization`	header	no	`string \| null`

Responses: 200 InfrastructureAttackSurface, 422 HTTPValidationError

GET `/v1/repositories/{repository_id}/regression`

Get Repository Regression

Parameter	In	Required	Type
`repository_id`	path	yes	`string (uuid)`
`base_commit`	query	no	`string \| null`
`head_commit`	query	no	`string \| null`
`base_report_id`	query	no	`string (uuid) \| null`
`head_report_id`	query	no	`string (uuid) \| null`
`authorization`	header	no	`string \| null`

Responses: 200 SecurityRegressionView, 422 HTTPValidationError

GET `/v1/repositories/{repository_id}/release-baselines`

List release baselines for repository

Parameter	In	Required	Type
`repository_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Responses: 200 ReleaseBaselineRead[], 422 HTTPValidationError

GET `/v1/repositories/{repository_id}/scan-policy`

Get Repository Scan Policy

Parameter	In	Required	Type
`repository_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Responses: 200, 422 HTTPValidationError

GET `/v1/repositories/{repository_id}/schedules`

List Schedules

Parameter	In	Required	Type
`repository_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Responses: 200 RepositoryScheduleRead[], 422 HTTPValidationError

GET `/v1/repositories/{repository_id}/scorecard`

Get Repository Scorecard

Parameter	In	Required	Type
`repository_id`	path	yes	`string (uuid)`
`days`	query	no	`integer`
`authorization`	header	no	`string \| null`

Responses: 200 AssetScorecard, 422 HTTPValidationError

Scope `repositories:write`

POST `/v1/repositories`

Create Repository

Parameter	In	Required	Type
`authorization`	header	no	`string \| null`

Body: RepositoryCreate as application/json

Responses: 201 RepositoryRead, 422 HTTPValidationError

PUT `/v1/repositories/{repository_id}/baseline`

Set Baseline

Parameter	In	Required	Type
`repository_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Body: RepositoryBaselineSet as application/json

Responses: 200 RepositoryBaselineRead, 422 HTTPValidationError

PUT `/v1/repositories/{repository_id}/scan-policy`

Replace Repository Scan Policy

Parameter	In	Required	Type
`repository_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Body: RepositoryScanPolicyUpdate as application/json

Responses: 200, 422 HTTPValidationError

DELETE `/v1/repositories/{repository_id}/scan-policy`

Reset Repository Scan Policy

Parameter	In	Required	Type
`repository_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Responses: 200, 422 HTTPValidationError

Scope `scans:read`

GET `/v1/ai-security-scans/{scan_id}`

Get Ai Security Scan

Parameter	In	Required	Type
`scan_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Responses: 200 AISecurityScanRead, 422 HTTPValidationError

GET `/v1/ai-targets`

List Ai Targets

Parameter	In	Required	Type
`authorization`	header	no	`string \| null`

Responses: 200 AITargetRead[], 422 HTTPValidationError

GET `/v1/ai-targets/{target_id}/scans`

List Ai Security Scans

Parameter	In	Required	Type
`target_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Responses: 200 AISecurityScanRead[], 422 HTTPValidationError

GET `/v1/assessments`

List Assessments

Parameter	In	Required	Type
`status`	query	no	`string \| null`
`scanner`	query	no	`string \| null`
`limit`	query	no	`integer`
`offset`	query	no	`integer`
`authorization`	header	no	`string \| null`

Responses: 200 AssessmentPage, 422 HTTPValidationError

GET `/v1/assessments/{assessment_id}`

Get Assessment

Parameter	In	Required	Type
`assessment_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Responses: 200 AssessmentRead, 422 HTTPValidationError

GET `/v1/assessments/{assessment_id}/comparison`

Assessment Comparison

Parameter	In	Required	Type
`assessment_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Responses: 200 AssessmentComparison, 422 HTTPValidationError

GET `/v1/assessments/{assessment_id}/summary`

Assessment Summary

Parameter	In	Required	Type
`assessment_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Responses: 200 AssessmentSummary, 422 HTTPValidationError

GET `/v1/cloud-posture/scans`

List Posture Scans

Parameter	In	Required	Type
`org_id`	query	no	`string (uuid) \| null`
`limit`	query	no	`integer`
`authorization`	header	no	`string \| null`

Responses: 200 CloudScanRead[], 422 HTTPValidationError

GET `/v1/cloud-posture/scans/{scan_id}`

Get Posture Scan

Parameter	In	Required	Type
`scan_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Responses: 200 CloudScanRead, 422 HTTPValidationError

GET `/v1/cloud/accounts`

List Cloud Accounts

Parameter	In	Required	Type
`org_id`	query	no	`string (uuid) \| null`
`provider`	query	no	`string \| null`
`authorization`	header	no	`string \| null`

Responses: 200 CloudAccountRead[], 422 HTTPValidationError

GET `/v1/cloud/accounts/{account_id}`

Get Cloud Account

Parameter	In	Required	Type
`account_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Responses: 200 CloudAccountRead, 422 HTTPValidationError

GET `/v1/organizations/{organization_id}/container-images/scans`

List Container Image Scans

Parameter	In	Required	Type
`organization_id`	path	yes	`string (uuid)`
`limit`	query	no	`integer`
`offset`	query	no	`integer`
`authorization`	header	no	`string \| null`

Responses: 200 ContainerImageScanPage, 422 HTTPValidationError

GET `/v1/organizations/{organization_id}/container-images/scans/{scan_id}`

Get Container Image Scan

Parameter	In	Required	Type
`organization_id`	path	yes	`string (uuid)`
`scan_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Responses: 200 ContainerImageScanRead, 422 HTTPValidationError

GET `/v1/web-scans/{scan_id}`

Get Web Scan

Parameter	In	Required	Type
`scan_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Responses: 200 WebScanRead, 422 HTTPValidationError

GET `/v1/web-targets`

List Web Targets

Parameter	In	Required	Type
`authorization`	header	no	`string \| null`

Responses: 200 WebTargetRead[], 422 HTTPValidationError

GET `/v1/web-targets/{target_id}/scans`

List Web Scans

Parameter	In	Required	Type
`target_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Responses: 200 WebScanRead[], 422 HTTPValidationError

Scope `scans:trigger`

POST `/v1/ai-security-scans/{scan_id}/cancel`

Cancel Ai Security Scan

Parameter	In	Required	Type
`scan_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Responses: 200 AISecurityScanRead, 422 HTTPValidationError

POST `/v1/ai-targets/{target_id}/scans`

Create Ai Security Scan

Parameter	In	Required	Type
`target_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Body: AISecurityScanCreate as application/json

Responses: 201 AISecurityScanRead, 422 HTTPValidationError

POST `/v1/assessments`

Create Assessment

Parameter	In	Required	Type
`authorization`	header	no	`string \| null`

Body: AssessmentCreate as application/json

Responses: 202 AssessmentRead, 422 HTTPValidationError

POST `/v1/assessments/{assessment_id}/cancel`

Cancel Assessment

Parameter	In	Required	Type
`assessment_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Responses: 200 AssessmentRead, 422 HTTPValidationError

POST `/v1/cloud/accounts/{account_id}/scans`

Enqueue Cloud Scan

Parameter	In	Required	Type
`account_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Body: CloudScanCreate as application/json

Responses: 202 CloudScanRead, 422 HTTPValidationError

POST `/v1/cloud/scans/{scan_id}/cancel`

Cancel Cloud Scan

Parameter	In	Required	Type
`scan_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Responses: 200 CloudScanRead, 422 HTTPValidationError

POST `/v1/organizations/{organization_id}/container-images/scans`

Create Container Image Scan

Parameter	In	Required	Type
`organization_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Body: ContainerImageScanCreate as application/json

Responses: 202 ContainerImageScanRead, 422 HTTPValidationError

POST `/v1/repository-schedules/{schedule_id}/run`

Run Schedule Now

Parameter	In	Required	Type
`schedule_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Responses: 202 SecurityReportRead, 422 HTTPValidationError

POST `/v1/security-reports`

Create Security Report

Parameter	In	Required	Type
`Idempotency-Key`	header	no	`string \| null`
`authorization`	header	no	`string \| null`

Body: SecurityReportCreate as application/json

Responses: 202 SecurityReportRead, 422 HTTPValidationError

POST `/v1/security-reports/{report_id}/cancel`

Cancel Report

Parameter	In	Required	Type
`report_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Responses: 200 SecurityReportRead, 422 HTTPValidationError

POST `/v1/web-scan-schedules/{schedule_id}/run`

Run Web Scan Schedule Now

Parameter	In	Required	Type
`schedule_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Responses: 202 WebScanRead, 422 HTTPValidationError

POST `/v1/web-scans/{scan_id}/cancel`

Cancel Web Scan

Parameter	In	Required	Type
`scan_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Responses: 200 WebScanRead, 422 HTTPValidationError

POST `/v1/web-targets/{target_id}/scans`

Create Web Scan

Parameter	In	Required	Type
`target_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Body: WebScanCreate as application/json

Responses: 202 WebScanRead, 422 HTTPValidationError

Scope `findings:read`

GET `/v1/assessments/{assessment_id}/findings`

List Findings

Parameter	In	Required	Type
`assessment_id`	path	yes	`string (uuid)`
`severity`	query	no	`string \| null`
`category`	query	no	`string \| null`
`limit`	query	no	`integer`
`offset`	query	no	`integer`
`authorization`	header	no	`string \| null`

Responses: 200 FindingPage, 422 HTTPValidationError

GET `/v1/cloud-posture/accounts/{account_id}/findings`

List Account Finding States

Parameter	In	Required	Type
`account_id`	path	yes	`string (uuid)`
`limit`	query	no	`integer`
`authorization`	header	no	`string \| null`

Responses: 200 CloudFindingStateRead[], 422 HTTPValidationError

GET `/v1/cloud-posture/scans/{scan_id}/issues`

Get Scan Issues

Parameter	In	Required	Type
`scan_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Responses: 200, 422 HTTPValidationError

GET `/v1/organizations/{organization_id}/container-images/scans/{scan_id}/findings`

List Container Image Findings

Parameter	In	Required	Type
`organization_id`	path	yes	`string (uuid)`
`scan_id`	path	yes	`string (uuid)`
`limit`	query	no	`integer`
`offset`	query	no	`integer`
`authorization`	header	no	`string \| null`

Responses: 200 ContainerImageFindingPage, 422 HTTPValidationError

GET `/v1/security-reports/{report_id}/findings`

List Security Report Findings

Parameter	In	Required	Type
`report_id`	path	yes	`string (uuid)`
`severity`	query	no	`string \| null`
`scanner`	query	no	`string \| null`
`status`	query	no	`string \| null`
`assignee`	query	no	`string \| null`
`q`	query	no	`string \| null`
`classification`	query	no	`string \| null`
`limit`	query	no	`integer`
`offset`	query	no	`integer`
`authorization`	header	no	`string \| null`

Responses: 200 ReportFindingPage, 422 HTTPValidationError

GET `/v1/security-reports/{report_id}/findings/{dedupe_key}`

Get Security Report Finding

Parameter	In	Required	Type
`report_id`	path	yes	`string (uuid)`
`dedupe_key`	path	yes	`string`
`authorization`	header	no	`string \| null`

Responses: 200 ReportFindingRead, 422 HTTPValidationError

GET `/v1/security-reports/{report_id}/findings/{dedupe_key}/remediation`

Get Security Report Finding Remediation

Parameter	In	Required	Type
`report_id`	path	yes	`string (uuid)`
`dedupe_key`	path	yes	`string`
`authorization`	header	no	`string \| null`

Responses: 200 FindingRemediationRead, 422 HTTPValidationError

GET `/v1/security-reports/{report_id}/secret-incidents`

List Secret Incidents

Parameter	In	Required	Type
`report_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Responses: 200, 422 HTTPValidationError

Scope `findings:write`

PATCH `/v1/findings/{finding_id}`

Update Finding Workflow

Parameter	In	Required	Type
`finding_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Body: FindingWorkflowUpdate as application/json

Responses: 200 FindingRead, 422 HTTPValidationError

PATCH `/v1/security-reports/{report_id}/findings/{dedupe_key}`

Update Security Report Finding

Parameter	In	Required	Type
`report_id`	path	yes	`string (uuid)`
`dedupe_key`	path	yes	`string`
`authorization`	header	no	`string \| null`

Body: FindingWorkflowUpdate as application/json

Responses: 200 ReportFindingRead, 422 HTTPValidationError

PATCH `/v1/security-reports/{report_id}/secret-incidents/{dedupe_key}`

Update Secret Incident

Parameter	In	Required	Type
`report_id`	path	yes	`string (uuid)`
`dedupe_key`	path	yes	`string`
`authorization`	header	no	`string \| null`

Body: SecretIncidentUpdate as application/json

Responses: 200, 422 HTTPValidationError

Scope `reports:read`

GET `/v1/assessments/{assessment_id}/reports/developer`

Assessment Developer Report

Parameter	In	Required	Type
`assessment_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Responses: 200 DeveloperReport, 422 HTTPValidationError

GET `/v1/assessments/{assessment_id}/reports/executive`

Assessment Executive Report

Parameter	In	Required	Type
`assessment_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Responses: 200 ExecutiveReport, 422 HTTPValidationError

GET `/v1/cloud-posture/scans/{scan_id}/report`

Get Scan Report

Parameter	In	Required	Type
`scan_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Responses: 200, 422 HTTPValidationError

GET `/v1/security-reports`

List Security Reports

Parameter	In	Required	Type
`status`	query	no	`string \| null`
`environment`	query	no	`string \| null`
`repository_id`	query	no	`string (uuid) \| null`
`source_type`	query	no	`string \| null`
`limit`	query	no	`integer`
`offset`	query	no	`integer`
`authorization`	header	no	`string \| null`

Responses: 200 SecurityReportPage, 422 HTTPValidationError

GET `/v1/security-reports/{report_id}`

Get Security Report

Parameter	In	Required	Type
`report_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Responses: 200 SecurityReportDetail, 422 HTTPValidationError

GET `/v1/security-reports/{report_id}/comparison`

Get Security Report Comparison

Parameter	In	Required	Type
`report_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Responses: 200 SecurityReportComparison, 422 HTTPValidationError

GET `/v1/security-reports/{report_id}/compliance`

Get Security Report Compliance

Parameter	In	Required	Type
`report_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Responses: 200, 422 HTTPValidationError

GET `/v1/security-reports/{report_id}/components`

Get Security Report Components

Parameter	In	Required	Type
`report_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Responses: 200, 422 HTTPValidationError

GET `/v1/security-reports/{report_id}/coverage`

Get Security Report Coverage

Parameter	In	Required	Type
`report_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Responses: 200 CoverageReportRead, 422 HTTPValidationError

GET `/v1/security-reports/{report_id}/license-compliance`

Report License Compliance

Parameter	In	Required	Type
`report_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Responses: 200 object, 422 HTTPValidationError

GET `/v1/security-reports/{report_id}/plain-summary`

Get Security Report Plain Summary

Parameter	In	Required	Type
`report_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Responses: 200, 422 HTTPValidationError

GET `/v1/security-reports/{report_id}/regression`

Get Security Report Regression

Parameter	In	Required	Type
`report_id`	path	yes	`string (uuid)`
`baseline_id`	query	no	`string (uuid) \| null`
`authorization`	header	no	`string \| null`

Responses: 200 SecurityRegressionView, 422 HTTPValidationError

GET `/v1/security-reports/{report_id}/sbom`

Export Security Report Sbom

Parameter	In	Required	Type
`report_id`	path	yes	`string (uuid)`
`format`	query	no	`string`
`authorization`	header	no	`string \| null`

Responses: 200, 422 HTTPValidationError

GET `/v1/security-reports/{report_id}/sbom/attestation`

Export Security Report Sbom Attestation

Parameter	In	Required	Type
`report_id`	path	yes	`string (uuid)`
`format`	query	no	`string`
`authorization`	header	no	`string \| null`

Responses: 200, 422 HTTPValidationError

GET `/v1/security-reports/{report_id}/sbom/comparison`

Compare Security Report Sbom

Parameter	In	Required	Type
`report_id`	path	yes	`string (uuid)`
`baseline_id`	query	no	`string (uuid) \| null`
`classification`	query	no	`string`
`authorization`	header	no	`string \| null`

Responses: 200, 422 HTTPValidationError

GET `/v1/security-reports/{report_id}/sbom/license-violations`

Check Report License Violations

Parameter	In	Required	Type
`report_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Responses: 200, 422 HTTPValidationError

GET `/v1/security-reports/{report_id}/signed-evidence`

Export Signed Report Evidence

Parameter	In	Required	Type
`report_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Responses: 200, 422 HTTPValidationError

GET `/v1/security-reports/{report_id}/summary`

Get Security Report Summary

Parameter	In	Required	Type
`report_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Responses: 200 SecurityReportSummary, 422 HTTPValidationError

GET `/v1/security-reports/{report_id}/vex`

Get Security Report Vex

Parameter	In	Required	Type
`report_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Responses: 200, 422 HTTPValidationError

Scope `reports:export`

GET `/v1/artifacts`

List Artifacts

Parameter	In	Required	Type
`organization_id`	query	yes	`string (uuid)`
`resource_type`	query	no	`string \| null`
`resource_id`	query	no	`string (uuid) \| null`
`artifact_type`	query	no	`string \| null`
`limit`	query	no	`integer`
`authorization`	header	no	`string \| null`

Responses: 200, 422 HTTPValidationError

GET `/v1/artifacts/{artifact_id}`

Get Artifact

Parameter	In	Required	Type
`artifact_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Responses: 200, 422 HTTPValidationError

GET `/v1/artifacts/{artifact_id}/download`

Download Artifact

Parameter	In	Required	Type
`artifact_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Responses: 200, 422 HTTPValidationError

GET `/v1/export-jobs`

List Export Jobs

Parameter	In	Required	Type
`limit`	query	no	`integer`
`authorization`	header	no	`string \| null`

Responses: 200, 422 HTTPValidationError

POST `/v1/export-jobs`

Create Export Job

Parameter	In	Required	Type
`authorization`	header	no	`string \| null`

Body: ExportJobRequest as application/json

Responses: 202, 422 HTTPValidationError

GET `/v1/export-jobs/{job_id}`

Get Export Job

Parameter	In	Required	Type
`job_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Responses: 200, 422 HTTPValidationError

GET `/v1/security-reports/{report_id}/evidence-pack`

Export Compliance Evidence Pack

Parameter	In	Required	Type
`report_id`	path	yes	`string (uuid)`
`format`	query	no	`string`
`authorization`	header	no	`string \| null`

Responses: 200, 422 HTTPValidationError

GET `/v1/security-reports/{report_id}/export`

Export Security Report

Parameter	In	Required	Type
`report_id`	path	yes	`string (uuid)`
`format`	query	yes	`string`
`authorization`	header	no	`string \| null`

Responses: 200, 422 HTTPValidationError

GET `/v1/security-reports/{report_id}/export/compliance`

Export Security Report Compliance

Parameter	In	Required	Type
`report_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Responses: 200, 422 HTTPValidationError

GET `/v1/security-reports/{report_id}/export/executive`

Export Security Report Executive

Parameter	In	Required	Type
`report_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Responses: 200, 422 HTTPValidationError

GET `/v1/security-reports/{report_id}/export/tickets`

Export Security Report Tickets

Parameter	In	Required	Type
`report_id`	path	yes	`string (uuid)`
`format`	query	no	`string`
`authorization`	header	no	`string \| null`

Responses: 200, 422 HTTPValidationError

Scope `gates:read`

GET `/v1/assessments/{assessment_id}/ci-gate`

Assessment Ci Gate

Parameter	In	Required	Type
`assessment_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Responses: 200 string, 422 HTTPValidationError

GET `/v1/assessments/{assessment_id}/ci-result`

Assessment Ci Result

Parameter	In	Required	Type
`assessment_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Responses: 200 CiResult, 422 HTTPValidationError

GET `/v1/assessments/{assessment_id}/policy-result`

Assessment Policy Result

Parameter	In	Required	Type
`assessment_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Responses: 200 PolicyResult, 422 HTTPValidationError

GET `/v1/release-gates/{evaluation_id}`

Get release gate evaluation record

Parameter	In	Required	Type
`evaluation_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Responses: 200 ReleaseGateEvaluationRead, 422 HTTPValidationError

GET `/v1/release-gates/{evaluation_id}/evidence.json`

Download signed machine-readable release evidence JSON

Parameter	In	Required	Type
`evaluation_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Responses: 200, 422 HTTPValidationError

GET `/v1/release-gates/{evaluation_id}/evidence.md`

Download human-readable release evidence Markdown report

Parameter	In	Required	Type
`evaluation_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Responses: 200, 422 HTTPValidationError

GET `/v1/security-reports/{report_id}/ci-gate`

Get Security Report Ci Gate

Parameter	In	Required	Type
`report_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Responses: 200 string, 422 HTTPValidationError

GET `/v1/security-reports/{report_id}/ci-result`

Get Security Report Ci Result

Parameter	In	Required	Type
`report_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Responses: 200 SecurityReportCiResult, 422 HTTPValidationError

GET `/v1/security-reports/{report_id}/policy-result`

Get Security Report Policy Result

Parameter	In	Required	Type
`report_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Responses: 200 SecurityReportPolicyResult, 422 HTTPValidationError

Scope `gates:evaluate`

POST `/v1/security-reports/{report_id}/release-gate/evaluate`

Evaluate candidate report against release baseline

Parameter	In	Required	Type
`report_id`	path	yes	`string (uuid)`
`authorization`	header	no	`string \| null`

Body: ReleaseGateEvaluateRequest as application/json

Responses: 201 ReleaseGateEvaluationRead, 422 HTTPValidationError

Scope `ide:read`

GET `/v1/ide/findings`

Ide Findings

Parameter	In	Required	Type
`organization_id`	query	yes	`string (uuid)`
`remote`	query	yes	`string`
`authorization`	header	no	`string \| null`

Responses: 200 IdeFindings, 422 HTTPValidationError

Using the API

Versioning and deprecation

Command-line client

Scope any token

GET /v1/auth/me

Scope org:read

GET /v1/organizations

GET /v1/scanner-capabilities

Scope repositories:read

GET /v1/repositories

GET /v1/repositories/{repository_id}/automation-runs

GET /v1/repositories/{repository_id}/baselines

GET /v1/repositories/{repository_id}/infrastructure-surface

GET /v1/repositories/{repository_id}/regression

GET /v1/repositories/{repository_id}/release-baselines

GET /v1/repositories/{repository_id}/scan-policy

GET /v1/repositories/{repository_id}/schedules

GET /v1/repositories/{repository_id}/scorecard

Scope repositories:write

POST /v1/repositories

PUT /v1/repositories/{repository_id}/baseline

PUT /v1/repositories/{repository_id}/scan-policy

DELETE /v1/repositories/{repository_id}/scan-policy

Scope scans:read

GET /v1/ai-security-scans/{scan_id}

GET /v1/ai-targets

GET /v1/ai-targets/{target_id}/scans

GET /v1/assessments

GET /v1/assessments/{assessment_id}

GET /v1/assessments/{assessment_id}/comparison

GET /v1/assessments/{assessment_id}/summary

GET /v1/cloud-posture/scans

GET /v1/cloud-posture/scans/{scan_id}

GET /v1/cloud/accounts

GET /v1/cloud/accounts/{account_id}

GET /v1/organizations/{organization_id}/container-images/scans

GET /v1/organizations/{organization_id}/container-images/scans/{scan_id}

GET /v1/web-scans/{scan_id}

GET /v1/web-targets

GET /v1/web-targets/{target_id}/scans

Scope scans:trigger

POST /v1/ai-security-scans/{scan_id}/cancel

POST /v1/ai-targets/{target_id}/scans

POST /v1/assessments

POST /v1/assessments/{assessment_id}/cancel

POST /v1/cloud/accounts/{account_id}/scans

POST /v1/cloud/scans/{scan_id}/cancel

POST /v1/organizations/{organization_id}/container-images/scans

POST /v1/repository-schedules/{schedule_id}/run

POST /v1/security-reports

POST /v1/security-reports/{report_id}/cancel

POST /v1/web-scan-schedules/{schedule_id}/run

POST /v1/web-scans/{scan_id}/cancel

POST /v1/web-targets/{target_id}/scans

Scope findings:read

GET /v1/assessments/{assessment_id}/findings

GET /v1/cloud-posture/accounts/{account_id}/findings

GET /v1/cloud-posture/scans/{scan_id}/issues

GET /v1/organizations/{organization_id}/container-images/scans/{scan_id}/findings

GET /v1/security-reports/{report_id}/findings

GET /v1/security-reports/{report_id}/findings/{dedupe_key}

GET /v1/security-reports/{report_id}/findings/{dedupe_key}/remediation

GET /v1/security-reports/{report_id}/secret-incidents

Scope findings:write

PATCH /v1/findings/{finding_id}

PATCH /v1/security-reports/{report_id}/findings/{dedupe_key}

PATCH /v1/security-reports/{report_id}/secret-incidents/{dedupe_key}

Scope reports:read

GET /v1/assessments/{assessment_id}/reports/developer

GET /v1/assessments/{assessment_id}/reports/executive

GET /v1/cloud-posture/scans/{scan_id}/report

GET /v1/security-reports

GET /v1/security-reports/{report_id}

GET /v1/security-reports/{report_id}/comparison

GET /v1/security-reports/{report_id}/compliance

GET /v1/security-reports/{report_id}/components

GET /v1/security-reports/{report_id}/coverage

GET /v1/security-reports/{report_id}/license-compliance

GET /v1/security-reports/{report_id}/plain-summary

GET /v1/security-reports/{report_id}/regression

Scope `any token`

GET `/v1/auth/me`

Scope `org:read`

GET `/v1/organizations`

GET `/v1/scanner-capabilities`

Scope `repositories:read`

GET `/v1/repositories`

GET `/v1/repositories/{repository_id}/automation-runs`

GET `/v1/repositories/{repository_id}/baselines`

GET `/v1/repositories/{repository_id}/infrastructure-surface`

GET `/v1/repositories/{repository_id}/regression`

GET `/v1/repositories/{repository_id}/release-baselines`

GET `/v1/repositories/{repository_id}/scan-policy`

GET `/v1/repositories/{repository_id}/schedules`

GET `/v1/repositories/{repository_id}/scorecard`

Scope `repositories:write`

POST `/v1/repositories`

PUT `/v1/repositories/{repository_id}/baseline`

PUT `/v1/repositories/{repository_id}/scan-policy`

DELETE `/v1/repositories/{repository_id}/scan-policy`

Scope `scans:read`

GET `/v1/ai-security-scans/{scan_id}`

GET `/v1/ai-targets`

GET `/v1/ai-targets/{target_id}/scans`

GET `/v1/assessments`

GET `/v1/assessments/{assessment_id}`

GET `/v1/assessments/{assessment_id}/comparison`

GET `/v1/assessments/{assessment_id}/summary`

GET `/v1/cloud-posture/scans`

GET `/v1/cloud-posture/scans/{scan_id}`

GET `/v1/cloud/accounts`

GET `/v1/cloud/accounts/{account_id}`

GET `/v1/organizations/{organization_id}/container-images/scans`

GET `/v1/organizations/{organization_id}/container-images/scans/{scan_id}`

GET `/v1/web-scans/{scan_id}`

GET `/v1/web-targets`

GET `/v1/web-targets/{target_id}/scans`

Scope `scans:trigger`

POST `/v1/ai-security-scans/{scan_id}/cancel`

POST `/v1/ai-targets/{target_id}/scans`

POST `/v1/assessments`

POST `/v1/assessments/{assessment_id}/cancel`

POST `/v1/cloud/accounts/{account_id}/scans`

POST `/v1/cloud/scans/{scan_id}/cancel`

POST `/v1/organizations/{organization_id}/container-images/scans`

POST `/v1/repository-schedules/{schedule_id}/run`

POST `/v1/security-reports`

POST `/v1/security-reports/{report_id}/cancel`

POST `/v1/web-scan-schedules/{schedule_id}/run`

POST `/v1/web-scans/{scan_id}/cancel`

POST `/v1/web-targets/{target_id}/scans`

Scope `findings:read`

GET `/v1/assessments/{assessment_id}/findings`

GET `/v1/cloud-posture/accounts/{account_id}/findings`

GET `/v1/cloud-posture/scans/{scan_id}/issues`

GET `/v1/organizations/{organization_id}/container-images/scans/{scan_id}/findings`

GET `/v1/security-reports/{report_id}/findings`

GET `/v1/security-reports/{report_id}/findings/{dedupe_key}`

GET `/v1/security-reports/{report_id}/findings/{dedupe_key}/remediation`

GET `/v1/security-reports/{report_id}/secret-incidents`

Scope `findings:write`

PATCH `/v1/findings/{finding_id}`

PATCH `/v1/security-reports/{report_id}/findings/{dedupe_key}`

PATCH `/v1/security-reports/{report_id}/secret-incidents/{dedupe_key}`

Scope `reports:read`

GET `/v1/assessments/{assessment_id}/reports/developer`

GET `/v1/assessments/{assessment_id}/reports/executive`

GET `/v1/cloud-posture/scans/{scan_id}/report`

GET `/v1/security-reports`

GET `/v1/security-reports/{report_id}`

GET `/v1/security-reports/{report_id}/comparison`

GET `/v1/security-reports/{report_id}/compliance`

GET `/v1/security-reports/{report_id}/components`

GET `/v1/security-reports/{report_id}/coverage`

GET `/v1/security-reports/{report_id}/license-compliance`

GET `/v1/security-reports/{report_id}/plain-summary`

GET `/v1/security-reports/{report_id}/regression`

GET `/v1/security-reports/{report_id}/sbom`

GET `/v1/security-reports/{report_id}/sbom/attestation`

GET `/v1/security-reports/{report_id}/sbom/comparison`