URL Scanner

url_scanner

Domain types

URLScannerDomain = { id, name, super_category_id }
URLScannerTask = { effectiveUrl, errors, location, 7 more... }
URL Scanner

Responses

url_scanner.responses

Methods

Get Raw Response -> string
get/accounts/{account_id}/urlscanner/v2/responses/{response_id}

Returns the raw response of the network request. If HTML, a plain text response will be returned.

url_scanner.scans

Methods

Bulk Create URL Scans -> Array<{ api, result, url, 3 more... }>
post/accounts/{account_id}/urlscanner/v2/bulk

Submit URLs to scan. Check limits at https://developers.cloudflare.com/security-center/investigate/scan-limits/ and take into account scans submitted in bulk have lower priority and may take longer to finish.

Create URL Scan -> Envelope<string>
post/accounts/{account_id}/urlscanner/v2/scan
Get URL Scan S DOM -> string
get/accounts/{account_id}/urlscanner/v2/dom/{scan_id}

Returns a plain text response, with the scan's DOM content as rendered by Chrome.

Get URL Scan -> { data, lists, meta, 5 more... }
get/accounts/{account_id}/urlscanner/v2/result/{scan_id}

Get URL scan by uuid

Get URL Scan S HAR -> { log }
get/accounts/{account_id}/urlscanner/v2/har/{scan_id}

Get a URL scan's HAR file. See HAR spec at http://www.softwareishard.com/blog/har-12-spec/.

Search URL Scans -> { results }
get/accounts/{account_id}/urlscanner/v2/search

Use a subset of ElasticSearch Query syntax to filter scans. Some example queries:

- 'page.domain:microsoft AND verdicts.malicious:true AND NOT page.domain:microsoft.com': malicious scans whose hostname starts with "microsoft".
- 'apikey:me AND date:[2024-01 TO 2024-10]': my scans from 2024 January to 2024 October.
- 'page.domain:(blogspot OR www.blogspot)': Searches for scans whose main domain starts with "blogspot" or with "www.blogspot"
- 'page.asn:AS24940 AND hash:xxx': Websites hosted in AS24940 where a resource with the given hash was downloaded.

Get Screenshot -> unknown
get/accounts/{account_id}/urlscanner/v2/screenshots/{scan_id}.png

Get scan's screenshot by resolution (desktop/mobile/tablet).