Skip to content

Acknowledge Backfill Request

POST
/session/v1/backfill/session/{session_id}

Acknowledge a backfill request, and keep it alive. If an acknowledgment is missed, open-match will delete the backfill object

Authorizations

Parameters

Path Parameters

session_id
required
string
>= 1 characters <= 128 characters

Query Parameters

refresh_ttl
boolean
default: true

Request Body required

object
instance_id
required

The instance ID for this backfill request

string
>= 1 characters <= 128 characters
extensions

Additional extensions to add to the Assignment for the backfill resource associated with the session

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

How to handle backfills that return too many players for a team

string
Allowed values: fail allow_overflow partial_with_overflow partial_without_overflow overfill

Responses

200

Successful Response

object
backfilled_players

List of players that were backfilled. If empty, no players were backfilled

Array<object>
default:

A player resource in a session

object
player_id

Legacy id for this player

integer
player_uuid
required

UUID for this player

string format: uuid
status
required

Status of the player in the session

string
Allowed values: leader member invited reserved
inviting_player_uuid

UUID of the player who sent this players invite, if any

string format: uuid
source_session_id

The UUID of the session that this player was invited from

string
>= 1 characters <= 128 characters
custom_data

Player-defined custom data

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

Product Client Version number. Used for compatibility checking with other players and instances

string format: semver
21.3.15-beta+12345
client_settings

Which input type and platform the client is using

object
platform_id

DEPRECATED. Use ‘platform’ instead. Id for which platform this client is on. ID will be ignored if ‘platform’ is given. At least one of the two is required

integer
platform

Which platform this client is on. If one is not provided, will get the platform from the ‘platform_id’. At least one of the two is required

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

Which input type this client is using

string
Allowed values: keyboardandmouse gamepad touch
crossplay_preferences

Client’s desired crossplay settings to determine which other clients it can play with. If not defined, assumed to be as permissive as possible

object
permitted_platform
required

The platform type that the client is allowed to play with (any, xbox-like only, playstation-like only etc.)

string
Allowed values: desired_platforms_any desired_platforms_xboxlike desired_platforms_playstationlike
permitted_input
required

The input type that the client is allowed to play with (keyboard and mouse, gamepad, touch input etc.)

string
Allowed values: desired_inputs_any desired_inputs_keyboardandmouse desired_inputs_gamepad desired_inputs_touch
invited

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone

string format: date-time
joined

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone

string format: date-time

403

Forbidden

object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

404

Backfill resource could not be found on the session, or in the open-match system

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