Skip to content
calternal docs

Update instance configuration from TOML

PUT
/api/v1/admin/config/toml
curl --request PUT \
  --url https://example.com/api/v1/admin/config/toml \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: text/plain' \
  --data example

Updates the instance configuration from TOML. It requires a signed-in User with the admin scope and the admin or owner Role. It can return 400 if the request is invalid, 401 if the session is missing or expired and 403 if access is denied. Route: /api/v1/admin/config/toml. Inputs: . A recent account assertion is required. Do not automatically replay this operation after an uncertain result.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typetext/plain
string

Responses

Section titled “Responses”

204

Section titled “204”

400

Section titled “400”

Invalid TOML, a failed validation, or an unreachable sign-in provider. TOML errors carry line and column details; provider errors carry provider.

Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}