Update Backfill Request

PATCH 
/session/v1/backfill/session/:session_id

Update a existing backfill's search fields and extensions

Request

Path Parameters

session_id Session Idrequired

Possible values: non-empty and <= 128 characters

Query Parameters

refresh_ttl Refresh Ttl

Default value: true

application/json

Body

required

instance_id Instance Id (string)required

Possible values: non-empty and <= 128 characters

The instance ID for this backfill request

additional_join_params

object

Additional parameters to apply to a matchmaking ticket

double_args

object

Additional double arguments to add to the matchmaking ticket

property name* number

string_args

object

Additional string arguments to add to the matchmaking ticket

property name* string

tags string[]

Possible values: non-empty and <= 4096 characters

Default value: ``

Additional tags to add to the matchmaking ticket

extensions

object

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

property name* string

teams

object[]

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 [

players_required Players Required (integer)required

The number of players we want to backfill

team_id Team Id (integer)required

Id for the team that requires backfilled players

]

Responses

204

Successful Response

403

Forbidden

application/json

Schema

Schema

auth_success Auth Success (boolean)

Default value: true

error_code Error Code (string)required
desc Desc (string)required

Example (from schema)

{
  "auth_success": true,
  "error_code": "string",
  "desc": "string"
}

404

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

application/json

Schema

Schema

auth_success Auth Success (boolean)

Default value: true

error_code Error Code (string)required
desc Desc (string)required

Example (from schema)

{
  "auth_success": true,
  "error_code": "string",
  "desc": "string"
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...