Skip to main content
POST
/
source-readers
/
{uuid}
Update a source reader
curl --request POST \
  --url https://api.artie.com/source-readers/{uuid} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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": {
    "archiveLogPassword": "<string>",
    "archiveLogPath": "<string>",
    "azureBlobStorageConfig": {
      "accountURL": "<string>",
      "containerName": "<string>",
      "sasToken": "<string>"
    },
    "backfillBatchSize": 1,
    "compositeTypesAsText": true,
    "databasesToSync": [
      "<string>"
    ],
    "disableAutoFetchTables": true,
    "disableFullDocumentBeforeChange": true,
    "disableNoCursorTimeout": true,
    "enableClientSideFullDocumentLookup": true,
    "enableHeartbeats": true,
    "enableSchemaHistoryCompaction": true,
    "maxConnIdleTimeSeconds": 123,
    "mssqlChangeTrackingConcurrency": 123,
    "mssqlChangeTrackingMaxIdleConns": 123,
    "mssqlChangeTrackingPollIntervalMs": 1,
    "mssqlReplicationMethod": "<string>",
    "oneTopicPerSchema": true,
    "publicationAutoCreateMode": "<string>",
    "publicationNameOverride": "<string>",
    "publishViaPartitionRoot": true,
    "replicationSlotOverride": "<string>",
    "unifyAcrossDatabases": true,
    "unifyAcrossSchemas": true,
    "unifyAcrossSchemasMaxParallelism": 1,
    "unifyAcrossSchemasRegex": "<string>",
    "useAdvanceOnPrimaryKeepAlive": true,
    "useNumericTypesForMoney": true,
    "useReaderForOracleStreaming": true
  },
  "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "apiBaseURL": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "isShared": true,
  "tablesConfig": {},
  "updatedAt": "2023-11-07T05:31:56Z"
}
'
import requests

url = "https://api.artie.com/source-readers/{uuid}"

payload = {
    "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": {
        "archiveLogPassword": "<string>",
        "archiveLogPath": "<string>",
        "azureBlobStorageConfig": {
            "accountURL": "<string>",
            "containerName": "<string>",
            "sasToken": "<string>"
        },
        "backfillBatchSize": 1,
        "compositeTypesAsText": True,
        "databasesToSync": ["<string>"],
        "disableAutoFetchTables": True,
        "disableFullDocumentBeforeChange": True,
        "disableNoCursorTimeout": True,
        "enableClientSideFullDocumentLookup": True,
        "enableHeartbeats": True,
        "enableSchemaHistoryCompaction": True,
        "maxConnIdleTimeSeconds": 123,
        "mssqlChangeTrackingConcurrency": 123,
        "mssqlChangeTrackingMaxIdleConns": 123,
        "mssqlChangeTrackingPollIntervalMs": 1,
        "mssqlReplicationMethod": "<string>",
        "oneTopicPerSchema": True,
        "publicationAutoCreateMode": "<string>",
        "publicationNameOverride": "<string>",
        "publishViaPartitionRoot": True,
        "replicationSlotOverride": "<string>",
        "unifyAcrossDatabases": True,
        "unifyAcrossSchemas": True,
        "unifyAcrossSchemasMaxParallelism": 1,
        "unifyAcrossSchemasRegex": "<string>",
        "useAdvanceOnPrimaryKeepAlive": True,
        "useNumericTypesForMoney": True,
        "useReaderForOracleStreaming": True
    },
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "apiBaseURL": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "isShared": True,
    "tablesConfig": {},
    "updatedAt": "2023-11-07T05:31:56Z"
}
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({
    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: {
      archiveLogPassword: '<string>',
      archiveLogPath: '<string>',
      azureBlobStorageConfig: {accountURL: '<string>', containerName: '<string>', sasToken: '<string>'},
      backfillBatchSize: 1,
      compositeTypesAsText: true,
      databasesToSync: ['<string>'],
      disableAutoFetchTables: true,
      disableFullDocumentBeforeChange: true,
      disableNoCursorTimeout: true,
      enableClientSideFullDocumentLookup: true,
      enableHeartbeats: true,
      enableSchemaHistoryCompaction: true,
      maxConnIdleTimeSeconds: 123,
      mssqlChangeTrackingConcurrency: 123,
      mssqlChangeTrackingMaxIdleConns: 123,
      mssqlChangeTrackingPollIntervalMs: 1,
      mssqlReplicationMethod: '<string>',
      oneTopicPerSchema: true,
      publicationAutoCreateMode: '<string>',
      publicationNameOverride: '<string>',
      publishViaPartitionRoot: true,
      replicationSlotOverride: '<string>',
      unifyAcrossDatabases: true,
      unifyAcrossSchemas: true,
      unifyAcrossSchemasMaxParallelism: 1,
      unifyAcrossSchemasRegex: '<string>',
      useAdvanceOnPrimaryKeepAlive: true,
      useNumericTypesForMoney: true,
      useReaderForOracleStreaming: true
    },
    uuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    apiBaseURL: '<string>',
    createdAt: '2023-11-07T05:31:56Z',
    isShared: true,
    tablesConfig: {},
    updatedAt: '2023-11-07T05:31:56Z'
  })
};

