Patch Observability

Upsert the singleton observability row.

First write requires observability. Updates apply only the fields explicitly present in the body. The reload pipeline reassembles + validates the engine config; failures roll back with a 422.

PATCH /admin/api/v1/observability

Patch Observability

cURL

curl --request PATCH \
  --url https://api.example.com/admin/api/v1/observability \
  --header 'Content-Type: application/json' \
  --data '
{
  "observability": {
    "config": {
      "provider": "LANGFUSE",
      "host": "https://cloud.langfuse.com",
      "publicKey": "",
      "secretKey": "",
      "runName": ""
    },
    "provider": "LANGFUSE",
    "enabled": true
  }
}
'

200

{
  "data": {
    "observability": {
      "config": {
        "provider": "LANGFUSE",
        "host": "https://cloud.langfuse.com",
        "publicKey": "",
        "secretKey": "",
        "runName": ""
      },
      "provider": "LANGFUSE",
      "enabled": true
    },
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "reload": {
    "message": "<string>",
    "error": "<string>"
  }
}

Body

application/json

Body for PATCH /admin/api/v1/observability. All fields optional.

observability · ObservabilityConfig · object

Observability configuration.

Show child attributes

Response

200

application/json

Successful Response

data · StandaloneObservabilityRead · object · required

GET response and the data payload of PATCH responses.

Show child attributes

reload · StandaloneReloadResult · object · required

Reload outcome attached to every admin mutation response.

reloaded means DB committed and runtime now uses the new config. restart_required means DB committed and process restart is needed. reload_failed means DB rolled back and runtime is unchanged.

Show child attributes