API Reference

URL Scanner

Scans

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Create URL Scan

client.URLScanner.Scans.New(ctx, params) (*ScanNewResponse, error)

POST/accounts/{account_id}/urlscanner/v2/scan

Submit a URL to scan. Check limits at https://developers.cloudflare.com/security-center/investigate/scan-limits/.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

URL Scanner WriteURL Scanner Read

ParametersExpand Collapse

params ScanNewParams

AccountID param.Field[string]

Path param: Account ID.

URL param.Field[string]

Body param

Country param.Field[ScanNewParamsCountry]optional

Body param: Country to geo egress from

const ScanNewParamsCountryAf ScanNewParamsCountry = "AF"

const ScanNewParamsCountryAl ScanNewParamsCountry = "AL"

const ScanNewParamsCountryDz ScanNewParamsCountry = "DZ"

const ScanNewParamsCountryAD ScanNewParamsCountry = "AD"

const ScanNewParamsCountryAo ScanNewParamsCountry = "AO"

const ScanNewParamsCountryAg ScanNewParamsCountry = "AG"

const ScanNewParamsCountryAr ScanNewParamsCountry = "AR"

const ScanNewParamsCountryAm ScanNewParamsCountry = "AM"

const ScanNewParamsCountryAu ScanNewParamsCountry = "AU"

const ScanNewParamsCountryAt ScanNewParamsCountry = "AT"

const ScanNewParamsCountryAz ScanNewParamsCountry = "AZ"

const ScanNewParamsCountryBh ScanNewParamsCountry = "BH"

const ScanNewParamsCountryBd ScanNewParamsCountry = "BD"

const ScanNewParamsCountryBb ScanNewParamsCountry = "BB"

const ScanNewParamsCountryBy ScanNewParamsCountry = "BY"

const ScanNewParamsCountryBe ScanNewParamsCountry = "BE"

const ScanNewParamsCountryBz ScanNewParamsCountry = "BZ"

const ScanNewParamsCountryBj ScanNewParamsCountry = "BJ"

const ScanNewParamsCountryBm ScanNewParamsCountry = "BM"

const ScanNewParamsCountryBt ScanNewParamsCountry = "BT"

const ScanNewParamsCountryBo ScanNewParamsCountry = "BO"

const ScanNewParamsCountryBa ScanNewParamsCountry = "BA"

const ScanNewParamsCountryBw ScanNewParamsCountry = "BW"

const ScanNewParamsCountryBr ScanNewParamsCountry = "BR"

const ScanNewParamsCountryBn ScanNewParamsCountry = "BN"

const ScanNewParamsCountryBg ScanNewParamsCountry = "BG"

const ScanNewParamsCountryBf ScanNewParamsCountry = "BF"

const ScanNewParamsCountryBi ScanNewParamsCountry = "BI"

const ScanNewParamsCountryKh ScanNewParamsCountry = "KH"

const ScanNewParamsCountryCm ScanNewParamsCountry = "CM"

const ScanNewParamsCountryCA ScanNewParamsCountry = "CA"

const ScanNewParamsCountryCv ScanNewParamsCountry = "CV"

const ScanNewParamsCountryKy ScanNewParamsCountry = "KY"

const ScanNewParamsCountryCf ScanNewParamsCountry = "CF"

const ScanNewParamsCountryTd ScanNewParamsCountry = "TD"

const ScanNewParamsCountryCl ScanNewParamsCountry = "CL"

const ScanNewParamsCountryCn ScanNewParamsCountry = "CN"

const ScanNewParamsCountryCo ScanNewParamsCountry = "CO"

const ScanNewParamsCountryKm ScanNewParamsCountry = "KM"

const ScanNewParamsCountryCg ScanNewParamsCountry = "CG"

const ScanNewParamsCountryCr ScanNewParamsCountry = "CR"

const ScanNewParamsCountryCi ScanNewParamsCountry = "CI"

const ScanNewParamsCountryHr ScanNewParamsCountry = "HR"

const ScanNewParamsCountryCu ScanNewParamsCountry = "CU"

const ScanNewParamsCountryCy ScanNewParamsCountry = "CY"

const ScanNewParamsCountryCz ScanNewParamsCountry = "CZ"

const ScanNewParamsCountryCd ScanNewParamsCountry = "CD"

const ScanNewParamsCountryDK ScanNewParamsCountry = "DK"

const ScanNewParamsCountryDj ScanNewParamsCountry = "DJ"

const ScanNewParamsCountryDm ScanNewParamsCountry = "DM"

const ScanNewParamsCountryDo ScanNewParamsCountry = "DO"

