Create URL Scan

Deprecated

POST /accounts/{account_id}/urlscanner/scan

Copy endpoint

https://api.cloudflare.com/client/v4

Submit a URL to scan. You can also set some options, like the visibility level and custom headers. Check limits at https://developers.cloudflare.com/security-center/investigate/scan-limits/.

Parameters

path Path Parameters

Name	Type
`account_id` required Account ID.	string

Request Body

application/json

{
country?: "AF" | "AL" | "DZ" | "AD" | "AO" | "AG" | "AR" | "AM" | "AU" | "AT" | "AZ" | "BH" | "BD" | "BB" | "BY" | "BE" | "BZ" | "BJ" | "BM" | "BT" | "BO" | "BA" | "BW" | "BR" | "BN" | "BG" | "BF" | "BI" | "KH" | "CM" | "CA" | "CV" | "KY" | "CF" | "TD" | "CL" | "CN" | "CO" | "KM" | "CG" | "CR" | "CI" | "HR" | "CU" | "CY" | "CZ" | "CD" | "DK" | "DJ" | "DM" | "DO" | "EC" | "EG" | "SV" | "GQ" | "ER" | "EE" | "SZ" | "ET" | "FJ" | "FI" | "FR" | "GA" | "GE" | "DE" | "GH" | "GR" | "GL" | "GD" | "GT" | "GN" | "GW" | "GY" | "HT" | "HN" | "HU" | "IS" | "IN" | "ID" | "IR" | "IQ" | "IE" | "IL" | "IT" | "JM" | "JP" | "JO" | "KZ" | "KE" | "KI" | "KW" | "KG" | "LA" | "LV" | "LB" | "LS" | "LR" | "LY" | "LI" | "LT" | "LU" | "MO" | "MG" | "MW" | "MY" | "MV" | "ML" | "MR" | "MU" | "MX" | "FM" | "MD" | "MC" | "MN" | "MS" | "MA" | "MZ" | "MM" | "NA" | "NR" | "NP" | "NL" | "NZ" | "NI" | "NE" | "NG" | "KP" | "MK" | "NO" | "OM" | "PK" | "PS" | "PA" | "PG" | "PY" | "PE" | "PH" | "PL" | "PT" | "QA" | "RO" | "RU" | "RW" | "SH" | "KN" | "LC" | "VC" | "WS" | "SM" | "ST" | "SA" | "SN" | "RS" | "SC" | "SL" | "SK" | "SI" | "SB" | "SO" | "ZA" | "KR" | "SS" | "ES" | "LK" | "SD" | "SR" | "SE" | "CH" | "SY" | "TW" | "TJ" | "TZ" | "TH" | "BS" | "GM" | "TL" | "TG" | "TO" | "TT" | "TN" | "TR" | "TM" | "UG" | "UA" | "AE" | "GB" | "US" | "UY" | "UZ" | "VU" | "VE" | "VN" | "YE" | "ZM" | "ZW";
customHeaders?: { };
screenshotsResolutions?: ("desktop" | "mobile" | "tablet")[];
url: string;
visibility?: "Public" | "Unlisted";
}

Responses

200 application/json

Scan request accepted successfully.

{
errors: { message: string; }[];
messages: { message: string; }[];
result: {
time: string;
url: string;
uuid: string;
visibility: "public" | "unlisted";
};
success: boolean;
}

Client Errors

400 application/json

Invalid params.

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

409 application/json

Scan request denied: hostname was recently scanned.

{
errors: { message: string; }[];
messages: { message: string; }[];
result: { tasks: {
clientLocation: string;
clientType: "Site" | "Automatic" | "Api";
effectiveUrl: string;
errors: { ... }[];
scannedFrom: { ... };
status: "Queued" | "InProgress" | "InPostProcessing" | "Finished";
success: boolean;
time: string;
timeEnd: string;
url: string;
uuid: string;
visibility: "Public" | "Unlisted";
}[]; };
success: boolean;
}

429 application/json

Scan request denied: rate limited.

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