Retrieving Diagnostics

Learn how to retrieve diagnostics.

Nuix RESTful Service provides the ability to retrieve diagnostics at any time to troubleshoot issues that may be impacting the health of the service. When requested, a ZIP archive is generated that contains the following diagnostics:

  • Logs
  • Product versions
  • Configured environment variables
  • System properties
  • Licence properties
  • Storage details
  • Process information
  • JVM arguments and settings
  • Installed and missing dependencies

To perform this action, submit a POST request to the /system/diagnostics endpoint to retrieve the data asynchronously. The diagnostics endpoint can also be called using the GET method to retrieve results synchronously.

curl -L -X POST '' \
-H 'nuix-auth-token: cf472e00-89c2-4006-ba59-4949b5dafce8'
    "functionKey": "a80b5f19-c4f0-4a32-8ef4-e43ff6bea980",
    "location": ""

As an asynchronous request, a functionKey is returned with the request so its progress can be tracked.

Using the functionKey, call the /asyncFunctions/{key} endpoint, identified by the returned location value, to retrieve information about the function, including:

  • The status of the function.
  • The location of the generated diagnostics, when complete.
  • User and server information.

When diagnostics are retrieved from a cluster, a single ZIP archive is generated. Within the archive, diagnostics for each node are provided within subfolders labeled using the node’s IP address.

curl --location --request GET 'http://localhost:8080/nuix-restful-service/svc/v1/asyncFunctions/a80b5f19-c4f0-4a32-8ef4-e43ff6bea980' \
--header 'nuix-auth-token: cf472e00-89c2-4006-ba59-4949b5dafce8'
    "done": true,
    "cancelled": false,
    "result": {
        "key": "e9924103-d9e2-4901-b82f-60b60d47bd33",
        "location": "",
        "members": [
                "member": "[]:5601",
                "exception": null,
                "additionalInfo": ""
    "token": "cf472e00-89c2-4006-ba59-4949b5dafce8",
    "functionKey": "a80b5f19-c4f0-4a32-8ef4-e43ff6bea980",
    "progress": 1,
    "total": 1,
    "percentComplete": 100.0000,
    "updatedOn": 1611610309395,
    "status": null,
    "statusId": null,
    "requestTime": 1611610305962,
    "startTime": 1611610305962,
    "finishTime": 1611610309396,
    "caseId": null,
    "caseName": null,
    "hasSuccessfullyCompleted": true,
    "friendlyName": "Distributed System Diagnostic Function",
    "caseLocation": null,
    "requestor": "nuixuser",
    "action": "MultiNodeAsyncSystemDiagnosticsFunction",
    "options": null,
    "participatingInCaseFunctionQueue": false,
    "processedBy": "637edbff-3e1c-4f63-921e-da022a763fbf",
    "errorMsg": null
Last modified April 22, 2021