Endpoint

/v2/audit/destinations/{id}/status

GET

Retrieves the per-node connection status for the specified audit log destination.

Parameters

Name Description Required
id The audit log destination ID. Yes

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "audit_destination_cluster_status",
  "type": "object",
  "properties": {
    "node_statuses": {
      "type": "array",
      "items": {
        "description": "node_statuses",
        "type": "object",
        "properties": {
          "node_id": {
            "description": "node_id",
            "type": "number"
          },
          "status": {
            "description": "status",
            "type": "object",
            "properties": {
              "connection_status": {
                "type": "string",
                "enum": [
                  "AUDIT_DESTINATION_CONNECTED",
                  "AUDIT_DESTINATION_CONNECTING",
                  "AUDIT_DESTINATION_DISABLED",
                  "AUDIT_DESTINATION_DISCONNECTED"
                ],
                "description": "connection_status:\n * `AUDIT_DESTINATION_CONNECTED` - AUDIT_DESTINATION_CONNECTED,\n * `AUDIT_DESTINATION_CONNECTING` - AUDIT_DESTINATION_CONNECTING,\n * `AUDIT_DESTINATION_DISABLED` - AUDIT_DESTINATION_DISABLED,\n * `AUDIT_DESTINATION_DISCONNECTED` - AUDIT_DESTINATION_DISCONNECTED"
              },
              "error_message": {
                "description": "error_message",
                "type": "string"
              },
              "error_details": {
                "description": "error_details",
                "type": "string"
              },
              "error_timestamp": {
                "description": "error_timestamp",
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}