List data sources

GET 
/api/v1/data_sources

List data sources

Request

Responses

200

Successful Response

application/json

Schema

Schema

• Array [
oneOf

ApiDataSourceBigQuery

catalog_exclude_list Catalog Exclude List

catalog_include_list Catalog Include List

created_from Created From

data_retention_days Data Retention Days

disable_profiling Disable Profiling

Default value: false

disable_schema_indexing Disable Schema Indexing

Default value: false

float_tolerance Float Tolerance

groups object

property name* boolean

hidden Hidden

Default value: false

id Id

is_paused Is Paused

Default value: false

last_test object

results object[]required

Array [

result Result

status JobStatusrequired

Possible values: [needs_confirmation, needs_authentication, waiting, processing, done, failed, cancelled]

An enumeration.

step ConfigurationCheckSteprequired

Possible values: [connection, temp_schema, schema_download, lineage_download]

An enumeration.

]

tested_at date-timerequired

lineage_schedule Lineage Schedule

max_allowed_connections Max Allowed Connections

name Namerequired

oauth_dwh_active Oauth Dwh Active

options object

extraProjectsToIndex List of extra projects to index (one per line)

location Processing Location

Default value: US

projectId Project IDrequired

totalMBytesProcessedLimit Scanned Data Limit (MB)

useStandardSql Use Standard SQL

Default value: true

userDefinedFunctionResourceUri UDF Source URIs

profile_exclude_list Profile Exclude List

profile_include_list Profile Include List

profile_schedule Profile Schedule

queue_name Queue Name

scheduled_queue_name Scheduled Queue Name

schema_indexing_schedule Schema Indexing Schedule

schema_max_age_s Schema Max Age S

secret_id Secret Id

source Source

temp_schema Temp Schema

type Typerequired

Possible values: [bigquery]

view_only View Only

Default value: false

ApiDataSourceDatabricks

catalog_exclude_list Catalog Exclude List

catalog_include_list Catalog Include List

created_from Created From

data_retention_days Data Retention Days

disable_profiling Disable Profiling

Default value: false

disable_schema_indexing Disable Schema Indexing

Default value: false

float_tolerance Float Tolerance

groups object

property name* boolean

hidden Hidden

Default value: false

id Id

is_paused Is Paused

Default value: false

last_test object

results object[]required

Array [

result Result

status JobStatusrequired

Possible values: [needs_confirmation, needs_authentication, waiting, processing, done, failed, cancelled]

An enumeration.

step ConfigurationCheckSteprequired

Possible values: [connection, temp_schema, schema_download, lineage_download]

An enumeration.

]

tested_at date-timerequired

lineage_schedule Lineage Schedule

max_allowed_connections Max Allowed Connections

name Namerequired

oauth_dwh_active Oauth Dwh Active

options object

database Database

host Hostrequired

Possible values: <= 128 characters

http_path HTTP Path

oauth_dwh_client_id Oauth Dwh Client Id

profile_exclude_list Profile Exclude List

profile_include_list Profile Include List

profile_schedule Profile Schedule

queue_name Queue Name

scheduled_queue_name Scheduled Queue Name

schema_indexing_schedule Schema Indexing Schedule

schema_max_age_s Schema Max Age S

secret_id Secret Id

source Source

temp_schema Temp Schema

type Typerequired

Possible values: [databricks]

view_only View Only

Default value: false

ApiDataSourceMySQL

catalog_exclude_list Catalog Exclude List

catalog_include_list Catalog Include List

created_from Created From

data_retention_days Data Retention Days

disable_profiling Disable Profiling

Default value: false

disable_schema_indexing Disable Schema Indexing

Default value: false

float_tolerance Float Tolerance

groups object

property name* boolean

hidden Hidden

Default value: false

id Id

is_paused Is Paused

Default value: false

last_test object

results object[]required

Array [

result Result

status JobStatusrequired

Possible values: [needs_confirmation, needs_authentication, waiting, processing, done, failed, cancelled]

An enumeration.

step ConfigurationCheckSteprequired

Possible values: [connection, temp_schema, schema_download, lineage_download]

An enumeration.

]

tested_at date-timerequired

lineage_schedule Lineage Schedule

max_allowed_connections Max Allowed Connections

name Namerequired

oauth_dwh_active Oauth Dwh Active

options object

db Database namerequired

host Hostrequired

Possible values: <= 128 characters

port Port

Default value: 3306

user Userrequired

profile_exclude_list Profile Exclude List

profile_include_list Profile Include List

profile_schedule Profile Schedule

queue_name Queue Name

scheduled_queue_name Scheduled Queue Name

schema_indexing_schedule Schema Indexing Schedule

schema_max_age_s Schema Max Age S

secret_id Secret Id

source Source

temp_schema Temp Schema

type Typerequired

Possible values: [mysql]

view_only View Only

Default value: false

ApiDataSourceMSSQL

catalog_exclude_list Catalog Exclude List

catalog_include_list Catalog Include List

created_from Created From

data_retention_days Data Retention Days

disable_profiling Disable Profiling

Default value: false

disable_schema_indexing Disable Schema Indexing

Default value: false

float_tolerance Float Tolerance

groups object

property name* boolean

hidden Hidden

Default value: false

id Id

is_paused Is Paused

Default value: false

last_test object

results object[]required

Array [

result Result

status JobStatusrequired

Possible values: [needs_confirmation, needs_authentication, waiting, processing, done, failed, cancelled]

An enumeration.

step ConfigurationCheckSteprequired

Possible values: [connection, temp_schema, schema_download, lineage_download]

An enumeration.

]

tested_at date-timerequired

lineage_schedule Lineage Schedule

max_allowed_connections Max Allowed Connections

name Namerequired

oauth_dwh_active Oauth Dwh Active

options object

dbname Dbname

host Hostrequired

Possible values: <= 128 characters

port Port

Default value: 1433

session_script Init script

The script to execute on connection; e.g. ALTER SESSION SET CONTAINER = ...

user User

Default value: DATAFOLD

profile_exclude_list Profile Exclude List

profile_include_list Profile Include List

profile_schedule Profile Schedule

queue_name Queue Name

scheduled_queue_name Scheduled Queue Name

schema_indexing_schedule Schema Indexing Schedule

schema_max_age_s Schema Max Age S

secret_id Secret Id

source Source

temp_schema Temp Schema

type Typerequired

Possible values: [mssql]

view_only View Only

Default value: false

ApiDataSourceOracle

catalog_exclude_list Catalog Exclude List

catalog_include_list Catalog Include List

created_from Created From

data_retention_days Data Retention Days

disable_profiling Disable Profiling

Default value: false

disable_schema_indexing Disable Schema Indexing

Default value: false

float_tolerance Float Tolerance

groups object

property name* boolean

hidden Hidden

Default value: false

id Id

is_paused Is Paused

Default value: false

last_test object

results object[]required

Array [

result Result

status JobStatusrequired

Possible values: [needs_confirmation, needs_authentication, waiting, processing, done, failed, cancelled]

An enumeration.

step ConfigurationCheckSteprequired

Possible values: [connection, temp_schema, schema_download, lineage_download]

An enumeration.

]

tested_at date-timerequired

lineage_schedule Lineage Schedule

max_allowed_connections Max Allowed Connections

name Namerequired

oauth_dwh_active Oauth Dwh Active

options object

database Database

database_type Database Type

Possible values: [service, sid]

ewallet_type Ewallet Type

Possible values: [x509, pkcs12]

host Hostrequired

Possible values: <= 128 characters

port Port

session_script Init script

The script to execute on connection; e.g. ALTER SESSION SET CONTAINER = ...

ssl Ssl

Default value: false

ssl_server_dn Server's SSL DN

e.g. C=US,O=example,CN=db.example.com; default: CN=

user User

Default value: DATAFOLD

profile_exclude_list Profile Exclude List

profile_include_list Profile Include List

profile_schedule Profile Schedule

queue_name Queue Name

scheduled_queue_name Scheduled Queue Name

schema_indexing_schedule Schema Indexing Schedule

schema_max_age_s Schema Max Age S

secret_id Secret Id

source Source

temp_schema Temp Schema

type Typerequired

Possible values: [oracle]

view_only View Only

Default value: false

ApiDataSourcePostgres

catalog_exclude_list Catalog Exclude List

catalog_include_list Catalog Include List

created_from Created From

data_retention_days Data Retention Days

disable_profiling Disable Profiling

Default value: false

disable_schema_indexing Disable Schema Indexing

Default value: false

float_tolerance Float Tolerance

groups object

property name* boolean

hidden Hidden

Default value: false

id Id

is_paused Is Paused

Default value: false

last_test object

results object[]required

Array [

result Result

status JobStatusrequired

Possible values: [needs_confirmation, needs_authentication, waiting, processing, done, failed, cancelled]

An enumeration.

step ConfigurationCheckSteprequired

Possible values: [connection, temp_schema, schema_download, lineage_download]

An enumeration.

]

tested_at date-timerequired

lineage_schedule Lineage Schedule

max_allowed_connections Max Allowed Connections

name Namerequired

oauth_dwh_active Oauth Dwh Active

options object

dbname Database Namerequired

host Hostrequired

Possible values: <= 128 characters

port Port

Default value: 5432

role Role (case sensitive)

sslmode SSL Mode

Default value: prefer

user Userrequired

profile_exclude_list Profile Exclude List

profile_include_list Profile Include List

profile_schedule Profile Schedule

queue_name Queue Name

scheduled_queue_name Scheduled Queue Name

schema_indexing_schedule Schema Indexing Schedule

schema_max_age_s Schema Max Age S

secret_id Secret Id

source Source

temp_schema Temp Schema

type Typerequired

Possible values: [pg]

view_only View Only

Default value: false

ApiDataSourcePostgresAurora

catalog_exclude_list Catalog Exclude List

catalog_include_list Catalog Include List

created_from Created From

data_retention_days Data Retention Days

disable_profiling Disable Profiling

Default value: false

disable_schema_indexing Disable Schema Indexing

Default value: false

float_tolerance Float Tolerance

groups object

property name* boolean

hidden Hidden

Default value: false

id Id

is_paused Is Paused

Default value: false

last_test object

results object[]required

Array [

result Result

status JobStatusrequired

Possible values: [needs_confirmation, needs_authentication, waiting, processing, done, failed, cancelled]

An enumeration.

step ConfigurationCheckSteprequired

Possible values: [connection, temp_schema, schema_download, lineage_download]

An enumeration.

]

tested_at date-timerequired

lineage_schedule Lineage Schedule

max_allowed_connections Max Allowed Connections

name Namerequired

oauth_dwh_active Oauth Dwh Active

options object

aws_access_key_id AWS Access Key

aws_cloudwatch_log_group Cloudwatch Postgres Log Group

aws_region AWS Region

dbname Database Namerequired

host Hostrequired

Possible values: <= 128 characters

keep_alive Keep Alive timeout in seconds, leave empty to disable

port Port

Default value: 5432

role Role (case sensitive)

sslmode SSL Mode

Default value: prefer

user Userrequired

profile_exclude_list Profile Exclude List

profile_include_list Profile Include List

profile_schedule Profile Schedule

queue_name Queue Name

scheduled_queue_name Scheduled Queue Name

schema_indexing_schedule Schema Indexing Schedule

schema_max_age_s Schema Max Age S

secret_id Secret Id

source Source

temp_schema Temp Schema

type Typerequired

Possible values: [postgres_aurora]

view_only View Only

Default value: false

ApiDataSourcePostgresRds

catalog_exclude_list Catalog Exclude List

catalog_include_list Catalog Include List

created_from Created From

data_retention_days Data Retention Days

disable_profiling Disable Profiling

Default value: false

disable_schema_indexing Disable Schema Indexing

Default value: false

float_tolerance Float Tolerance

groups object

property name* boolean

hidden Hidden

Default value: false

id Id

is_paused Is Paused

Default value: false

last_test object

results object[]required

Array [

result Result

status JobStatusrequired

Possible values: [needs_confirmation, needs_authentication, waiting, processing, done, failed, cancelled]

An enumeration.

step ConfigurationCheckSteprequired

Possible values: [connection, temp_schema, schema_download, lineage_download]

An enumeration.

]

tested_at date-timerequired

lineage_schedule Lineage Schedule

max_allowed_connections Max Allowed Connections

name Namerequired

oauth_dwh_active Oauth Dwh Active

options object

aws_access_key_id AWS Access Key

aws_cloudwatch_log_group Cloudwatch Postgres Log Group

aws_region AWS Region

dbname Database Namerequired

host Hostrequired

Possible values: <= 128 characters

keep_alive Keep Alive timeout in seconds, leave empty to disable

port Port

Default value: 5432

role Role (case sensitive)

sslmode SSL Mode

Default value: prefer

user Userrequired

profile_exclude_list Profile Exclude List

profile_include_list Profile Include List

profile_schedule Profile Schedule

queue_name Queue Name

scheduled_queue_name Scheduled Queue Name

schema_indexing_schedule Schema Indexing Schedule

schema_max_age_s Schema Max Age S

secret_id Secret Id

source Source

temp_schema Temp Schema

type Typerequired

Possible values: [postgres_aws_rds]

view_only View Only

Default value: false

ApiDataSourceRedshift

catalog_exclude_list Catalog Exclude List

catalog_include_list Catalog Include List

created_from Created From

data_retention_days Data Retention Days

disable_profiling Disable Profiling

Default value: false

disable_schema_indexing Disable Schema Indexing

Default value: false

float_tolerance Float Tolerance

groups object

property name* boolean

hidden Hidden

Default value: false

id Id

is_paused Is Paused

Default value: false

last_test object

results object[]required

Array [

result Result

status JobStatusrequired

Possible values: [needs_confirmation, needs_authentication, waiting, processing, done, failed, cancelled]

An enumeration.

step ConfigurationCheckSteprequired

Possible values: [connection, temp_schema, schema_download, lineage_download]

An enumeration.

]

tested_at date-timerequired

lineage_schedule Lineage Schedule

max_allowed_connections Max Allowed Connections

name Namerequired

oauth_dwh_active Oauth Dwh Active

options object

adhoc_query_group Query Group for Adhoc Queries

Default value: default

dbname Database Namerequired

host Hostrequired

Possible values: <= 128 characters

port Port

Default value: 5432

role Role (case sensitive)

scheduled_query_group Query Group for Scheduled Queries

Default value: default

sslmode SSL Mode

Default value: prefer

user Userrequired

profile_exclude_list Profile Exclude List

profile_include_list Profile Include List

profile_schedule Profile Schedule

queue_name Queue Name

scheduled_queue_name Scheduled Queue Name

schema_indexing_schedule Schema Indexing Schedule

schema_max_age_s Schema Max Age S

secret_id Secret Id

source Source

temp_schema Temp Schema

type Typerequired

Possible values: [redshift]

view_only View Only

Default value: false

ApiDataSourceTeradata

catalog_exclude_list Catalog Exclude List

catalog_include_list Catalog Include List

created_from Created From

data_retention_days Data Retention Days

disable_profiling Disable Profiling

Default value: false

disable_schema_indexing Disable Schema Indexing

Default value: false

float_tolerance Float Tolerance

groups object

property name* boolean

hidden Hidden

Default value: false

id Id

is_paused Is Paused

Default value: false

last_test object

results object[]required

Array [

result Result

status JobStatusrequired

Possible values: [needs_confirmation, needs_authentication, waiting, processing, done, failed, cancelled]

An enumeration.

step ConfigurationCheckSteprequired

Possible values: [connection, temp_schema, schema_download, lineage_download]

An enumeration.

]

tested_at date-timerequired

lineage_schedule Lineage Schedule

max_allowed_connections Max Allowed Connections

name Namerequired

oauth_dwh_active Oauth Dwh Active

options object

database Databaserequired

host Hostrequired

Possible values: <= 128 characters

port Port

user User

Default value: DATAFOLD

profile_exclude_list Profile Exclude List

profile_include_list Profile Include List

profile_schedule Profile Schedule

queue_name Queue Name

scheduled_queue_name Scheduled Queue Name

schema_indexing_schedule Schema Indexing Schedule

schema_max_age_s Schema Max Age S

secret_id Secret Id

source Source

temp_schema Temp Schema

type Typerequired

Possible values: [teradata]

view_only View Only

Default value: false

ApiDataSourceSapHana

catalog_exclude_list Catalog Exclude List

catalog_include_list Catalog Include List

created_from Created From

data_retention_days Data Retention Days

disable_profiling Disable Profiling

Default value: false

disable_schema_indexing Disable Schema Indexing

Default value: false

float_tolerance Float Tolerance

groups object

property name* boolean

hidden Hidden

Default value: false

id Id

is_paused Is Paused

Default value: false

last_test object

results object[]required

Array [

result Result

status JobStatusrequired

Possible values: [needs_confirmation, needs_authentication, waiting, processing, done, failed, cancelled]

An enumeration.

step ConfigurationCheckSteprequired

Possible values: [connection, temp_schema, schema_download, lineage_download]

An enumeration.

]

tested_at date-timerequired

lineage_schedule Lineage Schedule

max_allowed_connections Max Allowed Connections

name Namerequired

oauth_dwh_active Oauth Dwh Active

options object

host Hostrequired

Possible values: <= 128 characters

port Port

Default value: 443

user User

Default value: DATAFOLD

profile_exclude_list Profile Exclude List

profile_include_list Profile Include List

profile_schedule Profile Schedule

queue_name Queue Name

scheduled_queue_name Scheduled Queue Name

schema_indexing_schedule Schema Indexing Schedule

schema_max_age_s Schema Max Age S

secret_id Secret Id

source Source

temp_schema Temp Schema

type Typerequired

Possible values: [sap_hana]

view_only View Only

Default value: false

ApiDataSourceAwsAthena

catalog_exclude_list Catalog Exclude List

catalog_include_list Catalog Include List

created_from Created From

data_retention_days Data Retention Days

disable_profiling Disable Profiling

Default value: false

disable_schema_indexing Disable Schema Indexing

Default value: false

float_tolerance Float Tolerance

groups object

property name* boolean

hidden Hidden

Default value: false

id Id

is_paused Is Paused

Default value: false

last_test object

results object[]required

Array [

result Result

status JobStatusrequired

Possible values: [needs_confirmation, needs_authentication, waiting, processing, done, failed, cancelled]

An enumeration.

step ConfigurationCheckSteprequired

Possible values: [connection, temp_schema, schema_download, lineage_download]

An enumeration.

]

tested_at date-timerequired

lineage_schedule Lineage Schedule

max_allowed_connections Max Allowed Connections

name Namerequired

oauth_dwh_active Oauth Dwh Active

options object

aws_access_key_id Aws Access Key Idrequired

catalog Catalog

Default value: awsdatacatalog

database Database

Default value: default

region Regionrequired

s3_staging_dir urirequired

Possible values: non-empty and <= 65536 characters

profile_exclude_list Profile Exclude List

profile_include_list Profile Include List

profile_schedule Profile Schedule

queue_name Queue Name

scheduled_queue_name Scheduled Queue Name

schema_indexing_schedule Schema Indexing Schedule

schema_max_age_s Schema Max Age S

secret_id Secret Id

source Source

temp_schema Temp Schema

type Typerequired

Possible values: [athena]

view_only View Only

Default value: false

ApiDataSourceSnowflake

catalog_exclude_list Catalog Exclude List

catalog_include_list Catalog Include List

created_from Created From

data_retention_days Data Retention Days

disable_profiling Disable Profiling

Default value: false

disable_schema_indexing Disable Schema Indexing

Default value: false

float_tolerance Float Tolerance

groups object

property name* boolean

hidden Hidden

Default value: false

id Id

is_paused Is Paused

Default value: false

last_test object

results object[]required

Array [

result Result

status JobStatusrequired

Possible values: [needs_confirmation, needs_authentication, waiting, processing, done, failed, cancelled]

An enumeration.

step ConfigurationCheckSteprequired

Possible values: [connection, temp_schema, schema_download, lineage_download]

An enumeration.

]

tested_at date-timerequired

lineage_schedule Lineage Schedule

max_allowed_connections Max Allowed Connections

name Namerequired

oauth_dwh_active Oauth Dwh Active

options object

account Accountrequired

Possible values: <= 128 characters

authMethod Authmethod

Possible values: [password, keypair]

default_db Default DB (case sensitive)

default_schema Default schema (case sensitive)

Default value: PUBLIC

metadata_database Database containing metadata (usually SNOWFLAKE)

Default value: SNOWFLAKE

oauth_dwh_client_id Oauth Dwh Client Id

region Region

role Role (case sensitive)

sql_variables Session variables applied at every connection.

user User

Default value: DATAFOLD

warehouse Warehouse (case sensitive)

profile_exclude_list Profile Exclude List

profile_include_list Profile Include List

profile_schedule Profile Schedule

queue_name Queue Name

scheduled_queue_name Scheduled Queue Name

schema_indexing_schedule Schema Indexing Schedule

schema_max_age_s Schema Max Age S

secret_id Secret Id

source Source

temp_schema Temp Schema

type Typerequired

Possible values: [snowflake]

view_only View Only

Default value: false

ApiDataSourceDremio

catalog_exclude_list Catalog Exclude List

catalog_include_list Catalog Include List

created_from Created From

data_retention_days Data Retention Days

disable_profiling Disable Profiling

Default value: false

disable_schema_indexing Disable Schema Indexing

Default value: false

float_tolerance Float Tolerance

groups object

property name* boolean

hidden Hidden

Default value: false

id Id

is_paused Is Paused

Default value: false

last_test object

results object[]required

Array [

result Result

status JobStatusrequired

Possible values: [needs_confirmation, needs_authentication, waiting, processing, done, failed, cancelled]

An enumeration.

step ConfigurationCheckSteprequired

Possible values: [connection, temp_schema, schema_download, lineage_download]

An enumeration.

]

tested_at date-timerequired

lineage_schedule Lineage Schedule

max_allowed_connections Max Allowed Connections

name Namerequired

oauth_dwh_active Oauth Dwh Active

options object

host Hostrequired

Possible values: <= 128 characters

port Port

Default value: 443

project_id Project id

role Role (case sensitive)

tls Encryption

Default value: true

username User ID (optional)

view_temp_schema Temporary schema for views

profile_exclude_list Profile Exclude List

profile_include_list Profile Include List

profile_schedule Profile Schedule

queue_name Queue Name

scheduled_queue_name Scheduled Queue Name

schema_indexing_schedule Schema Indexing Schedule

schema_max_age_s Schema Max Age S

secret_id Secret Id

source Source

temp_schema Temp Schema

type Typerequired

Possible values: [dremio]

view_only View Only

Default value: false

ApiDataSourceStarburst

catalog_exclude_list Catalog Exclude List

catalog_include_list Catalog Include List

created_from Created From

data_retention_days Data Retention Days

disable_profiling Disable Profiling

Default value: false

disable_schema_indexing Disable Schema Indexing

Default value: false

float_tolerance Float Tolerance

groups object

property name* boolean

hidden Hidden

Default value: false

id Id

is_paused Is Paused

Default value: false

last_test object

results object[]required

Array [

result Result

status JobStatusrequired

Possible values: [needs_confirmation, needs_authentication, waiting, processing, done, failed, cancelled]

An enumeration.

step ConfigurationCheckSteprequired

Possible values: [connection, temp_schema, schema_download, lineage_download]

An enumeration.

]

tested_at date-timerequired

lineage_schedule Lineage Schedule

max_allowed_connections Max Allowed Connections

name Namerequired

oauth_dwh_active Oauth Dwh Active

options object

host Hostrequired

Possible values: <= 128 characters

port Port

Default value: 443

tls Encryption

Default value: true

username User ID (optional)

profile_exclude_list Profile Exclude List

profile_include_list Profile Include List

profile_schedule Profile Schedule

queue_name Queue Name

scheduled_queue_name Scheduled Queue Name

schema_indexing_schedule Schema Indexing Schedule

schema_max_age_s Schema Max Age S

secret_id Secret Id

source Source

temp_schema Temp Schema

type Typerequired

Possible values: [starburst]

view_only View Only

Default value: false

• ]

Example (from schema)

[
  {},
  {},
  {},
  {},
  {},
  {},
  {},
  {},
  {},
  {},
  {},
  {},
  {},
  {},
  {}
]

Loading...