Servers

Read one server with its live state

GET
/game-servers/{slice}

Adds state and resources, fetched live from the node. Both are null when the server is not yet provisioned or the node did not answer.

Authorization

orgApiKey game-servers.read
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.read

Path Parameters

slice*string

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

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/game-servers/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "data": {    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",    "identifier": "string",    "name": "string",    "service_id": 0,    "provisioned": true,    "limits": {      "memory": 0,      "cpu": 0,      "disk": 0    },    "state": "running",    "resources": {}  }}

List your game servers GET

Every game server your organisation owns that the key's creator is permitted to see. Servers are filtered individually…

Start, stop, restart or kill a server POST

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