Skip to content
RallyHere Docs

Get All Platform Session Templates

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

Get all Platform Session Templates in a specific sandbox

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

Authorizations

Parameters

Path Parameters

session_template_id
required
string format: uuid
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
platform_session_templates
required

A list of platform session templates

Array<object>
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
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