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:*,session:read:config
Required Session Permissions: None
Authorizations
Parameters
Path Parameters
Header Parameters
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.
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
Unique name for this template
Engine identifier for sessions of this type. For UE, this is commonly Party or Game.
Are sessions of this type allowed to join matchmaking?
Are players allowed to create sessions of this type?
DEPRECATED. Use ‘attempt_auto_join’ instead. Should players join existing sessions of this type before creating a new one
Should players join existing sessions of this type before creating a new one
Should sessions of this type should be publicly joinable by default
Should session be automatically added to the browser list
Browser parameters that can be used to filter results
object
Are sessions of this type able to be added to the server browser by players?
Should the session stay around, or be destroyed when the last player leaves it?
Platform-Specific session mappings that are used to coordinate Rally Here sessions with OnlineSubsystem sessions
object
Template used to create new platform sessions for a specific type of platform. Configurable in the developer portal
object
DEPRECATED. ID for the platform type for this template. Use ‘platform’ instead
Platform
Platform-Specific Identifier for the Platform’s template
The maximum number of players that can be a part of this platform session
Product-defined custom data
object
Parameters used to start an instance for this session when it is created. Has lower priority than auto_startup_instance_template_id
object
Name of the map for the instance to spawn with
Game mode for the instance to spawn in
Additional commandline parameters for the instance
Custom data to pass through to the instance
object
ID of instance request template to be used to automatically request an instance on creation of a session of this type. Takes priority over auto_startup_params
Minimum number of this type of session to be running at any given time per region.
Product-defined custom data about this session type
object
The number of teams this session type can have
The number of players that can be on each 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
If players should be notified when they are reserved in this type of session instead of waiting until they’re invited
Headers
Used to identify this version of the content. Provide with a get request to avoid downloading the same data multiple times.
403
Forbidden
object
422
Validation Error