Database debug info requests

Documents the Redis Enterprise Software REST API /bdbs/debuginfo requests.

Method Path Description
GET /v1/bdbs/debuginfo Get debug info from all databases
GET /v1/bdbs/{bdb_uid}/debuginfo Get debug info from a specific database

Get debug info from all databases

GET /v1/bdbs/debuginfo

Downloads a tar file that contains debug info from all databases.

Required permissions

Permission name
view_debugging_info

Request

Example HTTP request

GET /bdbs/debuginfo

Response

Downloads the debug info in a tar file called filename.tar.gz. Extract the files from the tar file to access the debug info.

Response headers

Key Value Description
Content-Type application/x-gzip Media type of request/response body
Content-Length 653350 Length of the response body in octets
Content-Disposition attachment; filename=debuginfo.tar.gz Display response in browser

Status codes

Code Description
200 OK Success.
500 Internal Server Error Failed to get debug info.

Get database debug info

GET /v1/bdbs/{int: bdb_uid}/debuginfo

Downloads a tar file that contains debug info from the database specified by bdb_uid.

Required permissions

Permission name
view_debugging_info

Request

Example HTTP request

GET /bdbs/1/debuginfo

Response

Downloads the debug info in a tar file called filename.tar.gz. Extract the files from the tar file to access the debug info.

Response headers

Key Value Description
Content-Type application/x-gzip Media type of request/response body
Content-Length 653350 Length of the response body in octets
Content-Disposition attachment; filename=debuginfo.tar.gz Display response in browser

Status codes

Code Description
200 OK Success.
500 Internal Server Error Failed to get debug info.
RATE THIS PAGE
Back to top ↑