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

Verify data source credentials

cURL

curl --request POST \
  --url https://charts.basedash.com/api/public/organizations/{orgId}/data-sources/verify \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dialect": "ELASTICSEARCH",
  "snowflakeAccountId": "<string>",
  "snowflakeWarehouse": "<string>",
  "snowflakeRole": "<string>",
  "snowflakePrivateKey": "<string>",
  "snowflakePrivateKeyPassphrase": "<string>",
  "databaseName": null,
  "username": "<string>",
  "host": "<string>",
  "port": 32767,
  "password": "<string>",
  "bigQueryJsonKey": "<string>",
  "bigQueryProjectId": "<string>",
  "spannerInstanceId": "<string>",
  "athenaWorkgroup": "<string>",
  "athenaOutputLocation": "<string>",
  "athenaCatalog": "<string>",
  "sslEnabled": true,
  "sslVerifyServerCertificate": true,
  "sslCaCertificate": "<string>",
  "sshEnabled": false,
  "sshHost": "<string>",
  "sshPort": 32767,
  "sshUsername": "<string>",
  "sshPassword": "<string>",
  "sshPrivateKey": "<string>",
  "sshPrivateKeyPassphrase": "<string>",
  "maxPoolSize": 50
}
'

200

{
  "data": {
    "success": true
  }
}

​

When to use

This endpoint is commonly used in combination with the create or update data source endpoints. It allows you to verify that the provided credentials can successfully connect to the database before committing to creating or updating a data source.

​

Typical workflow

1. Verify credentials - Call this endpoint with the connection details
2. Check response - If successful, proceed to create/update; if failed, display field-specific errors to the user
3. Create/update data source - Once verified, call the create or update endpoint with the same credentials

​

Field-specific errors

When a connection fails, the response includes fieldErrors that map specific fields to their errors. This allows you to display targeted feedback to users about which credential field is incorrect.

Common field errors:

• host: “Host not found” - The hostname could not be resolved
• port: “Incorrect port” - The connection was refused on the specified port
• username/password: “Incorrect username or password” - Authentication failed
• databaseName: “Database does not exist” - The specified database was not found

​

IP whitelisting

If the connection times out, ensure the Basedash IP address (24.199.77.73) is whitelisted in your database firewall rules.

Authorizations

Authorization · string · header · required

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

Path Parameters

orgId · string · required

Organization ID

Body

application/json

dialect · Option 1 · enum<string> Option 2 · enum<string> Option 3 · enum<string> Option 4 · enum<string> Option 5 · enum<string> Option 6 · enum<string> Option 7 · enum<string> Option 8 · enum<string> Option 9 · enum<string> Option 10 · enum<string> Option 11 · enum<string> Option 12 · enum<string> Option 13 · enum<string> Option 14 · enum<string> Option 15 · enum<string> Option 16 · enum<string> Option 17 · enum<string> · required

Database dialect/type

Available options: ELASTICSEARCH

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

password · string

Database password

bigQueryJsonKey · string

BigQuery JSON key

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: true

Enable SSL connection

sslVerifyServerCertificate · boolean

Verify the server's TLS certificate when SSL is on

sslCaCertificate · string | null

PEM CA certificate to trust for the server certificate

Maximum string length: 65536

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

SSH tunnel password

sshPrivateKey · string

SSH private key

sshPrivateKeyPassphrase · string

SSH private key passphrase

maxPoolSize · integer

Maximum number of connections in the pool per container

Required range: 1 <= x <= 100

Response

200

application/json

Credentials verified successfully

data · object · required

Show child attributes