Skip to main content
GET
Get Data Connection

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

Path Parameters

resource_uri
string
required

Data connection resource URI (e.g., 'data:acme-corp:ml-project:customer-db')

Response

Successful Response

Full data connection representation.

resource_uri
string
required
name
string
required
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
status
enum<string>
required

Status of a data connection.

Available options:
PENDING,
ACTIVE,
ERROR,
DISABLED
organization_id
string
required
project_id
string | null
required
owner_id
string
required
deprecated

Deprecated: use created_by instead. Will be removed in a future release.

created_at
string<date-time>
required
updated_at
string<date-time>
required
created_by
string
required
updated_by
string
required
type
string
default:data
status_message
string | null
description
string | null
tags
string[]
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.

secret_names
string[]