Documentation

GetServerBuildInfo

Retrieves the build details for the specified game server executable

Request Details

GetServerBuildInfoRequest
Request Properties
BuildId (required) String

unique identifier of the previously uploaded build executable for which information is being requested

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

Response Details

GetServerBuildInfoResult
Result Properties
ActiveRegions List<Region>

array of regions where this build can used, when it is active

BuildId String

unique identifier for this build executable

Comment String

developer comment(s) for this build

ErrorMessage String

error message, if any, about this build

MaxGamesPerHost (required) int32

maximum number of game server instances that can run on a single host machine

MinFreeGameSlots (required) int32

minimum capacity of additional game server instances that can be started before the autoscaling service starts new host machines (given the number of current running host machines and game server instances)

Status GameBuildStatus

the current status of the build validation and processing steps

Timestamp (required) DateTime

time this build was last modified (or uploaded, if this build has never been modified)

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.

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "code": 200,
  "status": "OK",
  "data": {
    "BuildId": "67732",
    "ActiveRegions": [
      "USCentral",
      "EUWest"
    ],
    "MaxGamesPerHost": 5,
    "MinFreeGameSlots": 2,
    "Comment": "Testing new IAP methods",
    "Timestamp": "2014-03-24T00:00:00Z",
    "TitleId": "2074",
    "Status": "Available"
  }
}

Authentication

SecretKey

Possible Error Codes

Name Code
BuildNotFound 1032