Struct BrowserConfig 

pub struct BrowserConfig {

    pub proxy_pool: Option<String>,
    pub os: Option<String>,
    pub country: Option<String>,
    pub session: Option<String>,
    pub timeout: Option<u32>,
    pub block_images: bool,
    pub block_styles: bool,
    pub block_fonts: bool,
    pub block_media: bool,
    pub screenshot: bool,
    pub cache: bool,
    pub blacklist: bool,
    pub debug: bool,
    pub resolution: Option<String>,
    pub browser_brand: Option<String>,
    pub byop_proxy: Option<String>,
    pub enable_mcp: bool,
    pub solve_captcha: bool,
    pub vault: Option<String>,
    pub vault_key: Option<String>,
    pub enable_vnc: bool,
    pub vnc_password: Option<String>,
    pub enable_rtc: bool,
    pub rtc_username: Option<String>,
    pub rtc_password: Option<String>,
    pub hitl_allowed_networks: Vec<String>,
}

Configuration for a Cloud Browser WebSocket session (passed to [cloud_browser_url]).

Fields

proxy_pool: Option<String>

Proxy pool.

os: Option<String>

OS fingerprint.

country: Option<String>

Proxy country.

session: Option<String>

Session name.

timeout: Option<u32>

Session timeout (seconds).

block_images: bool

Block images.

block_styles: bool

Block stylesheets.

block_fonts: bool

Block fonts.

block_media: bool

Block media.

screenshot: bool

Enable screenshot capability.

cache: bool

Enable cache.

blacklist: bool

Enable blacklist.

debug: bool

Debug.

resolution: Option<String>

Resolution.

browser_brand: Option<String>

Browser brand.

byop_proxy: Option<String>

BYOP proxy URL.

enable_mcp: bool

Enable MCP (Model Context Protocol) support.

solve_captcha: bool

Arm Scrapium’s built-in captcha detector + solver on the first page attach. Turnstile, DataDome slider, reCAPTCHA, GeeTest, PerimeterX hold, and puzzle captchas are handled automatically. Billed per solve; failures cost nothing. See https://scrapfly.io/docs/cloud-browser-api/captcha-solver.

vault: Option<String>

Cloud Browser credential vault NAME to attach to the session — the alphanumeric name given at create time. The server resolves the name to the vault scoped to the api-key’s project and environment, decrypts its items with the caller-supplied BrowserConfig::vault_key, and pushes them via CDP before the customer takes over. Pair with vault_key. See https://scrapfly.io/docs/cloud-browser-api/vault.

vault_key: Option<String>

Customer-held base64-encoded 32-byte vault key. Forwarded transiently on the WebSocket query string and zeroed by the server after items are decrypted. The SDK never logs or echoes this value — see the E2EE boundary documentation in the project’s HIPAA evidence pack.

enable_vnc: bool

Enable the human-in-the-loop VNC channel.

vnc_password: Option<String>

Customer-chosen VNC password. Required when enable_vnc is true and hitl_allowed_networks is empty.

enable_rtc: bool

Enable the human-in-the-loop WebRTC channel.

rtc_username: Option<String>

Optional WebRTC username (defaults to “scrapfly” server-side).

rtc_password: Option<String>

Customer-chosen WebRTC password. Required when enable_rtc is true and hitl_allowed_networks is empty.

hitl_allowed_networks: Vec<String>

Source IPs / CIDRs trusted to attach to HITL channels (VNC + WebRTC + downloads) without credentials. Sent on the wire as a comma-separated string.

Trait Implementations

impl Clone for BrowserConfig

fn clone(&self) -> BrowserConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BrowserConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for BrowserConfig

fn default() -> BrowserConfig

Returns the “default value” for a type.

impl Serialize for BrowserConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.