const ScanNewParamsCountryEc ScanNewParamsCountry = "EC"

const ScanNewParamsCountryEg ScanNewParamsCountry = "EG"

const ScanNewParamsCountrySv ScanNewParamsCountry = "SV"

const ScanNewParamsCountryGq ScanNewParamsCountry = "GQ"

const ScanNewParamsCountryEr ScanNewParamsCountry = "ER"

const ScanNewParamsCountryEe ScanNewParamsCountry = "EE"

const ScanNewParamsCountrySz ScanNewParamsCountry = "SZ"

const ScanNewParamsCountryEt ScanNewParamsCountry = "ET"

const ScanNewParamsCountryFj ScanNewParamsCountry = "FJ"

const ScanNewParamsCountryFi ScanNewParamsCountry = "FI"

const ScanNewParamsCountryFr ScanNewParamsCountry = "FR"

const ScanNewParamsCountryGa ScanNewParamsCountry = "GA"

const ScanNewParamsCountryGe ScanNewParamsCountry = "GE"

const ScanNewParamsCountryDe ScanNewParamsCountry = "DE"

const ScanNewParamsCountryGh ScanNewParamsCountry = "GH"

const ScanNewParamsCountryGr ScanNewParamsCountry = "GR"

const ScanNewParamsCountryGl ScanNewParamsCountry = "GL"

const ScanNewParamsCountryGd ScanNewParamsCountry = "GD"

const ScanNewParamsCountryGt ScanNewParamsCountry = "GT"

const ScanNewParamsCountryGn ScanNewParamsCountry = "GN"

const ScanNewParamsCountryGw ScanNewParamsCountry = "GW"

const ScanNewParamsCountryGy ScanNewParamsCountry = "GY"

const ScanNewParamsCountryHt ScanNewParamsCountry = "HT"

const ScanNewParamsCountryHn ScanNewParamsCountry = "HN"

const ScanNewParamsCountryHu ScanNewParamsCountry = "HU"

const ScanNewParamsCountryIs ScanNewParamsCountry = "IS"

const ScanNewParamsCountryIn ScanNewParamsCountry = "IN"

const ScanNewParamsCountryID ScanNewParamsCountry = "ID"

const ScanNewParamsCountryIr ScanNewParamsCountry = "IR"

const ScanNewParamsCountryIq ScanNewParamsCountry = "IQ"

const ScanNewParamsCountryIe ScanNewParamsCountry = "IE"

const ScanNewParamsCountryIl ScanNewParamsCountry = "IL"

const ScanNewParamsCountryIt ScanNewParamsCountry = "IT"

const ScanNewParamsCountryJm ScanNewParamsCountry = "JM"

const ScanNewParamsCountryJp ScanNewParamsCountry = "JP"

const ScanNewParamsCountryJo ScanNewParamsCountry = "JO"

const ScanNewParamsCountryKz ScanNewParamsCountry = "KZ"

const ScanNewParamsCountryKe ScanNewParamsCountry = "KE"

const ScanNewParamsCountryKi ScanNewParamsCountry = "KI"

const ScanNewParamsCountryKw ScanNewParamsCountry = "KW"

const ScanNewParamsCountryKg ScanNewParamsCountry = "KG"

const ScanNewParamsCountryLa ScanNewParamsCountry = "LA"

const ScanNewParamsCountryLv ScanNewParamsCountry = "LV"

const ScanNewParamsCountryLB ScanNewParamsCountry = "LB"

const ScanNewParamsCountryLs ScanNewParamsCountry = "LS"

const ScanNewParamsCountryLr ScanNewParamsCountry = "LR"

const ScanNewParamsCountryLy ScanNewParamsCountry = "LY"

const ScanNewParamsCountryLi ScanNewParamsCountry = "LI"

const ScanNewParamsCountryLt ScanNewParamsCountry = "LT"

const ScanNewParamsCountryLu ScanNewParamsCountry = "LU"

const ScanNewParamsCountryMo ScanNewParamsCountry = "MO"

const ScanNewParamsCountryMg ScanNewParamsCountry = "MG"

const ScanNewParamsCountryMw ScanNewParamsCountry = "MW"

const ScanNewParamsCountryMy ScanNewParamsCountry = "MY"

const ScanNewParamsCountryMv ScanNewParamsCountry = "MV"

const ScanNewParamsCountryMl ScanNewParamsCountry = "ML"

const ScanNewParamsCountryMr ScanNewParamsCountry = "MR"

const ScanNewParamsCountryMu ScanNewParamsCountry = "MU"

const ScanNewParamsCountryMX ScanNewParamsCountry = "MX"

