Skip to main content
POST
/
api
/
v1
/
scans
/
{scan_id}
/
cancel
Cancel Scan
curl --request POST \
  --url https://api.example.com/api/v1/scans/{scan_id}/cancel \
  --header 'X-API-Key: <api-key>'
{
  "completed_at": "2023-11-07T05:31:56Z",
  "connected_org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "errors": {},
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "scan_type": "<string>",
  "scanned_repos": 123,
  "skipped_repos": 123,
  "started_at": "2023-11-07T05:31:56Z",
  "status": "<string>",
  "total_repos": 123,
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
X-API-Key
string
header
required

Headers

​
X-Workspace-Id
string | null

Path Parameters

​
scan_id
string<uuid>
required

Cookies

​
riftmap_access
string | null

Response

Successful Response

Full scan record.

​
completed_at
string<date-time> | null
required
​
connected_org_id
string<uuid>
required
​
created_at
string<date-time>
required
​
errors
Errors · object
required
​
id
string<uuid>
required
​
scan_type
string
required
​
scanned_repos
integer
required
​
skipped_repos
integer
required
​
started_at
string<date-time> | null
required
​
status
string
required
​
total_repos
integer
required
​
updated_at
string<date-time>
required