List All Pipelines

get

https://us.hevodata.com/api/v2/pipelines

Retrieves details of all Pipelines in your workspace, including their Source and Destination details. Results are ordered oldest first. Pipelines that are being deleted, or have been deleted, are never listed. The response lists only the Pipelines in the region of the base URL that you call.

To keep the response small, this endpoint returns a summary of each Pipeline rather than its complete details. The following are not included:

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.

To retrieve the complete details of a single Pipeline, including both of these, use the Get Details of a Pipeline endpoint.

Refer to Listing your Pipelines for more information about how to list and filter your Pipelines.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

cursor

string

Value used to retrieve the next set of results. Provide the next_cursor value returned in the previous API response.

limit

integer

1 to 500

Defaults to 100

Maximum number of results the API should return. If not set, the API returns up to 100 items.

state

array of strings

Returns only the Pipelines in the specified states. To filter by more than one state, repeat the parameter. For example, to list the Pipelines that are disabled along with those that are replicating data, specify ?state=Disabled&state=Initialized. The response then contains only the Pipelines in these two states, and leaves out the Pipelines in every other state. Specify a state that has more than one word with spaces, such as Created Source. The value is not case-sensitive. Deleting and Deleted cannot be used, because deleted Pipelines are never listed.

Show Details

Created	Pipeline has been created, but the full configuration is still in progress.
Created Source	Source has been configured for the Pipeline.
Created Destination	Destination has been configured for the Pipeline.
Configured Pipeline	Pipeline settings have been configured.
Configured Object	Objects have been configured for replication.
Initializing	Pipeline is starting and preparing to replicate data.
Initialized	Pipeline has been fully set up and is replicating data.
Disabling	Pipeline is being disabled.
Disabled	Pipeline has been disabled and is no longer replicating data.
Enabling	Pipeline is being enabled.
Restarting	Pipeline is restarting after a resync.
Failed	Pipeline could not be set up or could not continue replicating data. This value selects every failed state except a failed deletion, because a Pipeline with a failed deletion is never listed.

state

connector_id

string

Returns only the Pipelines with a Source that uses this connector. This value is not case-sensitive.

destination_id

int64

Returns only the Pipelines that load data into this Destination.

Responses

400

The list of Pipelines could not be retrieved. This occurs when:

The state value is not valid.
A state for deleted Pipelines is specified.
The destination_id value is not numeric.
The limit value is not an integer, or is outside the range of 1 to 500.
The cursor value cannot be decoded.

A connector_id or destination_id that matches nothing is not an error. The response is a 200 with an empty data array.

200List of Pipelines retrieved successfully.