Modify Pipeline Configuration (POST)

post

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

Modifies the Pipeline settings for the specified pipeline_id.

In the request body, send only the values that you want to change. Hevo keeps the current value of every field that you do not send. You must send at least one field. You cannot change the destination_prefix and failure_handling_policy.object_failure_threshold values, because Hevo sets them when the Pipeline is created, and sending a different value returns a 400. A schedule change takes effect from the next run.

Note: Use this endpoint if you cannot send a PATCH request. Otherwise, use the Modify Pipeline Configuration (PATCH) endpoint, which performs the same update.

Refer to Modifying the Pipeline Configuration for more information about which settings you can change and how the change is applied.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

pipeline_id

int64

required

≥ 1

Unique identifier of the Pipeline.

Body Params

name

string

Unique name for your Pipeline, not exceeding 255 characters. The name must start with a letter or a digit, and can contain only letters, digits, spaces, hyphens (-) and underscores (_).

A blank name counts as not sent.

load_mode

string

enum

Mode in which you want to load data from the Source objects into the Destination tables.

This field accepts only APPEND and MERGE, and only the ones that both your Source connector and your Destination support. Any other value returns a 400.

HISTORY_TRACKING is an object-level load mode. Set it on an object through the Manage Objects in a Pipeline endpoint. Read History Mode for more information.

Show Details

MERGE	Existing records are updated based on matching criteria, such as primary keys, and new records are added to your Destination table if no match is found.
APPEND	New records are added at the end of your Destination table without modifying or deleting any existing data.

Allowed:

schema_evolution

string

enum

Policy that you want Hevo to apply when the schema of your Source changes.

Show Details

ALLOW_ALL	Hevo replicates all Source schema changes, such as new or updated columns and tables, to the Destination.
BLOCK_ALL	Hevo does not replicate any Source schema changes to the Destination.
ALLOW_COLUMN_LEVEL	Hevo replicates only new columns from the Source to the Destination. New schemas and tables are not synced.

Allowed:

schedule

object

Interval at which you want the Pipeline to run jobs to process data. Send the complete object when you change it.

latency_alert

object

Configuration for the alerts that you want Hevo to send when data loading is delayed. Send the complete object when you change it.

failure_handling_policy

object

Specifies how you want Hevo to handle failures for Source objects. You can send object_failure_level on its own.

destination_prefix

string

Prefix that you want Hevo to add to the Destination table names. This value is set when the Pipeline is created. You can send it with its current value, but a different value returns a 400.

Responses

400

The Pipeline settings could not be modified. This occurs when:

The request body is empty.
A value is not allowed.
A fixed field is sent with a different value.
The Pipeline is in a state that does not allow an edit. You can edit a Pipeline only from the Initialized or Disabled state.

403

You do not have the permission to modify a Pipeline. Ask your team administrator for a role that allows 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.

409

The Pipeline settings could not be modified. This occurs when:

The Pipeline is changing state, for example, when it is in the Enabling or Initializing state.
Another edit is in progress, in the Hevo UI or through the API.

Retry the request once the Pipeline reaches a stable state, such as Initialized or Disabled.