Multiplayer Server - Enable Multiplayer Servers For Title

Service:

Multiplayer

API Version:

240412

Enables the multiplayer server feature for a title.

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

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	Type	Description
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Responses

Name	Type	Description
200 OK	EnableMultiplayerServersForTitleResponse
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
EnableMultiplayerServersForTitleRequest	Enables the multiplayer server feature for a title and returns the enabled status. The enabled status can be Initializing, Enabled, and Disabled. It can up to 20 minutes or more for the title to be enabled for the feature. On average, it can take up to 20 minutes for the title to be enabled for the feature.
EnableMultiplayerServersForTitleResponse
TitleMultiplayerServerEnabledStatus

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

EnableMultiplayerServersForTitleRequest

Enables the multiplayer server feature for a title and returns the enabled status. The enabled status can be Initializing, Enabled, and Disabled. It can up to 20 minutes or more for the title to be enabled for the feature. On average, it can take up to 20 minutes for the title to be enabled for the feature.

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

EnableMultiplayerServersForTitleResponse

Name	Type	Description
Status	TitleMultiplayerServerEnabledStatus	The enabled status for the multiplayer server features for the title.

TitleMultiplayerServerEnabledStatus

Name	Type	Description
Disabled	string
Enabled	string
Initializing	string

Error Codes

Name	Code
APINotEnabledForGameClientAccess	1082
CannotEnableMultiplayerServersForTitle	1443
MultiplayerServerBadRequest	1382
MultiplayerServerForbidden	1384
MultiplayerServerInternalServerError	1387
MultiplayerServerUnauthorized	1383
MultiplayerServerUnavailable	1388