BAbasedash
Data Sources

Update a data source

Updates an existing data source connection settings. Requires admin access to the organization. Secrets you leave out keep their saved values, except where the change would send them somewhere new: changing host, port, username, snowflakeAccountId, an Oracle data source's databaseName (its service name) or the SSH tunnel (sshEnabled, sshHost, sshPort) requires password again when one is saved, and turning the SSH tunnel on or changing its sshHost, sshPort or sshUsername requires sshPassword again when one is saved. Without it the request fails with a 400 ValidationError.

patch/api/public/organizations/{orgId}/data-sources/{id}

Request

  • Base URL
    https://charts.basedash.com
  • Auth
    HTTP bearer

Path parameters

orgIdstring required

Organization ID

idstring required

Data source ID

Request body

snowflakeAccountIdstring

Snowflake account ID

snowflakeWarehousestring

Snowflake warehouse

snowflakeRolestring

Snowflake role

snowflakePrivateKeystring

Snowflake private key

snowflakePrivateKeyPassphrasestring

Snowflake private key passphrase

databaseNamestring nullable

Database name

usernamestring

Database username

hoststring

Database host

portinteger

Database port

bigQueryProjectIdstring

BigQuery project ID

spannerInstanceIdstring

Spanner instance ID

athenaWorkgroupstring

Athena workgroup

athenaOutputLocationstring

Athena output location (s3://...)

athenaCatalogstring

Athena catalog

sslEnabledboolean

Enable SSL connection

sslVerifyServerCertificateboolean

Verify the server's TLS certificate when SSL is on

sslCaCertificatestring nullable

PEM CA certificate to trust for the server certificate

sshEnabledboolean

Enable SSH tunnel

sshHoststring

SSH tunnel host

sshPortinteger

SSH tunnel port

sshUsernamestring

SSH tunnel username

sshPasswordstring nullable

SSH tunnel password

sshPrivateKeystring nullable

SSH private key

sshPrivateKeyPassphrasestring nullable

SSH private key passphrase

maxPoolSizeinteger nullable

Maximum number of connections in the pool per container

unsetPasswordboolean nullable
passwordstring nullable

Database password

unsetSshPasswordboolean nullable
unsetSshPrivateKeyboolean nullable
unsetSshPrivateKeyPassphraseboolean nullable
bigQueryJsonKeystring nullable

BigQuery JSON key

Response

Data source updated successfully

Changes

No recorded changes to this operation across all 1 revision of this API.