Endpoint

/v1/audit/syslog/status

GET

Retrieves the syslog connection status of audit log.

Parameters

This resource has no parameters.

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "syslog_audit_log_status",
  "type": "object",
  "properties": {
    "connection_status": {
      "type": "string",
      "enum": [
        "AUDIT_LOG_CONNECTED",
        "AUDIT_LOG_CONNECTING",
        "AUDIT_LOG_DISABLED",
        "AUDIT_LOG_DISCONNECTED"
      ],
      "description": "The current connection status of the audit logger.:\n * `AUDIT_LOG_CONNECTED` - AUDIT_LOG_CONNECTED,\n * `AUDIT_LOG_CONNECTING` - AUDIT_LOG_CONNECTING,\n * `AUDIT_LOG_DISABLED` - AUDIT_LOG_DISABLED,\n * `AUDIT_LOG_DISCONNECTED` - AUDIT_LOG_DISCONNECTED"
    },
    "error_message": {
      "description": "The current error, if audit is disconnected.",
      "type": "string"
    },
    "error_details": {
      "description": "Internal details for the current error, if audit is disconnected.",
      "type": "string"
    }
  }
}