const ScanNewParamsCountryFm ScanNewParamsCountry = "FM"

const ScanNewParamsCountryMd ScanNewParamsCountry = "MD"

const ScanNewParamsCountryMc ScanNewParamsCountry = "MC"

const ScanNewParamsCountryMn ScanNewParamsCountry = "MN"

const ScanNewParamsCountryMs ScanNewParamsCountry = "MS"

const ScanNewParamsCountryMa ScanNewParamsCountry = "MA"

const ScanNewParamsCountryMz ScanNewParamsCountry = "MZ"

const ScanNewParamsCountryMm ScanNewParamsCountry = "MM"

const ScanNewParamsCountryNa ScanNewParamsCountry = "NA"

const ScanNewParamsCountryNr ScanNewParamsCountry = "NR"

const ScanNewParamsCountryNp ScanNewParamsCountry = "NP"

const ScanNewParamsCountryNl ScanNewParamsCountry = "NL"

const ScanNewParamsCountryNz ScanNewParamsCountry = "NZ"

const ScanNewParamsCountryNi ScanNewParamsCountry = "NI"

const ScanNewParamsCountryNe ScanNewParamsCountry = "NE"

const ScanNewParamsCountryNg ScanNewParamsCountry = "NG"

const ScanNewParamsCountryKp ScanNewParamsCountry = "KP"

const ScanNewParamsCountryMk ScanNewParamsCountry = "MK"

const ScanNewParamsCountryNo ScanNewParamsCountry = "NO"

const ScanNewParamsCountryOm ScanNewParamsCountry = "OM"

const ScanNewParamsCountryPk ScanNewParamsCountry = "PK"

const ScanNewParamsCountryPs ScanNewParamsCountry = "PS"

const ScanNewParamsCountryPa ScanNewParamsCountry = "PA"

const ScanNewParamsCountryPg ScanNewParamsCountry = "PG"

const ScanNewParamsCountryPy ScanNewParamsCountry = "PY"

const ScanNewParamsCountryPe ScanNewParamsCountry = "PE"

const ScanNewParamsCountryPh ScanNewParamsCountry = "PH"

const ScanNewParamsCountryPl ScanNewParamsCountry = "PL"

const ScanNewParamsCountryPt ScanNewParamsCountry = "PT"

const ScanNewParamsCountryQa ScanNewParamsCountry = "QA"

const ScanNewParamsCountryRo ScanNewParamsCountry = "RO"

const ScanNewParamsCountryRu ScanNewParamsCountry = "RU"

const ScanNewParamsCountryRw ScanNewParamsCountry = "RW"

const ScanNewParamsCountrySh ScanNewParamsCountry = "SH"

const ScanNewParamsCountryKn ScanNewParamsCountry = "KN"

const ScanNewParamsCountryLc ScanNewParamsCountry = "LC"

const ScanNewParamsCountryVc ScanNewParamsCountry = "VC"

const ScanNewParamsCountryWs ScanNewParamsCountry = "WS"

const ScanNewParamsCountrySm ScanNewParamsCountry = "SM"

const ScanNewParamsCountrySt ScanNewParamsCountry = "ST"

const ScanNewParamsCountrySa ScanNewParamsCountry = "SA"

const ScanNewParamsCountrySn ScanNewParamsCountry = "SN"

const ScanNewParamsCountryRs ScanNewParamsCountry = "RS"

const ScanNewParamsCountrySc ScanNewParamsCountry = "SC"

const ScanNewParamsCountrySl ScanNewParamsCountry = "SL"

const ScanNewParamsCountrySk ScanNewParamsCountry = "SK"

const ScanNewParamsCountrySi ScanNewParamsCountry = "SI"

const ScanNewParamsCountrySb ScanNewParamsCountry = "SB"

const ScanNewParamsCountrySo ScanNewParamsCountry = "SO"

const ScanNewParamsCountryZa ScanNewParamsCountry = "ZA"

const ScanNewParamsCountryKr ScanNewParamsCountry = "KR"

const ScanNewParamsCountrySS ScanNewParamsCountry = "SS"

const ScanNewParamsCountryEs ScanNewParamsCountry = "ES"

const ScanNewParamsCountryLk ScanNewParamsCountry = "LK"

const ScanNewParamsCountrySd ScanNewParamsCountry = "SD"

const ScanNewParamsCountrySr ScanNewParamsCountry = "SR"

const ScanNewParamsCountrySe ScanNewParamsCountry = "SE"

const ScanNewParamsCountryCh ScanNewParamsCountry = "CH"

const ScanNewParamsCountrySy ScanNewParamsCountry = "SY"

