Skip to main content
POST
/
pipelines
/
{uuid}
Update pipeline
curl --request POST \
  --url https://api.artie.com/pipelines/{uuid} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pipeline": {
    "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,
      "splitEventsByType": true,
      "stagingSchema": "<string>",
      "staticColumns": [
        {
          "column": "<string>",
          "value": "<string>"
        }
      ],
      "truncateExceededValues": true,
      "turboLatencyThresholdMinutes": 123,
      "turboRowThreshold": 123,
      "turboWarehouse": "<string>",
      "useBQBatchPriority": true,
      "useBigNumericForVariableNumeric": true,
      "useNewStringMethod": true,
      "writeRawBinaryValues": true
    },
    "columnHashingSaltUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "dataPlaneName": "<string>",
    "destinationUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "encryptionKeyUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "snowflakeEcoScheduleUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "sourceReaderUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "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>",
          "bufferRows": 123,
          "columnsToCompress": [
            "<string>"
          ],
          "columnsToEncrypt": [
            "<string>"
          ],
          "columnsToHash": [
            "<string>"
          ],
          "ctidSettings": {
            "chunkSize": 1,
            "enabled": true,
            "maxParallelism": 1
          },
          "encryptJSONBColumns": true,
          "excludeColumns": [
            "<string>"
          ],
          "flushIntervalSeconds": 123,
          "flushSizeKb": 123,
          "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>"
          },
          "streamARN": "<string>",
          "unifyAcrossDatabases": true,
          "unifyAcrossSchemas": true
        },
        "disableReplication": true,
        "enableHistoryMode": true,
        "individualDeployment": true,
        "name": "<string>",
        "schema": "<string>",
        "status": "<string>",
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ]
  }
}
'
import requests

url = "https://api.artie.com/pipelines/{uuid}"

payload = { "pipeline": {
"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,
"splitEventsByType": True,
"stagingSchema": "<string>",
"staticColumns": [
{
"column": "<string>",
"value": "<string>"
}
],
"truncateExceededValues": True,
"turboLatencyThresholdMinutes": 123,
"turboRowThreshold": 123,
"turboWarehouse": "<string>",
"useBQBatchPriority": True,
"useBigNumericForVariableNumeric": True,
"useNewStringMethod": True,
"writeRawBinaryValues": True
},
"columnHashingSaltUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dataPlaneName": "<string>",
"destinationUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"encryptionKeyUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"snowflakeEcoScheduleUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sourceReaderUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"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>",
"bufferRows": 123,
"columnsToCompress": ["<string>"],
"columnsToEncrypt": ["<string>"],
"columnsToHash": ["<string>"],
"ctidSettings": {
"chunkSize": 1,
"enabled": True,
"maxParallelism": 1
},
"encryptJSONBColumns": True,
"excludeColumns": ["<string>"],
"flushIntervalSeconds": 123,
"flushSizeKb": 123,
"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>"
},
"streamARN": "<string>",
"unifyAcrossDatabases": True,
"unifyAcrossSchemas": True
},
"disableReplication": True,
"enableHistoryMode": True,
"individualDeployment": True,
"name": "<string>",
"schema": "<string>",
"status": "<string>",
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
} }
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({
pipeline: {
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,
splitEventsByType: true,
stagingSchema: '<string>',
staticColumns: [{column: '<string>', value: '<string>'}],
truncateExceededValues: true,
turboLatencyThresholdMinutes: 123,
turboRowThreshold: 123,
turboWarehouse: '<string>',
useBQBatchPriority: true,
useBigNumericForVariableNumeric: true,
useNewStringMethod: true,
writeRawBinaryValues: true
},
columnHashingSaltUUID: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
dataPlaneName: '<string>',
destinationUUID: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
encryptionKeyUUID: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
name: '<string>',
snowflakeEcoScheduleUUID: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
sourceReaderUUID: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
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>',
bufferRows: 123,
columnsToCompress: ['<string>'],
columnsToEncrypt: ['<string>'],
columnsToHash: ['<string>'],
ctidSettings: {chunkSize: 1, enabled: true, maxParallelism: 1},
encryptJSONBColumns: true,
excludeColumns: ['<string>'],
flushIntervalSeconds: 123,
flushSizeKb: 123,
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>'
},
streamARN: '<string>',
unifyAcrossDatabases: true,
unifyAcrossSchemas: true
},
disableReplication: true,
enableHistoryMode: true,
individualDeployment: true,
name: '<string>',
schema: '<string>',
status: '<string>',
uuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
}
]
}
})
};

