A newer version of this documentation is available.

View Latest

Logs API

  • reference
February 16, 2025
+ 12
REST API endpoints are provided for retrieving log and diagnostic information, and for adding entries into a log.

Summary

The following methods and URIs are provided:

HTTP method URI Description Role

GET

/diag

Retrieves log and additional server diagnostic information.

Full, Cluster

GET

/sasl_logs

Retrieves information from the debug log file.

Full, Cluster

GET

/sasl_logs/[log-name]

Retrieves information from the specified log file. See Retrieving Log Information, for a list of possible values for log-name.

Full, Cluster

POST

/logClientError

Adds entries to the central log from a Couchbase Server SDK.

Full, Cluster