Multiplayer Server - List Archived Multiplayer Servers

Lists archived multiplayer server sessions for a build.

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

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 servers to list.

Region True

AzureRegion

The region the multiplayer servers to list.

CustomTags

object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

PageSize

number

The page size for the request.

SkipToken

string

The skip token for the paged request.

Responses

Name Type Description
200 OK

ListMultiplayerServersResponse

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
ListMultiplayerServersRequest

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

ListMultiplayerServersResponse
MultiplayerServerSummary

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

ConnectedPlayer

Name Type Description
PlayerId

string

The player ID of the player connected to the multiplayer server.

ListMultiplayerServersRequest

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

Name Type Description
BuildId

string

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

CustomTags

object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

PageSize

number

The page size for the request.

Region

AzureRegion

The region the multiplayer servers to list.

SkipToken

string

The skip token for the paged request.

ListMultiplayerServersResponse

Name Type Description
MultiplayerServerSummaries

MultiplayerServerSummary[]

The list of multiplayer server summary details.

PageSize

number

The page size on the response.

SkipToken

string

The skip token for the paged response.

MultiplayerServerSummary

Name Type Description
ConnectedPlayers

ConnectedPlayer[]

The connected players in the multiplayer server.

LastStateTransitionTime

string

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

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 title generated 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.

Error Codes

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