Create a pipeline
curl --request POST \
--url https://{host}/api/public/v1/pipelines \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"definition_version": 1,
"name": "orders-to-snowflake",
"source": {
"connection": {
"id": 123
}
},
"destination": {
"connection": {
"id": 123
}
},
"sync": {
"frequency": 123,
"source_frequency": 123,
"destination_frequency": 123,
"auto_sync_new_tables": true
},
"tables": [
{
"name": "public.orders",
"append_only": true,
"columns": {
"include": [
"<string>"
],
"exclude": [
"<string>"
]
}
}
],
"transformations": [
{
"table": "<string>",
"config": {}
}
],
"hooks": [
{
"id": 123,
"events": [
"pipeline_failed",
"pipeline_stopped"
]
}
]
}
'import requests
url = "https://{host}/api/public/v1/pipelines"
payload = {
"definition_version": 1,
"name": "orders-to-snowflake",
"source": { "connection": { "id": 123 } },
"destination": { "connection": { "id": 123 } },
"sync": {
"frequency": 123,
"source_frequency": 123,
"destination_frequency": 123,
"auto_sync_new_tables": True
},
"tables": [
{
"name": "public.orders",
"append_only": True,
"columns": {
"include": ["<string>"],
"exclude": ["<string>"]
}
}
],
"transformations": [
{
"table": "<string>",
"config": {}
}
],
"hooks": [
{
"id": 123,
"events": ["pipeline_failed", "pipeline_stopped"]
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
definition_version: 1,
name: 'orders-to-snowflake',
source: {connection: {id: 123}},
destination: {connection: {id: 123}},
sync: {
frequency: 123,
source_frequency: 123,
destination_frequency: 123,
auto_sync_new_tables: true
},
tables: [
{
name: 'public.orders',
append_only: true,
columns: {include: ['<string>'], exclude: ['<string>']}
}
],
transformations: [{table: '<string>', config: {}}],
hooks: [{id: 123, events: ['pipeline_failed', 'pipeline_stopped']}]
})
};
fetch('https://{host}/api/public/v1/pipelines', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{host}/api/public/v1/pipelines",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'definition_version' => 1,
'name' => 'orders-to-snowflake',
'source' => [
'connection' => [
'id' => 123
]
],
'destination' => [
'connection' => [
'id' => 123
]
],
'sync' => [
'frequency' => 123,
'source_frequency' => 123,
'destination_frequency' => 123,
'auto_sync_new_tables' => true
],
'tables' => [
[
'name' => 'public.orders',
'append_only' => true,
'columns' => [
'include' => [
'<string>'
],
'exclude' => [
'<string>'
]
]
]
],
'transformations' => [
[
'table' => '<string>',
'config' => [
]
]
],
'hooks' => [
[
'id' => 123,
'events' => [
'pipeline_failed',
'pipeline_stopped'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{host}/api/public/v1/pipelines"
payload := strings.NewReader("{\n \"definition_version\": 1,\n \"name\": \"orders-to-snowflake\",\n \"source\": {\n \"connection\": {\n \"id\": 123\n }\n },\n \"destination\": {\n \"connection\": {\n \"id\": 123\n }\n },\n \"sync\": {\n \"frequency\": 123,\n \"source_frequency\": 123,\n \"destination_frequency\": 123,\n \"auto_sync_new_tables\": true\n },\n \"tables\": [\n {\n \"name\": \"public.orders\",\n \"append_only\": true,\n \"columns\": {\n \"include\": [\n \"<string>\"\n ],\n \"exclude\": [\n \"<string>\"\n ]\n }\n }\n ],\n \"transformations\": [\n {\n \"table\": \"<string>\",\n \"config\": {}\n }\n ],\n \"hooks\": [\n {\n \"id\": 123,\n \"events\": [\n \"pipeline_failed\",\n \"pipeline_stopped\"\n ]\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{host}/api/public/v1/pipelines")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"definition_version\": 1,\n \"name\": \"orders-to-snowflake\",\n \"source\": {\n \"connection\": {\n \"id\": 123\n }\n },\n \"destination\": {\n \"connection\": {\n \"id\": 123\n }\n },\n \"sync\": {\n \"frequency\": 123,\n \"source_frequency\": 123,\n \"destination_frequency\": 123,\n \"auto_sync_new_tables\": true\n },\n \"tables\": [\n {\n \"name\": \"public.orders\",\n \"append_only\": true,\n \"columns\": {\n \"include\": [\n \"<string>\"\n ],\n \"exclude\": [\n \"<string>\"\n ]\n }\n }\n ],\n \"transformations\": [\n {\n \"table\": \"<string>\",\n \"config\": {}\n }\n ],\n \"hooks\": [\n {\n \"id\": 123,\n \"events\": [\n \"pipeline_failed\",\n \"pipeline_stopped\"\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/api/public/v1/pipelines")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"definition_version\": 1,\n \"name\": \"orders-to-snowflake\",\n \"source\": {\n \"connection\": {\n \"id\": 123\n }\n },\n \"destination\": {\n \"connection\": {\n \"id\": 123\n }\n },\n \"sync\": {\n \"frequency\": 123,\n \"source_frequency\": 123,\n \"destination_frequency\": 123,\n \"auto_sync_new_tables\": true\n },\n \"tables\": [\n {\n \"name\": \"public.orders\",\n \"append_only\": true,\n \"columns\": {\n \"include\": [\n \"<string>\"\n ],\n \"exclude\": [\n \"<string>\"\n ]\n }\n }\n ],\n \"transformations\": [\n {\n \"table\": \"<string>\",\n \"config\": {}\n }\n ],\n \"hooks\": [\n {\n \"id\": 123,\n \"events\": [\n \"pipeline_failed\",\n \"pipeline_stopped\"\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"name": "<string>",
"status": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Pipelines
Create a pipeline
Creates a pipeline from a definition document in the request body. The response is the new pipeline’s metadata, including its id. Fetch the full definition from GET /pipelines/{id}/definition afterwards.
POST
/
pipelines
Create a pipeline
curl --request POST \
--url https://{host}/api/public/v1/pipelines \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"definition_version": 1,
"name": "orders-to-snowflake",
"source": {
"connection": {
"id": 123
}
},
"destination": {
"connection": {
"id": 123
}
},
"sync": {
"frequency": 123,
"source_frequency": 123,
"destination_frequency": 123,
"auto_sync_new_tables": true
},
"tables": [
{
"name": "public.orders",
"append_only": true,
"columns": {
"include": [
"<string>"
],
"exclude": [
"<string>"
]
}
}
],
"transformations": [
{
"table": "<string>",
"config": {}
}
],
"hooks": [
{
"id": 123,
"events": [
"pipeline_failed",
"pipeline_stopped"
]
}
]
}
'import requests
url = "https://{host}/api/public/v1/pipelines"
payload = {
"definition_version": 1,
"name": "orders-to-snowflake",
"source": { "connection": { "id": 123 } },
"destination": { "connection": { "id": 123 } },
"sync": {
"frequency": 123,
"source_frequency": 123,
"destination_frequency": 123,
"auto_sync_new_tables": True
},
"tables": [
{
"name": "public.orders",
"append_only": True,
"columns": {
"include": ["<string>"],
"exclude": ["<string>"]
}
}
],
"transformations": [
{
"table": "<string>",
"config": {}
}
],
"hooks": [
{
"id": 123,
"events": ["pipeline_failed", "pipeline_stopped"]
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
definition_version: 1,
name: 'orders-to-snowflake',
source: {connection: {id: 123}},
destination: {connection: {id: 123}},
sync: {
frequency: 123,
source_frequency: 123,
destination_frequency: 123,
auto_sync_new_tables: true
},
tables: [
{
name: 'public.orders',
append_only: true,
columns: {include: ['<string>'], exclude: ['<string>']}
}
],
transformations: [{table: '<string>', config: {}}],
hooks: [{id: 123, events: ['pipeline_failed', 'pipeline_stopped']}]
})
};
fetch('https://{host}/api/public/v1/pipelines', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{host}/api/public/v1/pipelines",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'definition_version' => 1,
'name' => 'orders-to-snowflake',
'source' => [
'connection' => [
'id' => 123
]
],
'destination' => [
'connection' => [
'id' => 123
]
],
'sync' => [
'frequency' => 123,
'source_frequency' => 123,
'destination_frequency' => 123,
'auto_sync_new_tables' => true
],
'tables' => [
[
'name' => 'public.orders',
'append_only' => true,
'columns' => [
'include' => [
'<string>'
],
'exclude' => [
'<string>'
]
]
]
],
'transformations' => [
[
'table' => '<string>',
'config' => [
]
]
],
'hooks' => [
[
'id' => 123,
'events' => [
'pipeline_failed',
'pipeline_stopped'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{host}/api/public/v1/pipelines"
payload := strings.NewReader("{\n \"definition_version\": 1,\n \"name\": \"orders-to-snowflake\",\n \"source\": {\n \"connection\": {\n \"id\": 123\n }\n },\n \"destination\": {\n \"connection\": {\n \"id\": 123\n }\n },\n \"sync\": {\n \"frequency\": 123,\n \"source_frequency\": 123,\n \"destination_frequency\": 123,\n \"auto_sync_new_tables\": true\n },\n \"tables\": [\n {\n \"name\": \"public.orders\",\n \"append_only\": true,\n \"columns\": {\n \"include\": [\n \"<string>\"\n ],\n \"exclude\": [\n \"<string>\"\n ]\n }\n }\n ],\n \"transformations\": [\n {\n \"table\": \"<string>\",\n \"config\": {}\n }\n ],\n \"hooks\": [\n {\n \"id\": 123,\n \"events\": [\n \"pipeline_failed\",\n \"pipeline_stopped\"\n ]\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{host}/api/public/v1/pipelines")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"definition_version\": 1,\n \"name\": \"orders-to-snowflake\",\n \"source\": {\n \"connection\": {\n \"id\": 123\n }\n },\n \"destination\": {\n \"connection\": {\n \"id\": 123\n }\n },\n \"sync\": {\n \"frequency\": 123,\n \"source_frequency\": 123,\n \"destination_frequency\": 123,\n \"auto_sync_new_tables\": true\n },\n \"tables\": [\n {\n \"name\": \"public.orders\",\n \"append_only\": true,\n \"columns\": {\n \"include\": [\n \"<string>\"\n ],\n \"exclude\": [\n \"<string>\"\n ]\n }\n }\n ],\n \"transformations\": [\n {\n \"table\": \"<string>\",\n \"config\": {}\n }\n ],\n \"hooks\": [\n {\n \"id\": 123,\n \"events\": [\n \"pipeline_failed\",\n \"pipeline_stopped\"\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/api/public/v1/pipelines")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"definition_version\": 1,\n \"name\": \"orders-to-snowflake\",\n \"source\": {\n \"connection\": {\n \"id\": 123\n }\n },\n \"destination\": {\n \"connection\": {\n \"id\": 123\n }\n },\n \"sync\": {\n \"frequency\": 123,\n \"source_frequency\": 123,\n \"destination_frequency\": 123,\n \"auto_sync_new_tables\": true\n },\n \"tables\": [\n {\n \"name\": \"public.orders\",\n \"append_only\": true,\n \"columns\": {\n \"include\": [\n \"<string>\"\n ],\n \"exclude\": [\n \"<string>\"\n ]\n }\n }\n ],\n \"transformations\": [\n {\n \"table\": \"<string>\",\n \"config\": {}\n }\n ],\n \"hooks\": [\n {\n \"id\": 123,\n \"events\": [\n \"pipeline_failed\",\n \"pipeline_stopped\"\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"name": "<string>",
"status": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Authorizations
Bearer API key, prefixed with fdk_.
Body
application/jsonapplication/yaml
A stable, customer-facing projection of the pipeline. It omits credentials, state backend configuration, region orchestration, and other internal fields. Unknown keys are rejected.
Contract version. Currently 1.
Example:
1
Example:
"orders-to-snowflake"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Provide either frequency (which sets both source and destination) or both source_frequency and destination_frequency. Values are in minutes.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Field-level transforms applied to records.
Show child attributes
Show child attributes
Existing notification hooks to attach to pipeline events.
Show child attributes
Show child attributes
Last modified on July 14, 2026
Was this page helpful?
⌘I