Documentation

ModifyMatchmakerGameModes

Updates the game server mode details for the specified game server executable

Request Details

These details are used by the PlayFab matchmaking service to determine if an existing Game Server Instance has room for additional users, and by the PlayFab game server management service to determine when a new Game Server Host should be created in order to prevent excess load on existing Hosts. This operation is not additive. Using it will cause the game mode definition for the game server executable in question to be created from scratch. If there is an existing game server mode definition for the given BuildVersion, it will be deleted and replaced with the data specified in this call.

ModifyMatchmakerGameModesRequest
Request Properties
BuildVersion (required) String

previously uploaded build version for which game modes are being specified

GameModes (required) List<GameModeInfo>

array of game modes (Note: this will replace all game modes for the indicated build version)

POST https://{{TitleID}}.playfabapi.com/Admin/ModifyMatchmakerGameModes
    Content-Type: application/json
    X-SecretKey: <developer_secret_key>
{
  "BuildVersion": "5.0.1",
  "GameModes": [
    {
      "Gamemode": "0",
      "MinPlayerCount": 2,
      "MaxPlayerCount": 25
    },
    {
      "Gamemode": "1",
      "MinPlayerCount": 4,
      "MaxPlayerCount": 35,
      "StartOpen": false
    }
  ]
}
        

Response Details

ModifyMatchmakerGameModesResult
Result Properties

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8


Authentication

SecretKey

Possible Error Codes

Name Code