fetch('https://api.artie.com/source-readers/{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/source-readers/{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([
    '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' => [
        'archiveLogPassword' => '<string>',
        'archiveLogPath' => '<string>',
        'azureBlobStorageConfig' => [
                'accountURL' => '<string>',
                'containerName' => '<string>',
                'sasToken' => '<string>'
        ],
        'backfillBatchSize' => 1,
        'compositeTypesAsText' => true,
        'databasesToSync' => [
                '<string>'
        ],
        'disableAutoFetchTables' => true,
        'disableFullDocumentBeforeChange' => true,
        'disableNoCursorTimeout' => true,
        'enableClientSideFullDocumentLookup' => true,
        'enableHeartbeats' => true,
        'enableSchemaHistoryCompaction' => true,
        'maxConnIdleTimeSeconds' => 123,
        'mssqlChangeTrackingConcurrency' => 123,
        'mssqlChangeTrackingMaxIdleConns' => 123,
        'mssqlChangeTrackingPollIntervalMs' => 1,
        'mssqlReplicationMethod' => '<string>',
        'oneTopicPerSchema' => true,
        'publicationAutoCreateMode' => '<string>',
        'publicationNameOverride' => '<string>',
        'publishViaPartitionRoot' => true,
        'replicationSlotOverride' => '<string>',
        'unifyAcrossDatabases' => true,
        'unifyAcrossSchemas' => true,
        'unifyAcrossSchemasMaxParallelism' => 1,
        'unifyAcrossSchemasRegex' => '<string>',
        'useAdvanceOnPrimaryKeepAlive' => true,
        'useNumericTypesForMoney' => true,
        'useReaderForOracleStreaming' => true
    ],
    'uuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'apiBaseURL' => '<string>',
    'createdAt' => '2023-11-07T05:31:56Z',
    'isShared' => true,
    'tablesConfig' => [
        
    ],
    'updatedAt' => '2023-11-07T05:31:56Z'
  ]),
  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/source-readers/{uuid}"

	payload := strings.NewReader("{\n  \"companyUUID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"connectorUUID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"containerName\": \"<string>\",\n  \"dataPlaneName\": \"<string>\",\n  \"database\": \"<string>\",\n  \"environmentUUID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"isValid\": true,\n  \"name\": \"<string>\",\n  \"settings\": {\n    \"archiveLogPassword\": \"<string>\",\n    \"archiveLogPath\": \"<string>\",\n    \"azureBlobStorageConfig\": {\n      \"accountURL\": \"<string>\",\n      \"containerName\": \"<string>\",\n      \"sasToken\": \"<string>\"\n    },\n    \"backfillBatchSize\": 1,\n    \"compositeTypesAsText\": true,\n    \"databasesToSync\": [\n      \"<string>\"\n    ],\n    \"disableAutoFetchTables\": true,\n    \"disableFullDocumentBeforeChange\": true,\n    \"disableNoCursorTimeout\": true,\n    \"enableClientSideFullDocumentLookup\": true,\n    \"enableHeartbeats\": true,\n    \"enableSchemaHistoryCompaction\": true,\n    \"maxConnIdleTimeSeconds\": 123,\n    \"mssqlChangeTrackingConcurrency\": 123,\n    \"mssqlChangeTrackingMaxIdleConns\": 123,\n    \"mssqlChangeTrackingPollIntervalMs\": 1,\n    \"mssqlReplicationMethod\": \"<string>\",\n    \"oneTopicPerSchema\": true,\n    \"publicationAutoCreateMode\": \"<string>\",\n    \"publicationNameOverride\": \"<string>\",\n    \"publishViaPartitionRoot\": true,\n    \"replicationSlotOverride\": \"<string>\",\n    \"unifyAcrossDatabases\": true,\n    \"unifyAcrossSchemas\": true,\n    \"unifyAcrossSchemasMaxParallelism\": 1,\n    \"unifyAcrossSchemasRegex\": \"<string>\",\n    \"useAdvanceOnPrimaryKeepAlive\": true,\n    \"useNumericTypesForMoney\": true,\n    \"useReaderForOracleStreaming\": true\n  },\n  \"uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"apiBaseURL\": \"<string>\",\n  \"createdAt\": \"2023-11-07T05:31:56Z\",\n  \"isShared\": true,\n  \"tablesConfig\": {},\n  \"updatedAt\": \"2023-11-07T05:31:56Z\"\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/source-readers/{uuid}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"companyUUID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"connectorUUID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"containerName\": \"<string>\",\n  \"dataPlaneName\": \"<string>\",\n  \"database\": \"<string>\",\n  \"environmentUUID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"isValid\": true,\n  \"name\": \"<string>\",\n  \"settings\": {\n    \"archiveLogPassword\": \"<string>\",\n    \"archiveLogPath\": \"<string>\",\n    \"azureBlobStorageConfig\": {\n      \"accountURL\": \"<string>\",\n      \"containerName\": \"<string>\",\n      \"sasToken\": \"<string>\"\n    },\n    \"backfillBatchSize\": 1,\n    \"compositeTypesAsText\": true,\n    \"databasesToSync\": [\n      \"<string>\"\n    ],\n    \"disableAutoFetchTables\": true,\n    \"disableFullDocumentBeforeChange\": true,\n    \"disableNoCursorTimeout\": true,\n    \"enableClientSideFullDocumentLookup\": true,\n    \"enableHeartbeats\": true,\n    \"enableSchemaHistoryCompaction\": true,\n    \"maxConnIdleTimeSeconds\": 123,\n    \"mssqlChangeTrackingConcurrency\": 123,\n    \"mssqlChangeTrackingMaxIdleConns\": 123,\n    \"mssqlChangeTrackingPollIntervalMs\": 1,\n    \"mssqlReplicationMethod\": \"<string>\",\n    \"oneTopicPerSchema\": true,\n    \"publicationAutoCreateMode\": \"<string>\",\n    \"publicationNameOverride\": \"<string>\",\n    \"publishViaPartitionRoot\": true,\n    \"replicationSlotOverride\": \"<string>\",\n    \"unifyAcrossDatabases\": true,\n    \"unifyAcrossSchemas\": true,\n    \"unifyAcrossSchemasMaxParallelism\": 1,\n    \"unifyAcrossSchemasRegex\": \"<string>\",\n    \"useAdvanceOnPrimaryKeepAlive\": true,\n    \"useNumericTypesForMoney\": true,\n    \"useReaderForOracleStreaming\": true\n  },\n  \"uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"apiBaseURL\": \"<string>\",\n  \"createdAt\": \"2023-11-07T05:31:56Z\",\n  \"isShared\": true,\n  \"tablesConfig\": {},\n  \"updatedAt\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.artie.com/source-readers/{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  \"companyUUID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"connectorUUID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"containerName\": \"<string>\",\n  \"dataPlaneName\": \"<string>\",\n  \"database\": \"<string>\",\n  \"environmentUUID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"isValid\": true,\n  \"name\": \"<string>\",\n  \"settings\": {\n    \"archiveLogPassword\": \"<string>\",\n    \"archiveLogPath\": \"<string>\",\n    \"azureBlobStorageConfig\": {\n      \"accountURL\": \"<string>\",\n      \"containerName\": \"<string>\",\n      \"sasToken\": \"<string>\"\n    },\n    \"backfillBatchSize\": 1,\n    \"compositeTypesAsText\": true,\n    \"databasesToSync\": [\n      \"<string>\"\n    ],\n    \"disableAutoFetchTables\": true,\n    \"disableFullDocumentBeforeChange\": true,\n    \"disableNoCursorTimeout\": true,\n    \"enableClientSideFullDocumentLookup\": true,\n    \"enableHeartbeats\": true,\n    \"enableSchemaHistoryCompaction\": true,\n    \"maxConnIdleTimeSeconds\": 123,\n    \"mssqlChangeTrackingConcurrency\": 123,\n    \"mssqlChangeTrackingMaxIdleConns\": 123,\n    \"mssqlChangeTrackingPollIntervalMs\": 1,\n    \"mssqlReplicationMethod\": \"<string>\",\n    \"oneTopicPerSchema\": true,\n    \"publicationAutoCreateMode\": \"<string>\",\n    \"publicationNameOverride\": \"<string>\",\n    \"publishViaPartitionRoot\": true,\n    \"replicationSlotOverride\": \"<string>\",\n    \"unifyAcrossDatabases\": true,\n    \"unifyAcrossSchemas\": true,\n    \"unifyAcrossSchemasMaxParallelism\": 1,\n    \"unifyAcrossSchemasRegex\": \"<string>\",\n    \"useAdvanceOnPrimaryKeepAlive\": true,\n    \"useNumericTypesForMoney\": true,\n    \"useReaderForOracleStreaming\": true\n  },\n  \"uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"apiBaseURL\": \"<string>\",\n  \"createdAt\": \"2023-11-07T05:31:56Z\",\n  \"isShared\": true,\n  \"tablesConfig\": {},\n  \"updatedAt\": \"2023-11-07T05:31:56Z\"\n}"

response = http.request(request)
puts response.read_body
{
  "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": {
    "archiveLogPassword": "<string>",
    "archiveLogPath": "<string>",
    "azureBlobStorageConfig": {
      "accountURL": "<string>",
      "containerName": "<string>",
      "sasToken": "<string>"
    },
    "backfillBatchSize": 1,
    "compositeTypesAsText": true,
    "databasesToSync": [
      "<string>"
    ],
    "disableAutoFetchTables": true,
    "disableFullDocumentBeforeChange": true,
    "disableNoCursorTimeout": true,
    "enableClientSideFullDocumentLookup": true,
    "enableHeartbeats": true,
    "enableSchemaHistoryCompaction": true,
    "maxConnIdleTimeSeconds": 123,
    "mssqlChangeTrackingConcurrency": 123,
    "mssqlChangeTrackingMaxIdleConns": 123,
    "mssqlChangeTrackingPollIntervalMs": 1,
    "mssqlReplicationMethod": "<string>",
    "oneTopicPerSchema": true,
    "publicationAutoCreateMode": "<string>",
    "publicationNameOverride": "<string>",
    "publishViaPartitionRoot": true,
    "replicationSlotOverride": "<string>",
    "unifyAcrossDatabases": true,
    "unifyAcrossSchemas": true,
    "unifyAcrossSchemasMaxParallelism": 1,
    "unifyAcrossSchemasRegex": "<string>",
    "useAdvanceOnPrimaryKeepAlive": true,
    "useNumericTypesForMoney": true,
    "useReaderForOracleStreaming": true
  },
  "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "apiBaseURL": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "isShared": true,
  "tablesConfig": {},
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
uuid
string
required

Body

application/json
​
companyUUID
string<uuid>
required
​
connectorUUID
string<uuid>
required
​
containerName
string
required
​
dataPlaneName
string
required
​
database
string
required
​
environmentUUID
string<uuid>
required
​
isValid
boolean
required
​
name
string
required
​
settings
object
required
​
status
enum<string>
required
Available options:
draft,
paused,
running
​
uuid
string<uuid>
required
​
apiBaseURL
string
​
createdAt
string<date-time>
​
isShared
null | boolean
​
tablesConfig
null | object
​
updatedAt
string<date-time>

Response

OK

​
companyUUID
string<uuid>
required
​
connectorUUID
string<uuid>
required
​
containerName
string
required
​
dataPlaneName
string
required
​
database
string
required
​
environmentUUID
string<uuid>
required
​
isValid
boolean
required
​
name
string
required
​
settings
object
required
​
status
enum<string>
required
Available options:
draft,
paused,
running
​
uuid
string<uuid>
required
​
apiBaseURL
string
​
createdAt
string<date-time>
​
isShared
null | boolean
​
tablesConfig
null | object
​
updatedAt
string<date-time>