Update Settings
const url = 'https://example.com/settings/';const options = { method: 'PUT', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"settings":{}}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PUT \ --url https://example.com/settings/ \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "settings": {} }'Update one or more settings (admin only). Returns updated settings.
Authorizations
Section titled “Authorizations ”Request Body required
Section titled “Request Body required ”Request for PUT /settings/.
object
Map of setting keys to new values. Maximum 50 settings per request.
object
Example generated
{ "settings": {}}Responses
Section titled “ Responses ”Successful Response
Response for GET /settings/all/.
object
Whether the instance is in env-only mode (settings are read-only and managed via environment variables).
Settings grouped by admin UI tab (general, auth, ai, etc.).
object
A single setting in the unified response.
object
Setting key (e.g. ‘login_rate_limit’, ‘basemaps’).
Human-readable label for display in the admin UI.
Where the value came from: ‘default’ (built-in default), ‘overridden’ (admin set via UI), or ‘env_only’ (configured via environment variable, read-only).
Current value. Type depends on the setting.
Example generated
{ "env_only": true, "tabs": { "additionalProperty": [ { "key": "example", "label": "example", "source": "example", "value": "example" } ] }}Bad request — invalid query parameters or payload
Unauthorized — missing or invalid credentials
Forbidden — caller lacks access to this resource
Not found
Validation error
Too many requests — retry after the advertised interval
Headers
Section titled “Headers ”Seconds until the request may be retried
Internal server error
Service unavailable — the database could not serve the request