Skip to main content
POST
/
v1
/
connections
Create connection
curl --request POST \
  --url https://{instance}.omniapp.co/api/v1/connections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dialect": "postgres",
  "name": "Production Database",
  "passwordUnencrypted": "secretpassword",
  "host": "db.example.com",
  "port": 5432,
  "database": "analytics"
}
'
{
  "success": true,
  "data": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
Authorization
string
header
required

Use either an Organization API Key or Personal Access Token (PAT). Include in the Authorization header as: Bearer YOUR_TOKEN

Body

application/json
​
dialect
enum<string>
required

Database type

Available options:
bigquery,
mysql,
postgres,
snowflake
​
name
string
required

Connection name

​
passwordUnencrypted
string
required

Database password

​
queryTimeoutSeconds
integer

Query timeout in seconds

​
host
string

Database host (required for MySQL, PostgreSQL)

​
port
integer

Database port

​
database
string

Database name

​
warehouse
string

Warehouse name (Snowflake)

​
schemas
string[]

Schema list

Response

Connection created successfully

​
success
boolean
​
data
string<uuid>

Connection ID