API Documentation
Connection Health
The Connection Health feature provides a high-level view of connection stability by evaluating the status of the most recent job run. It helps identify unhealthy connections, categorize failure types, and improve error visibility.
We classify connection job failures into three categories based on responsibility for resolution:
- Leen: Issues originating from Leen’s infrastructure or code. We prioritize these failures and work to resolve them as quickly as possible.
- Customer: Failures due to invalid or expired credentials. Customer must update credentials to resolve the failure.
- Vendor: Failures caused by the Vendor’s API, such as network issues or 5xx errors. These failures are often temporary and may resolve automatically in subsequent runs.
How to find Connection Health
You can use List Connections or Get Connection by ID. Here is an example response with connection health value:
Connection Health Statuses
Name | Status | Resolution Owner | Description |
---|---|---|---|
HEALTHY | HEALTHY | LEEN | Connection is healthy |
EXECUTION_TIMEOUT | UNHEALTHY | LEEN | Execution timeout |
RATE_LIMIT_EXCEEDED | UNHEALTHY | LEEN | Rate limit exceeded |
VENDOR_CLIENT_ERROR | UNHEALTHY | LEEN | Vendor returned a 4xx client error |
INTERNAL_ERROR | UNHEALTHY | LEEN | Internal error |
VENDOR_SERVER_ERROR | UNHEALTHY | VENDOR | Vendor returned a 5xx server error |
UNAUTHORIZED | UNHEALTHY | CUSTOMER | Connection is unauthorized |