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

201

Default Response

application/json

statusintegerRequiredExample: 201

207

Default Response

application/json

400

Bad Request

application/json

401

Unauthorized - The request requires a valid Bearer token.

	To access this endpoint:

    1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.
    2. Click the "Authorize" button in the Swagger UI and enter the token.
    3. All protected endpoints require the Authorization header: "Authorization: 'Bearer your-access-token'"

application/json

500

Internal Server Error

application/json

503

Service Unavailable — Connection Refused

application/json

post/api/public/v1/data-sources

POST /api/public/v1/data-sources HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 567

{
  "resourceName": "Apache Iceberg Data Catalog - S3",
  "fqdnId": "Apache Iceberg Data Catalog - S3",
  "databaseType": "APACHE_ICEBERG",
  "description": "Apache Iceberg table format with S3-compatible storage",
  "location": {
    "country": "US"
  },
  "affinityId": "DEFAULT",
  "configMethod": "uri",
  "uri": "http://iceberg-catalog.company.com:8181",
  "warehouse": "s3",
  "region": "us-east-1",
  "endpoint": "http://s3-compatible-warehouse.company.com:9000",
  "accessId": "warehouse_access_id",
  "secretKey": "warehouse_secret_key",
  "path": "true",
  "totalCapacity": null,
  "costPerTb": {
    "price": null,
    "frequency": "month"
  }
}

{
  "status": 201,
  "data": [
    {
      "_id": "text",
      "pId": 1,
      "databaseName": "text",
      "owners": [
        {}
      ],
      "jobClasspath": "text",
      "driverClassName": "text",
      "resourceName": "text",
      "resourceId": "text",
      "fqdnId": "text",
      "configMethod": "text",
      "host": "text",
      "lastTestConnectionId": "text",
      "lastIngestId": "text",
      "affinityId": "text",
      "port": "text",
      "uri": "text",
      "databaseType": "text",
      "spiVersion": "text",
      "serviceType": "text",
      "description": "text",
      "status": "text",
      "users": [
        "text"
      ],
      "userName": "text",
      "password": "text",
      "encryptedPassword": "text",
      "note": "text",
      "oauthClientId": "text",
      "oauthClientSecret": "text",
      "hdfsCredType": "text",
      "endpoint": "text",
      "accessKey": "text",
      "container": "text",
      "accessId": "text",
      "secretKey": "text",
      "secretManagerKey": "text",
      "totalCapacity": 1,
      "project": "text",
      "oAuthType": 0,
      "keyPath": "text",
      "clientEmail": "text",
      "warehouse": "text",
      "noAuth": true,
      "defaultEndpointsProtocol": "text",
      "schemaNames": [
        "text"
      ],
      "includePatterns": [
        "text"
      ],
      "excludePatterns": [
        "text"
      ],
      "includeSchemaPatterns": [
        "text"
      ],
      "excludeSchemaPatterns": [
        "text"
      ],
      "includeTablePatterns": [
        "text"
      ],
      "excludeTablePatterns": [
        "text"
      ],
      "deleteEmptyFolders": true,
      "region": "text",
      "accountNumber": "text",
      "iamUsername": "text",
      "accessKeyID": "text",
      "secretAccessKey": "text",
      "assumeRole": "text",
      "role": "text",
      "externalID": "text",
      "sslType": "encryptionOnly",
      "trustStoreType": "text",
      "trustStoreLocation": "text",
      "trustStorePassword": "text",
      "keyStoreType": "text",
      "keyStoreLocation": "text",
      "keyStorePassword": "text",
      "cipherSuite": "text",
      "serverDistinguishedName": "text",
      "connectionType": "text",
      "fileSystemType": "text",
      "path": "text",
      "followSymLinks": "text",
      "domain": "text",
      "shareName": "text",
      "accountName": "text",
      "azureCredType": "text",
      "azureSharedKey": "text",
      "azureTenantId": "text",
      "availableForMigration": true,
      "enabledForMigration": true,
      "availableForWriting": true,
      "availableForDataMastering": true,
      "costPerTb": {
        "price": 1,
        "currency": "text",
        "frequency": "month"
      },
      "location": {
        "name": "text",
        "street_address": "text",
        "street_address_2": "text",
        "locality_city": "text",
        "state_province": "text",
        "postal_code": "text",
        "country": "text"
      },
      "userId": "123e4567-e89b-12d3-a456-426614174000",
      "date": "2026-01-01T00:00:00.000Z"
    }
  ]
}

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

