Documentation

SetGameServerInstanceState

Set the state of the indicated Game Server Instance.

Request Details

SetGameServerInstanceStateRequest
Request Properties
LobbyId (required) String

Unique identifier of the Game Instance to be updated, in decimal format.

State (required) GameInstanceState

State to set for the specified game server instance.

POST https://{{TitleID}}.playfabapi.com/Server/SetGameServerInstanceState
    Content-Type: application/json
    X-SecretKey: <developer_secret_key>
{
  "LobbyId": "29439584",
  "State": "Closed"
}
        

Response Details

SetGameServerInstanceStateResult
Result Properties

Sample Response

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


Authentication

SecretKey

Possible Error Codes

Name Code
GameNotFound 1024