Change a runtime setting

PUT /ops/settings/{key}

Applies to every instance within moments. Send the version you read; a newer version returns setting_version_conflict.

Authorization

bearer

Authorizationheader · stringrequired

Session token from POST /v1/auth/login with "transport": "bearer". Browsers use the session cookie that login sets instead.

Path

keystringrequired

maxLength: 200

Body

application/json

valueanyrequired

New value, as JSON of the setting's kind

versionintegerrequired

Version last read

format: int64minimum: 0

reasonstring

Why; required when reason_required

maxLength: 500

Responses

errors: application/problem+json

200

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict

422

Unprocessable Entity

500

Internal Server Error

Match errors on the problem's code, which stays the same, not on its message.

Send a request

Server

Bearer token

key path

Body

The request goes from your browser straight to this server; nothing passes through this site. The API must allow this site's origin for CORS.

Requestexample

curl -X PUT "$API_URL/ops/settings/$KEY" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "value": null,
  "version": 0,
  "reason": "string"
}'

body := strings.NewReader(`{
  "value": null,
  "version": 0,
  "reason": "string"
}`)
req, err := http.NewRequestWithContext(ctx, http.MethodPut,
	apiURL + "/ops/settings/" + key, body)
if err != nil {
	return err
}
req.Header.Set("Authorization", "Bearer "+token)
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
	return err
}
defer res.Body.Close()

const res = await fetch(`${apiUrl}/ops/settings/${key}`, {
  method: "PUT",
  headers: {
    Authorization: `Bearer ${token}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "value": null,
    "version": 0,
    "reason": "string"
  }),
});
const data = await res.json();

Responseexample

{
  "default": null,
  "description": "string",
  "group": "example",
  "invalid_stored_value": false,
  "key": "example.ping_message",
  "kind": "string",
  "modified": false,
  "reason_required": false,
  "restart_pending": false,
  "restart_required": false,
  "value": null,
  "version": 0,
  "constraints": {},
  "updated_at": "2026-09-15T12:00:00Z",
  "updated_by": "string"
}

{
  "code": "string",
  "status": 401,
  "title": "Unauthorized",
  "detail": "string",
  "request_id": "req_9f86d081884c7d65",
  "type": "string"
}

{
  "code": "string",
  "status": 403,
  "title": "Forbidden",
  "detail": "string",
  "request_id": "req_9f86d081884c7d65",
  "type": "string"
}

{
  "code": "string",
  "status": 404,
  "title": "Not Found",
  "detail": "string",
  "request_id": "req_9f86d081884c7d65",
  "type": "string"
}

{
  "code": "string",
  "status": 409,
  "title": "Conflict",
  "detail": "string",
  "request_id": "req_9f86d081884c7d65",
  "type": "string"
}

{
  "code": "string",
  "status": 422,
  "title": "Unprocessable Entity",
  "detail": "string",
  "errors": [
    {
      "message": "expected length >= 1",
      "location": "body.name"
    }
  ],
  "request_id": "req_9f86d081884c7d65",
  "type": "string"
}