200

Default Response

application/json

statusintegerRequired

HTTP status code

Example: 200

400

Bad Request

application/json

401

Unauthorized - The request requires a valid Bearer token.

	To access this endpoint:

    1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.
    2. Click the "Authorize" button in the Swagger UI and enter the token.
    3. All protected endpoints require the Authorization header: "Authorization: 'Bearer your-access-token'"

application/json

500

Internal Server Error

application/json

503

Service Unavailable — Connection Refused

application/json

get/api/public/v1/data-sources/{id}

GET /api/public/v1/data-sources/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": 200,
  "data": {
    "_id": "text",
    "pId": 1,
    "databaseName": "text",
    "owners": [
      {}
    ],
    "jobClasspath": "text",
    "driverClassName": "text",
    "resourceName": "text",
    "resourceId": "text",
    "fqdnId": "text",
    "configMethod": "text",
    "host": "text",
    "lastTestConnectionId": "text",
    "lastIngestId": "text",
    "affinityId": "text",
    "port": "text",
    "uri": "text",
    "databaseType": "text",
    "spiVersion": "text",
    "serviceType": "text",
    "description": "text",
    "status": "text",
    "users": [
      "text"
    ],
    "userName": "text",
    "password": "text",
    "encryptedPassword": "text",
    "note": "text",
    "oauthClientId": "text",
    "oauthClientSecret": "text",
    "hdfsCredType": "text",
    "endpoint": "text",
    "accessKey": "text",
    "container": "text",
    "accessId": "text",
    "secretKey": "text",
    "secretManagerKey": "text",
    "totalCapacity": 1,
    "project": "text",
    "oAuthType": 0,
    "keyPath": "text",
    "clientEmail": "text",
    "warehouse": "text",
    "noAuth": true,
    "defaultEndpointsProtocol": "text",
    "schemaNames": [
      "text"
    ],
    "includePatterns": [
      "text"
    ],
    "excludePatterns": [
      "text"
    ],
    "includeSchemaPatterns": [
      "text"
    ],
    "excludeSchemaPatterns": [
      "text"
    ],
    "includeTablePatterns": [
      "text"
    ],
    "excludeTablePatterns": [
      "text"
    ],
    "deleteEmptyFolders": true,
    "region": "text",
    "accountNumber": "text",
    "iamUsername": "text",
    "accessKeyID": "text",
    "secretAccessKey": "text",
    "assumeRole": "text",
    "role": "text",
    "externalID": "text",
    "sslType": "encryptionOnly",
    "trustStoreType": "text",
    "trustStoreLocation": "text",
    "trustStorePassword": "text",
    "keyStoreType": "text",
    "keyStoreLocation": "text",
    "keyStorePassword": "text",
    "cipherSuite": "text",
    "serverDistinguishedName": "text",
    "connectionType": "text",
    "fileSystemType": "text",
    "path": "text",
    "followSymLinks": "text",
    "domain": "text",
    "shareName": "text",
    "accountName": "text",
    "azureCredType": "text",
    "azureSharedKey": "text",
    "azureTenantId": "text",
    "availableForMigration": true,
    "enabledForMigration": true,
    "availableForWriting": true,
    "availableForDataMastering": true,
    "costPerTb": {
      "price": 1,
      "currency": "text",
      "frequency": "month"
    },
    "location": {
      "name": "text",
      "street_address": "text",
      "street_address_2": "text",
      "locality_city": "text",
      "state_province": "text",
      "postal_code": "text",
      "country": "text"
    },
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "date": "2026-01-01T00:00:00.000Z"
  }
}

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

