Documentation

GetMatchmakerGameModes

Retrieves the details of defined game modes 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.

GetMatchmakerGameModesRequest
Request Properties
BuildVersion (required) String

previously uploaded build version for which game modes are being requested

POST https://{{TitleID}}.playfabapi.com/Admin/GetMatchmakerGameModes
    Content-Type: application/json
    X-SecretKey: <developer_secret_key>
{
  "BuildVersion": "5.0.1"
}
        

Response Details

GetMatchmakerGameModesResult
Result Properties
GameModes List<GameModeInfo>

array of game modes available for the specified build

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "code": 200,
  "status": "OK",
  "data": {
    "GameModes": [
      {
        "Gamemode": "0",
        "MinPlayerCount": 2,
        "MaxPlayerCount": 25
      },
      {
        "Gamemode": "1",
        "MinPlayerCount": 4,
        "MaxPlayerCount": 35,
        "StartOpen": false
      }
    ]
  }
}

Authentication

SecretKey

Possible Error Codes

Name Code