admin
admin:settings

Update Audit Settings

Update platform audit settings.

patch/admin/settings/audit

Request

  • Base URL
    https://platform.tracecat.com/api
  • Auth
    API key in cookie fastapiusersauth

Request body

audit_webhook_urlstring nullable

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

audit_webhook_custom_headersobject nullable

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

audit_webhook_custom_payloadobject nullable

Custom JSON fields merged into streamed audit event payloads. Canonical audit event fields take precedence; conflicting custom keys are ignored.

audit_webhook_payload_attributestring nullable

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

audit_webhook_verify_sslboolean

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

Response

Successful Response

audit_webhook_urlstring nullable required
audit_webhook_custom_headersobject nullable
audit_webhook_custom_payloadobject nullable
audit_webhook_payload_attributestring nullable
audit_webhook_verify_sslboolean
decryption_failed_keysstring[]

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

Changes

No recorded changes to this operation across all 1 revision of this API.