Multiplayer Server - Create Title Multiplayer Servers Quota Change

Service:

Multiplayer

API Version:

250228

Creates a request to change a title's multiplayer server quotas.

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

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
Changes	True	CoreCapacityChange[]	Changes to make to the titles cores quota.
ChangeDescription		string	A brief description of the requested changes.
ContactEmail		string	Email to be contacted by our team about this request. Only required when a request is not approved.
CustomTags		object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
Notes		string	Additional information about this request that our team can use to better understand the requirements.
StartDate		string	When these changes would need to be in effect. Only required when a request is not approved.

Responses

Name	Type	Description
200 OK	CreateTitleMultiplayerServersQuotaChangeResponse
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
AzureRegion
AzureVmFamily
CoreCapacityChange
CreateTitleMultiplayerServersQuotaChangeRequest	Creates a request to change a title's multiplayer server quotas.
CreateTitleMultiplayerServersQuotaChangeResponse

ApiErrorWrapper

Object

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

Enumeration

Value	Description
AustraliaEast
AustraliaSoutheast
BrazilSouth
CanadaCentral
CentralIndia
CentralUs
EastAsia
EastUs
EastUs2
FranceCentral
JapanEast
JapanWest
KoreaCentral
MexicoCentral
NorthCentralUs
NorthEurope
SouthAfricaNorth
SouthCentralUs
SoutheastAsia
SwedenCentral
UaeNorth
UkSouth
WestCentralUs
WestEurope
WestUs
WestUs2

AzureVmFamily

Enumeration

Value	Description
A
Av2
Dadsv5
Dasv4
Dav4
Ddsv4
Ddsv5
Ddv4
Ddv5
Dsv2
Dsv3
Dv2
Dv3
Easv4
Eav4
Esv4
Ev4
F
Fsv2
HBv3
NCasT4_v3

CoreCapacityChange

Object

Name	Type	Description
NewCoreLimit	number	New quota core limit for the given vm family/region.
Region	AzureRegion	Region to change.
VmFamily	AzureVmFamily	Virtual machine family to change.

CreateTitleMultiplayerServersQuotaChangeRequest

Object

Creates a request to change a title's multiplayer server quotas.

Name	Type	Description
ChangeDescription	string	A brief description of the requested changes.
Changes	CoreCapacityChange[]	Changes to make to the titles cores quota.
ContactEmail	string	Email to be contacted by our team about this request. Only required when a request is not approved.
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
Notes	string	Additional information about this request that our team can use to better understand the requirements.
StartDate	string	When these changes would need to be in effect. Only required when a request is not approved.

CreateTitleMultiplayerServersQuotaChangeResponse

Object

Name	Type	Description
RequestId	string	Id of the change request that was created.
WasApproved	boolean	Determines if the request was approved or not. When false, our team is reviewing and may respond within 2 business days.

Error Codes

Name	Code
APINotEnabledForGameClientAccess	1082
MultiplayerServerBadRequest	1382
MultiplayerServerForbidden	1384
MultiplayerServerInternalServerError	1387
MultiplayerServerUnauthorized	1383