Update Audit Settings

Update audit configuration for the organization.

Use this to enable or disable read auditing. Requires ADMIN permission.

PATCH /v1/organizations/audit/settings

Update Audit Settings

cURL

curl --request PATCH \
  --url https://api.mixpeek.com/v1/organizations/audit/settings \
  --header 'Content-Type: application/json' \
  --data '
{
  "read_auditing_enabled": true
}
'

200

{
  "read_auditing_enabled": false
}

Headers

Authorization · string

REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.

Examples:

"Bearer YOUR_API_KEY"

"Bearer YOUR_STRIPE_API_KEY"

Body

application/json

Payload for updating audit settings.

read_auditing_enabled · boolean | null

Enable or disable read operation auditing.

Response

200

application/json

Successful Response

Organization audit configuration.

Controls audit logging behavior for the organization. Allows enabling read access auditing for compliance requirements.

read_auditing_enabled · boolean · default: false

When enabled, read operations (GET requests) are logged to the audit trail. This includes resource access like NAMESPACE_ACCESSED, BUCKET_ACCESSED, etc. Disabled by default to reduce audit log volume. Enable for compliance requirements that mandate tracking all resource access.