Skip to main content
POST
Verify Connection Before Save

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Project-ID
string | null

Body

application/json

Request body for verifying a data connection before saving.

This allows testing connection credentials and discovering available tables before actually creating the data connection record.

connection_type
enum<string>
required

Data connection types.

Available options:
postgres,
redshift,
mysql,
bigquery,
snowflake,
databricks,
couchbase,
oracle,
hive,
mongodb,
s3,
gcs,
minio,
nfs,
smb
credentials
Credentials · object
required

Credentials for the connection. Format depends on connection type and auth_type.

database_config
DatabaseConnectionConfig · object | null

Configuration for database connections.

storage_config
StorageConnectionConfig · object | null

Configuration for object storage connections.

filesystem_config
FileSystemConnectionConfig · object | null

Configuration for file system connections.

Response

Verification result with available tables/metadata

Response for data connection verification.

success
boolean
required
message
string
required
latency_ms
number | null
details
Details · object | null

Provider-specific details (e.g., bucket_exists, permissions)