const ScanNewParamsCountryTw ScanNewParamsCountry = "TW"

const ScanNewParamsCountryTj ScanNewParamsCountry = "TJ"

const ScanNewParamsCountryTz ScanNewParamsCountry = "TZ"

const ScanNewParamsCountryTh ScanNewParamsCountry = "TH"

const ScanNewParamsCountryBs ScanNewParamsCountry = "BS"

const ScanNewParamsCountryGm ScanNewParamsCountry = "GM"

const ScanNewParamsCountryTl ScanNewParamsCountry = "TL"

const ScanNewParamsCountryTg ScanNewParamsCountry = "TG"

const ScanNewParamsCountryTo ScanNewParamsCountry = "TO"

const ScanNewParamsCountryTt ScanNewParamsCountry = "TT"

const ScanNewParamsCountryTn ScanNewParamsCountry = "TN"

const ScanNewParamsCountryTr ScanNewParamsCountry = "TR"

const ScanNewParamsCountryTm ScanNewParamsCountry = "TM"

const ScanNewParamsCountryUg ScanNewParamsCountry = "UG"

const ScanNewParamsCountryUA ScanNewParamsCountry = "UA"

const ScanNewParamsCountryAe ScanNewParamsCountry = "AE"

const ScanNewParamsCountryGB ScanNewParamsCountry = "GB"

const ScanNewParamsCountryUs ScanNewParamsCountry = "US"

const ScanNewParamsCountryUy ScanNewParamsCountry = "UY"

const ScanNewParamsCountryUz ScanNewParamsCountry = "UZ"

const ScanNewParamsCountryVu ScanNewParamsCountry = "VU"

const ScanNewParamsCountryVe ScanNewParamsCountry = "VE"

const ScanNewParamsCountryVn ScanNewParamsCountry = "VN"

const ScanNewParamsCountryYe ScanNewParamsCountry = "YE"

const ScanNewParamsCountryZm ScanNewParamsCountry = "ZM"

const ScanNewParamsCountryZw ScanNewParamsCountry = "ZW"

Customagent param.Field[string]optional

Body param

maxLength4096

CustomHeaders param.Field[map[string, string]]optional

Body param: Set custom headers.

Referer param.Field[string]optional

Body param

maxLength4096

ScreenshotsResolutions param.Field[[]ScanNewParamsScreenshotsResolution]optional

Body param: Take multiple screenshots targeting different device types.

const ScanNewParamsScreenshotsResolutionDesktop ScanNewParamsScreenshotsResolution = "desktop"

const ScanNewParamsScreenshotsResolutionMobile ScanNewParamsScreenshotsResolution = "mobile"

const ScanNewParamsScreenshotsResolutionTablet ScanNewParamsScreenshotsResolution = "tablet"

Visibility param.Field[ScanNewParamsVisibility]optional

Body param: The option Public means it will be included in listings like recent scans and search results. Unlisted means it will not be included in the aforementioned listings, users will need to have the scan's ID to access it. A a scan will be automatically marked as unlisted if it fails, if it contains potential PII or other sensitive material.

const ScanNewParamsVisibilityPublic ScanNewParamsVisibility = "Public"

const ScanNewParamsVisibilityUnlisted ScanNewParamsVisibility = "Unlisted"

ReturnsExpand Collapse

type ScanNewResponse struct{…}

API string

URL to api report.

Message string

Result string

Public URL to report.

URL string

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

UUID string

Scan ID.

formatuuid

Visibility ScanNewResponseVisibility

Submitted visibility status.

One of the following:

const ScanNewResponseVisibilityPublic ScanNewResponseVisibility = "public"

const ScanNewResponseVisibilityUnlisted ScanNewResponseVisibility = "unlisted"

Options ScanNewResponseOptionsoptional

Useragent stringoptional

Create URL Scan

Go

HTTP

TypeScript

Python

Go

Terraform

package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/option"
  "github.com/cloudflare/cloudflare-go/url_scanner"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  scan, err := client.URLScanner.Scans.New(context.TODO(), url_scanner.ScanNewParams{
    AccountID: cloudflare.F("account_id"),
    URL: cloudflare.F("https://www.example.com"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", scan.UUID)
}

200 example

{
  "api": "api",
  "message": "Submission successful",
  "result": "result",
  "url": "url",
  "uuid": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "visibility": "public",
  "options": {
    "useragent": "useragent"
  }
}

Returns Examples

200 example

{
  "api": "api",
  "message": "Submission successful",
  "result": "result",
  "url": "url",
  "uuid": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "visibility": "public",
  "options": {
    "useragent": "useragent"
  }
}