Multiplayer Server - Get Multiplayer Server Details

Service:

Multiplayer

API Version:

250228

Gets multiplayer server session details for a build.

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

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
SessionId	True	string	The title generated guid string session ID of the multiplayer server to get details for. This is to keep track of multiplayer server sessions.
CustomTags		object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Responses

Name	Type	Description
200 OK	GetMultiplayerServerDetailsResponse
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
ConnectedPlayer
GetMultiplayerServerDetailsRequest	Gets multiplayer server session details for a build in a specific region.
GetMultiplayerServerDetailsResponse
Port
ProtocolType
PublicIpAddress
RoutingType

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

ConnectedPlayer

Object

Name	Type	Description
PlayerId	string	The player ID of the player connected to the multiplayer server.

GetMultiplayerServerDetailsRequest

Object

Gets multiplayer server session details for a build in a specific region.

Name	Type	Description
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
SessionId	string	The title generated guid string session ID of the multiplayer server to get details for. This is to keep track of multiplayer server sessions.

GetMultiplayerServerDetailsResponse

Object

Name	Type	Description
BuildId	string	The identity of the build in which the server was allocated.
ConnectedPlayers	ConnectedPlayer[]	The connected players in the multiplayer server.
FQDN	string	The fully qualified domain name of the virtual machine that is hosting this multiplayer server.
IPV4Address	string	The public IPv4 address of the virtual machine that is hosting this multiplayer server.
LastStateTransitionTime	string	The time (UTC) at which a change in the multiplayer server state was observed.
Ports	Port[]	The ports the multiplayer server uses.
PublicIPV4Addresses	PublicIpAddress[]	The list of public Ipv4 addresses associated with the server.
Region	AzureRegion	The region the multiplayer server is located in.
ServerId	string	The string server ID of the multiplayer server generated by PlayFab.
SessionId	string	The guid string session ID of the multiplayer server.
State	string	The state of the multiplayer server.
VmId	string	The virtual machine ID that the multiplayer server is located on.

Port

Object

Name	Type	Description
Name	string	The name for the port.
Num	number	The number for the port.
Protocol	ProtocolType	The protocol for the port.

ProtocolType

Enumeration

Value	Description
TCP
UDP

PublicIpAddress

Object

Name	Type	Description
FQDN	string	FQDN of the public IP
IpAddress	string	Server IP Address
RoutingType	RoutingType	Routing Type of the public IP.

RoutingType

Enumeration

Value	Description
Internet
Microsoft

Error Codes

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