Configuration
System configuration — the key/value store that controls tenant-wide platform settings (mail server, token lifetimes, feature flags, integration secrets, etc.). Config keys are read and modified individually; the catalogue of available keys is returned by the list endpoint.
Scopes
| Scope | Reach |
|---|---|
admin | All configuration endpoints, including the mail-config verifier. |
Endpoints
Get All Config Keys
GET /api/admin/config/
Returns every configuration key the platform recognizes, along with its current value (or whether the value is sensitive/masked).
Required scope: admin · also accepts API key
Response 200 — list of config-key records.
Get Config by Key
GET /api/admin/config/{key}
Returns the value (or masked representation) of a single configuration key.
Required scope: admin · also accepts API key
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
key | string | yes | Configuration key name. |
Response 200 — config-key record.
Replace Config
PUT /api/admin/config/{key}
Replaces the value of a configuration key.
Required scope: admin
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
key | string | yes | Configuration key name. |
Request body — the new value, shape depends on the key being set (see GET /api/admin/config/ for the expected type per key).
Response 200 — the updated config record.
Update Config Partially
PATCH /api/admin/config/{key}
Partial update of a configuration key. Useful for object-typed keys where you only want to change one nested field.
Required scope: admin
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
key | string | yes | Configuration key name. |
Request body — the patch to apply.
Response 200 — the updated config record.
Verify Mail Config
GET /api/admin/config/mail/verify
Sends a test email using the current mail configuration to verify it works end-to-end. An optional token query parameter is accepted for tokenized verification flows.
Required scope: admin
Query parameters
| Name | Type | Description |
|---|---|---|
token | string | null | Optional tokenized verification. |
Response 200 — confirmation payload (or 4xx if the mail config is broken).
See also
- System Defaults — force-recreate default objects (often used after a config-driven schema change).
- System Health — runtime health checks that complement static config inspection.