SOsoax
Stateful Sessions

Get a stateful session

Get one session: its ruleset, its current binding (exit IP, location, network, bound_since) and its connection string.

Requires the proxy:packages:read scope.

get/v1/proxy/packages/{package_id}/stateful-sessions/{session_id}

Request

Path parameters

package_idstring required

The ID of the proxy package (UUID format)

session_idstring required

The ID of the stateful session (UUID format)

Response

Successful Response

idstring required
proxy_idstring required
namestring required
status'enabled' | 'disabled' required
exit_ipstring required

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

network_typestring 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.

countrystring required
regionstring nullable
citystring nullable
ispstring nullable
asnstring nullable
zipstring nullable
bound_sincestring date-time nullable

When the session was bound to its current node.

portinteger nullable

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

created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.