Multiplayer Server - Get Title Enabled For Multiplayer Servers Status

Service:

Multiplayer

API Version:

240426

Gets the status of whether a title is enabled for the multiplayer server feature.

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

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	GetTitleEnabledForMultiplayerServersStatusResponse
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
GetTitleEnabledForMultiplayerServersStatusRequest	Gets the status of whether a title is enabled for the multiplayer server feature. The enabled status can be Initializing, Enabled, and Disabled.
GetTitleEnabledForMultiplayerServersStatusResponse
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

GetTitleEnabledForMultiplayerServersStatusRequest

Gets the status of whether a title is enabled for the multiplayer server feature. The enabled status can be Initializing, Enabled, and Disabled.

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

GetTitleEnabledForMultiplayerServersStatusResponse

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
MultiplayerServerBadRequest	1382
MultiplayerServerForbidden	1384
MultiplayerServerInternalServerError	1387
MultiplayerServerNotFound	1385
MultiplayerServerUnauthorized	1383
MultiplayerServerUnavailable	1388