Documentation

GetMultiplayerServerDetails

Gets multiplayer server session details for a build.

Request Details

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

GetMultiplayerServerDetailsRequest
Request Properties
BuildId (required) String

The guid string build ID of the multiplayer server to get details for.

Region (required) AzureRegion

The region the multiplayer server is located in to get details for.

SessionId (required) 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.

POST https://{{TitleID}}.playfabapi.com/MultiplayerServer/GetMultiplayerServerDetails
    Content-Type: application/json
{
  "BuildId": "21781fa8-096d-4d9c-b699-75433d579285",
  "SessionId": "02bdef0e-e01e-4b29-8efe-ff9f47a06d8c",
  "Region": "SouthCentralUs"
}
        

Response Details

GetMultiplayerServerDetailsResponse
Result Properties
ConnectedPlayers List<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 IPv4 address of the virtual machine that is hosting this multiplayer server.

LastStateTransitionTime DateTime

The time (UTC) at which a change in the multiplayer server state was observed.

Ports List<Port>

The ports the multiplayer server uses.

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.

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "code": 200,
  "status": "OK",
  "data": {
    "SessionId": "02bdef0e-e01e-4b29-8efe-ff9f47a06d8c",
    "ServerId": "AMultiplayerGameServer",
    "VmId": "VmID1",
    "IPV4Address": "10.250.24.54",
    "Ports": [
      {
        "Name": "PortName",
        "Num": 1243,
        "Protocol": "TCP"
      }
    ],
    "Region": "SouthCentralUs",
    "State": "Active",
    "ConnectedPlayers": [
      {
        "PlayerId": "10931352888739351331"
      },
      {
        "PlayerId": "10271352123739051532"
      }
    ]
  }
}

Authentication

EntityToken

Possible Error Codes

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