Skip to main content
POST
/
api
/
v1
/
connected-orgs
/
{connected_org_id}
/
scans
Trigger Scan
curl --request POST \
  --url https://api.example.com/api/v1/connected-orgs/{connected_org_id}/scans \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "scan_type": "incremental"
}
'
{
  "message": "<string>",
  "scan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>"
}

Authorizations

​
X-API-Key
string
header
required

Headers

​
X-Workspace-Id
string | null

Path Parameters

​
connected_org_id
string<uuid>
required

Cookies

​
riftmap_access
string | null

Body

application/json

Optional request body for POST /organizations/{org_id}/scans.

​
scan_type
string
default:incremental

Response

Successful Response

Returned immediately after a scan is queued.

​
message
string
required
​
scan_id
string<uuid>
required
​
status
string
required