Endpoint

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

GET

Retrieves connection status for a specific audit log destination.

Parameters

Name Description Required
id ID of the audit destination Yes

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "audit_destination_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"
    }
  }
}