Multiplayer Server - Get Multiplayer Server Details
Gets multiplayer server session details for a build.
Allowed entity token types: title
POST https://titleId.playfabapi.com/MultiplayerServer/GetMultiplayerServerDetailsRequest 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 |
|---|---|---|---|
| SessionId | True |
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. |
| CustomTags |
object |
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK | ||
| 400 Bad Request |
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 |
|---|---|
|
Api |
The basic wrapper around every failed API response |
|
Azure |
|
|
Connected |
|
|
Get |
Gets multiplayer server session details for a build in a specific region. |
|
Get |
|
| Port | |
|
Protocol |
|
|
Public |
|
|
Routing |
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
| Value | Description |
|---|---|
| AustraliaEast | |
| AustraliaSoutheast | |
| BrazilSouth | |
| CentralUs | |
| EastAsia | |
| EastUs | |
| EastUs2 | |
| JapanEast | |
| JapanWest | |
| NorthCentralUs | |
| NorthEurope | |
| SouthCentralUs | |
| SoutheastAsia | |
| WestEurope | |
| WestUs | |
| SouthAfricaNorth | |
| WestCentralUs | |
| KoreaCentral | |
| FranceCentral | |
| WestUs2 | |
| CentralIndia | |
| UaeNorth | |
| UkSouth | |
| SwedenCentral | |
| CanadaCentral | |
| MexicoCentral |
ConnectedPlayer
| Name | Type | Description |
|---|---|---|
| PlayerId |
string |
The player ID of the player connected to the multiplayer server. |
GetMultiplayerServerDetailsRequest
Gets multiplayer server session details for a build in a specific region.
| Name | Type | Description |
|---|---|---|
| CustomTags |
object |
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
| SessionId |
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. |
GetMultiplayerServerDetailsResponse
| Name | Type | Description |
|---|---|---|
| BuildId |
string |
The identity of the build in which the server was allocated. |
| ConnectedPlayers |
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 public IPv4 address of the virtual machine that is hosting this multiplayer server. |
| LastStateTransitionTime |
string |
The time (UTC) at which a change in the multiplayer server state was observed. |
| Ports |
Port[] |
The ports the multiplayer server uses. |
| PublicIPV4Addresses |
The list of public Ipv4 addresses associated with the server. |
|
| Region |
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. |
Port
| Name | Type | Description |
|---|---|---|
| Name |
string |
The name for the port. |
| Num |
number |
The number for the port. |
| Protocol |
The protocol for the port. |
ProtocolType
| Value | Description |
|---|---|
| TCP | |
| UDP |
PublicIpAddress
| Name | Type | Description |
|---|---|---|
| FQDN |
string |
FQDN of the public IP |
| IpAddress |
string |
Server IP Address |
| RoutingType |
Routing Type of the public IP. |
RoutingType
| Value | Description |
|---|---|
| Microsoft | |
| Internet |
Error Codes
| Name | Code |
|---|---|
| APINotEnabledForGameClientAccess | 1082 |
| MultiplayerServerBadRequest | 1382 |
| MultiplayerServerForbidden | 1384 |
| MultiplayerServerInternalServerError | 1387 |
| MultiplayerServerNotFound | 1385 |
| MultiplayerServerUnauthorized | 1383 |
| MultiplayerServerUnavailable | 1388 |