Data Sources

Create one or more Data Sources

post

Creates one or multiple data sources with provided metadata and configuration

Authorizations

bearerAuth

AuthorizationstringRequired

Insert the JWT token here

Body

application/json

one ofOptional

or

Responses

201

Default Response

application/json

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

HTTPcURLJavaScriptPython

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

{
  "resourceName": "AWS S3 Data Lake",
  "fqdnId": "AWS S3 Data Lake",
  "description": "AWS S3 bucket for data lake storage",
  "databaseType": "AWS",
  "location": {
    "country": "US"
  },
  "affinityId": "DEFAULT",
  "region": "us-east-1",
  "container": "company-datalake-bucket",
  "accessId": "AKIAIOSFODNN7EXAMPLE",
  "secretKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
  "path": "/data/warehouse",
  "totalCapacity": null,
  "costPerTb": {
    "price": null,
    "frequency": "month"
  }
}

AWS S3 - CredentialsAWS S3 - Secret ManagerAmazon DynamoDB - CredentialsAmazon Redshift - CredentialsAmazon Redshift - URIAmazon Redshift - Secret ManagerAzure Blob Storage - Shared KeyGoogle BigQuery - Service AccountIBM DB2 - CredentialsFile System - LocalGoogle Cloud Storage - Service AccountHadoop HDFS - URIInfluxDB - CredentialsMariaDB - CredentialsMicrosoft SQL Server - CredentialsMicrosoft SQL Server - URIMicrosoft SQL Server - Secret ManagerMySQL - CredentialsMySQL - URIMySQL - Secret ManagerMultiple Data Sources - Batch CreationNFS - URIMicrosoft OneDrive - OAuthOracle Database - CredentialsOracle Database - URIOracle Database - SSL EncryptionOracle Database - SSL Encryption with AuthenticationPostgreSQL - CredentialsPostgreSQL - URIPostgreSQL - Secret ManagerSalesforce CRM - CredentialsSAP HANA - CredentialsSMB/CIFS - URISnowflake - CredentialsVertica - Credentials

{
  "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",
      "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": "2025-12-06T19:12:10.575Z"
    }
  ]
}

Get Data Source by ID

get

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

Authorizations

bearerAuth

AuthorizationstringRequired

Insert the JWT token here

Path parameters

idstringRequired

Data Source ID

Responses

200

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

get

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

HTTPcURLJavaScriptPython

GET /api/public/v1/data-sources/{id} HTTP/1.1
Host: hostname
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",
    "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": "2025-12-06T19:12:10.575Z"
  }
}

Get Data Sources by IDs

post

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

Authorizations

bearerAuth

AuthorizationstringRequired

Insert the JWT token here

Body

application/json

idsstring[] · min: 1Required

List of data source IDs

Responses

200

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/by-ids

HTTPcURLJavaScriptPython

POST /api/public/v1/data-sources/by-ids HTTP/1.1
Host: hostname
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",
      "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": "2025-12-06T19:12:10.575Z"
    }
  ]
}