Documentation

GetRemoteLoginEndpoint

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

Request Details

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

GetRemoteLoginEndpointRequest
Request Properties
BuildId (required) String

The guid string build ID of the multiplayer server to get remote login information for.

Region (required) AzureRegion

The region of the multiplayer server to get remote login information for.

VmId (required) String

The virtual machine ID the multiplayer server is located on.

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

Response Details

GetRemoteLoginEndpointResponse
Result Properties
IPV4Address String

The remote login IPV4 address of multiplayer server.

Port (required) int32

The remote login port of multiplayer server.

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "code": 200,
  "status": "OK",
  "data": {
    "IPV4Address": "10.250.24.54",
    "Port": 1234
  }
}

Authentication

EntityToken

Possible Error Codes

Name Code
MultiplayerServerBadRequest 1382
MultiplayerServerConflict 1386
MultiplayerServerForbidden 1384
MultiplayerServerInternalServerError 1387
MultiplayerServerNoContent 1381
MultiplayerServerNotFound 1385
MultiplayerServerTooManyRequests 1380
MultiplayerServerUnauthorized 1383
MultiplayerServerUnavailable 1388