Skip to main content
POST
/
connectors
Create a connector
curl --request POST \
  --url https://api.artie.com/connectors \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dataPlaneName": "<string>",
  "defaultDatabase": "<string>",
  "environmentUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "label": "<string>",
  "sharedConfig": {},
  "sshTunnelUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "<string>",
  "uuid": "<string>"
}
'
{
  "companyUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "environmentUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "isValid": true,
  "label": "<string>",
  "type": "api",
  "updatedAt": "2023-11-07T05:31:56Z",
  "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "connectionLabel": "<string>",
  "dataPlaneName": "<string>",
  "defaultDatabase": "<string>",
  "sharedConfig": "<unknown>",
  "sshTunnelUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
dataPlaneName
string
​
defaultDatabase
string | null
​
environmentUUID
string<uuid> | null
​
label
string
​
sharedConfig
object
​
sshTunnelUUID
string<uuid> | null
​
type
string
​
uuid
string

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,
dynamodb,
gcs,
iceberg,
keyspaces,
mongodb,
motherduck,
mssql,
mysql,
oracle,
postgresql,
redis,
redshift,
s3,
snowflake
​
updatedAt
string<date-time>
required
​
uuid
string<uuid>
required
​
connectionLabel
string
​
dataPlaneName
string | null
​
defaultDatabase
string
​
sharedConfig
any
​
sshTunnelUUID
string<uuid> | null