Multiplayer Server - Shutdown Multiplayer Server

Shuts down a multiplayer server session.

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

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
SessionId True
  • string

A guid string session ID of the multiplayer server to shut down.

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

ApiErrorWrapper

The basic wrapper around every failed API response

EmptyResponse
ShutdownMultiplayerServerRequest

Executes the shutdown callback from the GSDK and terminates the multiplayer server session. The callback in the GSDK will allow for graceful shutdown with a 15 minute timeoutIf graceful shutdown has not been completed before 15 minutes have elapsed, the multiplayer server session will be forcefully terminated on it's own.

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

EmptyResponse

ShutdownMultiplayerServerRequest

Executes the shutdown callback from the GSDK and terminates the multiplayer server session. The callback in the GSDK will allow for graceful shutdown with a 15 minute timeoutIf graceful shutdown has not been completed before 15 minutes have elapsed, the multiplayer server session will be forcefully terminated on it's own.

Name Type Description
CustomTags
  • object

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

SessionId
  • string

A guid string session ID of the multiplayer server to shut down.

Error Codes

Name Code
APINotEnabledForGameClientAccess 1082
MultiplayerServerForbidden 1384
MultiplayerServerInternalServerError 1387
MultiplayerServerNoContent 1381
MultiplayerServerNotFound 1385
MultiplayerServerUnauthorized 1383
MultiplayerServerUnavailable 1388