Change game settings
The same body the portal's editor saves. Every file named is read,
patched and validated before any is written, so one refused setting
— out of range, not a choice, locked, or a port that is not one of the
server's allocations — writes nothing, and rejected names it.
Values are the display values GET returns (true/false for a
boolean, a number for a number), not the file's raw tokens.
Most games read their settings at start: restart the server for a change to take effect.
Authorization
orgApiKey game-servers.settings.manageAn 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.manage
Path Parameters
The server's UUID, as returned by the list endpoint.
uuidRequest 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
application/json
application/json
curl -X PUT "https://example.com/game-servers/497f6eca-6276-4993-bfeb-53cbbbba6f08/settings" \ -H "Content-Type: application/json" \ -d '{ "changes": [ { "file": "string", "key": "string", "value": null } ] }'{ "data": { "updated": [ { "file": "string", "keys": [ "string" ] } ] }, "message": "string"}