Documentation

GetBuild

Gets a multiplayer server build.

Request Details

Returns the details about a multiplayer server build.

GetBuildRequest
Request Properties
BuildId (required) String

The guid string build ID of the build to get.

POST https://{{TitleID}}.playfabapi.com/MultiplayerServer/GetBuild
    Content-Type: application/json
{
  "BuildId": "53781fa8-006d-4e9c-b733-57433d579285"
}
        

Response Details

GetBuildResponse
Result Properties
BuildId String

The guid string build ID of the build.

BuildName String

The build name.

BuildStatus String

The current build status. Valid values are - Deploying, Deployed, DeletingRegion, Unhealthy.

ContainerFlavor ContainerFlavor

The flavor of container of he build.

ContainerRunCommand String

The container command to run when the multiplayer server has been allocated, including any arguments. This only applies to custom builds. If the build is a managed build, this field will be null.

CreationTime DateTime

The time the build was created in UTC.

CustomGameContainerImage ContainerImageReference

The custom game container image for a custom build.

GameAssetReferences List<AssetReference>

The game assets for the build.

GameCertificateReferences List<GameCertificateReference>

The game certificates for the build.

Metadata Dict<String, String>

Metadata of the build. The keys are case insensitive. The build metadata is made available to the server through Game Server SDK (GSDK).

MultiplayerServerCountPerVm (required) int32

The number of multiplayer servers to hosted on a single VM of the build.

Ports List<Port>

The ports the build is mapped on.

RegionConfigurations List<BuildRegion>

The region configuration for the build.

StartMultiplayerServerCommand String

The command to run when the multiplayer server has been allocated, including any arguments. This only applies to managed builds. If the build is a custom build, this field will be null.

VmSize AzureVmSize

The VM size the build was created on.

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "code": 200,
  "status": "OK",
  "data": {
    "BuildId": "21781fa8-096d-4d9c-b699-75433d579285",
    "BuildName": "GameBuildName",
    "BuildStatus": "Deployed",
    "CreationTime": "2014-04-07T09:04:28Z",
    "Metadata": {
      "MetadataKey": "MetadataValue"
    },
    "VmSize": "Standard_D2_v2",
    "ContainerFlavor": "ManagedWindowsServerCore",
    "Ports": [
      {
        "Name": "PortName",
        "Num": 1243,
        "Protocol": "TCP"
      }
    ],
    "RegionConfigurations": [
      {
        "Region": "EastUs",
        "Status": "Initializing",
        "MaxServers": 10,
        "StandbyServers": 5,
        "CurrentServerStats": {
          "Active": 0,
          "StandingBy": 0,
          "Propping": 5,
          "Total": 5
        }
      },
      {
        "Region": "WestUs",
        "Status": "Succeeded",
        "MaxServers": 12,
        "StandbyServers": 8,
        "CurrentServerStats": {
          "Active": 1,
          "StandingBy": 7,
          "Propping": 1,
          "Total": 9
        }
      },
      {
        "Region": "NorthEurope",
        "Status": "Unhealthy",
        "MaxServers": 7,
        "StandbyServers": 3,
        "CurrentServerStats": {
          "Active": 0,
          "StandingBy": 0,
          "Propping": 3,
          "Total": 3
        }
      }
    ],
    "GameAssetReferences": [
      {
        "FileName": "gameserver.zip",
        "MountPath": "C:\\Asset\\"
      }
    ],
    "GameCertificateReferences": [
      {
        "Name": "CertName",
        "GsdkAlias": "CertGsdkAlias"
      }
    ],
    "StartMultiplayerServerCommand": "C:\\Assets\\gameserver.exe -startserver",
    "MultiplayerServerCountPerVm": 1
  }
}

Authentication

EntityToken

Possible Error Codes

Name Code
MultiplayerServerBadRequest 1382
MultiplayerServerConflict 1386
MultiplayerServerForbidden 1384
MultiplayerServerInternalServerError 1387
MultiplayerServerNotFound 1385
MultiplayerServerUnauthorized 1383