Data Sources

Create one or more Data Sources

post

Creates one or multiple data sources with provided metadata and configuration

Authorizations
AuthorizationstringRequired

Insert the JWT token here

Body
or
Responses
post
/api/public/v1/data-sources

Get Data Source by ID

get

Returns metadata and configuration for a single data source by its ID

Authorizations
AuthorizationstringRequired

Insert the JWT token here

Path parameters
idstringRequired

Data Source ID

Responses
chevron-right
200

Default Response

application/json
statusintegerRequired

HTTP status code

Example: 200
get
/api/public/v1/data-sources/{id}

Update Data Source Attributes

patch

Update attributes of a data source connection.

🚨 Note:

  • Only the specified fields will be affected — other attributes remain untouched.

  • Scalar fields (e.g. description, host, port) will overwrite the current value.

  • Array-type fields (e.g. includePatterns, excludePatterns) will fully replace existing values if provided.

Authorizations
AuthorizationstringRequired

Insert the JWT token here

Path parameters
idstringRequired

Data Source ID

Body
userNamestringOptional

User name

passwordstringOptional

Password

lastTestConnectionIdstringOptional

Last test connection ID

lastIngestIdstringOptional

Last ingest ID

accessIdstringOptional

Access ID

secretKeystringOptional

Secret key

regionstringOptional

AWS region

secretManagerKeystringOptional

Secret manager key

accountNamestringOptional

Account name

azureSharedKeystringOptional

Azure shared key

azureTenantIdstringOptional

Azure tenant ID

notestringOptional

Note

descriptionstringOptional

Description

affinityIdstringOptional

Affinity ID

rolestringOptional

Role

hoststringOptional

Host

portstringOptional

Port

databaseNamestringOptional

Database name

warehousestringOptional

Warehouse

availableForMigrationbooleanOptional

Available for migration

availableForWritingbooleanOptional

Available for writing

availableForDataMasteringbooleanOptional

Available for data mastering

totalCapacitynumberOptional

Total capacity

driverClassNamestringOptional

Driver class name

includePatternsstring[]Optional

Include patterns - Resources matching these patterns

excludePatternsstring[]Optional

Exclude patterns - Resources matching these patterns

scanSinceTimeframestringOptional

Scan since timeframe

incrementalbooleanOptional

Enable incremental scanning

uristringOptional

URI

pathstringOptional

Path

Responses
chevron-right
200

Default Response

application/json
statusintegerRequired

HTTP status code

Example: 200
patch
/api/public/v1/data-sources/{id}

Get Data Sources by IDs

post

Returns an array of metadata and configuration for multiple data sources by their IDs

Authorizations
AuthorizationstringRequired

Insert the JWT token here

Body
idsstring[] · min: 1Required

List of data source IDs

Responses
chevron-right
200

Default Response

application/json
statusintegerRequired

HTTP status code

Example: 200
post
/api/public/v1/data-sources/by-ids

Filter Data Sources

post

Returns array of data sources filtered by criteria with pagination support.

Wildcard Support: The resourceNames and databaseTypes filters support wildcard patterns using *.

  • Exact match: my-db

  • Prefix search: prod-*

  • Suffix search: *-primary

  • Contains: *postgres*

Authorizations
AuthorizationstringRequired

Insert the JWT token here

Query parameters
skipintegerOptional

Number of documents to skip

Default: 0
limitinteger · min: 1 · max: 10000Optional

Maximum number of documents to return (max 10000)

Default: 100
Body

At least one filter must be provided

Responses
chevron-right
200

Default Response

application/json
statusintegerRequired

HTTP status code

Example: 200
post
/api/public/v1/data-sources/filter

Last updated

Was this helpful?