Create Scan

POST /api/v1/scans

Create Scan

cURL

curl --request POST \
  --url https://api.veridical.dev/api/v1/scans \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "repository_id": "<string>",
  "workspace_id": "<string>",
  "client_request_id": "<string>",
  "config": {},
  "scan_type": "security",
  "source_ref": "<string>",
  "trigger_type": "manual"
}
'

202

{}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key · string | null

Required string length: 8 - 200

X-Correlation-ID · string | null

authorization · string | null

Body

application/json

repository_id · string · required

workspace_id · string · required

client_request_id · string | null

Required string length: 8 - 200

config · Config · object

scan_type · string · default: security

Pattern: ^(security|onboarding|full)$

source_ref · string | null

Maximum string length: 256

trigger_type · string · default: manual

Pattern: ^(manual|onboarding|scheduled|deployment|api)$

Response

202

application/json

Successful Response

The response is of type Response Create Scan Api V1 Scans Post · object.