Skip to main content
PUT
/
assets
/
data
/
{resource_uri}
Update Data Connection
curl --request PUT \
  --url https://api.example.com/assets/data/{resource_uri} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "status_message": "<string>",
  "tags": [
    "<string>"
  ],
  "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
  },
  "credentials": {}
}
'
{
  "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": []
}

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

Body

application/json

Request body for updating a data connection.

Note: resource_uri cannot be changed (it's part of the primary key). Credentials can be updated by providing new credential values.

​
name
string | null
Required string length: 1 - 255
Pattern: ^[a-zA-Z0-9][a-zA-Z0-9 _.:-]*$
​
description
string | null
Maximum string length: 1000
​
status
enum<string> | null

Connection status

Available options:
PENDING,
ACTIVE,
ERROR,
DISABLED
​
status_message
string | null

Context about current status

Maximum string length: 1000
​
tags
string[] | null
​
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.

​
credentials
Credentials · object

Updated credentials (optional). If provided, will replace existing credentials.

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[]