200

Default Response

application/json

statusintegerRequired

HTTP status code

Example: 200

400

Bad Request

application/json

401

Unauthorized - The request requires a valid Bearer token.

	To access this endpoint:

    1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.
    2. Click the "Authorize" button in the Swagger UI and enter the token.
    3. All protected endpoints require the Authorization header: "Authorization: 'Bearer your-access-token'"

application/json

500

Internal Server Error

application/json

503

Service Unavailable — Connection Refused

application/json

patch/api/public/v1/data-sources/{id}

PATCH /api/public/v1/data-sources/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "host": "new-db-host.example.com",
  "port": "5433"
}

{
  "status": 200,
  "data": {
    "_id": "text",
    "pId": 1,
    "databaseName": "text",
    "owners": [
      {}
    ],
    "jobClasspath": "text",
    "driverClassName": "text",
    "resourceName": "text",
    "resourceId": "text",
    "fqdnId": "text",
    "configMethod": "text",
    "host": "text",
    "lastTestConnectionId": "text",
    "lastIngestId": "text",
    "affinityId": "text",
    "port": "text",
    "uri": "text",
    "databaseType": "text",
    "spiVersion": "text",
    "serviceType": "text",
    "description": "text",
    "status": "text",
    "users": [
      "text"
    ],
    "userName": "text",
    "password": "text",
    "encryptedPassword": "text",
    "note": "text",
    "oauthClientId": "text",
    "oauthClientSecret": "text",
    "hdfsCredType": "text",
    "endpoint": "text",
    "accessKey": "text",
    "container": "text",
    "accessId": "text",
    "secretKey": "text",
    "secretManagerKey": "text",
    "totalCapacity": 1,
    "project": "text",
    "oAuthType": 0,
    "keyPath": "text",
    "clientEmail": "text",
    "warehouse": "text",
    "noAuth": true,
    "defaultEndpointsProtocol": "text",
    "schemaNames": [
      "text"
    ],
    "includePatterns": [
      "text"
    ],
    "excludePatterns": [
      "text"
    ],
    "includeSchemaPatterns": [
      "text"
    ],
    "excludeSchemaPatterns": [
      "text"
    ],
    "includeTablePatterns": [
      "text"
    ],
    "excludeTablePatterns": [
      "text"
    ],
    "deleteEmptyFolders": true,
    "region": "text",
    "accountNumber": "text",
    "iamUsername": "text",
    "accessKeyID": "text",
    "secretAccessKey": "text",
    "assumeRole": "text",
    "role": "text",
    "externalID": "text",
    "sslType": "encryptionOnly",
    "trustStoreType": "text",
    "trustStoreLocation": "text",
    "trustStorePassword": "text",
    "keyStoreType": "text",
    "keyStoreLocation": "text",
    "keyStorePassword": "text",
    "cipherSuite": "text",
    "serverDistinguishedName": "text",
    "connectionType": "text",
    "fileSystemType": "text",
    "path": "text",
    "followSymLinks": "text",
    "domain": "text",
    "shareName": "text",
    "accountName": "text",
    "azureCredType": "text",
    "azureSharedKey": "text",
    "azureTenantId": "text",
    "availableForMigration": true,
    "enabledForMigration": true,
    "availableForWriting": true,
    "availableForDataMastering": true,
    "costPerTb": {
      "price": 1,
      "currency": "text",
      "frequency": "month"
    },
    "location": {
      "name": "text",
      "street_address": "text",
      "street_address_2": "text",
      "locality_city": "text",
      "state_province": "text",
      "postal_code": "text",
      "country": "text"
    },
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "date": "2026-01-01T00:00:00.000Z"
  }
}

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

