POST /accounts/{account_id}/urlscanner/scan

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/.

Servers

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

Path parameters

Name	Type	Required	Description
`account_id`	String	Yes	Account ID.

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`customHeaders`	Object	No	Set custom headers.
`visibility`	String	No	The option `Public` means it will be included in listings like recent scans and search results. `Unlisted` means it will not be included in the aforementioned listings, users will need to have the scan's ID to access it. A a scan will be automatically marked as unlisted if it fails, if it contains potential PII or other sensitive material. Possible values: `"Unlisted"` `"Public"` Default value: "Public"
`url`	String	Yes
`screenshotsResolutions[]`	Array	No	Take multiple screenshots targeting different device types. Default value: [ "desktop" ]
`country`	String	No	Possible values: `"BO"` `"AM"` `"MU"` `"LS"` `"JO"` `"TR"` `"MD"` `"LB"` `"GY"` `"CR"` `"SA"` `"MV"` `"LT"` `"KR"` `"JP"` `"IN"` `"EE"` `"CA"` `"RO"` `"PK"` `"NG"` `"LC"` `"TD"` `"SB"` `"AO"` `"MW"` `"LU"` `"FI"` `"EG"` `"DE"` `"TT"` `"SR"` `"PL"` `"BR"` `"SC"` `"NZ"` `"MX"` `"LV"` `"ZA"` `"HN"` `"GL"` `"FJ"` `"CD"` `"ST"` `"SS"` `"BA"` `"NI"` `"MG"` `"UG"` `"MY"` `"IQ"` `"GM"` `"UY"` `"TW"` `"RS"` `"BB"` `"CU"` `"SD"` `"BS"` `"QA"` `"MZ"` `"IR"` `"GN"` `"UZ"` `"CF"` `"SV"` `"BD"` `"OM"` `"KE"` `"CV"` `"TG"` `"BT"` `"SE"` `"AR"` `"LY"` `"KW"` `"IS"` `"FM"` `"CG"` `"BE"` `"RU"` `"NL"` `"TH"` `"IT"` `"HR"` `"DJ"` `"TZ"` `"CH"` `"BF"` `"AD"` `"MK"` `"LI"` `"KG"` `"DZ"` `"AT"` `"PA"` `"KY"` `"GQ"` `"DK"` `"CI"` `"SY"` `"BG"` `"RW"` `"AE"` `"PS"` `"NO"` `"ML"` `"KH"` `"ID"` `"VN"` `"CY"` `"TJ"` `"BW"` `"SH"` `"AU"` `"KZ"` `"HT"` `"YE"` `"GR"` `"SZ"` `"BH"` `"AF"` `"PT"` `"NP"` `"MN"` `"MM"` `"LK"` `"KI"` `"ZW"` `"IE"` `"GA"` `"CZ"` `"SI"` `"HU"` `"DM"` `"BI"` `"AG"` `"MO"` `"GB"` `"TL"` `"BY"` `"GT"` `"FR"` `"CL"` `"BJ"` `"NR"` `"WS"` `"TM"` `"BZ"` `"SK"` `"PE"` `"NA"` `"DO"` `"CM"` `"KM"` `"GD"` `"TN"` `"SL"` `"ER"` `"VC"` `"UA"` `"CN"` `"MR"` `"KN"` `"GE"` `"TO"` `"SM"` `"AZ"` `"PG"` `"MA"` `"GW"` `"ES"` `"CO"` `"BM"` `"PY"` `"MS"` `"JM"` `"SN"` `"PH"` `"ET"` `"VE"` `"BN"` `"AL"` `"LR"` `"KP"` `"IL"` `"GH"` `"VU"` `"EC"` `"US"` `"SO"` `"NE"` `"MC"` `"LA"` `"ZM"`

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.