Skip to main content
POST
Rotate a stateful session

Authorizations

Authorization
string
header
required

API key secret (starts with s_live_). Create keys in the dashboard under Settings → API keys, or via POST /v1/api-keys/. Send it as Authorization: Bearer <secret>.

Path Parameters

package_id
string
required

The ID of the proxy package (UUID format)

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
session_id
string
required

The ID of the stateful session (UUID format)

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Response

Successful Response

id
string
required
proxy_id
string
required
name
string
required
status
enum<string>
required

enabled or disabled.

Available options:
enabled,
disabled
ruleset
StatefulSessionRulesetSchema · object
required

The rules you set: what the session is allowed to use.

exit_ip
string
required

IP address of the exit node the session is bound to now.

network_type
string
required

Network of the bound node. The top-level geo and network fields describe where the session is bound now; ruleset holds what you asked for.

country
string
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
region
string | null
city
string | null
isp
string | null
asn
string | null
zip
string | null
bound_since
string<date-time> | null

When the session was bound to its current node.

port
integer | null

Gateway port to connect to. IP allowlist packages get a dedicated port per session; credential packages share the gateway port.

connection_string
ConnectionStringSchema · object | null

How to connect. For credential packages the username is stateful-<name> and the password is the package key. For IP allowlist packages username and password are empty and uri is host:port.