Skip to main content
GET
/
platform
/
pipeline-api
/
{pipeline_id}
/
destination-health
Get destination health
curl --request GET \
  --url https://api.covalenthq.com/platform/pipeline-api/{pipeline_id}/destination-health/ \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "healthy": true,
    "last_checked_at": "2023-11-07T05:31:56Z",
    "latency_ms": 123,
    "last_error": "<string>"
  },
  "error": true,
  "error_message": "<string>",
  "error_code": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://goldrush.dev/docs/llms.txt

Use this file to discover all available pages before exploring further.

Requires a ServiceKey. See Service Keys.
Reports the result of the most recent destination connectivity probe. Use this to detect destination-side outages (your Postgres is down, your webhook endpoint is returning 5xx, your S3 bucket policy changed) without inspecting full logs. When healthy is false, last_error contains a short human-readable summary; full details are in logs.

Authorizations

​
Authorization
string
header
required

Pipeline REST endpoints require a ServiceKey. Regular GoldRush API keys are rejected with 403. See Service Keys.

Path Parameters

​
pipeline_id
string
required

The pipeline identifier, prefixed with pipe_.

Response

Destination health status.

​
data
object
​
error
boolean
​
error_message
string | null
​
error_code
string | null