200

Default Response

application/json

statusintegerRequired

HTTP status code

Example: 200

400

Bad Request

application/json

401

Unauthorized - The request requires a valid Bearer token.

	To access this endpoint:

    1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.
    2. Click the "Authorize" button in the Swagger UI and enter the token.
    3. All protected endpoints require the Authorization header: "Authorization: 'Bearer your-access-token'"

application/json

500

Internal Server Error

application/json

503

Service Unavailable — Connection Refused

application/json

post/api/public/v1/data-sources/by-ids

POST /api/public/v1/data-sources/by-ids HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "ids": [
    "text"
  ]
}

{
  "status": 200,
  "data": [
    {
      "_id": "text",
      "pId": 1,
      "databaseName": "text",
      "owners": [
        {}
      ],
      "jobClasspath": "text",
      "driverClassName": "text",
      "resourceName": "text",
      "resourceId": "text",
      "fqdnId": "text",
      "configMethod": "text",
      "host": "text",
      "lastTestConnectionId": "text",
      "lastIngestId": "text",
      "affinityId": "text",
      "port": "text",
      "uri": "text",
      "databaseType": "text",
      "spiVersion": "text",
      "serviceType": "text",
      "description": "text",
      "status": "text",
      "users": [
        "text"
      ],
      "userName": "text",
      "password": "text",
      "encryptedPassword": "text",
      "note": "text",
      "oauthClientId": "text",
      "oauthClientSecret": "text",
      "hdfsCredType": "text",
      "endpoint": "text",
      "accessKey": "text",
      "container": "text",
      "accessId": "text",
      "secretKey": "text",
      "secretManagerKey": "text",
      "totalCapacity": 1,
      "project": "text",
      "oAuthType": 0,
      "keyPath": "text",
      "clientEmail": "text",
      "warehouse": "text",
      "noAuth": true,
      "defaultEndpointsProtocol": "text",
      "schemaNames": [
        "text"
      ],
      "includePatterns": [
        "text"
      ],
      "excludePatterns": [
        "text"
      ],
      "includeSchemaPatterns": [
        "text"
      ],
      "excludeSchemaPatterns": [
        "text"
      ],
      "includeTablePatterns": [
        "text"
      ],
      "excludeTablePatterns": [
        "text"
      ],
      "deleteEmptyFolders": true,
      "region": "text",
      "accountNumber": "text",
      "iamUsername": "text",
      "accessKeyID": "text",
      "secretAccessKey": "text",
      "assumeRole": "text",
      "role": "text",
      "externalID": "text",
      "sslType": "encryptionOnly",
      "trustStoreType": "text",
      "trustStoreLocation": "text",
      "trustStorePassword": "text",
      "keyStoreType": "text",
      "keyStoreLocation": "text",
      "keyStorePassword": "text",
      "cipherSuite": "text",
      "serverDistinguishedName": "text",
      "connectionType": "text",
      "fileSystemType": "text",
      "path": "text",
      "followSymLinks": "text",
      "domain": "text",
      "shareName": "text",
      "accountName": "text",
      "azureCredType": "text",
      "azureSharedKey": "text",
      "azureTenantId": "text",
      "availableForMigration": true,
      "enabledForMigration": true,
      "availableForWriting": true,
      "availableForDataMastering": true,
      "costPerTb": {
        "price": 1,
        "currency": "text",
        "frequency": "month"
      },
      "location": {
        "name": "text",
        "street_address": "text",
        "street_address_2": "text",
        "locality_city": "text",
        "state_province": "text",
        "postal_code": "text",
        "country": "text"
      },
      "userId": "123e4567-e89b-12d3-a456-426614174000",
      "date": "2026-01-01T00:00:00.000Z"
    }
  ]
}

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

200

Default Response

application/json

statusintegerRequired

HTTP status code

Example: 200

400

