Get URL scan
client.urlScanner.scans.get(stringscanId, ScanGetParams { account_id } params, RequestOptionsoptions?): ScanGetResponse { data, lists, meta, 5 more }
GET/accounts/{account_id}/urlscanner/v2/result/{scan_id}
Get URL scan by uuid
Security
API Token
The preferred authorization scheme for interacting with the Cloudflare API. Create a token.
Example:
API Email + API Key
The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.
Example:
The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.
Example:
Accepted Permissions (at least one required)
Get URL scan
import Cloudflare from 'cloudflare';
const client = new Cloudflare({
apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});
const scan = await client.urlScanner.scans.get('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', {
account_id: 'account_id',
});
console.log(scan.data);{
"data": {
"console": [
{
"message": {
"level": "level",
"source": "source",
"text": "text",
"url": "url"
}
}
],
"cookies": [
{
"domain": "domain",
"expires": 0,
"httpOnly": true,
"name": "name",
"path": "path",
"priority": "priority",
"sameParty": true,
"secure": true,
"session": true,
"size": 0,
"sourcePort": 0,
"sourceScheme": "sourceScheme",
"value": "value"
}
],
"globals": [
{
"prop": "prop",
"type": "type"
}
],
"links": [
{
"href": "href",
"text": "text"
}
],
"performance": [
{
"duration": 0,
"entryType": "entryType",
"name": "name",
"startTime": 0
}
],
"requests": [
{
"request": {
"documentURL": "documentURL",
"hasUserGesture": true,
"initiator": {
"host": "host",
"type": "type",
"url": "url"
},
"redirectHasExtraInfo": true,
"request": {
"initialPriority": "initialPriority",
"isSameSite": true,
"method": "method",
"mixedContentType": "mixedContentType",
"referrerPolicy": "referrerPolicy",
"url": "url",
"headers": {}
},
"requestId": "requestId",
"type": "type",
"wallTime": 0,
"frameId": "frameId",
"loaderId": "loaderId",
"primaryRequest": true,
"redirectResponse": {
"charset": "charset",
"mimeType": "mimeType",
"protocol": "protocol",
"remoteIPAddress": "remoteIPAddress",
"remotePort": 0,
"securityHeaders": [
{
"name": "name",
"value": "value"
}
],
"securityState": "securityState",
"status": 0,
"statusText": "statusText",
"url": "url",
"headers": {}
}
},
"response": {
"asn": {
"asn": "asn",
"country": "country",
"description": "description",
"ip": "ip",
"name": "name",
"org": "org"
},
"dataLength": 0,
"encodedDataLength": 0,
"geoip": {
"city": "city",
"country": "country",
"country_name": "country_name",
"geonameId": "geonameId",
"ll": [
0
],
"region": "region"
},
"hasExtraInfo": true,
"requestId": "requestId",
"response": {
"charset": "charset",
"mimeType": "mimeType",
"protocol": "protocol",
"remoteIPAddress": "remoteIPAddress",
"remotePort": 0,
"securityDetails": {
"certificateId": 0,
"certificateTransparencyCompliance": "certificateTransparencyCompliance",
"cipher": "cipher",
"encryptedClientHello": true,
"issuer": "issuer",
"keyExchange": "keyExchange",
"keyExchangeGroup": "keyExchangeGroup",
"protocol": "protocol",
"sanList": [
"string"
],
"serverSignatureAlgorithm": 0,
"subjectName": "subjectName",
"validFrom": 0,
"validTo": 0
},
"securityHeaders": [
{
"name": "name",
"value": "value"
}
],
"securityState": "securityState",
"status": 0,
"statusText": "statusText",
"url": "url",
"headers": {}
},
"size": 0,
"type": "type",
"contentAvailable": true,
"hash": "hash"
},
"requests": [
{
"documentURL": "documentURL",
"frameId": "frameId",
"hasUserGesture": true,
"initiator": {
"type": "type"
},
"loaderId": "loaderId",
"redirectHasExtraInfo": true,
"request": {
"headers": {
"name": "name"
},
"initialPriority": "initialPriority",
"isSameSite": true,
"method": "method",
"mixedContentType": "mixedContentType",
"referrerPolicy": "referrerPolicy",
"url": "url"
},
"requestId": "requestId",
"type": "type",
"wallTime": 0
}
]
}
]
},
"lists": {
"asns": [
"string"
],
"certificates": [
{
"issuer": "issuer",
"subjectName": "subjectName",
"validFrom": 0,
"validTo": 0
}
],
"continents": [
"string"
],
"countries": [
"string"
],
"domains": [
"string"
],
"hashes": [
"string"
],
"ips": [
"string"
],
"linkDomains": [
"string"
],
"servers": [
"string"
],
"urls": [
"string"
]
},
"meta": {
"processors": {
"asn": {
"data": [
{
"asn": "asn",
"country": "country",
"description": "description",
"ip": "ip",
"name": "name"
}
]
},
"dns": {
"data": [
{
"address": "address",
"dnssec_valid": true,
"name": "name",
"type": "type"
}
]
},
"domainCategories": {
"data": [
{
"inherited": {},
"isPrimary": true,
"name": "name"
}
]
},
"geoip": {
"data": [
{
"geoip": {
"city": "city",
"country": "country",
"country_name": "country_name",
"ll": [
0
],
"region": "region"
},
"ip": "ip"
}
]
},
"phishing": {
"data": [
"string"
]
},
"radarRank": {
"data": [
{
"bucket": "bucket",
"hostname": "hostname",
"rank": 0
}
]
},
"wappa": {
"data": [
{
"app": "app",
"categories": [
{
"name": "name",
"priority": 0
}
],
"confidence": [
{
"confidence": 0,
"name": "name",
"pattern": "pattern",
"patternType": "patternType"
}
],
"confidenceTotal": 0,
"icon": "icon",
"website": "website"
}
]
},
"phishing_v2": {
"data": [
"string"
]
},
"robotsTxt": {
"data": [
{
"rules": {
"*": {
"allow": [
"string"
],
"disallow": [
"string"
],
"contentSignal": {
"ai-input": "no",
"ai-train": "yes",
"search": "yes"
},
"crawlDelay": 0
}
},
"sitemaps": [
"string"
],
"hash": "hash"
}
]
},
"urlCategories": {
"data": [
{
"content": [
{
"id": 0,
"name": "name",
"super_category_id": 0
}
],
"inherited": {
"content": [
{
"id": 0,
"name": "name",
"super_category_id": 0
}
],
"from": "from",
"risks": [
{
"id": 0,
"name": "name",
"super_category_id": 0
}
]
},
"name": "name",
"risks": [
{
"id": 0,
"name": "name",
"super_category_id": 0
}
]
}
]
}
}
},
"page": {
"apexDomain": "apexDomain",
"asn": "asn",
"asnname": "asnname",
"city": "city",
"country": "country",
"domain": "domain",
"ip": "ip",
"mimeType": "mimeType",
"server": "server",
"status": "200",
"title": "title",
"tlsAgeDays": 0,
"tlsIssuer": "tlsIssuer",
"tlsValidDays": 0,
"tlsValidFrom": "tlsValidFrom",
"url": "url",
"screenshot": {
"dhash": "dhash",
"mm3Hash": 0,
"name": "name",
"phash": "phash"
}
},
"scanner": {
"colo": "colo",
"country": "country"
},
"stats": {
"domainStats": [
{
"count": 0,
"countries": [
"string"
],
"domain": "domain",
"encodedSize": 0,
"index": 0,
"initiators": [
"string"
],
"ips": [
"string"
],
"redirects": 0,
"size": 0
}
],
"ipStats": [
{
"asn": {
"asn": "asn",
"country": "country",
"description": "description",
"ip": "ip",
"name": "name",
"org": "org"
},
"countries": [
"string"
],
"domains": [
"string"
],
"encodedSize": 0,
"geoip": {
"city": "city",
"country": "country",
"country_name": "country_name",
"ll": [
0
],
"region": "region"
},
"index": 0,
"ip": "ip",
"ipv6": true,
"redirects": 0,
"requests": 0,
"size": 0,
"count": 0
}
],
"IPv6Percentage": 0,
"malicious": 0,
"protocolStats": [
{
"count": 0,
"countries": [
"string"
],
"encodedSize": 0,
"ips": [
"string"
],
"protocol": "protocol",
"size": 0
}
],
"resourceStats": [
{
"compression": 0,
"count": 0,
"countries": [
"string"
],
"encodedSize": 0,
"ips": [
"string"
],
"percentage": 0,
"size": 0,
"type": "type"
}
],
"securePercentage": 0,
"secureRequests": 0,
"serverStats": [
{
"count": 0,
"countries": [
"string"
],
"encodedSize": 0,
"ips": [
"string"
],
"server": "server",
"size": 0
}
],
"tlsStats": [
{
"count": 0,
"countries": [
"string"
],
"encodedSize": 0,
"ips": [
"string"
],
"protocols": {
"TLS 1.3 / AES_128_GCM": 0
},
"securityState": "securityState",
"size": 0
}
],
"totalLinks": 0,
"uniqASNs": 0,
"uniqCountries": 0
},
"task": {
"apexDomain": "apexDomain",
"domain": "domain",
"domURL": "domURL",
"method": "method",
"options": {
"customHeaders": {},
"screenshotsResolutions": [
"string"
]
},
"reportURL": "reportURL",
"screenshotURL": "screenshotURL",
"source": "source",
"success": true,
"time": "time",
"url": "url",
"uuid": "uuid",
"visibility": "visibility"
},
"verdicts": {
"overall": {
"categories": [
"string"
],
"hasVerdicts": true,
"malicious": true,
"tags": [
"string"
]
}
}
}Returns Examples
{
"data": {
"console": [
{
"message": {
"level": "level",
"source": "source",
"text": "text",
"url": "url"
}
}
],
"cookies": [
{
"domain": "domain",
"expires": 0,
"httpOnly": true,
"name": "name",
"path": "path",
"priority": "priority",
"sameParty": true,
"secure": true,
"session": true,
"size": 0,
"sourcePort": 0,
"sourceScheme": "sourceScheme",
"value": "value"
}
],
"globals": [
{
"prop": "prop",
"type": "type"
}
],
"links": [
{
"href": "href",
"text": "text"
}
],
"performance": [
{
"duration": 0,
"entryType": "entryType",
"name": "name",
"startTime": 0
}
],
"requests": [
{
"request": {
"documentURL": "documentURL",
"hasUserGesture": true,
"initiator": {
"host": "host",
"type": "type",
"url": "url"
},
"redirectHasExtraInfo": true,
"request": {
"initialPriority": "initialPriority",
"isSameSite": true,
"method": "method",
"mixedContentType": "mixedContentType",
"referrerPolicy": "referrerPolicy",
"url": "url",
"headers": {}
},
"requestId": "requestId",
"type": "type",
"wallTime": 0,
"frameId": "frameId",
"loaderId": "loaderId",
"primaryRequest": true,
"redirectResponse": {
"charset": "charset",
"mimeType": "mimeType",
"protocol": "protocol",
"remoteIPAddress": "remoteIPAddress",
"remotePort": 0,
"securityHeaders": [
{
"name": "name",
"value": "value"
}
],
"securityState": "securityState",
"status": 0,
"statusText": "statusText",
"url": "url",
"headers": {}
}
},
"response": {
"asn": {
"asn": "asn",
"country": "country",
"description": "description",
"ip": "ip",
"name": "name",
"org": "org"
},
"dataLength": 0,
"encodedDataLength": 0,
"geoip": {
"city": "city",
"country": "country",
"country_name": "country_name",
"geonameId": "geonameId",
"ll": [
0
],
"region": "region"
},
"hasExtraInfo": true,
"requestId": "requestId",
"response": {
"charset": "charset",
"mimeType": "mimeType",
"protocol": "protocol",
"remoteIPAddress": "remoteIPAddress",
"remotePort": 0,
"securityDetails": {
"certificateId": 0,
"certificateTransparencyCompliance": "certificateTransparencyCompliance",
"cipher": "cipher",
"encryptedClientHello": true,
"issuer": "issuer",
"keyExchange": "keyExchange",
"keyExchangeGroup": "keyExchangeGroup",
"protocol": "protocol",
"sanList": [
"string"
],
"serverSignatureAlgorithm": 0,
"subjectName": "subjectName",
"validFrom": 0,
"validTo": 0
},
"securityHeaders": [
{
"name": "name",
"value": "value"
}
],
"securityState": "securityState",
"status": 0,
"statusText": "statusText",
"url": "url",
"headers": {}
},
"size": 0,
"type": "type",
"contentAvailable": true,
"hash": "hash"
},
"requests": [
{
"documentURL": "documentURL",
"frameId": "frameId",
"hasUserGesture": true,
"initiator": {
"type": "type"
},
"loaderId": "loaderId",
"redirectHasExtraInfo": true,
"request": {
"headers": {
"name": "name"
},
"initialPriority": "initialPriority",
"isSameSite": true,
"method": "method",
"mixedContentType": "mixedContentType",
"referrerPolicy": "referrerPolicy",
"url": "url"
},
"requestId": "requestId",
"type": "type",
"wallTime": 0
}
]
}
]
},
"lists": {
"asns": [
"string"
],
"certificates": [
{
"issuer": "issuer",
"subjectName": "subjectName",
"validFrom": 0,
"validTo": 0
}
],
"continents": [
"string"
],
"countries": [
"string"
],
"domains": [
"string"
],
"hashes": [
"string"
],
"ips": [
"string"
],
"linkDomains": [
"string"
],
"servers": [
"string"
],
"urls": [
"string"
]
},
"meta": {
"processors": {
"asn": {
"data": [
{
"asn": "asn",
"country": "country",
"description": "description",
"ip": "ip",
"name": "name"
}
]
},
"dns": {
"data": [
{
"address": "address",
"dnssec_valid": true,
"name": "name",
"type": "type"
}
]
},
"domainCategories": {
"data": [
{
"inherited": {},
"isPrimary": true,
"name": "name"
}
]
},
"geoip": {
"data": [
{
"geoip": {
"city": "city",
"country": "country",
"country_name": "country_name",
"ll": [
0
],
"region": "region"
},
"ip": "ip"
}
]
},
"phishing": {
"data": [
"string"
]
},
"radarRank": {
"data": [
{
"bucket": "bucket",
"hostname": "hostname",
"rank": 0
}
]
},
"wappa": {
"data": [
{
"app": "app",
"categories": [
{
"name": "name",
"priority": 0
}
],
"confidence": [
{
"confidence": 0,
"name": "name",
"pattern": "pattern",
"patternType": "patternType"
}
],
"confidenceTotal": 0,
"icon": "icon",
"website": "website"
}
]
},
"phishing_v2": {
"data": [
"string"
]
},
"robotsTxt": {
"data": [
{
"rules": {
"*": {
"allow": [
"string"
],
"disallow": [
"string"
],
"contentSignal": {
"ai-input": "no",
"ai-train": "yes",
"search": "yes"
},
"crawlDelay": 0
}
},
"sitemaps": [
"string"
],
"hash": "hash"
}
]
},
"urlCategories": {
"data": [
{
"content": [
{
"id": 0,
"name": "name",
"super_category_id": 0
}
],
"inherited": {
"content": [
{
"id": 0,
"name": "name",
"super_category_id": 0
}
],
"from": "from",
"risks": [
{
"id": 0,
"name": "name",
"super_category_id": 0
}
]
},
"name": "name",
"risks": [
{
"id": 0,
"name": "name",
"super_category_id": 0
}
]
}
]
}
}
},
"page": {
"apexDomain": "apexDomain",
"asn": "asn",
"asnname": "asnname",
"city": "city",
"country": "country",
"domain": "domain",
"ip": "ip",
"mimeType": "mimeType",
"server": "server",
"status": "200",
"title": "title",
"tlsAgeDays": 0,
"tlsIssuer": "tlsIssuer",
"tlsValidDays": 0,
"tlsValidFrom": "tlsValidFrom",
"url": "url",
"screenshot": {
"dhash": "dhash",
"mm3Hash": 0,
"name": "name",
"phash": "phash"
}
},
"scanner": {
"colo": "colo",
"country": "country"
},
"stats": {
"domainStats": [
{
"count": 0,
"countries": [
"string"
],
"domain": "domain",
"encodedSize": 0,
"index": 0,
"initiators": [
"string"
],
"ips": [
"string"
],
"redirects": 0,
"size": 0
}
],
"ipStats": [
{
"asn": {
"asn": "asn",
"country": "country",
"description": "description",
"ip": "ip",
"name": "name",
"org": "org"
},
"countries": [
"string"
],
"domains": [
"string"
],
"encodedSize": 0,
"geoip": {
"city": "city",
"country": "country",
"country_name": "country_name",
"ll": [
0
],
"region": "region"
},
"index": 0,
"ip": "ip",
"ipv6": true,
"redirects": 0,
"requests": 0,
"size": 0,
"count": 0
}
],
"IPv6Percentage": 0,
"malicious": 0,
"protocolStats": [
{
"count": 0,
"countries": [
"string"
],
"encodedSize": 0,
"ips": [
"string"
],
"protocol": "protocol",
"size": 0
}
],
"resourceStats": [
{
"compression": 0,
"count": 0,
"countries": [
"string"
],
"encodedSize": 0,
"ips": [
"string"
],
"percentage": 0,
"size": 0,
"type": "type"
}
],
"securePercentage": 0,
"secureRequests": 0,
"serverStats": [
{
"count": 0,
"countries": [
"string"
],
"encodedSize": 0,
"ips": [
"string"
],
"server": "server",
"size": 0
}
],
"tlsStats": [
{
"count": 0,
"countries": [
"string"
],
"encodedSize": 0,
"ips": [
"string"
],
"protocols": {
"TLS 1.3 / AES_128_GCM": 0
},
"securityState": "securityState",
"size": 0
}
],
"totalLinks": 0,
"uniqASNs": 0,
"uniqCountries": 0
},
"task": {
"apexDomain": "apexDomain",
"domain": "domain",
"domURL": "domURL",
"method": "method",
"options": {
"customHeaders": {},
"screenshotsResolutions": [
"string"
]
},
"reportURL": "reportURL",
"screenshotURL": "screenshotURL",
"source": "source",
"success": true,
"time": "time",
"url": "url",
"uuid": "uuid",
"visibility": "visibility"
},
"verdicts": {
"overall": {
"categories": [
"string"
],
"hasVerdicts": true,
"malicious": true,
"tags": [
"string"
]
}
}
}