POST socket-server/{serverId}/game/{gameId}/state

Perform a state update for a game session on a socket server.

Example

POST /api/v1/socket-server/20/game/21b2330e-1f67-4e0f-9362-a447d5d2876c/state HTTP/1.1
Authorization: Signature ...
Content-Type: application/json

{
  "open": false
}
----------------------------------------
HTTP/1.1 204 No Content

Security

Authentication is required and restricted to system processes. Requests should be signed using a System key.

URL Parameters

NameDescriptionValue
serverIdthe ID of the server, 0 to 255number
gameIdthe ID of the game, as a UUID with dashesstring

Request Body

NameDescriptionValue
opentrue if the game should be open to new players joining, false if notboolean

Response

Successful responses are code 204. Error responses are standard.

Response Body

NONE