Skip to main content
POST
/
pipelines
/
create-from-source
Create pipeline from source
curl --request POST \
  --url https://api.artie.com/pipelines/create-from-source \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dataPlaneName": "<string>",
  "destinationType": "<string>",
  "environmentUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sourceConnectorUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sourceType": "<string>"
}
'
import requests

url = "https://api.artie.com/pipelines/create-from-source"

payload = {
    "dataPlaneName": "<string>",
    "destinationType": "<string>",
    "environmentUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "sourceConnectorUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "sourceType": "<string>"
}
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({
    dataPlaneName: '<string>',
    destinationType: '<string>',
    environmentUUID: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    sourceConnectorUUID: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    sourceType: '<string>'
  })
};

fetch('https://api.artie.com/pipelines/create-from-source', 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://api.artie.com/pipelines/create-from-source",
  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([
    'dataPlaneName' => '<string>',
    'destinationType' => '<string>',
    'environmentUUID' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'sourceConnectorUUID' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'sourceType' => '<string>'
  ]),
  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://api.artie.com/pipelines/create-from-source"

	payload := strings.NewReader("{\n  \"dataPlaneName\": \"<string>\",\n  \"destinationType\": \"<string>\",\n  \"environmentUUID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"sourceConnectorUUID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"sourceType\": \"<string>\"\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://api.artie.com/pipelines/create-from-source")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"dataPlaneName\": \"<string>\",\n  \"destinationType\": \"<string>\",\n  \"environmentUUID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"sourceConnectorUUID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"sourceType\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.artie.com/pipelines/create-from-source")

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  \"dataPlaneName\": \"<string>\",\n  \"destinationType\": \"<string>\",\n  \"environmentUUID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"sourceConnectorUUID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"sourceType\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "advancedSettings": {
    "appendOnly": true,
    "autoEnableHistoryForNewTables": true,
    "autoReplicateIgnoreRegex": "<string>",
    "autoReplicateNewTables": true,
    "bigQueryReservation": "<string>",
    "bufferRows": 123,
    "defaultSourceSchema": "<string>",
    "disableAlerts": true,
    "dropDeletedColumns": true,
    "dynamoDBBackfillConfig": {
      "bucket": "<string>",
      "enabled": true,
      "exportArn": "<string>",
      "optionalFolder": "<string>"
    },
    "enableSoftDelete": true,
    "flushIntervalSeconds": 123,
    "flushSizeKb": 123,
    "forceUTCTimezone": true,
    "includeArtieOperationColumn": true,
    "includeArtieUpdatedAtColumn": true,
    "includeDatabaseUpdatedAtColumn": true,
    "includeFullSourceTableNameColumn": true,
    "includeFullSourceTableNameColumnAsPrimaryKey": true,
    "includeSourceMetadataColumn": true,
    "maxConcurrentSnapshots": 1,
    "nullOutInvalidValues": true,
    "reuseStagingTable": true,
    "sessionDriverMemory": "<string>",
    "sessionExecutorMemory": "<string>",
    "snowpipeStreamingMaxChannels": 123,
    "splitEventsByType": true,
    "stagingSchema": "<string>",
    "staticColumns": [
      {
        "column": "<string>",
        "value": "<string>"
      }
    ],
    "tablesPerTransferPod": 1,
    "truncateExceededValues": true,
    "turboLatencyThresholdMinutes": 123,
    "turboRowThreshold": 123,
    "turboWarehouse": "<string>",
    "useBQBatchPriority": true,
    "useBigNumericForVariableNumeric": true,
    "useNewStringMethod": true,
    "useSnowpipeStreaming": true,
    "waitForTopics": true,
    "writeRawBinaryValues": true
  },
  "companyUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "dataPlaneName": "<string>",
  "environmentUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "hasUndeployedChanges": true,
  "isDeploying": true,
  "lastUpdatedAt": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "specificDestCfg": {
    "bucketName": "<string>",
    "checkpointInterval": 123,
    "compaction": {
      "enabled": true,
      "everySeconds": 123,
      "quietWindow": {
        "end": "<string>",
        "start": "<string>"
      }
    },
    "containerName": "<string>",
    "database": "<string>",
    "dynamicallyCreateNamespaces": true,
    "externalStageName": "<string>",
    "externalStageS3Bucket": "<string>",
    "externalStageS3Prefix": "<string>",
    "folderName": "<string>",
    "schema": "<string>",
    "schemaNamePrefix": "<string>",
    "tableNameSeparator": "<string>",
    "useSameSchemaAsSource": true
  },
  "tables": [
    {
      "advancedSettings": {
        "alias": "<string>",
        "backfillFromDatabases": [
          "<string>"
        ],
        "backfillFromSchemas": [
          "<string>"
        ],
        "bigQueryPartitionSettings": {
          "partitionBy": "<string>",
          "partitionField": "<string>",
          "partitionType": "<string>"
        },
        "bufferRows": 123,
        "columnsToCompress": [
          "<string>"
        ],
        "columnsToEncrypt": [
          "<string>"
        ],
        "columnsToHash": [
          "<string>"
        ],
        "ctidSettings": {
          "chunkSize": 1,
          "enabled": true,
          "maxParallelism": 1
        },
        "encryptJSONBColumns": true,
        "endingPrimaryKey": "<string>",
        "excludeColumns": [
          "<string>"
        ],
        "flushIntervalSeconds": 123,
        "flushSizeKb": 123,
        "historyTableBackfillFromSchemas": [
          "<string>"
        ],
        "includeColumns": [
          "<string>"
        ],
        "k8sRequestCPU": 1,
        "k8sRequestMemoryMB": 1,
        "mergePredicates": [
          {
            "partitionBy": "<string>",
            "partitionField": "<string>",
            "partitionType": "<string>"
          }
        ],
        "msmFlushCount": 1,
        "primaryKeysOverride": [
          "<string>"
        ],
        "rangeSettings": {
          "batchSize": 1,
          "chunksSize": 1,
          "enabled": true,
          "maxParallelism": 1
        },
        "shouldBackfillHistoryTable": true,
        "skipBackfill": true,
        "skipDelete": true,
        "skipNoOpUpdates": true,
        "softPartitioning": {
          "enabled": true,
          "maxPartitions": 123,
          "partitionColumn": "<string>",
          "partitionFrequency": "<string>",
          "partitionSchema": "<string>"
        },
        "startingPrimaryKey": "<string>",
        "streamARN": "<string>",
        "unifyAcrossDatabases": true,
        "unifyAcrossSchemas": true
      },
      "backfillStage": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "destinationTableName": "<string>",
      "disableReplication": true,
      "enableHistoryMode": true,
      "historyTableBackfillStage": "<string>",
      "historyTableStatus": "<string>",
      "individualDeployment": true,
      "name": "<string>",
      "schema": "<string>",
      "status": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z",
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "columnHashingSaltUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "destinationUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "encryptionKeyUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "hasBackfillingTables": true,
  "lastDeployedAt": "2023-11-07T05:31:56Z",
  "snowflakeEcoScheduleUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sourceReaderUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
Authorization
string
header
required

API key passed as a Bearer token in the Authorization header.

Body

application/json
​
dataPlaneName
string
​
destinationType
string
​
environmentUUID
null | string<uuid>
​
sourceConnectorUUID
null | string<uuid>
​
sourceType
string

Response

OK

​
advancedSettings
object
required
​
companyUUID
string<uuid>
required
​
createdAt
string<date-time>
required
​
dataPlaneName
string
required
​
environmentUUID
string<uuid>
required
​
hasUndeployedChanges
boolean
required
​
isDeploying
boolean
required
​
lastUpdatedAt
string<date-time>
required
​
name
string
required
​
sourceType
enum<string>
required
Available options:
api,
bigquery,
clickhouse,
cockroach,
databricks,
documentdb,
delta,
dynamodb,
gcs,
iceberg,
keyspaces,
mongodb,
motherduck,
mssql,
mysql,
oracle,
planetscale,
postgresql,
redis,
redshift,
s3,
snowflake
​
specificDestCfg
object
required
​
tables
object[]
required
​
uuid
string<uuid>
required
​
columnHashingSaltUUID
null | string<uuid>
​
destinationUUID
null | string<uuid>
​
encryptionKeyUUID
null | string<uuid>
​
hasBackfillingTables
boolean
​
lastDeployedAt
null | string<date-time>
​
snowflakeEcoScheduleUUID
null | string<uuid>
​
sourceReaderUUID
string<uuid>
​
status
enum<string>
Available options:
draft,
paused,
transfer paused,
running