Skip to main content
GET
/
connectors
/
{uuid}
Get a connector
curl --request GET \
  --url https://api.artie.com/connectors/{uuid} \
  --header 'Authorization: Bearer <token>'
import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.artie.com/connectors/{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/connectors/{uuid}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.artie.com/connectors/{uuid}")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

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

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "companyUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "environmentUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "isValid": true,
  "label": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "connectionLabel": "<string>",
  "dataPlaneName": "<string>",
  "defaultDatabase": "<string>",
  "privateLinkUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sharedConfig": "<unknown>",
  "snapshotPrivateLinkUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sshTunnelUUID": "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

Response

OK

​
companyUUID
string<uuid>
required
​
createdAt
string<date-time>
required
​
environmentUUID
string<uuid>
required
​
isValid
boolean
required
​
label
string
required
​
type
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
​
updatedAt
string<date-time>
required
​
uuid
string<uuid>
required
​
connectionLabel
string
​
dataPlaneName
null | string
​
defaultDatabase
string
​
privateLinkUUID
null | string<uuid>
​
sharedConfig
any
​
snapshotPrivateLinkUUID
null | string<uuid>
​
sshTunnelUUID
null | string<uuid>