Node debug info requests

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

Method Path Description
GET /v1/nodes/debuginfo Get debug info from all nodes
GET /v1/nodes/{node_uid}/debuginfo Get debug info from a specific node

Get debug info from all nodes

GET /v1/nodes/debuginfo

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

Required permissions

Permission name
view_debugging_info

Request

Example HTTP request

GET /nodes/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 or download as attachment

Status codes

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

Get node debug info

GET /v1/nodes/{int: node_uid}/debuginfo

Downloads a tar file that contains debug info from a specific node.

Required permissions

Permission name
view_debugging_info

Request

Example HTTP request

GET /nodes/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 or download as attachment

Status codes

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