Multiplayer Server - Delete Build

Service:

Multiplayer

API Version:

241122

Deletes a multiplayer server build.

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

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 build ID of the build 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	EmptyResponse
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
DeleteBuildRequest	Deletes a multiplayer server build.
EmptyResponse

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

DeleteBuildRequest

Deletes a multiplayer server build.

Name	Type	Description
BuildId	string	The guid string build ID of the build to delete.
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

EmptyResponse

Error Codes

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