Stateful Sessions

Create stateful sessions

Create one or more stateful sessions on a package. Each session is bound to a matching exit node before the response returns, so you get its exit IP and connection string straight away.

The ruleset is optional: omit it or send {} to use the defaults (lookalike: false, rotation_trigger: "timed:300", error_handling: "replace"). With count > 1, each session gets the base name plus a number (job gives job1, job2, …).

Node assignment is per session. A session that cannot be bound is discarded, so the response can hold fewer sessions than you asked for: check failed and reason. If none could be bound, the request fails with 503 and a Retry-After header.

Creates for the same package run one at a time; an overlapping create may get 429.

Requires the proxy:packages:write scope.

post/v1/proxy/packages/{package_id}/stateful-sessions

Request

Path parameters

package_idstring required

The ID of the proxy package (UUID format)

Request body

namestring nullable

Session name, ^[a-z0-9]{1,16}$, unique within the package. With count > 1 it is the base name and each session gets a number appended, which counts toward the 16 characters. Omit it and a name is generated.

countinteger

Number of sessions to create, 1 to 1000.

Response

Successful Response

failedinteger required
reasonstring nullable

Changes

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