Multiplayer Server - Delete Build Region
Removes a multiplayer server build's region.
POST https://titleId.playfabapi.com/MultiplayerServer/DeleteBuildRegion
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 |
---|---|---|---|
BuildId | True |
string |
The guid string ID of the build we want to update regions for. |
Region | True |
The build region to delete. |
|
CustomTags |
object |
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
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 |
Azure |
|
Delete |
Removes a multiplayer server build's region. |
Empty |
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 |
AzureRegion
Name | Type | Description |
---|---|---|
AustraliaEast |
string |
|
AustraliaSoutheast |
string |
|
BrazilSouth |
string |
|
CanadaCentral |
string |
|
CentralIndia |
string |
|
CentralUs |
string |
|
EastAsia |
string |
|
EastUs |
string |
|
EastUs2 |
string |
|
FranceCentral |
string |
|
JapanEast |
string |
|
JapanWest |
string |
|
KoreaCentral |
string |
|
MexicoCentral |
string |
|
NorthCentralUs |
string |
|
NorthEurope |
string |
|
SouthAfricaNorth |
string |
|
SouthCentralUs |
string |
|
SoutheastAsia |
string |
|
SwedenCentral |
string |
|
UaeNorth |
string |
|
UkSouth |
string |
|
WestCentralUs |
string |
|
WestEurope |
string |
|
WestUs |
string |
|
WestUs2 |
string |
DeleteBuildRegionRequest
Removes a multiplayer server build's region.
Name | Type | Description |
---|---|---|
BuildId |
string |
The guid string ID of the build we want to update regions for. |
CustomTags |
object |
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
Region |
The build region to delete. |
EmptyResponse
Error Codes
Name | Code |
---|---|
APINotEnabledForGameClientAccess | 1082 |
MultiplayerServerBadRequest | 1382 |
MultiplayerServerConflict | 1386 |
MultiplayerServerForbidden | 1384 |
MultiplayerServerInternalServerError | 1387 |
MultiplayerServerNotFound | 1385 |
MultiplayerServerUnauthorized | 1383 |
MultiplayerServerUnavailable | 1388 |