BAbasedash
Data Sources

Verify data source credentials

Tests database connection credentials without creating a data source. Use this endpoint to validate credentials before creating or updating a data source.

post/api/public/organizations/{orgId}/data-sources/verify

Request

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

Path parameters

orgIdstring required

Organization 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

passwordstring

Database password

bigQueryJsonKeystring

BigQuery JSON key

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

SSH tunnel password

sshPrivateKeystring

SSH private key

sshPrivateKeyPassphrasestring

SSH private key passphrase

maxPoolSizeinteger

Maximum number of connections in the pool per container

Response

Credentials verified successfully

Changes

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