Skip to content

Get All Session Templates For Sandbox

GET
/v1/sandbox/{sandbox_id}/session-template

Get all Session Templates for a sandbox

Requires any of permissions: 
 sandbox:config:view, sandbox:config:edit

Authorizations

Parameters

Path Parameters

sandbox_id
required

Sandbox ID

string format: uuid

Sandbox ID

Query Parameters

page_size

The maximum number of elements to be returned per call

integer
default: 50 >= 1 <= 10000

The maximum number of elements to be returned per call

cursor

Cursor to designate where you are in iterating through values. Start with ‘0’, and pass this on subsequent calls to continue iteration

string
default: 0 >= 1 characters <= 128 characters

Cursor to designate where you are in iterating through values. Start with '0', and pass this on subsequent calls to continue iteration

Responses

200

Successful Response

object
session_templates
required

A list of Session Templates

Array<object>
object
session_type
required

Unique name for this type of session

string
>= 1 characters <= 50 characters
engine_session_type
required

The engine name for this session type

string
>= 1 characters <= 50 characters
can_join_matchmaking

If sessions of this type can be entered into the matchmaking system

boolean
default: true
can_be_created_by_players

If players can create this session directly

boolean
default: true
publicly_joinable

If the session should be publicly joinable without invites

boolean
attempt_auto_join

Should we attempt to automatically join an existing session before creating a new one

boolean
default_public

If the session should be publicly joinable without invites

boolean
auto_add_to_browser

If the session should be automatically added to the public session browser

boolean
auto_browser_params

Parameters added to the session when it is automatically added to the public session browser

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

Can this session type be added to the public session browser

boolean
default: true
keep_alive_on_empty

If the session should be kept alive when there are no players actively in it

boolean
auto_startup_params

Parameters passed to an instance when it is automatically started for this session type

object
map
required

Name of the map for the instance to spawn with

string
>= 1 characters <= 50 characters
mode

Game mode for the instance to spawn in

string
>= 1 characters <= 50 characters
misc_params

Additional commandline parameters for the instance

string
>= 1 characters <= 50 characters
custom_data

Custom data to pass through to the instance

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

The minimum number of these sessions that should be kept alive at all times

integer
default_num_teams

Default number of teams this session type will have

integer
default: 2 >= 1
default_players_per_team

Default number of players allowed per team

integer
default: 4 >= 1
can_player_change_team

Can a player change their own team without elevated permissions

boolean
default: true
custom_data

Custom passthrough data that will be added to all sessions of this type

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

ID of the Sandbox

string format: uuid
session_template_id
required

UUID to identify this specific session template

string format: uuid
platform_session_templates

List of PlatformSessionTemplates that belong to this session type

Array<object>
default:
object
platform_session_type
required

The platform’s name for this type of platform session

string
>= 1 characters <= 50 characters
custom_data

Custom passthrough data that will be added to all sessions of this type

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

ID of the Sandbox

string format: uuid
session_template_id
required

Unique id for this type of session that this template is associated with

string format: uuid
platform
required

Which platform this template is associated with

string
Allowed values: Anon Basic XboxLive PSN NintendoNAID NintendoSwitch NintendoPPID Google GooglePlay Apple Epic Steam Amazon Twitch
last_modified_account_id

Account ID of the user who last modified the resource

string format: uuid
last_modified_timestamp

Timestamp of when the resource was last modified

string format: date-time
last_modified_account_id

Account ID of the user who last modified the resource

string format: uuid
last_modified_timestamp

Timestamp of when the resource was last modified

string format: date-time
cursor
required

Cursor to designate where you are in iterating through values. Start with ‘0’, and pass this on subsequent calls to continue iteration

string
>= 1 characters <= 128 characters

422

Validation Error

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