--- title: Create URL Scan --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [URL Scanner](https://developers.cloudflare.com/api/go/resources/url_scanner) [Scans](https://developers.cloudflare.com/api/go/resources/url_scanner/subresources/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 Write``URL Scanner Read` ##### ParametersExpand Collapse

params ScanNewParams

AccountID param.Field\[string] Path param: Account ID. Link to this property URL param.Field\[string] Body param Link to this property AgentReadiness param.Field\[bool]Optional Body param: Enable agent readiness checks. Link to this property

Country param.Field\[ScanNewParamsCountry]Optional Body param: Country to geo egress from

Link to this property Customagent param.Field\[string]Optional Body param maxLength4096 Link to this property CustomHeaders param.Field\[map\[string, string]]Optional Body param: Set custom headers. Link to this property Referer param.Field\[string]Optional Body param maxLength4096 Link to this property

ScreenshotsResolutions param.Field\[\[]ScanNewParamsScreenshotsResolution]Optional Body param: Take multiple screenshots targeting different device types.

const ScanNewParamsScreenshotsResolutionDesktop ScanNewParamsScreenshotsResolution = "desktop" Link to this property const ScanNewParamsScreenshotsResolutionMobile ScanNewParamsScreenshotsResolution = "mobile" Link to this property const ScanNewParamsScreenshotsResolutionTablet ScanNewParamsScreenshotsResolution = "tablet" Link to this property

Link to this property

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" Link to this property const ScanNewParamsVisibilityUnlisted ScanNewParamsVisibility = "Unlisted" Link to this property

Link to this property

[Link to this property](<#(resource)%20url_scanner.scans%20%3E%20(method)%20create%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse

type ScanNewResponse struct{…}

API string URL to api report. Link to this property Message string Link to this property Result string Public URL to report. Link to this property URL string Canonical form of submitted URL. Use this if you want to later search by URL. Link to this property UUID string Scan ID. formatuuid Link to this property

Visibility ScanNewResponseVisibility Submitted visibility status.

One of the following: const ScanNewResponseVisibilityPublic ScanNewResponseVisibility = "public" Link to this property const ScanNewResponseVisibilityUnlisted ScanNewResponseVisibility = "unlisted" Link to this property

Link to this property

Options ScanNewResponseOptionsOptional

Useragent stringOptional Link to this property

Link to this property

[Link to this property](<#(resource)%20url_scanner.scans%20%3E%20(model)%20ScanNewResponse%20%3E%20(schema)>) ### Create URL Scan Go HTTPTypeScriptPythonGoTerraform ``` 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" } } ```