Documentation

GetGameServerRegions

Get details about the regions hosting game servers matching the given parameters.

Request Details

GameServerRegionsRequest
Request Properties
BuildVersion (required) String

version of game server for which stats are being requested

TitleId String

Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected.

POST https://{{TitleID}}.playfabapi.com/Client/GetGameServerRegions
    Content-Type: application/json
    X-Authentication: <user_session_ticket_value>
{
  "BuildVersion": "5.0.1",
  "TitleId": "2074"
}
        

Response Details

GameServerRegionsResult
Result Properties
Regions List<RegionInfo>

array of regions found matching the request parameters

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "code": 200,
  "status": "OK",
  "data": {
    "Regions": [
      {
        "Region": "USEast",
        "Name": "USCentral",
        "Available": true,
        "PingUrl": "10.31.58.95"
      }
    ]
  }
}

Authentication

SessionTicket

Possible Error Codes

Name Code