Multiplayer Server - Get Remote Login Endpoint

Service:

Multiplayer

API Version:

240412

Gets a remote login endpoint to a VM that is hosting a multiplayer server build.

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

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 multiplayer server to get remote login information for.
Region	True	AzureRegion	The region of the multiplayer server to get remote login information for.
VmId	True	string	The virtual machine ID the multiplayer server is located on.
CustomTags		object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Responses

Name	Type	Description
200 OK	GetRemoteLoginEndpointResponse
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
GetRemoteLoginEndpointRequest	Gets a remote login endpoint to a VM that is hosting a multiplayer server build in a specific region.
GetRemoteLoginEndpointResponse

ApiErrorWrapper

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

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

GetRemoteLoginEndpointRequest

Gets a remote login endpoint to a VM that is hosting a multiplayer server build in a specific region.

Name	Type	Description
BuildId	string	The guid string build ID of the multiplayer server to get remote login information for.
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
Region	AzureRegion	The region of the multiplayer server to get remote login information for.
VmId	string	The virtual machine ID the multiplayer server is located on.

GetRemoteLoginEndpointResponse

Name	Type	Description
IPV4Address	string	The remote login IPV4 address of multiplayer server.
Port	number	The remote login port of multiplayer server.

Error Codes

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