Skip to main content

Get All Session Templates

GET 
/session/v1/template

Get the config about all session templates

Required Permissions:

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

Required Session Permissions: None

Request​

Header Parameters

    if-none-match 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.

Responses​

Successful Response

Response Headers

  • ETag

    string

    Used to identify this version of the content. Provide with a get request to avoid downloading the same data multiple times.

Schema

    templates

    object

    Dictionary of SessionTemplates keyed on their template type

    property name*

    SessionTemplate

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

    session_type Session Type (string)required

    unique name for this template

    engine_session_type Engine Session Type (string)

    Default value: Game

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

    can_join_matchmaking Can Join Matchmaking (boolean)

    Are sessions of this type allowed to join matchmaking?

    can_be_created_by_players_directly Can Be Created By Players Directly (boolean)

    Are players allowed to create sessions of this type?

    joinable Joinable (boolean)

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

    attempt_auto_join Attempt Auto Join (boolean)

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

    default_public Default Public (boolean)

    Should sessions of this type should be publicly joinable by default

    auto_add_to_browser Auto Add To Browser (boolean)

    Should session be automatically added to the browser list

    auto_browser_params

    object

    Browser parameters that can be used to filter results

    property name* string
    can_be_added_to_server_browser Can Be Added To Server Browser (boolean)

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

    keep_alive_on_empty Keep Alive On Empty (boolean)

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

    platform_templates

    object

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

    property name*

    PlatformSessionTemplate

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

    platform_id PlatformID (integer)required

    Possible values: [2, 4, 5, 9, 10, 11, 13, 16, 22, 24, 26, 28]

    DEPRECATED. Use Platform instead. Unique ids for different client platforms

    platform Platform (string)required

    Possible values: [Anon, Basic, XboxLive, PSN, NintendoNAID, NintendoSwitch, NintendoPPID, Google, GooglePlay, Apple, Epic, Steam, Amazon, Twitch, RallyHere, LegacyName]

    An enumeration.

    platform_session_type Platform Session Type (string)required

    Possible values: non-empty and <= 128 characters

    Platform-Specific Identifier for the Platform's template

    max_players Max Players (integer)

    Possible values: >= 1 and <= 100

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

    custom_data

    object

    Product-defined custom data

    property name* string

    auto_startup_params

    object

    Parameters given to an instance to change what map and mode it loads, and other gameplay behavior

    map Map (string)required

    Name of the map for the instance to spawn with

    mode Mode (string)

    Game mode for the instance to spawn in

    misc_params Misc Params (string)required

    Additional commandline parameters for the instance

    custom_data

    object

    Custom data to pass through to the instance

    property name* string
    auto_startup_instance_template_id uuid

    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

    min_session_count Min Session Count (integer)

    Default value: 0

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

    custom_data

    object

    Product-defined custom data about this session type

    property name* string
    num_teams Num Teams (integer)

    Possible values: >= 1 and <= 50

    Default value: 1

    The number of teams this session type can have

    players_per_team Players Per Team (integer)

    Possible values: >= 1 and <= 100

    Default value: 4

    The number of players that can be on each team

    can_change_own_team Can Change Own Team (boolean)

    Default value: true

    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

    notify_on_reservation Notify On Reservation (boolean)

    Default value: true

    If players should be notified when they are reserved in this type of session instead of waiting until they're invited

    player_visibility PlayerVisibility (string)

    Possible values: [ALL, TEAM, SELF, NONE]

    What subset of players any given player will have information about

    admin_player_visibility PlayerVisibility (string)

    Possible values: [ALL, TEAM, SELF, NONE]

    What subset of players any given player will have information about

    player_notification_frequency PlayerVisibility (string)

    Possible values: [ALL, TEAM, SELF, NONE]

    What subset of players any given player will have information about

    admin_player_notification_frequency PlayerVisibility (string)

    Possible values: [ALL, TEAM, SELF, NONE]

    What subset of players any given player will have information about

Loading...