Skip to main content
POST
/
assets
/
data
Create Data Connection
curl --request POST \
  --url https://api.example.com/assets/data \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "connection_type": "redshift",
  "credentials": {
    "password": "securepassword123",
    "username": "analytics_user"
  },
  "database_config": {
    "auth_type": "basic",
    "database": "analytics",
    "db_schema": "public",
    "host": "redshift-cluster.amazonaws.com",
    "port": 5439,
    "selected_tables": {
      "public": [
        "customers",
        "orders",
        "products"
      ]
    },
    "ssl_mode": "require"
  },
  "description": "Production Redshift database for customer analytics",
  "name": "Customer Analytics DB",
  "resource_uri": "customer-analytics-db",
  "tags": [
    "production",
    "analytics",
    "pii"
  ]
}
'
{
  "resource_uri": "<string>",
  "name": "<string>",
  "organization_id": "<string>",
  "project_id": "<string>",
  "owner_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "created_by": "<string>",
  "updated_by": "<string>",
  "type": "data",
  "status_message": "<string>",
  "description": "<string>",
  "tags": [],
  "database_config": {
    "host": "<string>",
    "port": 123,
    "database": "<string>",
    "auth_type": "basic",
    "ssl_mode": "disable",
    "selected_tables": [
      {
        "database_name": "<string>",
        "schemas": [
          {
            "schema_name": "<string>",
            "tables": [
              "<string>"
            ],
            "views": []
          }
        ]
      }
    ],
    "options": {}
  },
  "storage_config": {
    "provider": "<string>",
    "bucket": "<string>",
    "region": "<string>",
    "endpoint_url": "<string>"
  },
  "filesystem_config": {
    "path": "<string>",
    "protocol": "<string>",
    "auth_required": false
  },
  "secret_names": []
}

Documentation Index

Fetch the complete documentation index at: https://docs.emergence.ai/llms.txt

Use this file to discover all available pages before exploring further.

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 creating a data connection.

Now supports inline credentials which will be stored as secrets automatically.

name
string
required
Required string length: 1 - 255
Pattern: ^[a-zA-Z0-9][a-zA-Z0-9 _.:-]*$
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 authentication. These will be securely stored as secrets.

resource_uri
string | null

Custom kebab-case name for the resource URI (e.g., 'customer-db'). Auto-generated from name if omitted. The full URI is constructed as {type}:{org_id}:{scope}:{name}.

Pattern: ^[a-z0-9-]+$
description
string | null
Maximum string length: 1000
database_config
DatabaseConnectionConfig · object

Configuration for database connections.

storage_config
StorageConnectionConfig · object

Configuration for object storage connections.

filesystem_config
FileSystemConnectionConfig · object

Configuration for file system connections.

tags
string[]

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

Configuration for database connections.

storage_config
StorageConnectionConfig · object

Configuration for object storage connections.

filesystem_config
FileSystemConnectionConfig · object

Configuration for file system connections.

secret_names
string[]