​
Overview

The Databrain APIs provides endpoints to sync you Datasource in both Cloud Databrain and Selfhosted Databrain environment. To use the API, you need to pass a parameter datasourceId.

​
API Endpoints

​
Cloud Databrain Endpoint

POST https://api.usedatabrain.com/api/v2/datasource/sync

​
Self-hosted Databrain Endpoint

POST <SELF_HOSTED_URL>/api/v2/datasource/sync

​
Headers

​
Authorization
string
required
Bearer API TOKEN

​
API Methods

​
Sync Datasource

Endpoint: 
POST /datasource/sync
Request Body: 
{
  "input": {
    "datasourceId": "ba8e6e45-d864-4d00-a07a-008507828114" // ?id=
  }
}
Response Body: 
{
  "data": {
    "message": "Sync completed"
  }
}
Get your datasourceId from the URL query params on the datasource page.

​
Get AWSS3 sync Progress status

Endpoint: 
POST /datasource/getDatasourceProgress
Request Body: 
{
  "input": {
    "datasourceId": "ba8e6e45-d864-4d00-a07a-008507828114" // ?id=
  }
}
Response Body: 
{
  "status": {
    "progress": "16/16",
    "error": ""
  }
}

​
Response Body:

Below is a response when no sync is completed for AWSS3: 
{
  "status": {
    "progress": "0/...",
    "error": ""
  }
}

​
Response Error:

Below is a response error when while syncing AWSS3 throws an error: 
{
  "status": {
    "progress": "0/...",
    "error": "Error: Bind error data type"
  }
}