Settings

Read the startup command and variables

GET
/game-servers/{slice}/startup

The command the server starts with, and every startup variable you can see: its current value, the egg's default, the validation rules a new value must pass, and whether you may change it at all.

A 403 with Startup settings are hidden for this server means the game's provider keeps these to itself; no key can read them.

Authorization

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

application/json

application/json

curl -X GET "https://example.com/game-servers/497f6eca-6276-4993-bfeb-53cbbbba6f08/startup"
{  "data": {    "startup_command": "string",    "variables": [      {        "env_variable": "MAX_PLAYERS",        "name": "string",        "description": "string",        "value": "string",        "default": "string",        "editable": true,        "rules": "string"      }    ]  }}