Scanning

Scan

Submit a URL to be scanned and control options for how the scan should be performed.

post/api/v1/scan

Request

  • Base URL: https://urlscan.io
  • URL: https://urlscan.io/api/v1/scan
  • Auth: API key in header api-key

Request body

urlstring uri required

The URL to be scanned

visibility'public' | 'unlisted' | 'private'

Intended visibility of the final scan result

countrystring

Country to scan from. ISO 3166-1 alpha-2 format. If not supplied, an appropriate country will automatically be chosen.

tagsstring[]

User-defined tags to annotate this scan, e.g. "phishing" or "malicious".

overrideSafetystring

If set to any value, this will disable reclassification of URLs with potential PII in them. Use with care!

refererstring

Override HTTP referer for this scan

customagentstring

Override HTTP User-Agent for this scan

Example request

{
  "url": "https://urlscan.io",
  "visibility": "public",
  "country": "de",
  "tags": [
    "iloveurlscan",
    "testing"
  ]
}

Response

OK

uuidstring uuid

UUID for scan result, also called $scanId

countrystring

Country for scanning

visibilitystring

Determined visibility for scan

urlstring uri

Determined URL being scanned

Changes

No recorded changes to this operation across all 6 revisions of this API.