Skip to main content
PATCH

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 package's ID. To find it, open the package in Packages and expand the header, or call List packages.

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 session's id (a UUID), not its name. In the dashboard, expand the session row to copy it.

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

Body

application/json
name
string | null

New name, ^[a-z0-9]{1,16}$. Changes the connection string username.

ruleset
StatefulSessionRequestRulesetSchema · object | null

Rules to change. Omitted fields keep their stored value.

status
enum<string> | null

enabled or disabled.

Available options:
enabled,
disabled

Response

Successful Response

id
string
required

Session ID, a UUID. Use it as session_id in API calls.

proxy_id
string
required
name
string
required

Session name. Forms the username stateful-<name>. Not accepted as session_id.

status
enum<string>
required

enabled or disabled.

Available options:
enabled,
disabled
placement_region
enum<string>
required

Where SOAX hosts the session, set at creation.

Available options:
eu,
na,
se
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 password. For IP allowlist packages username and password are empty and uri is host:port.