Skip to content
Cloudflare API
Start here
API Reference

URL Scanner

ModelsExpand Collapse
class URLScannerDomain: …
id: int
name: str
super_category_id: Optional[int]
class URLScannerTask: …
effective_url: str
errors: List[Error]
message: str
location: str
region: str
status: str
success: bool
time: str
url: str
uuid: str
visibility: str

URL ScannerResponses

Get raw response
url_scanner.responses.get(strresponse_id, ResponseGetParams**kwargs) -> ResponseGetResponse
GET/accounts/{account_id}/urlscanner/v2/responses/{response_id}
ModelsExpand Collapse
str

Web resource or image.

URL ScannerScans

Search URL scans
url_scanner.scans.list(ScanListParams**kwargs) -> ScanListResponse
GET/accounts/{account_id}/urlscanner/v2/search
Get URL scan
url_scanner.scans.get(strscan_id, ScanGetParams**kwargs) -> ScanGetResponse
GET/accounts/{account_id}/urlscanner/v2/result/{scan_id}
Create URL Scan
url_scanner.scans.create(ScanCreateParams**kwargs) -> ScanCreateResponse
POST/accounts/{account_id}/urlscanner/v2/scan
Bulk create URL Scans
url_scanner.scans.bulk_create(ScanBulkCreateParams**kwargs) -> ScanBulkCreateResponse
POST/accounts/{account_id}/urlscanner/v2/bulk
Get URL scan's HAR
url_scanner.scans.har(strscan_id, ScanHARParams**kwargs) -> ScanHARResponse
GET/accounts/{account_id}/urlscanner/v2/har/{scan_id}
Get screenshot
url_scanner.scans.screenshot(strscan_id, ScanScreenshotParams**kwargs) -> BinaryResponseContent
GET/accounts/{account_id}/urlscanner/v2/screenshots/{scan_id}.png
Get URL scan's DOM
url_scanner.scans.dom(strscan_id, ScanDOMParams**kwargs) -> ScanDOMResponse
GET/accounts/{account_id}/urlscanner/v2/dom/{scan_id}
ModelsExpand Collapse
class ScanListResponse: …
results: List[Result]
_id: str
page: ResultPage
asn: str
country: str
ip: str
url: str
result: str
stats: ResultStats
data_length: float
requests: float
uniq_countries: float
uniq_ips: float
task: ResultTask
time: str
url: str
uuid: str
visibility: str
verdicts: ResultVerdicts
malicious: bool
class ScanGetResponse: …
data: Data
console: List[DataConsole]
message: DataConsoleMessage
level: str
source: str
text: str
url: str
cookies: List[DataCookie]
domain: str
expires: float
http_only: bool
name: str
path: str
priority: str
same_party: bool
secure: bool
session: bool
size: float
source_port: float
source_scheme: str
value: str
globals: List[DataGlobal]
prop: str
type: str
text: str
performance: List[DataPerformance]
duration: float
entry_type: str
name: str
start_time: float
requests: List[DataRequest]
request: DataRequestRequest
document_url: str
has_user_gesture: bool
initiator: DataRequestRequestInitiator
host: str
type: str
url: str
redirect_has_extra_info: bool
request: DataRequestRequestRequest
initial_priority: str
is_same_site: bool
method: str
mixed_content_type: str
referrer_policy: str
url: str
headers: Optional[object]
request_id: str
type: str
wall_time: float
frame_id: Optional[str]
loader_id: Optional[str]
primary_request: Optional[bool]
redirect_response: Optional[DataRequestRequestRedirectResponse]
charset: str
mime_type: str
protocol: str
remote_ip_address: str
remote_port: float
security_headers: List[DataRequestRequestRedirectResponseSecurityHeader]
name: str
value: str
security_state: str
status: float
status_text: str
url: str
headers: Optional[object]
response: DataRequestResponse
asn: DataRequestResponseASN
asn: str
country: str
description: str
ip: str
name: str
org: str
data_length: float
encoded_data_length: float
geoip: DataRequestResponseGeoip
city: str
country: str
country_name: str
geoname_id: str
ll: List[float]
region: str
has_extra_info: bool
request_id: str
response: DataRequestResponseResponse
charset: str
mime_type: str
protocol: str
remote_ip_address: str
remote_port: float
security_details: DataRequestResponseResponseSecurityDetails
certificate_id: float
certificate_transparency_compliance: str
cipher: str
encrypted_client_hello: bool
issuer: str
key_exchange: str
key_exchange_group: str
protocol: str
san_list: List[str]
server_signature_algorithm: float
subject_name: str
valid_from: float
valid_to: float
security_headers: List[DataRequestResponseResponseSecurityHeader]
name: str
value: str
security_state: str
status: float
status_text: str
url: str
headers: Optional[object]
size: float
type: str
content_available: Optional[bool]
hash: Optional[str]
requests: Optional[List[DataRequestRequest]]
document_url: str
frame_id: str
has_user_gesture: bool
initiator: DataRequestRequestInitiator
type: str
loader_id: str
redirect_has_extra_info: bool
request: DataRequestRequestRequest
headers: DataRequestRequestRequestHeaders
name: str
initial_priority: str
is_same_site: bool
method: str
mixed_content_type: str
referrer_policy: str
url: str
request_id: str
type: str
wall_time: float
lists: Lists
asns: List[str]
certificates: List[ListsCertificate]
issuer: str
subject_name: str
valid_from: float
valid_to: float
continents: List[str]
countries: List[str]
domains: List[str]
hashes: List[str]
ips: List[str]
link_domains: List[str]
servers: List[str]
urls: List[str]
meta: Meta
processors: MetaProcessors
asn: MetaProcessorsASN
data: List[MetaProcessorsASNData]
asn: str
country: str
description: str
ip: str
name: str
dns: MetaProcessorsDNS
data: List[MetaProcessorsDNSData]
address: str
dnssec_valid: bool
name: str
type: str
domain_categories: MetaProcessorsDomainCategories
data: List[MetaProcessorsDomainCategoriesData]
inherited: object
is_primary: bool
name: str
geoip: MetaProcessorsGeoip
data: List[MetaProcessorsGeoipData]
geoip: MetaProcessorsGeoipDataGeoip
city: str
country: str
country_name: str
ll: List[float]
region: str
ip: str
phishing: MetaProcessorsPhishing
data: List[str]
radar_rank: MetaProcessorsRadarRank
data: List[MetaProcessorsRadarRankData]
bucket: str
hostname: str
rank: Optional[float]
wappa: MetaProcessorsWappa
data: List[MetaProcessorsWappaData]
app: str
categories: List[MetaProcessorsWappaDataCategory]
name: str
priority: float
confidence: List[MetaProcessorsWappaDataConfidence]
confidence: float
name: str
pattern: str
pattern_type: str
confidence_total: float
icon: str
website: str
phishing_v2: Optional[MetaProcessorsPhishingV2]
data: List[str]
robots_txt: Optional[MetaProcessorsRobotsTXT]
data: List[MetaProcessorsRobotsTXTData]
rules: MetaProcessorsRobotsTXTDataRules
api_empty: MetaProcessorsRobotsTXTDataRulesapi_empty
allow: List[str]
disallow: List[str]
content_signal: Optional[MetaProcessorsRobotsTXTDataRulesapi_emptyContentSignal]
ai_input: Optional[str]
ai_train: Optional[str]
crawl_delay: Optional[float]
sitemaps: List[str]
hash: Optional[str]
url_categories: Optional[MetaProcessorsURLCategories]
data: List[MetaProcessorsURLCategoriesData]
content: List[MetaProcessorsURLCategoriesDataContent]
id: float
name: str
super_category_id: float
inherited: MetaProcessorsURLCategoriesDataInherited
content: List[MetaProcessorsURLCategoriesDataInheritedContent]
id: float
name: str
super_category_id: float
from_: str
risks: List[MetaProcessorsURLCategoriesDataInheritedRisk]
id: float
name: str
super_category_id: float
name: str
risks: List[MetaProcessorsURLCategoriesDataRisk]
id: float
name: str
super_category_id: float
page: Page
apex_domain: str
asn: str
asnname: str
city: str
country: str
domain: str
ip: str
mime_type: str
server: str
status: str
title: str
tls_age_days: float
tls_issuer: str
tls_valid_days: float
tls_valid_from: str
url: str
screenshot: Optional[PageScreenshot]
dhash: str
mm3_hash: float
name: str
phash: str
scanner: Scanner
colo: str
country: str
stats: Stats
domain_stats: List[StatsDomainStat]
count: float
countries: List[str]
domain: str
encoded_size: float
index: float
initiators: List[str]
ips: List[str]
redirects: float
size: float
ip_stats: List[StatsIPStat]
asn: StatsIPStatASN
asn: str
country: str
description: str
ip: str
name: str
org: str
countries: List[str]
domains: List[str]
encoded_size: float
geoip: StatsIPStatGeoip
city: str
country: str
country_name: str
ll: List[float]
region: str
index: float
ip: str
ipv6: bool
redirects: float
requests: float
size: float
count: Optional[float]
i_pv6_percentage: float
malicious: float
protocol_stats: List[StatsProtocolStat]
count: float
countries: List[str]
encoded_size: float
ips: List[str]
protocol: str
size: float
resource_stats: List[StatsResourceStat]
compression: float
count: float
countries: List[str]
encoded_size: float
ips: List[str]
percentage: float
size: float
type: str
secure_percentage: float
secure_requests: float
server_stats: List[StatsServerStat]
count: float
countries: List[str]
encoded_size: float
ips: List[str]
server: str
size: float
tls_stats: List[StatsTLSStat]
count: float
countries: List[str]
encoded_size: float
ips: List[str]
protocols: StatsTLSStatProtocols
tls_1_3_aes_128_gcm: float
security_state: str
size: float
uniq_asns: float
uniq_countries: float
task: Task
apex_domain: str
domain: str
dom_url: str
method: str
options: TaskOptions
custom_headers: Optional[object]

