Skip to content

Get Browser Sessions By Type

GET
/session/v1/browser

Get all public sessions of a specific type

Required Permissions:

  • For any player (including themselves) any of: session:read:browser, session:*

Required Permissions: None

Authorizations

Parameters

Query Parameters

session_type
required
string
cursor
integer
page_size
integer
default: 50 >= 1 <= 50
region_id
string
>= 1 characters <= 128 characters

Responses

200

Successful Response

A response with a list of browsers, and a cursor to continue iterating through them

object
cursor
required

Cursor to continue iterating through browser sessions. 0 means we have returned the last entry

integer
browser_sessions
required

List of sessions in the browser

Array<object>

Information about a session listed in a browser

object
session_id
required

ID for the session

string
>= 1 characters <= 128 characters
player_count

Number of players actively in this session

integer
max_player_count

Maximum number of players that can be in this session

integer
>= 1 <= 100
custom_data

Custom data with the listing of the instance in the Session browser

object
key
additional properties
string
>= 1 characters <= 4096 characters

Headers

ETag
string

Used to identify this version of the content. Provide with a get request to avoid downloading the same data multiple times.

403

Forbidden

object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string