Create a Pipeline

post

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

Creates a Pipeline with the specified Source, Destination, and Pipeline settings.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request body to create a Pipeline.

name

string

required

Unique name for your Pipeline, not exceeding 255 characters.

source

required

Select the Source you want to configure in your Pipeline.

destination_id

int64

required

≥ 1

Unique identifier of the Destination where you want to load data.

destination_prefix

string

required

Prefix used for Destination table names.

replication_type

string

enum

required

Type of data Hevo replicates from your Source objects.

Show Details

HISTORICAL_AND_INCREMENTAL	Hevo first replicates all existing data from the selected Source objects and then captures only data changes.
INCREMENTAL_ONLY	Hevo replicates only new and changed data from your Source object after the Pipeline is created.

Allowed:

failure_handling_policy

object

required

Defines how failures are handled for Source objects.

load_mode

string

enum

required

Mode used to load data from the Source objects into the Destination tables.

Show Details

APPEND	New records are added at the end of your Destination table without modifying or deleting any existing data.
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.

Allowed:

schema_evolution

string

enum

required

Policy for applying Source schema changes with the Destination schema.

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

required

Configuration for when and how often the Pipeline should run jobs to process data.

latency_alert

object

Configuration for triggering alerts when data loading is delayed.

Response

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Pipeline created successfully.