> ## 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.

# Get destination health

> Most recent connectivity check against the configured destination.

<Info>
  Requires a **ServiceKey**. See [Service Keys](/goldrush-pipeline-api/service-keys).
</Info>

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`](/api-reference/pipeline-api/get-pipeline-logs).


## OpenAPI

````yaml GET /platform/pipeline-api/{pipeline_id}/destination-health/
openapi: 3.1.0
info:
  title: GoldRush Pipeline API
  version: 1.0.0
  description: >-
    REST API for programmatic CRUD over GoldRush pipelines. Authentication uses
    a ServiceKey - regular GoldRush API keys are not accepted on these
    endpoints.
servers:
  - url: https://api.covalenthq.com
security:
  - serviceKeyAuth: []
paths:
  /platform/pipeline-api/{pipeline_id}/destination-health/:
    parameters:
      - name: pipeline_id
        in: path
        required: true
        description: The pipeline identifier, prefixed with `pipe_`.
        schema:
          type: string
    get:
      tags:
        - pipelines
      summary: Get destination health
      description: >-
        Reports the most recent connectivity check against the configured
        destination. Use this to detect destination-side outages without
        inspecting full logs.
      operationId: getPipelineDestinationHealth
      responses:
        '200':
          description: Destination health status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PipelineDestinationHealthEnvelope'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    PipelineDestinationHealthEnvelope:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PipelineDestinationHealth'
        error:
          type: boolean
        error_message:
          type: string
          nullable: true
        error_code:
          type: string
          nullable: true
    PipelineDestinationHealth:
      type: object
      properties:
        healthy:
          type: boolean
        last_checked_at:
          type: string
          format: date-time
        latency_ms:
          type: integer
          nullable: true
        last_error:
          type: string
          nullable: true
    ErrorEnvelope:
      type: object
      properties:
        data:
          type: object
          nullable: true
        error:
          type: boolean
        error_message:
          type: string
        error_code:
          type: string
  responses:
    Unauthorized:
      description: Missing or invalid ServiceKey.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Forbidden:
      description: >-
        The credential supplied is not a ServiceKey, or the ServiceKey does not
        have access to this pipeline.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    NotFound:
      description: Pipeline does not exist or is not visible to this ServiceKey.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  securitySchemes:
    serviceKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: ServiceKey
      description: >-
        Pipeline REST endpoints require a ServiceKey. Regular GoldRush API keys
        are rejected with 403. See [Service
        Keys](/goldrush-pipeline-api/service-keys).

````