Documentation

ListVirtualMachineSummaries

Lists virtual machines for a title.

Request Details

Returns a list of virtual machines for a title.

ListVirtualMachineSummariesRequest
Request Properties
BuildId (required) String

The guid string build ID of the virtual machines to list.

PageSize int32

The page size for the request.

Region (required) AzureRegion

The region of the virtual machines to list.

SkipToken String

The skip token for the paged request.

POST https://{{TitleID}}.playfabapi.com/MultiplayerServer/ListVirtualMachineSummaries
    Content-Type: application/json
{
  "BuildId": "21781fa8-096d-4d9c-b699-75433d579285",
  "Region": "SouthCentralUs",
  "PageSize": 10
}
        

Response Details

ListVirtualMachineSummariesResponse
Result Properties
PageSize (required) int32

The page size on the response.

SkipToken String

The skip token for the paged response.

VirtualMachines List<VirtualMachineSummary>

The list of virtual machine summaries.

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "code": 200,
  "status": "OK",
  "data": {
    "VirtualMachines": [
      {
        "VmId": "VmID1",
        "State": "Running",
        "HealthStatus": "Healthy"
      },
      {
        "VmId": "VmID2",
        "State": "Propping",
        "HealthStatus": "Healthy"
      }
    ],
    "PageSize": 10
  }
}

Authentication

EntityToken

Possible Error Codes

Name Code
MultiplayerServerBadRequest 1382
MultiplayerServerForbidden 1384
MultiplayerServerInternalServerError 1387
MultiplayerServerNotFound 1385
MultiplayerServerUnauthorized 1383
MultiplayerServerUnavailable 1388