Sessions
This API is for the creation and management of sessions, which are just generic groups of players, and operations on those sessions, such as joining matchmaking.
📄️ Get All Session Templates
Get the config about all session templates
📄️ Get Session Template By Type
Get config about a session template by ID
📄️ Get Browser Sessions By Type
Get all public sessions of a specific type
📄️ Create Or Join Session
Join the first publicly available session of given type. If there is no public session, and the session type
📄️ Get Session By Id
Get Session by ID. This request will return limited results for non-members of the session, such as excluding info for
📄️ Update Session By Id
Update session info by session id
📄️ Update Team By Id
Update specific team info by session and team id
📄️ Get Session By Allocation Id
Get session by allocation ID. Returns the same limited results as getting the session by session id
📄️ Post Browser Info
Register session in the public browser
📄️ Delete Browser Info
Delete the session from the public browser
📄️ Update Browser Info
Update the browser info for the session
📄️ Get Connection Info Self
Get public connection info for self
📄️ Join Queue
Add session to a matchmaking queue
📄️ Leave Queue
Remove session from a matchmaking queue
📄️ Create Matchmade Session
Create a match session based on matchmaking results.
📄️ Create Instance Request
Request an instance be spawned for the session, or register self as a host of the instance
📄️ End Instance
Unregister the instance from the session.
📄️ Update Instance Info
Update info about the instance. If the instance was a result of the instance allocation system, then it will have an allocation id.
📄️ Instance Health Check
Endpoint to post health status of an instance
📄️ Instance Health Config
Get config about expected poll rates for instance health, and when instances will go missing/unhealthy
📄️ Add Platform Session To Rally Here Session
Add a platform session to an existing RallyHere session. The requesting player will be added to the platform session
📄️ Delete Platform Session From Rally Here Session
Remove a platform session from a Rally Here session
📄️ Get Platform Session Info
Get information about a platform session
📄️ Join Session By Platform Session Id Self
Join a platform session by ID, and the parent session
📄️ Leave Session By Platform Session Self
Leave a platform session by platform ID and parent platform session id
📄️ Join Session By Platform Session By Uuid
Join a platform session by platform ID and parent platform session id
📄️ Leave Session By Platform Session By Uuid
Leave a platform session by platform ID and parent platform session id
📄️ Get Player In Session
Get a specific player from a session by id.
📄️ Update Session Player By Uuid V2
Add or invite a player to the session, or change the status of a player already in the session
📄️ Kick Player From Session By Uuid V2
Kick or Remove a player from a session, or cancel an invite for a player to the session
📄️ Get Players In Session
Get a page of players in a specific session.
📄️ Join Session By Id Self
Join a session with currently authed player
📄️ Leave Session By Id Self
Leave a session with currently authed player
📄️ Get Player Permission By Uuid
Get a specific player's intra-session permissions
📄️ Remove Player Permission By Uuid
Remove intra-session permissions from a specific player
📄️ Give Player Permission By Uuid
Give a specific player intra-session permissions
📄️ Invite Player By Uuid V2
Invite a player to the session
📄️ Promote Player By Uuid V2
Invite a player to the session
📄️ Move Player By Uuid V2
Move a specific player to a different team in a specific session
📄️ Update Player By Uuid V2
Update data about a specific player in a specific session
📄️ Update Session Player By Uuid
Add or invite a player to the session, or change the status of a player already in the session
📄️ Kick Player From Session By Uuid
Kick or Remove a player from a session, or cancel an invite for a player to the session
📄️ Update Session Player By Id
Add or invite a player to the session, or change the status of a player already in the session
📄️ Kick Player From Session By Id
Kick or Remove a player from a session, or cancel an invite for a player to the session
📄️ Get Player Sessions Self
Get all session IDs associated with the token's player. NOTE This list is eventually consistent with the data from the session by ID endpoints.
📄️ Get Player Sessions By Uuid V2
Get all session IDs associated with a player. NOTE This list is eventually consistent with the data from the session by ID endpoints.
📄️ Get Player Sessions By Uuid
Get all session IDs associated with a player. NOTE This list is eventually consistent with the data from the session by ID endpoints.
📄 ️ Get Player Sessions
Get all session IDs associated with a player. NOTE This list is eventually consistent with the data from the session by ID endpoints.
📄️ Swap Players In Session
Swap two players on different teams. Leaders cannot be swapped
📄️ Backfill Config
Get config about how often backfill heartbeats must be sent in order to prevent the backfill resource from being deleted
📄️ Acknowledge Backfill Request
Acknowledge a backfill request, and keep it alive. If an acknowledgment is missed, open-match will delete the backfill object
📄️ Delete Backfill Request
Manually delete the backfill associated with this session
📄️ Update Backfill Request
Update a existing backfill's search fields and extensions
📄️ Invite Session To Session
Invite an entire session to a target session
📄️ Kick Session From Session
Remove players from a session, `{kicked_session_id}`, if they are also in the session `{session_id}`
📄️ Get All Queue Info
Get all the available and active queues that sessions can try to join
📄️ Get All Queue Info V2
Get all the available and active queues that sessions can try to join
📄️ Get All Map Game Info
Get the config used to launch an instance by the launch template id. Launch template ID can be found in
📄️ Get Instance Request Template
Get the config used to request an instance by the InstanceRequestTemplate ID. This ID can be found in
📄️ Get Match Making Templates
Get match making templates, rules, and profiles for a template group. Groups can be found on the queue information
📄️ Get Match Making Profile
Get info about a specific match making profile
📄️ Get Match Making Profile V2
Get info about a specific match making profile
📄️ Get Match Making Templates V2
Get match making templates, rules, and profiles for a template group. Groups can be found on the queue information
📄️ Get All Regions
Get all of the enabled regions and their configuration
📄️ Get Session Audit
Get all audit events for a specific session or player. Empty list means there is no audit history.
📄️ Create Session Audit
Create an audit event in the log for this session.
📄️ Get Voip Login Token
Generate a token to login with vivox
📄️ Get Voip Action Token Me
Generate a token for one of the specific vivox actions except logging in
📄️ Get Voip Action Token
Generate a token for one of the specific vivox actions except logging in