Documentation

ShutdownMultiplayerServer

Shuts down a multiplayer server session.

Request Details

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.

ShutdownMultiplayerServerRequest
Request Properties
BuildId (required) String

The guid string build ID of the multiplayer server to delete.

Region (required) AzureRegion

The region of the multiplayer server to shut down.

SessionId (required) String

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

POST https://{{TitleID}}.playfabapi.com/MultiplayerServer/ShutdownMultiplayerServer
    Content-Type: application/json
{
  "BuildId": "21781fa8-096d-4d9c-b699-75433d579285",
  "Region": "SouthCentralUs",
  "SessionId": "02bdef0e-e01e-4b29-8efe-ff9f47a06d8c"
}
        

Response Details

EmptyResponse
Result Properties

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8


Authentication

EntityToken

Possible Error Codes

Name Code
MultiplayerServerForbidden 1384
MultiplayerServerInternalServerError 1387
MultiplayerServerNoContent 1381
MultiplayerServerNotFound 1385
MultiplayerServerTooManyRequests 1380
MultiplayerServerUnauthorized 1383