COcodethreat
Scans

Run scan (sync/async)

Start a scan and optionally wait for completion

post/scans/run

Request

  • Base URL
    https://app.codethreat.com/api/v1
  • Auth
    API key in header X-API-Key

Request body

repositoryIdstring required
branchstring
scanTypesstring[]
waitboolean

Wait for scan completion

timeoutinteger

Timeout in seconds (only if wait=true)

pollIntervalinteger

Poll interval in seconds (only if wait=true)

scanTrigger'manual' | 'ci/cd' | 'api'
pullRequestIdstring
commitShastring
metadataobject

Response

Scan completed (if wait=true)

successboolean

Changes

No recorded changes to this operation across all 1 revision of this API.