Get Details of a Pipeline

Retrieves complete configuration details of the Pipeline for the specified pipeline_id, including its Source, Destination, and Pipeline settings. The response also includes the following:

  • source_schema_status, which shows when Hevo last read the structure of the objects and fields in your Source.
  • runs, which shows when the Pipeline last ran, when it is scheduled to run next, and whether a run is currently in progress.

Hevo leaves out source_schema_status, runs and health when they are temporarily unavailable, and leaves out health when it has no label for the Pipeline’s health.

Actions such as enabling, disabling or resyncing a Pipeline do not complete immediately. After you trigger an action, call this endpoint until the state value reaches a final state, such as Initialized, Disabled or Failed. A manual sync does not change the state, so read its progress from runs.active or from the List All Jobs for a Pipeline endpoint.

Refer to Reading One Pipeline for more information about how to retrieve a Pipeline and check its state after an action.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required
≥ 1

Unique identifier of the Pipeline.

Responses

404

The Pipeline could not be found. This occurs when:

  • No Pipeline exists with the specified pipeline_id, or you do not have access to it.
  • The Pipeline is deleted, or its deletion is in progress.
  • The Pipeline is in a different region from the base URL that you call.
Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json