Start, stop, restart or kill a server

POST
/game-servers/{slice}/power

kill terminates the process immediately and does not let the server save. Prefer stop unless the server is unresponsive.

The call reports whether the node accepted the signal, not whether the server finished changing state. Poll the detail endpoint for that.

Authorization

orgApiKey game-servers.manage
AuthorizationBearer <token>

An organisation API key, prefixed tbk_. Create one under Organisation to API keys; the plaintext is shown once.

The scopes listed on each operation are the abilities the key must carry. They are not OAuth scopes and are not negotiated per request.

In: header

Scope: game-servers.manage

Path Parameters

slice*string

The server's UUID, as returned by the list endpoint.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/game-servers/497f6eca-6276-4993-bfeb-53cbbbba6f08/power" \  -H "Content-Type: application/json" \  -d '{    "signal": "start"  }'
{  "ok": true,  "message": "string"}