List All Pipeline Objects

get

https://us.hevodata.com/api/v2/pipelines/{pipeline_id}/objects

Retrieves a list of objects for the specified pipeline_id. The response includes each object's name, its location in the Source, the Destination table it loads into, and its current status. The response returns an empty list until Hevo reads the objects from your Source.

Refer to Managing Objects in Pipelines for more information about object statuses and how to choose the objects that Hevo replicates.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

pipeline_id

int64

required

≥ 1

Unique identifier of the Pipeline.

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.

status

array of strings

Returns only the objects in the specified statuses. To filter by more than one status, repeat the parameter. For example, to list the objects that are active along with those that are blocked, specify ?status=ACTIVE&status=BLOCKED. This value is not case-sensitive. If you do not send this parameter, Hevo returns the objects in every status except DELETED. Deleted objects are returned only when you specify DELETED. A comma-separated list is read as one unknown value and returns a 400.

Most Pipelines report only ACTIVE, INACTIVE, DELETED, INACCESSIBLE and INCONSISTENT. For such a Pipeline, filtering on BLOCKED, DISABLED or RESETTING always returns an empty list.

Show Details

ACTIVE	Object is being replicated.
BLOCKED	The object is not replicated because the schema evolution setting of the Pipeline blocks it.
DELETED	Object has been deleted from the Pipeline.
DISABLED	Object has been disabled and is not being replicated.
INACCESSIBLE	Object cannot be accessed at the Source.
INACTIVE	Object is not selected for replication.
INCONSISTENT	A schema change left the object inconsistent with its Destination table, and the object is not being replicated. To replicate the object again, resync it.
RESETTING	Object is being reset. Hevo replicates its data again from the beginning once the reset finishes.

status

Responses

400

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

The status value is not valid.
The limit value is not an integer, or is outside the range of 1 to 500.
The cursor value cannot be decoded. A cursor that decodes but was never issued is not rejected, and returns the objects after it.

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.

200List of Pipeline objects retrieved successfully.