Update Datasource

curl --request PUT \
  --url https://api.usedatabrain.com/api/v2/datasource \
  --header 'Authorization: Bearer dbn_live_abc123...' \
  --header 'Content-Type: application/json' \
  --data '{
    "datasourceType": "postgres",
    "credentials": {
      "name": "production-postgres",
      "host": "new-db.example.com",
      "port": 5432,
      "username": "dbuser",
      "password": "newpassword",
      "database": "analytics",
      "schema": "public"
    }
  }'

{
  "name": "production-postgres"
}

curl --request PUT \
  --url https://api.usedatabrain.com/api/v2/datasource \
  --header 'Authorization: Bearer dbn_live_abc123...' \
  --header 'Content-Type: application/json' \
  --data '{
    "datasourceType": "postgres",
    "credentials": {
      "name": "production-postgres",
      "host": "new-db.example.com",
      "port": 5432,
      "username": "dbuser",
      "password": "newpassword",
      "database": "analytics",
      "schema": "public"
    }
  }'

{
  "name": "production-postgres"
}

curl --request PUT \
  --url https://api.usedatabrain.com/api/v2/datasource \
  --header 'Authorization: Bearer dbn_live_abc123...' \
  --header 'Content-Type: application/json' \
  --data '{
    "datasourceType": "postgres",
    "credentials": {
      "name": "production-postgres",
      "host": "new-db.example.com",
      "port": 5432,
      "username": "dbuser",
      "password": "newpassword",
      "database": "analytics",
      "schema": "public"
    }
  }'

{
  "name": "production-postgres"
}

PUT

https://api.usedatabrain.com

api

datasource

curl --request PUT \
  --url https://api.usedatabrain.com/api/v2/datasource \
  --header 'Authorization: Bearer dbn_live_abc123...' \
  --header 'Content-Type: application/json' \
  --data '{
    "datasourceType": "postgres",
    "credentials": {
      "name": "production-postgres",
      "host": "new-db.example.com",
      "port": 5432,
      "username": "dbuser",
      "password": "newpassword",
      "database": "analytics",
      "schema": "public"
    }
  }'

{
  "name": "production-postgres"
}

Update an existing datasource’s credentials or configuration. The API validates the new credentials, tests the connection, and automatically refreshes the cached schema.

You can only update datasources that already exist in your organization. The datasource is identified by the name field in the credentials. After updating, the schema will be automatically re-cached.

Endpoint

PUT https://api.usedatabrain.com/api/v2/datasource

Self-hosted Databrain Endpoint

PUT <SELF_HOSTED_URL>/api/v2/datasource

Authentication

This endpoint requires a service token in the Authorization header. Service tokens differ from data app API keys and provide organization-level permissions. To access your service token:

Go to your Databrain dashboard and open Settings.
Navigate to Settings.
Find the Service Tokens section.
Click the “Generate Token” button to generate a new service token if you don’t have one already.
Use this token as the Bearer value in your Authorization header.

Headers

Authorization

string

required

Bearer token for API authentication. Use your API key from the data app.

Authorization: Bearer dbn_live_abc123...

Content-Type

string

required

Must be set to application/json for all requests.

Content-Type: application/json

Request Body

datasourceType

string

required

The type of datasource. Must match the existing datasource type. See Create Datasource for supported types.

credentials

object

required

Updated connection credentials for the datasource. Must include the name field matching the existing datasource name.

The credentials.name field must match the exact name of the existing datasource you want to update. This name is used to identify which datasource to update.

credentials.name

string

required

The name of the existing datasource to update. Must match exactly as it was created.

Show Finding datasource names

Use the List Datasources API to see all datasource names
Check the response from datasource creation
Available in the DataBrain dashboard when viewing datasources

tenancySettings

object

Multi-tenant configuration for the datasource. Defines how data is isolated between different tenants/clients. Optional - if not provided, existing tenancy settings will remain unchanged.

Show Tenancy configuration details

TABLE level: Uses a dedicated table to map client identifiers
DATABASE level: Each client has a separate database
If the datasource doesn’t have existing tenancy settings, new settings will be created
If tenancy settings already exist, they will be updated with the new values

tenancySettings.tenancyLevel

string

The level at which tenant isolation occurs. Must be one of: TABLE or DATABASE.

TABLE: Client mapping is stored in a specific table (most common)
DATABASE: Each client has a separate database instance

Required when tenancySettings is provided. If tenancySettings is omitted, this field is not needed.

tenancySettings.clientColumnType

string

Data type of the client identifier column. Must be either NUMBER or STRING.Required when tenancyLevel is TABLE.

tenancySettings.schemaName

string

Schema name where the client mapping table is located.Required when tenancyLevel is TABLE.

tenancySettings.tableName

string

Name of the table that contains client mapping information.Required when tenancyLevel is TABLE.

tenancySettings.tableClientNameColumn

string

Column name in the mapping table that stores the client identifier.Required when tenancyLevel is TABLE.

tenancySettings.tablePrimaryKeyColumn

string

Primary key column of the client mapping table.Required when tenancyLevel is TABLE.

Datasource-Specific Credentials

The credentials structure is the same as in Create Datasource. You must provide all required fields for the datasource type, even if only some values are changing.

When updating credentials, you must provide all required fields for the datasource type. Partial updates are not supported - provide the complete credential structure.

Response

name

string

The name of the updated datasource (same as credentials.name).

error

null

Error field, null when successful. Not included in successful responses.

Examples

Error Codes

Error Code	HTTP Status	Description
`INVALID_REQUEST_BODY`	400	Missing required fields or invalid credential structure
`DATASOURCE_NAME_ERROR`	400	Datasource not found
`CREDENTIAL_TEST_FAILED`	400	Connection test failed
`AUTHENTICATION_ERROR`	401	Invalid or missing service token
`SCHEMA_CACHE_FAILED`	500	Schema caching failed
`DATASOURCE_NOT_FOUND`	404	The specified datasource does not exist
`TENANCY_SETTINGS_CREATE_FAILED`	500	Failed to create tenancy settings for the datasource
`TENANCY_SETTINGS_UPDATE_FAILED`	500	Failed to update existing tenancy settings
`INTERNAL_SERVER_ERROR`	500	Server error occurred

Next Steps

List Datasources

View all datasources to verify the update

Sync Datasource

Manually sync the datasource schema if needed

Create Datasource

Create a new datasource instead of updating

Delete Datasource

Remove a datasource you no longer need

List Datasources

Delete Datasource

⌘I

Authentication

Datasource APIs

Datamart APIs

Workspace APIs

Embeds

Embedding APIs (Legacy)

Data App APIs

Metric APIs

Endpoint

Self-hosted Databrain Endpoint

Authentication

Headers

Request Body

Datasource-Specific Credentials

Response

Examples

Error Codes

Next Steps

List Datasources

Sync Datasource

Create Datasource

Delete Datasource

Authentication

Datasource APIs

Datamart APIs

Workspace APIs

Embeds

Embedding APIs (Legacy)

Data App APIs

Metric APIs

​Endpoint

​Self-hosted Databrain Endpoint

​Authentication

​Headers

​Request Body

​Datasource-Specific Credentials

​Response

​Examples

​Error Codes

​Next Steps

List Datasources

Sync Datasource

Create Datasource

Delete Datasource

Endpoint

Self-hosted Databrain Endpoint

Authentication

Headers

Request Body

Datasource-Specific Credentials

Response

Examples

Error Codes

Next Steps