Skip to main content
POST
/
pipelines
/
validate-unsaved-source
Validate unsaved source
curl --request POST \
  --url https://api.artie.com/pipelines/validate-unsaved-source \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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"
    }
  ],
  "validateTables": true,
  "dataPlaneName": "<string>",
  "dynamoDBBackfillConfig": {
    "bucket": "<string>",
    "enabled": true,
    "exportArn": "<string>",
    "optionalFolder": "<string>"
  },
  "sourceConnector": {
    "dataPlaneName": "<string>",
    "defaultDatabase": "<string>",
    "environmentUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "label": "<string>",
    "sharedConfig": {},
    "sshTunnelUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "<string>",
    "uuid": "<string>"
  },
  "sourceReader": {
    "companyUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "connectorUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "containerName": "<string>",
    "dataPlaneName": "<string>",
    "database": "<string>",
    "environmentUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "isValid": true,
    "name": "<string>",
    "settings": {
      "azureBlobStorageConfig": {
        "accountURL": "<string>",
        "containerName": "<string>",
        "sasToken": "<string>"
      },
      "backfillBatchSize": 1,
      "databasesToSync": [
        "<string>"
      ],
      "disableAutoFetchTables": true,
      "enableHeartbeats": true,
      "mssqlReplicationMethod": "<string>",
      "oneTopicPerSchema": true,
      "partitionRegex": {
        "pattern": "<string>"
      },
      "publicationAutoCreateMode": "<string>",
      "publicationNameOverride": "<string>",
      "publishViaPartitionRoot": true,
      "replicationSlotOverride": "<string>",
      "unifyAcrossDatabases": true,
      "unifyAcrossSchemas": true,
      "unifyAcrossSchemasRegex": "<string>",
      "useAdvanceOnPrimaryKeepAlive": true,
      "useNumericTypesForMoney": true,
      "useReaderForPostgresStreaming": true
    },
    "status": "draft",
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "apiBaseURL": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "isShared": true,
    "tablesConfig": {},
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "sourceReaderUUID": "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
tables
object[]
required
validateTables
boolean
required
dataPlaneName
string
dynamoDBBackfillConfig
object
sourceConnector
object
sourceReader
object
sourceReaderUUID
string<uuid> | null

Response

OK

error
string