Skip to content

Get Session Template By Type

GET
/session/v1/template/{session_type}

Get config about a session template by ID

Required Permissions:

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

Required Session Permissions: None

Authorizations

Parameters

Path Parameters

session_type
required
string

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

Template used to create new RallyHere sessions of a specific type. Configurable in the developer portal

object
session_type
required

Unique name for this template

string
engine_session_type

Engine identifier for sessions of this type. For UE, this is commonly Party or Game.

string
default: Game
can_join_matchmaking

Are sessions of this type allowed to join matchmaking?

boolean
can_be_created_by_players_directly

Are players allowed to create sessions of this type?

boolean
joinable

DEPRECATED. Use ‘attempt_auto_join’ instead. Should players join existing sessions of this type before creating a new one

boolean
attempt_auto_join

Should players join existing sessions of this type before creating a new one

boolean
default_public

Should sessions of this type should be publicly joinable by default

boolean
auto_add_to_browser

Should session be automatically added to the browser list

boolean
auto_browser_params

Browser parameters that can be used to filter results

object
key
additional properties
string
can_be_added_to_server_browser

Are sessions of this type able to be added to the server browser by players?

boolean
keep_alive_on_empty

Should the session stay around, or be destroyed when the last player leaves it?

boolean
platform_templates

Platform-Specific session mappings that are used to coordinate Rally Here sessions with OnlineSubsystem sessions

object
key
additional properties

Template used to create new platform sessions for a specific type of platform. Configurable in the developer portal

object
platform_id
required

DEPRECATED. ID for the platform type for this template. Use ‘platform’ instead

integer
platform
required

Platform

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

Platform-Specific Identifier for the Platform’s template

string
>= 1 characters <= 128 characters
max_players

The maximum number of players that can be a part of this platform session

integer
>= 1 <= 100
custom_data

Product-defined custom data

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

Parameters used to start an instance for this session when it is created

object
map
required

Name of the map for the instance to spawn with

string
mode

Game mode for the instance to spawn in

string
misc_params
required

Additional commandline parameters for the instance

string
custom_data

Custom data to pass through to the instance

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

Minimum number of this type of session to be running at any given time per region.

integer
custom_data

Product-defined custom data about this session type

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

The number of teams this session type can have

integer
default: 1 >= 1 <= 50
players_per_team

The number of players that can be on each team

integer
default: 4 >= 1 <= 100
can_change_own_team

Whether or not a player can change which team they are on. If true, they are able to. If False, they player’s team can only be changed by an admin

boolean
default: true

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