fetch('https://api.artie.com/pipelines/{uuid}', 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/{uuid}",
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([
'pipeline' => [
'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,
'splitEventsByType' => true,
'stagingSchema' => '<string>',
'staticColumns' => [
[
'column' => '<string>',
'value' => '<string>'
]
],
'truncateExceededValues' => true,
'turboLatencyThresholdMinutes' => 123,
'turboRowThreshold' => 123,
'turboWarehouse' => '<string>',
'useBQBatchPriority' => true,
'useBigNumericForVariableNumeric' => true,
'useNewStringMethod' => true,
'writeRawBinaryValues' => true
],
'columnHashingSaltUUID' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'dataPlaneName' => '<string>',
'destinationUUID' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'encryptionKeyUUID' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'name' => '<string>',
'snowflakeEcoScheduleUUID' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'sourceReaderUUID' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'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>',
'bufferRows' => 123,
'columnsToCompress' => [
'<string>'
],
'columnsToEncrypt' => [
'<string>'
],
'columnsToHash' => [
'<string>'
],
'ctidSettings' => [
'chunkSize' => 1,
'enabled' => true,
'maxParallelism' => 1
],
'encryptJSONBColumns' => true,
'excludeColumns' => [
'<string>'
],
'flushIntervalSeconds' => 123,
'flushSizeKb' => 123,
'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>'
],
'streamARN' => '<string>',
'unifyAcrossDatabases' => true,
'unifyAcrossSchemas' => true
],
'disableReplication' => true,
'enableHistoryMode' => true,
'individualDeployment' => true,
'name' => '<string>',
'schema' => '<string>',
'status' => '<string>',
'uuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]
]
]),
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/{uuid}"

