Multiplayer Server - List Build Aliases
Lists details of all build aliases for a title. Accepts tokens for title and if game client access is enabled, allows game client to request list of builds with player entity token.
Allowed entity token types: title, title_player_account
POST https://titleId.playfabapi.com/MultiplayerServer/ListBuildAliasesRequest 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 | Type | Description |
|---|---|---|
| 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 | ||
| 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 |
|
Build |
|
|
Build |
|
|
List |
Returns a list of summarized details of all multiplayer server builds for a title. |
|
List |
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 |
BuildAliasDetailsResponse
| Name | Type | Description |
|---|---|---|
| AliasId |
string |
The guid string alias Id of the alias to be created or updated. |
| AliasName |
string |
The alias name. |
| BuildSelectionCriteria |
Array of build selection criteria. |
BuildSelectionCriterion
| Name | Type | Description |
|---|---|---|
| BuildWeightDistribution |
object |
Dictionary of build ids and their respective weights for distribution of allocation requests. |
ListBuildAliasesRequest
Returns a list of summarized details of all multiplayer server builds for a title.
| Name | Type | Description |
|---|---|---|
| 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. |
ListBuildAliasesResponse
| Name | Type | Description |
|---|---|---|
| BuildAliases |
The list of build aliases for the title |
|
| PageSize |
number |
The page size on the response. |
| SkipToken |
string |
The skip token for the paged response. |
Error Codes
| Name | Code |
|---|---|
| APINotEnabledForGameClientAccess | 1082 |
| MultiplayerServerBadRequest | 1382 |
| MultiplayerServerForbidden | 1384 |
| MultiplayerServerInternalServerError | 1387 |
| MultiplayerServerNotFound | 1385 |
| MultiplayerServerUnauthorized | 1383 |
| MultiplayerServerUnavailable | 1388 |