Search + K

Command Palette

Search for a command to run...

Sign In

Get URL scan

Deprecated
GET /accounts/{account_id}/urlscanner/scan/{scan_id}
Copy endpoint
https://api.cloudflare.com/client/v4

Get URL scan by uuid

Parameters

path Path Parameters

Name Type
scan_id required

Scan UUID.

string
account_id required

Account ID.

string

query Query Parameters

Name Type
full

Whether to return full report (scan summary and network log).

boolean

Responses

200 application/json

Scan has finished. It may or may not have been successful.

{
errors: { message: string; }[];
messages: { message: string; }[];
result: { scan: {
asns?: { ... };
certificates: { ... }[];
domains?: { ... };
geo: { ... };
ips?: { ... };
links?: { ... };
meta: { ... };
page: { ... };
performance: { ... }[];
task: { ... };
verdicts: { ... };
}
; }
;
success: boolean;
}
202 application/json

Scan is in progress. Check current status in result.scan.task.status. Possible statuses: Queued,InProgress,InPostProcessing,Finished.

{
errors: { message: string; }[];
messages: { message: string; }[];
result: { scan: { task: { ... }; }; };
success: boolean;
}

Client Errors

400 application/json

Invalid params.

{ errors: { message: string; }[];messages: { message: string; }[];success: boolean; }
404 application/json

Scan not found.

{ errors: { message: string; }[];messages: { message: string; }[];success: boolean; }