Trigger Resync for a Set of Objects

Re-ingests all the data for the objects that you name in the specified pipeline_id. The schedule, the state of the Pipeline, and every object that you do not name are left unchanged.

List the fully qualified names of the objects that you want to resync in object_names, up to 50 in a single request. A fully qualified name is the database, the schema and the table of the object joined by dots, leaving out any level that your Source does not have. For example, public.orders or shop.public.orders. Retrieve the names from the List All Pipeline Objects endpoint. To resync every active object instead, use the Resync a Pipeline endpoint.

Use the drop_and_load parameter to specify whether Hevo drops and recreates the Destination table of each object before it loads the data again.

Refer to Resyncing Objects for more information about the actions performed on your objects when you resync them.

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.

Body Params
object_names
array of strings
required
length between 1 and 50

Fully qualified names of the objects that you want to resync, up to 50 in a single request, as returned in fully_qualified_name by the List All Pipeline Objects endpoint. A name that you repeat is resynced once. Hevo removes leading and trailing spaces from each name.

object_names*
boolean
Defaults to false

If set to true, Hevo drops and recreates the Destination table of each object that you name, and then re-ingests its data. If set to false, Hevo keeps the existing tables and updates them to match the Source. With the APPEND load mode, loading the data again can create duplicate records in the Destination tables. This value is optional, and leaving it out is the same as setting it to false.

Responses

400

The resync could not be initiated. This occurs when:

  • The Pipeline is in the Disabling or Disabled state, or it failed during setup, enable or disable. A Pipeline in any other state, including one that is initializing or being enabled, is not rejected.
  • The object_names list is missing or empty, names more than 50 objects, or contains a blank name.
  • A named object is not selected for replication. Select it with the Manage Objects in a Pipeline (PATCH) endpoint, which loads its data for you.
  • A named object has a parent object. Hevo resyncs such an object along with its parent, so name the parent object instead. This rejection applies to an object for which the List All Pipeline Objects endpoint does not return the selectable field.
  • A named object does not allow a resync in its current state. Hevo checks the object’s resync_allowed value.
  • A named object is in a status that does not allow a resync. Only an object in the ACTIVE, INCONSISTENT or RESETTING status can be resynced.
403

You do not have the permission to modify a Pipeline. Ask your team administrator for a role that allows it.

404

The Pipeline or an object 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.
  • A name in object_names is not an object of the Pipeline.
409

The resync could not be initiated. This occurs when a resync is already running for one or more of these objects. Wait for it to finish. Use the List All Jobs for a Pipeline endpoint to see the job that is running.

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