Skip to main content
POST

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}$

Body

application/json
placement_region
enum<string>
required

Required. Where SOAX hosts the session: eu (Europe, Middle East and Africa), na (North and South America) or se (Asia and Pacific). Choose the region nearest the servers that connect to the session. It doesn't set the exit location; that comes from ruleset. Fixed at creation.

Available options:
eu,
na,
se
name
string | null

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.

ruleset
StatefulSessionRequestRulesetSchema · object
count
integer
default:1

Number of sessions to create, 1 to 1000.

Required range: 1 <= x <= 1000
port
integer | null

IP allowlist packages only. The port to create the session on, instead of the lowest free one. Must be in the package's port range and not used by another session. Can't be combined with count > 1.

Response

Successful Response

data
StatefulSessionResponse · object[]
required
failed
integer
required
reason
string | null