Multiplayer Server - Create Build Alias

  • Reference
Service:
Multiplayer
API Version:
240412

Creates a multiplayer server build alias.

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

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
AliasName True

string

The alias name.
BuildSelectionCriteria

BuildSelectionCriterion[]

Array of build selection criteria.
CustomTags

object

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

Responses

Name Type Description
200 OK

BuildAliasDetailsResponse

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
BuildAliasDetailsResponse
BuildSelectionCriterion
CreateBuildAliasRequest

Creates a multiplayer server build alias and returns the created alias.

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

BuildSelectionCriterion[]

Array of build selection criteria.

BuildSelectionCriterion

Name Type Description
BuildWeightDistribution

object

Dictionary of build ids and their respective weights for distribution of allocation requests.

CreateBuildAliasRequest

Creates a multiplayer server build alias and returns the created alias.

Name Type Description
AliasName

string

The alias name.
BuildSelectionCriteria

BuildSelectionCriterion[]

Array of build selection criteria.
CustomTags

object

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

Error Codes

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