Skip to main content
PATCH
/
api
/
public
/
organizations
/
{orgId}
/
data-sources
/
{id}
Update a data source
curl --request PATCH \
  --url https://charts.basedash.com/api/public/organizations/{orgId}/data-sources/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "snowflakeAccountId": "<string>",
  "snowflakeWarehouse": "<string>",
  "snowflakeRole": "<string>",
  "snowflakePrivateKey": "<string>",
  "snowflakePrivateKeyPassphrase": "<string>",
  "databaseName": null,
  "username": "<string>",
  "host": "<string>",
  "port": 32767,
  "bigQueryProjectId": "<string>",
  "spannerInstanceId": "<string>",
  "sslEnabled": false,
  "sshEnabled": false,
  "sshHost": "<string>",
  "sshPort": 32767,
  "sshUsername": "<string>",
  "sshPassword": "<string>",
  "sshPrivateKey": "<string>",
  "sshPrivateKeyPassphrase": "<string>",
  "unsetPassword": true,
  "password": "<string>",
  "unsetSshPassword": true,
  "unsetSshPrivateKey": true,
  "unsetSshPrivateKeyPassphrase": true,
  "bigQueryJsonKey": "<string>"
}
'
{
  "data": {
    "id": "<string>",
    "displayName": "<string>",
    "description": "<string>",
    "dialect": "POSTGRES",
    "databaseName": "<string>",
    "username": "<string>",
    "host": "<string>",
    "port": 123,
    "sslEnabled": true,
    "sslCustomCertificatesEnabled": true,
    "sshEnabled": true,
    "sshHost": "<string>",
    "sshPort": 123,
    "sshUsername": "<string>",
    "bigQueryProjectId": "<string>",
    "spannerInstanceId": "<string>",
    "snowflakeAccountId": "<string>",
    "snowflakeWarehouse": "<string>",
    "snowflakeRole": "<string>",
    "lastSuccessfulSyncAt": "2023-11-07T05:31:56Z",
    "lastSyncStatus": "PENDING",
    "lastSyncAttemptAt": "2023-11-07T05:31:56Z",
    "hasCompletedFirstSync": true,
    "syncErrorMessage": "<string>",
    "lastHealthyAt": "2023-11-07T05:31:56Z",
    "lastHealthStatus": "HEALTHY",
    "lastHealthCheckAttemptAt": "2023-11-07T05:31:56Z",
    "isDemo": true,
    "isBasedashWarehouse": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization
string
header
required

API key authentication using Bearer token format: Bearer <basedash_api_key>

Path Parameters

orgId
string
required

Organization ID

id
string
required

Data source ID

Body

application/json
snowflakeAccountId
string

Snowflake account ID

snowflakeWarehouse
string

Snowflake warehouse

snowflakeRole
string

Snowflake role

snowflakePrivateKey
string

Snowflake private key

snowflakePrivateKeyPassphrase
string

Snowflake private key passphrase

databaseName
string | null

Database name

username
string

Database username

host
string

Database host

port
integer

Database port

Required range: 0 <= x <= 65535
bigQueryProjectId
string

BigQuery project ID

spannerInstanceId
string

Spanner instance ID

sslEnabled
boolean
default:false

Enable SSL connection

sshEnabled
boolean
default:false

Enable SSH tunnel

sshHost
string

SSH tunnel host

sshPort
integer

SSH tunnel port

Required range: 0 <= x <= 65535
sshUsername
string

SSH tunnel username

sshPassword
string | null

SSH tunnel password

sshPrivateKey
string | null

SSH private key

sshPrivateKeyPassphrase
string | null

SSH private key passphrase

unsetPassword
boolean | null
password
string | null

Database password

unsetSshPassword
boolean | null
unsetSshPrivateKey
boolean | null
unsetSshPrivateKeyPassphrase
boolean | null
bigQueryJsonKey
string | null

BigQuery JSON key

Response

Data source updated successfully

data
object
required