Bad Request

application/json

401

Unauthorized - The request requires a valid Bearer token.

	To access this endpoint:

    1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.
    2. Click the "Authorize" button in the Swagger UI and enter the token.
    3. All protected endpoints require the Authorization header: "Authorization: 'Bearer your-access-token'"

application/json

500

Internal Server Error

application/json

503

Service Unavailable — Connection Refused

application/json

post/api/public/v1/data-sources/filter

POST /api/public/v1/data-sources/filter HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 75

{
  "filters": {
    "ids": [
      "64a1b2c3d4e5f6a7b8c9d0e1",
      "64a1b2c3d4e5f6a7b8c9d0e2"
    ]
  }
}

{
  "status": 200,
  "data": [
    {
      "_id": "text",
      "pId": 1,
      "databaseName": "text",
      "owners": [
        {}
      ],
      "jobClasspath": "text",
      "driverClassName": "text",
      "resourceName": "text",
      "resourceId": "text",
      "fqdnId": "text",
      "configMethod": "text",
      "host": "text",
      "lastTestConnectionId": "text",
      "lastIngestId": "text",
      "affinityId": "text",
      "port": "text",
      "uri": "text",
      "databaseType": "text",
      "spiVersion": "text",
      "serviceType": "text",
      "description": "text",
      "status": "text",
      "users": [
        "text"
      ],
      "userName": "text",
      "password": "text",
      "encryptedPassword": "text",
      "note": "text",
      "oauthClientId": "text",
      "oauthClientSecret": "text",
      "hdfsCredType": "text",
      "endpoint": "text",
      "accessKey": "text",
      "container": "text",
      "accessId": "text",
      "secretKey": "text",
      "secretManagerKey": "text",
      "totalCapacity": 1,
      "project": "text",
      "oAuthType": 0,
      "keyPath": "text",
      "clientEmail": "text",
      "warehouse": "text",
      "noAuth": true,
      "defaultEndpointsProtocol": "text",
      "schemaNames": [
        "text"
      ],
      "includePatterns": [
        "text"
      ],
      "excludePatterns": [
        "text"
      ],
      "includeSchemaPatterns": [
        "text"
      ],
      "excludeSchemaPatterns": [
        "text"
      ],
      "includeTablePatterns": [
        "text"
      ],
      "excludeTablePatterns": [
        "text"
      ],
      "deleteEmptyFolders": true,
      "region": "text",
      "accountNumber": "text",
      "iamUsername": "text",
      "accessKeyID": "text",
      "secretAccessKey": "text",
      "assumeRole": "text",
      "role": "text",
      "externalID": "text",
      "sslType": "encryptionOnly",
      "trustStoreType": "text",
      "trustStoreLocation": "text",
      "trustStorePassword": "text",
      "keyStoreType": "text",
      "keyStoreLocation": "text",
      "keyStorePassword": "text",
      "cipherSuite": "text",
      "serverDistinguishedName": "text",
      "connectionType": "text",
      "fileSystemType": "text",
      "path": "text",
      "followSymLinks": "text",
      "domain": "text",
      "shareName": "text",
      "accountName": "text",
      "azureCredType": "text",
      "azureSharedKey": "text",
      "azureTenantId": "text",
      "availableForMigration": true,
      "enabledForMigration": true,
      "availableForWriting": true,
      "availableForDataMastering": true,
      "costPerTb": {
        "price": 1,
        "currency": "text",
        "frequency": "month"
      },
      "location": {
        "name": "text",
        "street_address": "text",
        "street_address_2": "text",
        "locality_city": "text",
        "state_province": "text",
        "postal_code": "text",
        "country": "text"
      },
      "userId": "123e4567-e89b-12d3-a456-426614174000",
      "date": "2026-01-01T00:00:00.000Z"
    }
  ],
  "pageInfo": {
    "skip": 0,
    "limit": 100,
    "totalCount": 150
  }
}