Skip to main content
GET
Error

Authorizations

​
Authorization
string
header
required

Scoped API token from Settings → API Tokens (scopes: scans:trigger, scans:read).

Headers

​
CF-Access-Client-Id
string

Cloudflare Access service-token client id (ends in .access). Only for CF-Access-fronted deployments; leave blank for self-hosted.

​
CF-Access-Client-Secret
string

Cloudflare Access service-token secret. Pair it with CF-Access-Client-Id.

Path Parameters

​
scanId
string
required

Scan job ID returned by a trigger call.

Response

Current scan state.

​
id
string
​
status
enum<string>

Terminal states are COMPLETED, FAILED, and CANCELLED.

Available options:
PENDING,
RUNNING,
COMPLETED,
FAILED,
CANCELLED
​
scanTypes
string[]

Scan tiers to run. Omit for the server default (SAST, SCA, SECRET, IAC for repositories). Valid values depend on target type.

Example:
​
currentPhase
string

Present while RUNNING.

​
currentPhasePct
integer

0–100, present while RUNNING.