Get All Queue Info V2

GET

/session/v2/queues

Get all the available and active queues that sessions can try to join

Required Permissions:

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

Required Session Permissions: None

Authorizations

• HTTPBearerHeadersOrCookie

Parameters

Query Parameters

cursor

integer

page_size

integer

default: 50 >= 1 <= 50

Header Parameters

if-none-match

If you provide the ETag that matches the current ETag for this resource, a 304 response will be returned - indicating that the resource has not changed.

string

If you provide the ETag that matches the current ETag for this resource, a 304 response will be returned - indicating that the resource has not changed.

Responses

200

Successful Response

A list of configuration about queues

object

queues

required

List of queues

Array<object>

V2 Configuration about a specific queue

object

queue_id

required

ID to uniquely identify this queue

string

>= 1 characters <= 128 characters

active

required

Flag for whether or not the queue is active, and can be joined or sessions created from it

boolean

max_queue_group_size

required

The maximum size of a group that can join this queue

integer

match_making_template_group_id

required

ID for which group of matchmaking templates/rules will be used when joining this queue

string format: uuid

legacy_config

Legacy config to help migrate clients

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