---
title: URL Scanner
---

[Skip to content](#_top)

[API Reference](https://developers.cloudflare.com/api/go)

Copy Markdown

Open in **Claude**Open in **ChatGPT**Open in **Cursor**

---

**Copy Markdown****View as Markdown**

# URL Scanner

##### ModelsExpand Collapse

<details>

<summary>

type URLScannerDomain struct{…}

</summary>

ID int64

<a href="#(resource)%20url_scanner%20%3E%20(model)%20url_scanner_domain%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

Name string

<a href="#(resource)%20url_scanner%20%3E%20(model)%20url_scanner_domain%20%3E%20(schema)%20%3E%20(property)%20name">Link to this property</a>

SuperCategoryID int64Optional

<a href="#(resource)%20url_scanner%20%3E%20(model)%20url_scanner_domain%20%3E%20(schema)%20%3E%20(property)%20super_category_id">Link to this property</a>

</details>

[Link to this property](<#(resource)%20url_scanner%20%3E%20(model)%20url_scanner_domain%20%3E%20(schema)>)

<details>

<summary>

type URLScannerTask struct{…}

</summary>

EffectiveURL string

<a href="#(resource)%20url_scanner%20%3E%20(model)%20url_scanner_task%20%3E%20(schema)%20%3E%20(property)%20effectiveUrl">Link to this property</a>

<details>

<summary>

Errors \[]URLScannerTaskError

</summary>

Message string

<a href="#(resource)%20url_scanner%20%3E%20(model)%20url_scanner_task%20%3E%20(schema)%20%3E%20(property)%20errors%20%3E%20(items)%20%3E%20(property)%20message">Link to this property</a>

</details>

<a href="#(resource)%20url_scanner%20%3E%20(model)%20url_scanner_task%20%3E%20(schema)%20%3E%20(property)%20errors">Link to this property</a>

Location string

<a href="#(resource)%20url_scanner%20%3E%20(model)%20url_scanner_task%20%3E%20(schema)%20%3E%20(property)%20location">Link to this property</a>

Region string

<a href="#(resource)%20url_scanner%20%3E%20(model)%20url_scanner_task%20%3E%20(schema)%20%3E%20(property)%20region">Link to this property</a>

Status string

<a href="#(resource)%20url_scanner%20%3E%20(model)%20url_scanner_task%20%3E%20(schema)%20%3E%20(property)%20status">Link to this property</a>

Success bool

<a href="#(resource)%20url_scanner%20%3E%20(model)%20url_scanner_task%20%3E%20(schema)%20%3E%20(property)%20success">Link to this property</a>

Time string

<a href="#(resource)%20url_scanner%20%3E%20(model)%20url_scanner_task%20%3E%20(schema)%20%3E%20(property)%20time">Link to this property</a>

URL string

<a href="#(resource)%20url_scanner%20%3E%20(model)%20url_scanner_task%20%3E%20(schema)%20%3E%20(property)%20url">Link to this property</a>

UUID string

<a href="#(resource)%20url_scanner%20%3E%20(model)%20url_scanner_task%20%3E%20(schema)%20%3E%20(property)%20uuid">Link to this property</a>

Visibility string

<a href="#(resource)%20url_scanner%20%3E%20(model)%20url_scanner_task%20%3E%20(schema)%20%3E%20(property)%20visibility">Link to this property</a>

</details>

[Link to this property](<#(resource)%20url_scanner%20%3E%20(model)%20url_scanner_task%20%3E%20(schema)>)

#### URL ScannerResponses

##### [Get raw response](https://developers.cloudflare.com/api/go/resources/url_scanner/subresources/responses/methods/get)

client.URLScanner.Responses.Get(ctx, responseID, query) (\*string, error)

GET/accounts/{account\_id}/urlscanner/v2/responses/{response\_id}

#### URL ScannerScans

##### [Search URL scans](https://developers.cloudflare.com/api/go/resources/url_scanner/subresources/scans/methods/list)

client.URLScanner.Scans.List(ctx, params) (\*[ScanListResponse](<https://developers.cloudflare.com/api/go/resources/url_scanner#(resource)%20url_scanner.scans%20%3E%20(model)%20ScanListResponse%20%3E%20(schema)>), error)

GET/accounts/{account\_id}/urlscanner/v2/search

##### [Get URL scan](https://developers.cloudflare.com/api/go/resources/url_scanner/subresources/scans/methods/get)

client.URLScanner.Scans.Get(ctx, scanID, query) (\*[ScanGetResponse](<https://developers.cloudflare.com/api/go/resources/url_scanner#(resource)%20url_scanner.scans%20%3E%20(model)%20ScanGetResponse%20%3E%20(schema)>), error)

GET/accounts/{account\_id}/urlscanner/v2/result/{scan\_id}

##### [Create URL Scan](https://developers.cloudflare.com/api/go/resources/url_scanner/subresources/scans/methods/create)

client.URLScanner.Scans.New(ctx, params) (\*[ScanNewResponse](<https://developers.cloudflare.com/api/go/resources/url_scanner#(resource)%20url_scanner.scans%20%3E%20(model)%20ScanNewResponse%20%3E%20(schema)>), error)

POST/accounts/{account\_id}/urlscanner/v2/scan

##### [Bulk create URL Scans](https://developers.cloudflare.com/api/go/resources/url_scanner/subresources/scans/methods/bulk_create)

client.URLScanner.Scans.BulkNew(ctx, params) (\*\[] [ScanBulkNewResponse](<https://developers.cloudflare.com/api/go/resources/url_scanner#(resource)%20url_scanner.scans%20%3E%20(model)%20ScanBulkNewResponse%20%3E%20(schema)>), error)

POST/accounts/{account\_id}/urlscanner/v2/bulk

##### [Get URL scan's HAR](https://developers.cloudflare.com/api/go/resources/url_scanner/subresources/scans/methods/har)

client.URLScanner.Scans.HAR(ctx, scanID, query) (\*[ScanHARResponse](<https://developers.cloudflare.com/api/go/resources/url_scanner#(resource)%20url_scanner.scans%20%3E%20(model)%20ScanHARResponse%20%3E%20(schema)>), error)

GET/accounts/{account\_id}/urlscanner/v2/har/{scan\_id}

##### [Get screenshot](https://developers.cloudflare.com/api/go/resources/url_scanner/subresources/scans/methods/screenshot)

client.URLScanner.Scans.Screenshot(ctx, scanID, params) (\*Response, error)

GET/accounts/{account\_id}/urlscanner/v2/screenshots/{scan\_id}.png

##### [Get URL scan's DOM](https://developers.cloudflare.com/api/go/resources/url_scanner/subresources/scans/methods/dom)

client.URLScanner.Scans.DOM(ctx, scanID, query) (\*string, error)

GET/accounts/{account\_id}/urlscanner/v2/dom/{scan\_id}