Skip to main content
PATCH
Update a data source

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

athenaWorkgroup
string

Athena workgroup

athenaOutputLocation
string

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

athenaCatalog
string

Athena catalog

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

maxPoolSize
integer | null

Maximum number of connections in the pool per container

Required range: 1 <= x <= 100
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