Custom headers set.

screenshots_resolutions: Optional[List[str]]
report_url: str
screenshot_url: str
source: str
success: bool
time: str
url: str
uuid: str
visibility: str
verdicts: Verdicts
overall: VerdictsOverall
categories: List[str]
has_verdicts: bool
malicious: bool
tags: List[str]
class ScanCreateResponse: …
api: str

URL to api report.

message: str
result: str

Public URL to report.

url: str

Canonical form of submitted URL. Use this if you want to later search by URL.

uuid: str

Scan ID.

formatuuid
visibility: Literal["public", "unlisted"]

Submitted visibility status.

One of the following:
"public"
"unlisted"
options: Optional[Options]
useragent: Optional[str]
List[ScanBulkCreateResponseItem]
api: str

URL to api report.

result: str

URL to report.

url: str

Submitted URL

uuid: str

Scan ID.

formatuuid
visibility: Literal["public", "unlisted"]

Submitted visibility status.

One of the following:
"public"
"unlisted"
options: Optional[ScanBulkCreateResponseItemOptions]
useragent: Optional[str]
class ScanHARResponse: …
log: Log
creator: LogCreator
comment: str
name: str
version: str
entries: List[LogEntry]
_initial_priority: str
_initiator_type: str
_priority: str
_request_id: str
_request_time: float
_resource_type: str
cache: object
connection: str
pageref: str
request: LogEntryRequest
body_size: float
headers: List[LogEntryRequestHeader]
name: str
value: str
headers_size: float
http_version: str
method: str
url: str
response: LogEntryResponse
_transfer_size: float
body_size: float
content: LogEntryResponseContent
mime_type: str
size: float
compression: Optional[int]
headers: List[LogEntryResponseHeader]
name: str
value: str
headers_size: float
http_version: str
redirect_url: str
status: float
status_text: str
server_ip_address: str
started_date_time: str
time: float
pages: List[LogPage]
id: str
page_timings: LogPagePageTimings
on_content_load: float
on_load: float
started_date_time: str
title: str
version: str
str

HTML of webpage.