Documentation

ListArchivedMultiplayerServers

Lists archived multiplayer server sessions for a build.

Request Details

Returns a list of archived multiplayer servers for a build in a specific region.

ListMultiplayerServersRequest
Request Properties
BuildId (required) String

The guid string build ID of the multiplayer servers to list.

PageSize int32

The page size for the request.

Region (required) AzureRegion

The region the multiplayer servers to list.

SkipToken String

The skip token for the paged request.

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

Response Details

ListMultiplayerServersResponse
Result Properties
MultiplayerServerSummaries List<MultiplayerServerSummary>

The list of multiplayer server summary details.

PageSize (required) int32

The page size on the response.

SkipToken String

The skip token for the paged response.

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "code": 200,
  "status": "OK",
  "data": {
    "MultiplayerServerSummaries": [
      {
        "ServerId": "AMultiplayerGameServer",
        "SessionId": "02bdef0e-e01e-4b29-8efe-ff9f47a06d8c",
        "VmId": "VmID1",
        "Region": "SouthCentralUs",
        "State": "Active",
        "ConnectedPlayers": [
          {
            "PlayerId": "10931352888739351331"
          },
          {
            "PlayerId": "10271352123739051532"
          }
        ]
      },
      {
        "ServerId": "SomeOtherMultiplayerGameServer",
        "SessionId": "82bdef0e-a21e-3b29-8efe-ff9e57a08c1d",
        "VmId": "VmID2",
        "Region": "SouthCentralUs",
        "State": "Terminated",
        "ConnectedPlayers": []
      }
    ],
    "PageSize": 0
  }
}

Authentication

EntityToken

Possible Error Codes

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