Multiplayer Server - List Virtual Machine Summaries

Service:

Multiplayer

API Version:

250228

Lists virtual machines for a title.

POST https://titleId.playfabapi.com/MultiplayerServer/ListVirtualMachineSummaries

Request Header

Name	Required	Type	Description
X-EntityToken	True	string	This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Request Body

Name	Required	Type	Description
BuildId	True	string	The guid string build ID of the virtual machines to list.
Region	True	AzureRegion	The region of the virtual machines to list.
CustomTags		object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
PageSize		number	The page size for the request.
SkipToken		string	The skip token for the paged request.

Responses

Name	Type	Description
200 OK	ListVirtualMachineSummariesResponse
400 Bad Request	ApiErrorWrapper	This is the outer wrapper for all responses with errors

Security

X-EntityToken

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Type: apiKey
In: header

Definitions

Name	Description
ApiErrorWrapper	The basic wrapper around every failed API response
AzureRegion
ListVirtualMachineSummariesRequest	Returns a list of virtual machines for a title.
ListVirtualMachineSummariesResponse
VirtualMachineSummary

ApiErrorWrapper

Object

The basic wrapper around every failed API response

Name	Type	Description
code	integer	Numerical HTTP code
error	string	Playfab error code
errorCode	integer	Numerical PlayFab error code
errorDetails	object	Detailed description of individual issues with the request object
errorMessage	string	Description for the PlayFab errorCode
status	string	String HTTP code

AzureRegion

Enumeration

Value	Description
AustraliaEast
AustraliaSoutheast
BrazilSouth
CanadaCentral
CentralIndia
CentralUs
EastAsia
EastUs
EastUs2
FranceCentral
JapanEast
JapanWest
KoreaCentral
MexicoCentral
NorthCentralUs
NorthEurope
SouthAfricaNorth
SouthCentralUs
SoutheastAsia
SwedenCentral
UaeNorth
UkSouth
WestCentralUs
WestEurope
WestUs
WestUs2

ListVirtualMachineSummariesRequest

Object

Returns a list of virtual machines for a title.

Name	Type	Description
BuildId	string	The guid string build ID of the virtual machines to list.
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
PageSize	number	The page size for the request.
Region	AzureRegion	The region of the virtual machines to list.
SkipToken	string	The skip token for the paged request.

ListVirtualMachineSummariesResponse

Object

Name	Type	Description
PageSize	number	The page size on the response.
SkipToken	string	The skip token for the paged response.
VirtualMachines	VirtualMachineSummary[]	The list of virtual machine summaries.

VirtualMachineSummary

Object

Name	Type	Description
HealthStatus	string	The virtual machine health status.
State	string	The virtual machine state.
VmId	string	The virtual machine ID.

Error Codes

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