Integration Diagnostics
The Integrations Diagnostics API allows handling error messages received from BigPanda's integrations.Use the Integrations Diagnostics API to retrieve and handle received error messages.
Integration Diagnostics
Authentication
All BigPanda APIs require Bearer Token Authorization in the call headers.
This API uses the User API Key type of Authorization token.
BigPanda recommends adding Authentication headers only in the secure tool you use to make API calls.
curl --request GET \
--url https://api.bigpanda.io/resources/v2.0/troubleshooting/logs \
--header 'Authorization: Bearer <User API Key>' \
--header 'Content-type: application/json' \ curl --request GET \
--url https://eu-api.bigpanda.io/resources/v2.0/troubleshooting/logs \
--header 'Authorization: Bearer <User API Key>' \
--header 'Content-type: application/json' \{
log_id: "log_idABC",
log_type: "invalid_payload",
level: "error",
message: "alert 1: 'status' must exist and be one of the following: ok, critical, warning, unknown, acknowledged",
component_name: "inbound",
resource_id: "api.default",
payload: {
host: "production-database-1",
check: "CPU overloaded",
status: "criticald"
},
timestamp: "1610622725329"
},
],
total: 1
}Diagnostic Logs Object
The Troubleshooting object schema includes the following attributes:
Attribute | Description | Type |
|---|---|---|
log_id | System-generated unique identifier for the log record. | String |
log_type | Type of logged event. | String |
message | Brief message describing the event. | String |
level | Level of logged event. One of: error, warning, or info. | String |
timestamp | Unix epoch time when the event occurred (in seconds). | Timestamp |
component_name | Name of the component reporting the event. In the current state, "inbound" value is the only component that is supported. | String |
resource_id | System-generated unique identifier for the resource. | String |
payload | The received event object. | Object |