Skip to main content
GET
/
api
/
public
/
data-sources
/
{id}
Get a data source
curl --request GET \
  --url https://charts.basedash.com/api/public/data-sources/{id} \
  --header 'Authorization: Bearer <token>'
{
  "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 bd_key_<secret>

Path Parameters

id
string
required

Data source ID

Response

Data source retrieved successfully

data
object
required