Skip to content

Get All Regions

GET
/session/v1/regions

Get all of the enabled regions and their configuration

Required Permissions:

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

Required Session Permissions: None

Authorizations

Parameters

Query Parameters

cursor
integer
page_size
integer
default: 50 >= 1 <= 50

Responses

200

Successful Response

A list of regions and a cursor to continue iterating

object
regions
required

List of all regions

Array<object>

Information about a specific region

object
region_id
required

ID for this region

string
>= 1 characters <= 128 characters
sort_order
required

The sorting priority order for this region

integer
custom_only
required

Indicates if the region is for custom games only

boolean
description

Text description of the region

string
>= 1 characters <= 256 characters
cursor
required

Cursor to continue iterating through enabled regions. Non 0 cursor in the response means there are more regions. Pass the returned cursor up on a subsequent call to continue. A 0 cursor in the response means you have reached the end

integer

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