scan

Start a repository scan

Changed on
post/workspaces/{workspaceSlug}/practices/scans

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /workspaces/{workspaceSlug}/practices/scans
  • Auth: HTTP bearer

Path parameters

workspaceSlugstring required

Workspace slug

Headers

Idempotency-Keystring uuid required

Request body

budgetUsdstring required
expectedVersionstring nullable required
practiceSlugsstring[] nullable required
refstring nullable required
repositoryItemIdstring required
reuseboolean nullable required

Response

Accepted

baselineScanIdstring uuid nullable required
completedAtstring date-time nullable required
createdAtstring date-time required
idstring uuid required
itemVersionstring required
origin'EVENT' | 'REQUEST' | 'SCHEDULE' | 'BACKFILL' required
practiceCountinteger required
refstring required
startedAtstring date-time nullable required
status'QUEUED' | 'RUNNING' | 'COMPLETE' | 'PARTIAL' | 'FAILED' | 'CANCELLED' required
stopReason'TIMED_OUT' | 'EXECUTION_FAILED' | 'PREPARATION_FAILED' | 'PROCESSING_FAILED' | 'PERSON_DATA_ERASED' | 'STALE_ROLLOUT_REVISION' | 'CANCELLED_BY_ADMIN' | 'REPLACED' | 'LEGACY_FAILURE' | 'EXECUTION_INCOMPLETE' | 'RESULT_WITHHELD' | 'READINESS_REFUSED' | 'SUSPECT_LISTING' | 'BUDGET' | 'USAGE_UNVERIFIABLE' | 'DEADLINE' | 'CANCELLED' | 'ENUMERATION_FAILED' | 'ENUMERATION_LIMIT' | 'NO_SCAN_PRACTICES' | 'MODEL_CHANGED' | 'MODEL_UNAVAILABLE' | 'ERROR' | 'LEGACY_SCOPE_UNKNOWN' | 'CONTRACT_CHANGED' | 'null' nullable required

Changes