Struct CreateSessionOptions 

pub struct CreateSessionOptions {
    pub profile_id: Option<String>,
    pub recording: bool,
    pub stealth: bool,
    pub captcha: bool,
    pub web_bot_auth: bool,
    pub proxy: Option<ProxySpec>,
}

Options accepted by POST /sessions.

Falsy fields are omitted from the request body; if every field is falsy the request is sent with no body at all.

Fields

profile_id: Option<String>

Attach a stored browser profile (cookies + localStorage).

recording: bool

Enable session recording. Off by default.

stealth: bool

Enable the runtime stealth shim. Off by default.

captcha: bool

Enable managed captcha solving. Requires stealth.

web_bot_auth: bool

Opt in to Cloudflare Web Bot Auth — sign every outbound HTTP request with an Ed25519 key registered to our verified bot directory. Independent of stealth; silently inert if the acquired slot has no signing key configured.

proxy: Option<ProxySpec>

Request managed proxy egress. Requires stealth.

Implementations

impl CreateSessionOptions

pub fn new() -> Self

pub fn profile_id(self, id: impl Into<String>) -> Self

pub fn recording(self, on: bool) -> Self

pub fn stealth(self, on: bool) -> Self

pub fn captcha(self, on: bool) -> Self

pub fn web_bot_auth(self, on: bool) -> Self

pub fn proxy(self, spec: impl Into<ProxySpec>) -> Self

Trait Implementations

impl Clone for CreateSessionOptions

fn clone(&self) -> CreateSessionOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateSessionOptions

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

Formats the value using the given formatter.

impl Default for CreateSessionOptions

fn default() -> CreateSessionOptions

Returns the “default value” for a type.