# Scrapfly Documentation

## Table of Contents

### Dashboard

- [Intro](https://scrapfly.io/docs)
- [Project](https://scrapfly.io/docs/project)
- [Account](https://scrapfly.io/docs/account)
- [Workspace & Team](https://scrapfly.io/docs/workspace-and-team)
- [Billing](https://scrapfly.io/docs/billing)

### Products

#### MCP Server

- [Getting Started](https://scrapfly.io/docs/mcp/getting-started)
- [Tools & API Spec](https://scrapfly.io/docs/mcp/tools)
- [Authentication](https://scrapfly.io/docs/mcp/authentication)
- [Examples & Use Cases](https://scrapfly.io/docs/mcp/examples)
- [FAQ](https://scrapfly.io/docs/mcp/faq)
##### Integrations

- [Overview](https://scrapfly.io/docs/mcp/integrations)
- [Claude Desktop](https://scrapfly.io/docs/mcp/integrations/claude-desktop)
- [Claude Code](https://scrapfly.io/docs/mcp/integrations/claude-code)
- [ChatGPT](https://scrapfly.io/docs/mcp/integrations/chatgpt)
- [Cursor](https://scrapfly.io/docs/mcp/integrations/cursor)
- [Cline](https://scrapfly.io/docs/mcp/integrations/cline)
- [Windsurf](https://scrapfly.io/docs/mcp/integrations/windsurf)
- [Zed](https://scrapfly.io/docs/mcp/integrations/zed)
- [Roo Code](https://scrapfly.io/docs/mcp/integrations/roo-code)
- [VS Code](https://scrapfly.io/docs/mcp/integrations/vscode)
- [LangChain](https://scrapfly.io/docs/mcp/integrations/langchain)
- [LlamaIndex](https://scrapfly.io/docs/mcp/integrations/llamaindex)
- [CrewAI](https://scrapfly.io/docs/mcp/integrations/crewai)
- [OpenAI](https://scrapfly.io/docs/mcp/integrations/openai)
- [n8n](https://scrapfly.io/docs/mcp/integrations/n8n)
- [Make](https://scrapfly.io/docs/mcp/integrations/make)
- [Zapier](https://scrapfly.io/docs/mcp/integrations/zapier)
- [Vapi AI](https://scrapfly.io/docs/mcp/integrations/vapi)
- [Agent Builder](https://scrapfly.io/docs/mcp/integrations/agent-builder)
- [Custom Client](https://scrapfly.io/docs/mcp/integrations/custom-client)


#### Web Scraping API

- [Getting Started](https://scrapfly.io/docs/scrape-api/getting-started)
- [API Specification]()
- [Monitoring](https://scrapfly.io/docs/monitoring)
- [Customize Request](https://scrapfly.io/docs/scrape-api/custom)
- [Debug](https://scrapfly.io/docs/scrape-api/debug)
- [Anti Scraping Protection](https://scrapfly.io/docs/scrape-api/anti-scraping-protection)
- [Proxy](https://scrapfly.io/docs/scrape-api/proxy)
- [Proxy Mode](https://scrapfly.io/docs/scrape-api/proxy-mode)
- [Proxy Mode - Screaming Frog](https://scrapfly.io/docs/scrape-api/proxy-mode/screaming-frog)
- [Proxy Mode - Apify](https://scrapfly.io/docs/scrape-api/proxy-mode/apify)
- [(Auto) Data Extraction](https://scrapfly.io/docs/scrape-api/extraction)
- [Javascript Rendering](https://scrapfly.io/docs/scrape-api/javascript-rendering)
- [Javascript Scenario](https://scrapfly.io/docs/scrape-api/javascript-scenario)
- [SSL](https://scrapfly.io/docs/scrape-api/ssl)
- [DNS](https://scrapfly.io/docs/scrape-api/dns)
- [Cache](https://scrapfly.io/docs/scrape-api/cache)
- [Session](https://scrapfly.io/docs/scrape-api/session)
- [Webhook](https://scrapfly.io/docs/scrape-api/webhook)
- [Screenshot](https://scrapfly.io/docs/scrape-api/screenshot)
- [Errors](https://scrapfly.io/docs/scrape-api/errors)
- [Timeout](https://scrapfly.io/docs/scrape-api/understand-timeout)
- [Throttling](https://scrapfly.io/docs/throttling)
- [Troubleshoot](https://scrapfly.io/docs/scrape-api/troubleshoot)
- [Billing](https://scrapfly.io/docs/scrape-api/billing)
- [FAQ](https://scrapfly.io/docs/scrape-api/faq)

#### Crawler API

- [Getting Started](https://scrapfly.io/docs/crawler-api/getting-started)
- [API Specification]()
- [Retrieving Results](https://scrapfly.io/docs/crawler-api/results)
- [WARC Format](https://scrapfly.io/docs/crawler-api/warc-format)
- [Data Extraction](https://scrapfly.io/docs/crawler-api/extraction-rules)
- [Webhook](https://scrapfly.io/docs/crawler-api/webhook)
- [Billing](https://scrapfly.io/docs/crawler-api/billing)
- [Errors](https://scrapfly.io/docs/crawler-api/errors)
- [Troubleshoot](https://scrapfly.io/docs/crawler-api/troubleshoot)
- [FAQ](https://scrapfly.io/docs/crawler-api/faq)

#### Screenshot API

- [Getting Started](https://scrapfly.io/docs/screenshot-api/getting-started)
- [API Specification]()
- [Accessibility Testing](https://scrapfly.io/docs/screenshot-api/accessibility)
- [Webhook](https://scrapfly.io/docs/screenshot-api/webhook)
- [Billing](https://scrapfly.io/docs/screenshot-api/billing)
- [Errors](https://scrapfly.io/docs/screenshot-api/errors)

#### Extraction API

- [Getting Started](https://scrapfly.io/docs/extraction-api/getting-started)
- [API Specification]()
- [Rules Template](https://scrapfly.io/docs/extraction-api/rules-and-template)
- [LLM Extraction](https://scrapfly.io/docs/extraction-api/llm-prompt)
- [AI Auto Extraction](https://scrapfly.io/docs/extraction-api/automatic-ai)
- [Webhook](https://scrapfly.io/docs/extraction-api/webhook)
- [Billing](https://scrapfly.io/docs/extraction-api/billing)
- [Errors](https://scrapfly.io/docs/extraction-api/errors)
- [FAQ](https://scrapfly.io/docs/extraction-api/faq)

#### Proxy Saver

- [Getting Started](https://scrapfly.io/docs/proxy-saver/getting-started)
- [Fingerprints](https://scrapfly.io/docs/proxy-saver/fingerprints)
- [Optimizations](https://scrapfly.io/docs/proxy-saver/optimizations)
- [SSL Certificates](https://scrapfly.io/docs/proxy-saver/certificates)
- [Protocols](https://scrapfly.io/docs/proxy-saver/protocols)
- [Pacfile](https://scrapfly.io/docs/proxy-saver/pacfile)
- [Secure Credentials](https://scrapfly.io/docs/proxy-saver/security)
- [Billing](https://scrapfly.io/docs/proxy-saver/billing)

#### Cloud Browser API

- [Getting Started](https://scrapfly.io/docs/cloud-browser-api/getting-started)
- [Proxy & Geo-Targeting](https://scrapfly.io/docs/cloud-browser-api/proxy)
- [Unblock API](https://scrapfly.io/docs/cloud-browser-api/unblock)
- [File Downloads](https://scrapfly.io/docs/cloud-browser-api/file-downloads)
- [Session Resume](https://scrapfly.io/docs/cloud-browser-api/session-resume)
- [Human-in-the-Loop](https://scrapfly.io/docs/cloud-browser-api/human-in-the-loop)
- [Debug Mode](https://scrapfly.io/docs/cloud-browser-api/debug-mode)
- [Bring Your Own Proxy](https://scrapfly.io/docs/cloud-browser-api/bring-your-own-proxy)
- [Browser Extensions](https://scrapfly.io/docs/cloud-browser-api/extensions)
- [Native Browser MCP](https://scrapfly.io/docs/cloud-browser-api/mcp)
- [DevTools Protocol](https://scrapfly.io/docs/cloud-browser-api/cdp-reference)
##### Integrations

- [Puppeteer](https://scrapfly.io/docs/cloud-browser-api/puppeteer)
- [Playwright](https://scrapfly.io/docs/cloud-browser-api/playwright)
- [Selenium](https://scrapfly.io/docs/cloud-browser-api/selenium)
- [Vercel Agent Browser](https://scrapfly.io/docs/cloud-browser-api/agent-browser)
- [Browser Use](https://scrapfly.io/docs/cloud-browser-api/browser-use)
- [Stagehand](https://scrapfly.io/docs/cloud-browser-api/stagehand)

- [Billing](https://scrapfly.io/docs/cloud-browser-api/billing)
- [Errors](https://scrapfly.io/docs/cloud-browser-api/errors)


### Tools

- [Antibot Detector](https://scrapfly.io/docs/tools/antibot-detector)

### SDK

- [Golang](https://scrapfly.io/docs/sdk/golang)
- [Python](https://scrapfly.io/docs/sdk/python)
- [Rust](https://scrapfly.io/docs/sdk/rust)
- [TypeScript](https://scrapfly.io/docs/sdk/typescript)
- [Scrapy](https://scrapfly.io/docs/sdk/scrapy)

### Integrations

- [Getting Started](https://scrapfly.io/docs/integration/getting-started)
- [LangChain](https://scrapfly.io/docs/integration/langchain)
- [LlamaIndex](https://scrapfly.io/docs/integration/llamaindex)
- [CrewAI](https://scrapfly.io/docs/integration/crewai)
- [Zapier](https://scrapfly.io/docs/integration/zapier)
- [Make](https://scrapfly.io/docs/integration/make)
- [n8n](https://scrapfly.io/docs/integration/n8n)

### Academy

- [Overview](https://scrapfly.io/academy)
- [Web Scraping Overview](https://scrapfly.io/academy/scraping-overview)
- [Tools](https://scrapfly.io/academy/tools-overview)
- [Reverse Engineering](https://scrapfly.io/academy/reverse-engineering)
- [Static Scraping](https://scrapfly.io/academy/static-scraping)
- [HTML Parsing](https://scrapfly.io/academy/html-parsing)
- [Dynamic Scraping](https://scrapfly.io/academy/dynamic-scraping)
- [Hidden API Scraping](https://scrapfly.io/academy/hidden-api-scraping)
- [Headless Browsers](https://scrapfly.io/academy/headless-browsers)
- [Hidden Web Data](https://scrapfly.io/academy/hidden-web-data)
- [JSON Parsing](https://scrapfly.io/academy/json-parsing)
- [Data Processing](https://scrapfly.io/academy/data-processing)
- [Scaling](https://scrapfly.io/academy/scaling)
- [Walkthrough Summary](https://scrapfly.io/academy/walkthrough-summary)
- [Scraper Blocking](https://scrapfly.io/academy/scraper-blocking)
- [Proxies](https://scrapfly.io/academy/proxies)

---

 1. [DevTools Protocol](https://scrapfly.io/docs/cloud-browser-api/cdp-reference)
2. Security
 
  # Security

 

 - [Commands (5)](#commands)
- [Events (3)](#events)
- [Types (10)](#types)
 
   

No symbols match your filter.

## Commands

#### `Security.disable`

 

Disables tracking security state changes.

 

 

#### `Security.enable`

 

Enables tracking security state changes.

 

 

#### `Security.setIgnoreCertificateErrors`

 

Enable/disable whether all certificate errors should be ignored.

###### Parameters

 | Name | Type | Description |
|---|---|---|
| `ignore` | `boolean` | If true, all certificate errors will be ignored. |

 

 

 

#### `Security.handleCertificateError`

 Deprecated 

Handles a certificate error that fired a certificateError event.

###### Parameters

 | Name | Type | Description |
|---|---|---|
| `eventId` | `integer` | The ID of the event. |
| `action` | `<a href="/docs/cloud-browser-api/cdp-reference/Security#type-CertificateErrorAction">CertificateErrorAction</a>` | The action to take on the certificate error. |

 

 

 

#### `Security.setOverrideCertificateErrors`

 Deprecated 

Enable/disable overriding certificate errors. If enabled, all certificate error events need to
be handled by the DevTools client and should be answered with `handleCertificateError` commands.

###### Parameters

 | Name | Type | Description |
|---|---|---|
| `override` | `boolean` | If true, certificate errors will be overridden. |

 

 

 

 

## Events

#### `Security.certificateError`

 Deprecated 

There is a certificate error. If overriding certificate errors is enabled, then it should be
handled with the `handleCertificateError` command. Note: this event does not fire if the
certificate error has been allowed internally. Only one client per target should override
certificate errors at the same time.

###### Parameters

 | Name | Type | Description |
|---|---|---|
| `eventId` | `integer` | The ID of the event. |
| `errorType` | `string` | The type of the error. |
| `requestURL` | `string` | The url that was requested. |

 

 

 

#### `Security.visibleSecurityStateChanged`

 Experimental 

The security state of the page changed.

###### Parameters

 | Name | Type | Description |
|---|---|---|
| `visibleSecurityState` | `<a href="/docs/cloud-browser-api/cdp-reference/Security#type-VisibleSecurityState">VisibleSecurityState</a>` | Security state information about the page. |

 

 

 

#### `Security.securityStateChanged`

 Deprecated 

The security state of the page changed. No longer being sent.

###### Parameters

 | Name | Type | Description |
|---|---|---|
| `securityState` | `<a href="/docs/cloud-browser-api/cdp-reference/Security#type-SecurityState">SecurityState</a>` | Security state. |
| `schemeIsCryptographic` Deprecated | `boolean` | True if the page was loaded over cryptographic transport such as HTTPS. |
| `explanations` Deprecated | `array<<a href="/docs/cloud-browser-api/cdp-reference/Security#type-SecurityStateExplanation">SecurityStateExplanation</a>>` | Previously a list of explanations for the security state. Now always empty. |
| `insecureContentStatus` Deprecated | `<a href="/docs/cloud-browser-api/cdp-reference/Security#type-InsecureContentStatus">InsecureContentStatus</a>` | Information about insecure content on the page. |
| `summary`  (optional) Deprecated | `string` | Overrides user-visible description of the state. Always omitted. |

 

 

 

 

## Types

#### `CertificateId`

 (integer) 

An internal certificate ID value.

 

 

#### `MixedContentType`

 (string) 

A description of mixed content (HTTP resources on HTTPS pages), as defined by
https://www.w3.org/TR/mixed-content/#categories

###### Allowed Values

- `blockable`
- `optionally-blockable`
- `none`
 
 

 

#### `SecurityState`

 (string) 

The security level of a page or resource.

###### Allowed Values

- `unknown`
- `neutral`
- `insecure`
- `secure`
- `info`
- `insecure-broken`
 
 

 

#### `CertificateSecurityState`

 (object) Experimental 

Details about the security state of the page certificate.

###### Properties

 | Name | Type | Description |
|---|---|---|
| `protocol` | `string` | Protocol name (e.g. "TLS 1.2" or "QUIC"). |
| `keyExchange` | `string` | Key Exchange used by the connection, or the empty string if not applicable. |
| `keyExchangeGroup`  (optional) | `string` | (EC)DH group used by the connection, if applicable. |
| `cipher` | `string` | Cipher name. |
| `mac`  (optional) | `string` | TLS MAC. Note that AEAD ciphers do not have separate MACs. |
| `certificate` | `array<<a href="/docs/cloud-browser-api/cdp-reference/Security#type-string">string</a>>` | Page certificate. |
| `subjectName` | `string` | Certificate subject name. |
| `issuer` | `string` | Name of the issuing CA. |
| `validFrom` | `<a href="/docs/cloud-browser-api/cdp-reference/Network#type-TimeSinceEpoch">Network.TimeSinceEpoch</a>` | Certificate valid from date. |
| `validTo` | `<a href="/docs/cloud-browser-api/cdp-reference/Network#type-TimeSinceEpoch">Network.TimeSinceEpoch</a>` | Certificate valid to (expiration) date |
| `certificateNetworkError`  (optional) | `string` | The highest priority network error code, if the certificate has an error. |
| `certificateHasWeakSignature` | `boolean` | True if the certificate uses a weak signature algorithm. |
| `certificateHasSha1Signature` | `boolean` | True if the certificate has a SHA1 signature in the chain. |
| `modernSSL` | `boolean` | True if modern SSL |
| `obsoleteSslProtocol` | `boolean` | True if the connection is using an obsolete SSL protocol. |
| `obsoleteSslKeyExchange` | `boolean` | True if the connection is using an obsolete SSL key exchange. |
| `obsoleteSslCipher` | `boolean` | True if the connection is using an obsolete SSL cipher. |
| `obsoleteSslSignature` | `boolean` | True if the connection is using an obsolete SSL signature. |

 

 

 

#### `SafetyTipStatus`

 (string) Experimental 

###### Allowed Values

- `badReputation`
- `lookalike`
 
 

 

#### `SafetyTipInfo`

 (object) Experimental 

###### Properties

 | Name | Type | Description |
|---|---|---|
| `safetyTipStatus` | `<a href="/docs/cloud-browser-api/cdp-reference/Security#type-SafetyTipStatus">SafetyTipStatus</a>` | Describes whether the page triggers any safety tips or reputation warnings. Default is unknown. |
| `safeUrl`  (optional) | `string` | The URL the safety tip suggested ("Did you mean?"). Only filled in for lookalike matches. |

 

 

 

#### `VisibleSecurityState`

 (object) Experimental 

Security state information about the page.

###### Properties

 | Name | Type | Description |
|---|---|---|
| `securityState` | `<a href="/docs/cloud-browser-api/cdp-reference/Security#type-SecurityState">SecurityState</a>` | The security level of the page. |
| `certificateSecurityState`  (optional) | `<a href="/docs/cloud-browser-api/cdp-reference/Security#type-CertificateSecurityState">CertificateSecurityState</a>` | Security state details about the page certificate. |
| `safetyTipInfo`  (optional) | `<a href="/docs/cloud-browser-api/cdp-reference/Security#type-SafetyTipInfo">SafetyTipInfo</a>` | The type of Safety Tip triggered on the page. Note that this field will be set even if the Safety Tip UI was not actually shown. |
| `securityStateIssueIds` | `array<<a href="/docs/cloud-browser-api/cdp-reference/Security#type-string">string</a>>` | Array of security state issues ids. |

 

 

 

#### `SecurityStateExplanation`

 (object) 

An explanation of an factor contributing to the security state.

###### Properties

 | Name | Type | Description |
|---|---|---|
| `securityState` | `<a href="/docs/cloud-browser-api/cdp-reference/Security#type-SecurityState">SecurityState</a>` | Security state representing the severity of the factor being explained. |
| `title` | `string` | Title describing the type of factor. |
| `summary` | `string` | Short phrase describing the type of factor. |
| `description` | `string` | Full text explanation of the factor. |
| `mixedContentType` | `<a href="/docs/cloud-browser-api/cdp-reference/Security#type-MixedContentType">MixedContentType</a>` | The type of mixed content described by the explanation. |
| `certificate` | `array<<a href="/docs/cloud-browser-api/cdp-reference/Security#type-string">string</a>>` | Page certificate. |
| `recommendations`  (optional) | `array<<a href="/docs/cloud-browser-api/cdp-reference/Security#type-string">string</a>>` | Recommendations to fix any issues. |

 

 

 

#### `InsecureContentStatus`

 (object) Deprecated 

Information about insecure content on the page.

###### Properties

 | Name | Type | Description |
|---|---|---|
| `ranMixedContent` | `boolean` | Always false. |
| `displayedMixedContent` | `boolean` | Always false. |
| `containedMixedForm` | `boolean` | Always false. |
| `ranContentWithCertErrors` | `boolean` | Always false. |
| `displayedContentWithCertErrors` | `boolean` | Always false. |
| `ranInsecureContentStyle` | `<a href="/docs/cloud-browser-api/cdp-reference/Security#type-SecurityState">SecurityState</a>` | Always set to unknown. |
| `displayedInsecureContentStyle` | `<a href="/docs/cloud-browser-api/cdp-reference/Security#type-SecurityState">SecurityState</a>` | Always set to unknown. |

 

 

 

#### `CertificateErrorAction`

 (string) 

The action to take when a certificate error occurs. continue will continue processing the
request and cancel will cancel the request.

###### Allowed Values

- `continue`
- `cancel`