Search scans by date and webpages' requests, including full URL (after redirects), hostname, and path. <br/> 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.
/accounts/{accountId}/urlscanner/scan
get
URL Scanner
urlscanner-search-scans
{
"business": true,
"enterprise": true,
"free": true,
"pro": true
}{
"enum": [
"com.cloudflare.api.account.url-scanner.read"
]
}[
{
"in": "path",
"name": "accountId",
"required": true,
"schema": {
"description": "Account Id",
"type": "string"
}
},
{
"in": "query",
"name": "scanId",
"schema": {
"description": "Scan uuid",
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"schema": {
"description": "Limit the number of objects in the response.",
"example": 100,
"type": "integer"
}
},
{
"in": "query",
"name": "next_cursor",
"schema": {
"description": "Pagination cursor to get the next set of results.",
"type": "string"
}
},
{
"in": "query",
"name": "date_start",
"schema": {
"description": "Filter scans requested after date (inclusive).",
"format": "date-time",
"type": "string"
}
},
{
"in": "query",
"name": "date_end",
"schema": {
"description": "Filter scans requested before date (inclusive).",
"format": "date-time",
"type": "string"
}
},
{
"in": "query",
"name": "url",
"schema": {
"description": "Filter scans by exact match URL of _any_ request made by the webpage",
"example": "https://example.com/?hello",
"type": "string"
}
},
{
"in": "query",
"name": "hostname",
"schema": {
"description": "Filter scans by hostname of _any_ request made by the webpage.",
"example": "example.com",
"type": "string"
}
},
{
"in": "query",
"name": "path",
"schema": {
"description": "Filter scans by url path of _any_ request made by the webpage.",
"example": "/samples/subresource-integrity/",
"type": "string"
}
},
{
"in": "query",
"name": "page_url",
"schema": {
"description": "Filter scans by exact match to scanned URL (_after redirects_)",
"type": "string"
}
},
{
"in": "query",
"name": "page_hostname",
"schema": {
"description": "Filter scans by main page hostname .",
"type": "string"
}
},
{
"in": "query",
"name": "page_path",
"schema": {
"description": "Filter scans by exact match URL path (also supports suffix search).",
"type": "string"
}
},
{
"in": "query",
"name": "account_scans",
"schema": {
"description": "Return only scans created by account.",
"type": "boolean"
}
}
]null{
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"errors": {
"items": {
"properties": {
"message": {
"example": "Error",
"type": "string"
}
},
"required": [
"message"
],
"type": "object"
},
"type": "array"
},
"messages": {
"items": {
"properties": {
"message": {
"example": "OK",
"type": "string"
}
},
"required": [
"message"
],
"type": "object"
},
"type": "array"
},
"result": {
"properties": {
"tasks": {
"items": {
"properties": {
"success": {
"description": "Whether scan was successful or not",
"type": "boolean"
},
"time": {
"description": "When scan was submitted (UTC)",
"format": "date-time",
"type": "string"
},
"url": {
"description": "Scan url (after redirects)",
"example": "https://www.example.com/",
"type": "string"
},
"uuid": {
"description": "Scan id",
"format": "uuid",
"type": "string"
}
},
"required": [
"uuid",
"url",
"success",
"time"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"tasks"
],
"type": "object"
},
"success": {
"description": "Whether search request was successful or not",
"type": "boolean"
}
},
"required": [
"messages",
"errors",
"success",
"result"
],
"type": "object"
}
}
},
"description": "Search results"
},
"400": {
"content": {
"application/json": {
"schema": {
"properties": {
"errors": {
"items": {
"properties": {
"message": {
"example": "Scan ID is not a valid uuid.",
"type": "string"
}
},
"required": [
"message"
],
"type": "object"
},
"type": "array"
},
"messages": {
"items": {
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
],
"type": "object"
},
"type": "array"
},
"success": {
"description": "Whether request was successful or not",
"type": "boolean"
}
},
"required": [
"messages",
"errors",
"success"
],
"type": "object"
}
}
},
"description": "Invalid params."
}
}[
{
"api_email": [],
"api_key": []
}
]