Skip to main content
POST
/
connectors
/
schemas
Fetch schemas for an unsaved connector
curl --request POST \
  --url https://api.artie.com/connectors/schemas \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "connector": {
    "dataPlaneName": "<string>",
    "defaultDatabase": "<string>",
    "environmentUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "label": "<string>",
    "privateLinkUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "sharedConfig": {},
    "snapshotPrivateLinkUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "sshTunnelUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "<string>",
    "uuid": "<string>"
  },
  "databaseName": "<string>"
}
'
import requests

url = "https://api.artie.com/connectors/schemas"

payload = {
    "connector": {
        "dataPlaneName": "<string>",
        "defaultDatabase": "<string>",
        "environmentUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "label": "<string>",
        "privateLinkUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "sharedConfig": {},
        "snapshotPrivateLinkUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "sshTunnelUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "type": "<string>",
        "uuid": "<string>"
    },
    "databaseName": "<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({
    connector: {
      dataPlaneName: '<string>',
      defaultDatabase: '<string>',
      environmentUUID: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      label: '<string>',
      privateLinkUUID: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      sharedConfig: {},
      snapshotPrivateLinkUUID: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      sshTunnelUUID: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      type: '<string>',
      uuid: '<string>'
    },
    databaseName: '<string>'
  })
};

fetch('https://api.artie.com/connectors/schemas', 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/connectors/schemas",
  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([
    'connector' => [
        'dataPlaneName' => '<string>',
        'defaultDatabase' => '<string>',
        'environmentUUID' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'label' => '<string>',
        'privateLinkUUID' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'sharedConfig' => [
                
        ],
        'snapshotPrivateLinkUUID' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'sshTunnelUUID' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'type' => '<string>',
        'uuid' => '<string>'
    ],
    'databaseName' => '<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/connectors/schemas"

	payload := strings.NewReader("{\n  \"connector\": {\n    \"dataPlaneName\": \"<string>\",\n    \"defaultDatabase\": \"<string>\",\n    \"environmentUUID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"label\": \"<string>\",\n    \"privateLinkUUID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"sharedConfig\": {},\n    \"snapshotPrivateLinkUUID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"sshTunnelUUID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"type\": \"<string>\",\n    \"uuid\": \"<string>\"\n  },\n  \"databaseName\": \"<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/connectors/schemas")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"connector\": {\n    \"dataPlaneName\": \"<string>\",\n    \"defaultDatabase\": \"<string>\",\n    \"environmentUUID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"label\": \"<string>\",\n    \"privateLinkUUID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"sharedConfig\": {},\n    \"snapshotPrivateLinkUUID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"sshTunnelUUID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"type\": \"<string>\",\n    \"uuid\": \"<string>\"\n  },\n  \"databaseName\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.artie.com/connectors/schemas")

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  \"connector\": {\n    \"dataPlaneName\": \"<string>\",\n    \"defaultDatabase\": \"<string>\",\n    \"environmentUUID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"label\": \"<string>\",\n    \"privateLinkUUID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"sharedConfig\": {},\n    \"snapshotPrivateLinkUUID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"sshTunnelUUID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"type\": \"<string>\",\n    \"uuid\": \"<string>\"\n  },\n  \"databaseName\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

Authorizations

Authorization
string
header
required

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

Body

application/json
connector
object
required
databaseName
string
required

Response

OK