Settings
Read the game settings
The game's settings editor — the same fields as the Config tab in the portal — with each field's type, bounds and current value, file by file.
- A
lockedfield is managed by the panel (a port, a name the startup variables own). Itsliveblock says what it is really set to, which can differ from the file's copy until the next restart;known: falsemeans that cannot be derived. - A
maskedfield is a password. Itsvalueis alwaysnullhere: it can be set, not read. othernames keys the file holds that the editor does not describe, without their values: an undescribed key is where a secret the editor never surfaces tends to live. Read the file itself, withgame-servers.files.read, to see them.hashesis a SHA-256 per file. Send it back on thePUTto refuse the save if someone changed the file in between.
A game with no settings editor answers 422 with a reason.
Authorization
orgApiKey game-servers.settings.readAuthorizationBearer <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.
Format
uuidResponse 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/settings"{ "data": { "game": "string", "files": [ { "name": "string", "path": "string", "groups": [ "string" ], "presets": [ { "id": "string", "label": "string" } ], "fields": [ { "key": "string", "label": "string", "group": "string", "type": "string", "help": "string", "min": 0, "max": 0, "choices": [], "choice_labels": {}, "boolean_tokens": {}, "locked": true, "masked": true, "allocatable": true, "value": null, "live": { "known": true, "value": null, "source": "string" } } ], "other": [ { "key": "string", "locked": true } ] } ], "files_missing": [ "string" ], "defaults_shown": [ "string" ], "hashes": { "property1": "string", "property2": "string" } }}