Settings API

Read and update system-wide configuration. The GET endpoint is public. The PUT endpoint requires manage:settings permission.

Get System Settings

Get system settings

GET

/v1/settings/system

Returns non-sensitive system settings such as language, timezone, and feature flags. This endpoint is public — no authentication required. Sensitive settings are never exposed.

Authorizations

bearerAuth

JWT obtained from POST /v1/auth/login. Pass as Authorization: Bearer <token>.

Type

HTTP (bearer)

or

apiKeyAuth

API key generated via POST /v1/api-keys. Pass as X-API-KEY: <key>.

Type

API Key (header: X-API-KEY)

Responses

Current system settings.

Content-Type

application/json

{

  

"language": "en",

  

"theme": "system",

  

"supportEmail": "[email protected]"

}

GET

/v1/settings/system

Playground

Authorization

bearerAuth

Samples

Powered by VitePress OpenAPI

Update System Settings

Update system settings

PUT

/v1/settings/system

Updates system settings. Requires manage:settings permission.

Authorizations

bearerAuth

JWT obtained from POST /v1/auth/login. Pass as Authorization: Bearer <token>.

Type

HTTP (bearer)

or

apiKeyAuth

API key generated via POST /v1/api-keys. Pass as X-API-KEY: <key>.

Type

API Key (header: X-API-KEY)

Request Body

application/json

{

  

"language": "en",

  

"theme": "system",

  

"supportEmail": "[email protected]"

}

Responses

Updated system settings.

Content-Type

application/json

{

  

"language": "en",

  

"theme": "system",

  

"supportEmail": "[email protected]"

}

PUT

/v1/settings/system

Playground

Authorization

bearerAuth

Body

Samples

Powered by VitePress OpenAPI