A newer version of this documentation is available.

View Latest

Auditing API

Couchbase Server APIs for audit management.
GET settings/audit

Returns information about the audit settings.

POST settings/audit

GET /settings/audit


This command retrieves information about the audit settings.


curl -X GET -u Administrator:password

POST /settings/audit


This command configures the audit settings.


curl -X POST -d auditdEnabled=true -u Administrator:password

Enable audit. The value of auditdEnabled can be either true or false.

curl -X POST -d logPath='/opt/couchbase/var/lib/couchbase/logs' \
-u Administrator:password

Set the location for audit logs. The default location on Linux is /opt/couchbase/var/lib/couchbase/logs.

curl -X POST -d rotateInterval=582300  -u Administrator:password

Specify the time to elapse between log-rotations. The value of rotateInterval must be a number of whole minutes, expressed as seconds: therefore, the specified number must be a multiple of 60. The acceptable range is 900 (15 minutes) to 604800 (7 days), inclusive.