Skip to content
RallyHere Docs

Update Backfill Request

PATCH
/session/v1/backfill/session/{session_id}

Update a existing backfill’s search fields and extensions

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
additional_join_params

Additional fields put on the matchmaking ticket for open match to search with (see https://openmatch.dev/site/docs/reference/api/#searchfields)

object
double_args

Additional double arguments to add to the matchmaking ticket

object
key
additional properties
number
string_args

Additional string arguments to add to the matchmaking ticket

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

Additional tags to add to the matchmaking ticket

Array<string>
default:
extensions

Additional extensions to add to the matchmaking ticket. Value is a base64 string representation of the protobuf binary data. The data will be converted back to binary before being put on the ticket

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

The teams and number of players that need to be backfilled. Leaving this out (or supplying an empty list) is treated as no players are currently required

Array<object>
default:
object
players_required
required

The number of players we want to backfill

integer
team_id
required

Id for the team that requires backfilled players

integer

Responses

204

Successful Response

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