Skip to main content
PATCH
/
admin
/
settings
/
audit
Error
A valid request URL is required to generate request examples
{
  "audit_webhook_url": "<string>",
  "audit_webhook_custom_headers": {},
  "audit_webhook_custom_payload": {},
  "audit_webhook_payload_attribute": "<string>",
  "audit_webhook_verify_ssl": true,
  "decryption_failed_keys": [
    "<string>"
  ]
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

​
fastapiusersauth
string
cookie
required

Body

application/json

Update platform audit settings.

​
audit_webhook_url
string | null

Webhook URL that receives streamed audit events. When unset, audit events are skipped.

​
audit_webhook_custom_headers
Audit Webhook Custom Headers · object | null

Custom headers to include in audit webhook requests. Header names are case-insensitive.

​
audit_webhook_custom_payload
Audit Webhook Custom Payload · object | null

Custom JSON payload merged into streamed audit event payloads. Custom keys override default audit event keys.

​
audit_webhook_payload_attribute
string | null

Optional wrapper key for audit payloads. When set to a value like 'event', payload is sent as {'event': <audit_payload>}.

​
audit_webhook_verify_ssl
boolean
default:true

Whether TLS certificates are verified for webhook requests. Disable only for trusted on-prem/self-signed endpoints.

Response

Successful Response

Platform audit settings response.

​
audit_webhook_url
string | null
required
​
audit_webhook_custom_headers
Audit Webhook Custom Headers · object | null
​
audit_webhook_custom_payload
Audit Webhook Custom Payload · object | null
​
audit_webhook_payload_attribute
string | null
​
audit_webhook_verify_ssl
boolean
default:true
​
decryption_failed_keys
string[]

Encrypted setting keys that could not be decrypted with the current encryption key and must be reconfigured.