Skip to content

Get Instance Request Template

GET
/session/v1/instance-request-template/{instance_request_template_id}

Get the config used to request an instance by the InstanceRequestTemplate ID. This ID can be found in MatchMakingProfiles that are return by the /v1/match-making-templates/ endpoint

Required Permissions:

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

Required Session Permissions: None

Authorizations

Parameters

Path Parameters

instance_request_template_id
required
string format: uuid

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

Configuration about how an instance should behave when it’s allocated

object
instance_request_template_id
required

ID to uniquely identify this instance launch template

string format: uuid
map_selection_list
required

A selection list of maps that can be chosen to launch into

object
map_selection_list_id
required

ID to uniquely identify this map selection list

string
maps
required

List of maps that can be chosen in this selection list

Array<object>

Configuration about a specific map for an instance to load into

object
map_id
required

ID to uniquely identify this map game

string
name
required

Name of the map the instance should load into

string
mode

Game mode for the instance to spawn in

string
map_weight
required

Chance that this map will get selected in a rotation list

number
<= 100
custom_data

Custom data to pass through to the instance

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

Default host type for this template. Can be overriden in instance requests

string
Allowed values: dedicated player
custom_data

Custom data that will be passed to the session during the instance launch request

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