Skip to main content
GET
List stateful sessions

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

Query Parameters

cursor
string | null
limit
integer
default:20
Required range: 1 <= x <= 100
status
enum<string> | null
Available options:
enabled,
disabled
search
string | null

Case-insensitive search. Digits only match a session whose port starts with them (200 finds ports 2000-2009, not 3200) or whose name contains them; any other text matches a session whose ID or name contains it.

Response

Successful Response

data
StatefulSessionResponse · object[]
required
has_more
boolean
required

Whether another page exists.

next_cursor
string | null

Pass as cursor to fetch the next page. null on the last page.