Skip to main content
POST
/
pipelines
/
validate-unsaved-destination
Validate unsaved destination
curl --request POST \
  --url https://api.artie.com/pipelines/validate-unsaved-destination \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "specificCfg": {
    "bucketName": "<string>",
    "containerName": "<string>",
    "database": "<string>",
    "dynamicallyCreateNamespaces": true,
    "externalStageName": "<string>",
    "externalStageS3Bucket": "<string>",
    "externalStageS3Prefix": "<string>",
    "folderName": "<string>",
    "schema": "<string>",
    "schemaNamePrefix": "<string>",
    "tableNameSeparator": "<string>",
    "useSameSchemaAsSource": true
  },
  "advancedSettings": {
    "appendOnly": true,
    "autoReplicateIgnoreRegex": "<string>",
    "autoReplicateNewTables": true,
    "bufferRows": 123,
    "defaultSourceSchema": "<string>",
    "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,
    "splitEventsByType": true,
    "stagingSchema": "<string>",
    "staticColumns": [
      {
        "column": "<string>",
        "value": "<string>"
      }
    ],
    "truncateExceededValues": true,
    "turboLatencyThresholdMinutes": 123,
    "turboRowThreshold": 123,
    "turboWarehouse": "<string>",
    "useBQBatchPriority": true,
    "useBigNumericForVariableNumeric": true,
    "writeRawBinaryValues": true
  },
  "destination": {
    "dataPlaneName": "<string>",
    "defaultDatabase": "<string>",
    "environmentUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "label": "<string>",
    "sharedConfig": {},
    "sshTunnelUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "<string>",
    "uuid": "<string>"
  },
  "destinationUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sourceReaderUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sourceType": "<string>",
  "tables": [
    {
      "advancedSettings": {
        "alias": "<string>",
        "backfillFromDatabases": [
          "<string>"
        ],
        "backfillFromSchemas": [
          "<string>"
        ],
        "bigQueryPartitionSettings": {
          "partitionBy": "<string>",
          "partitionField": "<string>",
          "partitionType": "<string>"
        },
        "bufferRows": 123,
        "columnsToHash": [
          "<string>"
        ],
        "ctidSettings": {
          "chunkSize": 1,
          "enabled": true,
          "maxParallelism": 1
        },
        "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,
        "skipDelete": true,
        "softPartitioning": {
          "enabled": true,
          "maxPartitions": 123,
          "partitionColumn": "<string>",
          "partitionFrequency": "<string>",
          "partitionSchema": "<string>"
        },
        "streamARN": "<string>",
        "unifyAcrossDatabases": true,
        "unifyAcrossSchemas": true
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "destinationTableName": "<string>",
      "disableReplication": true,
      "enableHistoryMode": true,
      "historyTableStatus": "<string>",
      "individualDeployment": true,
      "isPartitioned": true,
      "name": "<string>",
      "schema": "<string>",
      "status": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z",
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ]
}
'
{
  "error": "<string>"
}

Authorizations

Authorization
string
header
required

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

Body

application/json
specificCfg
object
required
advancedSettings
object
destination
object
destinationUUID
string<uuid> | null
sourceReaderUUID
string<uuid> | null
sourceType
string | null
tables
object[] | null

Response

OK

error
string