payload := strings.NewReader("{\n \"pipeline\": {\n \"advancedSettings\": {\n \"appendOnly\": true,\n \"autoEnableHistoryForNewTables\": true,\n \"autoReplicateIgnoreRegex\": \"<string>\",\n \"autoReplicateNewTables\": true,\n \"bigQueryReservation\": \"<string>\",\n \"bufferRows\": 123,\n \"defaultSourceSchema\": \"<string>\",\n \"disableAlerts\": true,\n \"dropDeletedColumns\": true,\n \"dynamoDBBackfillConfig\": {\n \"bucket\": \"<string>\",\n \"enabled\": true,\n \"exportArn\": \"<string>\",\n \"optionalFolder\": \"<string>\"\n },\n \"enableSoftDelete\": true,\n \"flushIntervalSeconds\": 123,\n \"flushSizeKb\": 123,\n \"forceUTCTimezone\": true,\n \"includeArtieOperationColumn\": true,\n \"includeArtieUpdatedAtColumn\": true,\n \"includeDatabaseUpdatedAtColumn\": true,\n \"includeFullSourceTableNameColumn\": true,\n \"includeFullSourceTableNameColumnAsPrimaryKey\": true,\n \"includeSourceMetadataColumn\": true,\n \"maxConcurrentSnapshots\": 1,\n \"splitEventsByType\": true,\n \"stagingSchema\": \"<string>\",\n \"staticColumns\": [\n {\n \"column\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"truncateExceededValues\": true,\n \"turboLatencyThresholdMinutes\": 123,\n \"turboRowThreshold\": 123,\n \"turboWarehouse\": \"<string>\",\n \"useBQBatchPriority\": true,\n \"useBigNumericForVariableNumeric\": true,\n \"useNewStringMethod\": true,\n \"writeRawBinaryValues\": true\n },\n \"columnHashingSaltUUID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"dataPlaneName\": \"<string>\",\n \"destinationUUID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"encryptionKeyUUID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"snowflakeEcoScheduleUUID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"sourceReaderUUID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"specificDestCfg\": {\n \"bucketName\": \"<string>\",\n \"checkpointInterval\": 123,\n \"compaction\": {\n \"enabled\": true,\n \"everySeconds\": 123,\n \"quietWindow\": {\n \"end\": \"<string>\",\n \"start\": \"<string>\"\n }\n },\n \"containerName\": \"<string>\",\n \"database\": \"<string>\",\n \"dynamicallyCreateNamespaces\": true,\n \"externalStageName\": \"<string>\",\n \"externalStageS3Bucket\": \"<string>\",\n \"externalStageS3Prefix\": \"<string>\",\n \"folderName\": \"<string>\",\n \"schema\": \"<string>\",\n \"schemaNamePrefix\": \"<string>\",\n \"tableNameSeparator\": \"<string>\",\n \"useSameSchemaAsSource\": true\n },\n \"tables\": [\n {\n \"advancedSettings\": {\n \"alias\": \"<string>\",\n \"bufferRows\": 123,\n \"columnsToCompress\": [\n \"<string>\"\n ],\n \"columnsToEncrypt\": [\n \"<string>\"\n ],\n \"columnsToHash\": [\n \"<string>\"\n ],\n \"ctidSettings\": {\n \"chunkSize\": 1,\n \"enabled\": true,\n \"maxParallelism\": 1\n },\n \"encryptJSONBColumns\": true,\n \"excludeColumns\": [\n \"<string>\"\n ],\n \"flushIntervalSeconds\": 123,\n \"flushSizeKb\": 123,\n \"includeColumns\": [\n \"<string>\"\n ],\n \"k8sRequestCPU\": 1,\n \"k8sRequestMemoryMB\": 1,\n \"mergePredicates\": [\n {\n \"partitionBy\": \"<string>\",\n \"partitionField\": \"<string>\",\n \"partitionType\": \"<string>\"\n }\n ],\n \"msmFlushCount\": 1,\n \"primaryKeysOverride\": [\n \"<string>\"\n ],\n \"rangeSettings\": {\n \"batchSize\": 1,\n \"chunksSize\": 1,\n \"enabled\": true,\n \"maxParallelism\": 1\n },\n \"shouldBackfillHistoryTable\": true,\n \"skipBackfill\": true,\n \"skipDelete\": true,\n \"skipNoOpUpdates\": true,\n \"softPartitioning\": {\n \"enabled\": true,\n \"maxPartitions\": 123,\n \"partitionColumn\": \"<string>\",\n \"partitionFrequency\": \"<string>\",\n \"partitionSchema\": \"<string>\"\n },\n \"streamARN\": \"<string>\",\n \"unifyAcrossDatabases\": true,\n \"unifyAcrossSchemas\": true\n },\n \"disableReplication\": true,\n \"enableHistoryMode\": true,\n \"individualDeployment\": true,\n \"name\": \"<string>\",\n \"schema\": \"<string>\",\n \"status\": \"<string>\",\n \"uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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://api.artie.com/pipelines/{uuid}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"pipeline\": {\n \"advancedSettings\": {\n \"appendOnly\": true,\n \"autoEnableHistoryForNewTables\": true,\n \"autoReplicateIgnoreRegex\": \"<string>\",\n \"autoReplicateNewTables\": true,\n \"bigQueryReservation\": \"<string>\",\n \"bufferRows\": 123,\n \"defaultSourceSchema\": \"<string>\",\n \"disableAlerts\": true,\n \"dropDeletedColumns\": true,\n \"dynamoDBBackfillConfig\": {\n \"bucket\": \"<string>\",\n \"enabled\": true,\n \"exportArn\": \"<string>\",\n \"optionalFolder\": \"<string>\"\n },\n \"enableSoftDelete\": true,\n \"flushIntervalSeconds\": 123,\n \"flushSizeKb\": 123,\n \"forceUTCTimezone\": true,\n \"includeArtieOperationColumn\": true,\n \"includeArtieUpdatedAtColumn\": true,\n \"includeDatabaseUpdatedAtColumn\": true,\n \"includeFullSourceTableNameColumn\": true,\n \"includeFullSourceTableNameColumnAsPrimaryKey\": true,\n \"includeSourceMetadataColumn\": true,\n \"maxConcurrentSnapshots\": 1,\n \"splitEventsByType\": true,\n \"stagingSchema\": \"<string>\",\n \"staticColumns\": [\n {\n \"column\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"truncateExceededValues\": true,\n \"turboLatencyThresholdMinutes\": 123,\n \"turboRowThreshold\": 123,\n \"turboWarehouse\": \"<string>\",\n \"useBQBatchPriority\": true,\n \"useBigNumericForVariableNumeric\": true,\n \"useNewStringMethod\": true,\n \"writeRawBinaryValues\": true\n },\n \"columnHashingSaltUUID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"dataPlaneName\": \"<string>\",\n \"destinationUUID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"encryptionKeyUUID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"snowflakeEcoScheduleUUID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"sourceReaderUUID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"specificDestCfg\": {\n \"bucketName\": \"<string>\",\n \"checkpointInterval\": 123,\n \"compaction\": {\n \"enabled\": true,\n \"everySeconds\": 123,\n \"quietWindow\": {\n \"end\": \"<string>\",\n \"start\": \"<string>\"\n }\n },\n \"containerName\": \"<string>\",\n \"database\": \"<string>\",\n \"dynamicallyCreateNamespaces\": true,\n \"externalStageName\": \"<string>\",\n \"externalStageS3Bucket\": \"<string>\",\n \"externalStageS3Prefix\": \"<string>\",\n \"folderName\": \"<string>\",\n \"schema\": \"<string>\",\n \"schemaNamePrefix\": \"<string>\",\n \"tableNameSeparator\": \"<string>\",\n \"useSameSchemaAsSource\": true\n },\n \"tables\": [\n {\n \"advancedSettings\": {\n \"alias\": \"<string>\",\n \"bufferRows\": 123,\n \"columnsToCompress\": [\n \"<string>\"\n ],\n \"columnsToEncrypt\": [\n \"<string>\"\n ],\n \"columnsToHash\": [\n \"<string>\"\n ],\n \"ctidSettings\": {\n \"chunkSize\": 1,\n \"enabled\": true,\n \"maxParallelism\": 1\n },\n \"encryptJSONBColumns\": true,\n \"excludeColumns\": [\n \"<string>\"\n ],\n \"flushIntervalSeconds\": 123,\n \"flushSizeKb\": 123,\n \"includeColumns\": [\n \"<string>\"\n ],\n \"k8sRequestCPU\": 1,\n \"k8sRequestMemoryMB\": 1,\n \"mergePredicates\": [\n {\n \"partitionBy\": \"<string>\",\n \"partitionField\": \"<string>\",\n \"partitionType\": \"<string>\"\n }\n ],\n \"msmFlushCount\": 1,\n \"primaryKeysOverride\": [\n \"<string>\"\n ],\n \"rangeSettings\": {\n \"batchSize\": 1,\n \"chunksSize\": 1,\n \"enabled\": true,\n \"maxParallelism\": 1\n },\n \"shouldBackfillHistoryTable\": true,\n \"skipBackfill\": true,\n \"skipDelete\": true,\n \"skipNoOpUpdates\": true,\n \"softPartitioning\": {\n \"enabled\": true,\n \"maxPartitions\": 123,\n \"partitionColumn\": \"<string>\",\n \"partitionFrequency\": \"<string>\",\n \"partitionSchema\": \"<string>\"\n },\n \"streamARN\": \"<string>\",\n \"unifyAcrossDatabases\": true,\n \"unifyAcrossSchemas\": true\n },\n \"disableReplication\": true,\n \"enableHistoryMode\": true,\n \"individualDeployment\": true,\n \"name\": \"<string>\",\n \"schema\": \"<string>\",\n \"status\": \"<string>\",\n \"uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ]\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.artie.com/pipelines/{uuid}")

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 \"pipeline\": {\n \"advancedSettings\": {\n \"appendOnly\": true,\n \"autoEnableHistoryForNewTables\": true,\n \"autoReplicateIgnoreRegex\": \"<string>\",\n \"autoReplicateNewTables\": true,\n \"bigQueryReservation\": \"<string>\",\n \"bufferRows\": 123,\n \"defaultSourceSchema\": \"<string>\",\n \"disableAlerts\": true,\n \"dropDeletedColumns\": true,\n \"dynamoDBBackfillConfig\": {\n \"bucket\": \"<string>\",\n \"enabled\": true,\n \"exportArn\": \"<string>\",\n \"optionalFolder\": \"<string>\"\n },\n \"enableSoftDelete\": true,\n \"flushIntervalSeconds\": 123,\n \"flushSizeKb\": 123,\n \"forceUTCTimezone\": true,\n \"includeArtieOperationColumn\": true,\n \"includeArtieUpdatedAtColumn\": true,\n \"includeDatabaseUpdatedAtColumn\": true,\n \"includeFullSourceTableNameColumn\": true,\n \"includeFullSourceTableNameColumnAsPrimaryKey\": true,\n \"includeSourceMetadataColumn\": true,\n \"maxConcurrentSnapshots\": 1,\n \"splitEventsByType\": true,\n \"stagingSchema\": \"<string>\",\n \"staticColumns\": [\n {\n \"column\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"truncateExceededValues\": true,\n \"turboLatencyThresholdMinutes\": 123,\n \"turboRowThreshold\": 123,\n \"turboWarehouse\": \"<string>\",\n \"useBQBatchPriority\": true,\n \"useBigNumericForVariableNumeric\": true,\n \"useNewStringMethod\": true,\n \"writeRawBinaryValues\": true\n },\n \"columnHashingSaltUUID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"dataPlaneName\": \"<string>\",\n \"destinationUUID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"encryptionKeyUUID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"snowflakeEcoScheduleUUID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"sourceReaderUUID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"specificDestCfg\": {\n \"bucketName\": \"<string>\",\n \"checkpointInterval\": 123,\n \"compaction\": {\n \"enabled\": true,\n \"everySeconds\": 123,\n \"quietWindow\": {\n \"end\": \"<string>\",\n \"start\": \"<string>\"\n }\n },\n \"containerName\": \"<string>\",\n \"database\": \"<string>\",\n \"dynamicallyCreateNamespaces\": true,\n \"externalStageName\": \"<string>\",\n \"externalStageS3Bucket\": \"<string>\",\n \"externalStageS3Prefix\": \"<string>\",\n \"folderName\": \"<string>\",\n \"schema\": \"<string>\",\n \"schemaNamePrefix\": \"<string>\",\n \"tableNameSeparator\": \"<string>\",\n \"useSameSchemaAsSource\": true\n },\n \"tables\": [\n {\n \"advancedSettings\": {\n \"alias\": \"<string>\",\n \"bufferRows\": 123,\n \"columnsToCompress\": [\n \"<string>\"\n ],\n \"columnsToEncrypt\": [\n \"<string>\"\n ],\n \"columnsToHash\": [\n \"<string>\"\n ],\n \"ctidSettings\": {\n \"chunkSize\": 1,\n \"enabled\": true,\n \"maxParallelism\": 1\n },\n \"encryptJSONBColumns\": true,\n \"excludeColumns\": [\n \"<string>\"\n ],\n \"flushIntervalSeconds\": 123,\n \"flushSizeKb\": 123,\n \"includeColumns\": [\n \"<string>\"\n ],\n \"k8sRequestCPU\": 1,\n \"k8sRequestMemoryMB\": 1,\n \"mergePredicates\": [\n {\n \"partitionBy\": \"<string>\",\n \"partitionField\": \"<string>\",\n \"partitionType\": \"<string>\"\n }\n ],\n \"msmFlushCount\": 1,\n \"primaryKeysOverride\": [\n \"<string>\"\n ],\n \"rangeSettings\": {\n \"batchSize\": 1,\n \"chunksSize\": 1,\n \"enabled\": true,\n \"maxParallelism\": 1\n },\n \"shouldBackfillHistoryTable\": true,\n \"skipBackfill\": true,\n \"skipDelete\": true,\n \"skipNoOpUpdates\": true,\n \"softPartitioning\": {\n \"enabled\": true,\n \"maxPartitions\": 123,\n \"partitionColumn\": \"<string>\",\n \"partitionFrequency\": \"<string>\",\n \"partitionSchema\": \"<string>\"\n },\n \"streamARN\": \"<string>\",\n \"unifyAcrossDatabases\": true,\n \"unifyAcrossSchemas\": true\n },\n \"disableReplication\": true,\n \"enableHistoryMode\": true,\n \"individualDeployment\": true,\n \"name\": \"<string>\",\n \"schema\": \"<string>\",\n \"status\": \"<string>\",\n \"uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ]\n }\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.

Path Parameters

uuid
string
required

Body

application/json
pipeline
object
required

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