Skip to main content
POST
security.url.scans.search

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
url
string

Exact scanned URL.

domain
string

Exact page domain.

ip
string

Exact scanned server IP.

Minimum string length: 1
hash
string

Page DOM SHA-256 hash.

Pattern: ^[a-f0-9]{64}$
since
string<date-time>

Scan time range start.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
until
string<date-time>

Scan time range end.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
country
string

Scanned server country code.

Pattern: ^[A-Z]{2}$
verdict
enum<string>

Reported clean or malicious verdict; unknown scans are not clean.

Available options:
clean,
malicious
limit
integer
default:10

Maximum rows, 1 to 50.

Required range: 1 <= x <= 50
cursor
string

Continuation for this same search.

Required string length: 1 - 4096

Response

The result

items
object[]
required

Public scans only; private and unlisted scans are excluded independently of upstream filters.

Maximum array length: 50
nextCursor
string

Continuation for the next page.