Skip to content
getgeolens.com
GeoLens Docs

Update Settings

PUT
/settings/
 
curl --request PUT \
  --url https://example.com/api/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 ”
Media type application/json
SettingsUpdateRequest

Request for PUT /settings/.

object
settings
required
Settings

Map of setting keys to new values. Maximum 50 settings per request.

object
key
additional properties
any
Example generated
{
  "settings": {}
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
SettingsAllResponse

Response for GET /settings/all/.

object
env_only
required
Env Only

Whether the instance is in env-only mode (settings are read-only and managed via environment variables).

boolean
tabs
required
Tabs

Settings grouped by admin UI tab (general, auth, ai, etc.).

object
key
additional properties
Array<object>
SettingItem

A single setting in the unified response.

object
key
required
Key

Setting key (e.g. ‘login_rate_limit’, ‘basemaps’).

string
value
required
Value

Current value. Type depends on the setting.

source
required
Source

Where the value came from: ‘default’ (built-in default), ‘overridden’ (admin set via UI), or ‘env_only’ (configured via environment variable, read-only).

string
label
required
Label

Human-readable label for display in the admin UI.

string
Example generated
{
  "env_only": true,
  "tabs": {
    "additionalProperty": [
      {
        "key": "example",
        "value": "example",
        "source": "example",
        "label": "example"
      }
    ]
  }
}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}