API Reference

Send a console command

POST
/game-servers/{slice}/command

Sends one line to the server console.

There is no output in the response — this endpoint reports only whether the node accepted the command. Read output from the console in the portal.

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/command" \  -H "Content-Type: application/json" \  -d '{    "command": "string"  }'
{  "ok": true,  "message": "string"}

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.

Read one server with its live state GET

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