GET /accounts/{account_id}/urlscanner/scan
Search scans by date and webpages' requests, including full URL (after redirects), hostname, and path.
A successful scan will appear in search results a few minutes after finishing but may take much longer if the system in under load. By default, only successfully completed scans will appear in search results, unless searching by scanId
. Please take into account that older scans may be removed from the search index at an unspecified time.
Servers
- https://api.cloudflare.com/client/v4
Path parameters
Name | Type | Required | Description |
---|---|---|---|
account_id |
String | Yes |
Account ID. |
Query parameters
Name | Type | Required | Description |
---|---|---|---|
account_scans |
Boolean | No |
Return only scans created by account. |
date_start |
String | No |
Filter scans requested after date (inclusive). |
url |
String | No |
Filter scans by URL of any request made by the webpage |
page_path |
String | No |
Filter scans by exact match of effective URL path (also supports suffix search). |
hostname |
String | No |
Filter scans by hostname of any request made by the webpage. |
page_url |
String | No |
Filter scans by submitted or scanned URL |
path |
String | No |
Filter scans by url path of any request made by the webpage. |
limit |
Integer | No |
Limit the number of objects in the response. |
hash |
String | No |
Filter scans by hash of any html/js/css request made by the webpage. |
scan_id |
String | No |
Scan UUID. |
page_ip |
String | No |
Filter scans by main page IP address (IPv4 or IPv6). |
next_cursor |
String | No |
Pagination cursor to get the next set of results. |
is_malicious |
Boolean | No |
Filter scans by malicious verdict. |
ip |
String | No |
Filter scans by IP address (IPv4 or IPv6) of any request made by the webpage. |
page_hostname |
String | No |
Filter scans by main page hostname (domain of effective URL). |
page_asn |
String | No |
Filter scans by main page Autonomous System Number (ASN). |
date_end |
String | No |
Filter scans requested before date (inclusive). |
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.