Datafold Data sources API
The Data sources API from Datafold — 7 operation(s) for data sources.
The Data sources API from Datafold — 7 operation(s) for data sources.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/datafold-data-sources-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
contact:
email: support@datafold.com
name: API Support
description: "The Datafold API reference is a guide to our available endpoints and authentication methods.\nIf you're just getting started with Datafold, we recommend first checking out our [documentation](https://docs.datafold.com).\n\n:::info\n To use the Datafold API, you should first create a Datafold API Key,\n which should be stored as a local environment variable named DATAFOLD_API_KEY.\n This can be set in your Datafold Cloud's Settings under the Account page.\n:::"
title: Datafold Audit Logs Data sources API
version: latest
servers:
- description: Default server
url: https://app.datafold.com
security:
- ApiKeyAuth: []
tags:
- name: Data sources
paths:
/api/v1/data_sources:
get:
description: 'Retrieves all data sources for the organization, annotated with an `accessible` boolean.
Returns active data sources (not deleted, hidden, or draft). Each DS includes `accessible=True`
if the user is admin or the user''s groups overlap with the DS''s groups.'
operationId: list_data_sources_api_v1_data_sources_get
responses:
'200':
content:
application/json:
schema:
items:
discriminator:
mapping:
athena: '#/components/schemas/ApiDataSourceAwsAthena'
aws_s3: '#/components/schemas/ApiDataSourceS3'
azure_synapse: '#/components/schemas/ApiDataSourceAzureSynapse'
bigquery: '#/components/schemas/ApiDataSourceBigQuery'
databricks: '#/components/schemas/ApiDataSourceDatabricks'
db2: '#/components/schemas/ApiDataSourceDB2'
dremio: '#/components/schemas/ApiDataSourceDremio'
duckdb: '#/components/schemas/ApiDataSourceDuckDB'
files_azure_datalake: '#/components/schemas/ApiDataSourceAzureDataLake'
google_cloud_storage: '#/components/schemas/ApiDataSourceGCS'
mariadb: '#/components/schemas/ApiDataSourceMariaDB'
microsoft_fabric: '#/components/schemas/ApiDataSourceMicrosoftFabric'
mongodb: '#/components/schemas/ApiDataSourceMongoDB'
mssql: '#/components/schemas/ApiDataSourceMSSQL'
mysql: '#/components/schemas/ApiDataSourceMySQL'
netezza: '#/components/schemas/ApiDataSourceNetezza'
oracle: '#/components/schemas/ApiDataSourceOracle'
pg: '#/components/schemas/ApiDataSourcePostgres'
postgres_aurora: '#/components/schemas/ApiDataSourcePostgresAurora'
postgres_aws_rds: '#/components/schemas/ApiDataSourcePostgresRds'
redshift: '#/components/schemas/ApiDataSourceRedshift'
sap_hana: '#/components/schemas/ApiDataSourceSapHana'
snowflake: '#/components/schemas/ApiDataSourceSnowflake'
starburst: '#/components/schemas/ApiDataSourceStarburst'
teradata: '#/components/schemas/ApiDataSourceTeradata'
trino: '#/components/schemas/ApiDataSourceTrino'
vertica: '#/components/schemas/ApiDataSourceVertica'
propertyName: type
oneOf:
- $ref: '#/components/schemas/ApiDataSourceBigQuery'
- $ref: '#/components/schemas/ApiDataSourceDatabricks'
- $ref: '#/components/schemas/ApiDataSourceDuckDB'
- $ref: '#/components/schemas/ApiDataSourceMongoDB'
- $ref: '#/components/schemas/ApiDataSourceMySQL'
- $ref: '#/components/schemas/ApiDataSourceMariaDB'
- $ref: '#/components/schemas/ApiDataSourceMSSQL'
- $ref: '#/components/schemas/ApiDataSourceOracle'
- $ref: '#/components/schemas/ApiDataSourcePostgres'
- $ref: '#/components/schemas/ApiDataSourcePostgresAurora'
- $ref: '#/components/schemas/ApiDataSourcePostgresRds'
- $ref: '#/components/schemas/ApiDataSourceRedshift'
- $ref: '#/components/schemas/ApiDataSourceTeradata'
- $ref: '#/components/schemas/ApiDataSourceSapHana'
- $ref: '#/components/schemas/ApiDataSourceDB2'
- $ref: '#/components/schemas/ApiDataSourceAwsAthena'
- $ref: '#/components/schemas/ApiDataSourceSnowflake'
- $ref: '#/components/schemas/ApiDataSourceDremio'
- $ref: '#/components/schemas/ApiDataSourceStarburst'
- $ref: '#/components/schemas/ApiDataSourceNetezza'
- $ref: '#/components/schemas/ApiDataSourceAzureDataLake'
- $ref: '#/components/schemas/ApiDataSourceGCS'
- $ref: '#/components/schemas/ApiDataSourceS3'
- $ref: '#/components/schemas/ApiDataSourceAzureSynapse'
- $ref: '#/components/schemas/ApiDataSourceMicrosoftFabric'
- $ref: '#/components/schemas/ApiDataSourceVertica'
- $ref: '#/components/schemas/ApiDataSourceTrino'
title: Response List Data Sources Api V1 Data Sources Get
type: array
description: Successful Response
summary: List data sources
tags:
- Data sources
post:
operationId: create_new_datasource_api_v1_data_sources_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApiDataSourceForm'
required: true
responses:
'200':
content:
application/json:
schema:
discriminator:
mapping:
athena: '#/components/schemas/ApiDataSourceAwsAthena'
aws_s3: '#/components/schemas/ApiDataSourceS3'
azure_synapse: '#/components/schemas/ApiDataSourceAzureSynapse'
bigquery: '#/components/schemas/ApiDataSourceBigQuery'
databricks: '#/components/schemas/ApiDataSourceDatabricks'
db2: '#/components/schemas/ApiDataSourceDB2'
dremio: '#/components/schemas/ApiDataSourceDremio'
duckdb: '#/components/schemas/ApiDataSourceDuckDB'
files_azure_datalake: '#/components/schemas/ApiDataSourceAzureDataLake'
google_cloud_storage: '#/components/schemas/ApiDataSourceGCS'
mariadb: '#/components/schemas/ApiDataSourceMariaDB'
microsoft_fabric: '#/components/schemas/ApiDataSourceMicrosoftFabric'
mongodb: '#/components/schemas/ApiDataSourceMongoDB'
mssql: '#/components/schemas/ApiDataSourceMSSQL'
mysql: '#/components/schemas/ApiDataSourceMySQL'
netezza: '#/components/schemas/ApiDataSourceNetezza'
oracle: '#/components/schemas/ApiDataSourceOracle'
pg: '#/components/schemas/ApiDataSourcePostgres'
postgres_aurora: '#/components/schemas/ApiDataSourcePostgresAurora'
postgres_aws_rds: '#/components/schemas/ApiDataSourcePostgresRds'
redshift: '#/components/schemas/ApiDataSourceRedshift'
sap_hana: '#/components/schemas/ApiDataSourceSapHana'
snowflake: '#/components/schemas/ApiDataSourceSnowflake'
starburst: '#/components/schemas/ApiDataSourceStarburst'
teradata: '#/components/schemas/ApiDataSourceTeradata'
trino: '#/components/schemas/ApiDataSourceTrino'
vertica: '#/components/schemas/ApiDataSourceVertica'
propertyName: type
oneOf:
- $ref: '#/components/schemas/ApiDataSourceBigQuery'
- $ref: '#/components/schemas/ApiDataSourceDatabricks'
- $ref: '#/components/schemas/ApiDataSourceDuckDB'
- $ref: '#/components/schemas/ApiDataSourceMongoDB'
- $ref: '#/components/schemas/ApiDataSourceMySQL'
- $ref: '#/components/schemas/ApiDataSourceMariaDB'
- $ref: '#/components/schemas/ApiDataSourceMSSQL'
- $ref: '#/components/schemas/ApiDataSourceOracle'
- $ref: '#/components/schemas/ApiDataSourcePostgres'
- $ref: '#/components/schemas/ApiDataSourcePostgresAurora'
- $ref: '#/components/schemas/ApiDataSourcePostgresRds'
- $ref: '#/components/schemas/ApiDataSourceRedshift'
- $ref: '#/components/schemas/ApiDataSourceTeradata'
- $ref: '#/components/schemas/ApiDataSourceSapHana'
- $ref: '#/components/schemas/ApiDataSourceDB2'
- $ref: '#/components/schemas/ApiDataSourceAwsAthena'
- $ref: '#/components/schemas/ApiDataSourceSnowflake'
- $ref: '#/components/schemas/ApiDataSourceDremio'
- $ref: '#/components/schemas/ApiDataSourceStarburst'
- $ref: '#/components/schemas/ApiDataSourceNetezza'
- $ref: '#/components/schemas/ApiDataSourceAzureDataLake'
- $ref: '#/components/schemas/ApiDataSourceGCS'
- $ref: '#/components/schemas/ApiDataSourceS3'
- $ref: '#/components/schemas/ApiDataSourceAzureSynapse'
- $ref: '#/components/schemas/ApiDataSourceMicrosoftFabric'
- $ref: '#/components/schemas/ApiDataSourceVertica'
- $ref: '#/components/schemas/ApiDataSourceTrino'
title: Response Create New Datasource Api V1 Data Sources Post
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: Create a data source
tags:
- Data sources
/api/v1/data_sources/test/{job_id}:
get:
operationId: get_data_source_test_result_api_v1_data_sources_test__job_id__get
parameters:
- in: path
name: job_id
required: true
schema:
title: Data source testing task id
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AsyncDataSourceTestResults'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: Get data source testing results
tags:
- Data sources
/api/v1/data_sources/types:
get:
operationId: get_data_source_types_api_v1_data_sources_types_get
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiDataSourceType'
title: Response Get Data Source Types Api V1 Data Sources Types Get
type: array
description: Successful Response
summary: List data source types
tags:
- Data sources
/api/v1/data_sources/{data_source_id}:
get:
operationId: get_data_source_api_v1_data_sources__data_source_id__get
parameters:
- in: path
name: data_source_id
required: true
schema:
title: Data source id
type: integer
responses:
'200':
content:
application/json:
schema:
discriminator:
mapping:
athena: '#/components/schemas/ApiDataSourceAwsAthena'
aws_s3: '#/components/schemas/ApiDataSourceS3'
azure_synapse: '#/components/schemas/ApiDataSourceAzureSynapse'
bigquery: '#/components/schemas/ApiDataSourceBigQuery'
databricks: '#/components/schemas/ApiDataSourceDatabricks'
db2: '#/components/schemas/ApiDataSourceDB2'
dremio: '#/components/schemas/ApiDataSourceDremio'
duckdb: '#/components/schemas/ApiDataSourceDuckDB'
files_azure_datalake: '#/components/schemas/ApiDataSourceAzureDataLake'
google_cloud_storage: '#/components/schemas/ApiDataSourceGCS'
mariadb: '#/components/schemas/ApiDataSourceMariaDB'
microsoft_fabric: '#/components/schemas/ApiDataSourceMicrosoftFabric'
mongodb: '#/components/schemas/ApiDataSourceMongoDB'
mssql: '#/components/schemas/ApiDataSourceMSSQL'
mysql: '#/components/schemas/ApiDataSourceMySQL'
netezza: '#/components/schemas/ApiDataSourceNetezza'
oracle: '#/components/schemas/ApiDataSourceOracle'
pg: '#/components/schemas/ApiDataSourcePostgres'
postgres_aurora: '#/components/schemas/ApiDataSourcePostgresAurora'
postgres_aws_rds: '#/components/schemas/ApiDataSourcePostgresRds'
redshift: '#/components/schemas/ApiDataSourceRedshift'
sap_hana: '#/components/schemas/ApiDataSourceSapHana'
snowflake: '#/components/schemas/ApiDataSourceSnowflake'
starburst: '#/components/schemas/ApiDataSourceStarburst'
teradata: '#/components/schemas/ApiDataSourceTeradata'
trino: '#/components/schemas/ApiDataSourceTrino'
vertica: '#/components/schemas/ApiDataSourceVertica'
propertyName: type
oneOf:
- $ref: '#/components/schemas/ApiDataSourceBigQuery'
- $ref: '#/components/schemas/ApiDataSourceDatabricks'
- $ref: '#/components/schemas/ApiDataSourceDuckDB'
- $ref: '#/components/schemas/ApiDataSourceMongoDB'
- $ref: '#/components/schemas/ApiDataSourceMySQL'
- $ref: '#/components/schemas/ApiDataSourceMariaDB'
- $ref: '#/components/schemas/ApiDataSourceMSSQL'
- $ref: '#/components/schemas/ApiDataSourceOracle'
- $ref: '#/components/schemas/ApiDataSourcePostgres'
- $ref: '#/components/schemas/ApiDataSourcePostgresAurora'
- $ref: '#/components/schemas/ApiDataSourcePostgresRds'
- $ref: '#/components/schemas/ApiDataSourceRedshift'
- $ref: '#/components/schemas/ApiDataSourceTeradata'
- $ref: '#/components/schemas/ApiDataSourceSapHana'
- $ref: '#/components/schemas/ApiDataSourceDB2'
- $ref: '#/components/schemas/ApiDataSourceAwsAthena'
- $ref: '#/components/schemas/ApiDataSourceSnowflake'
- $ref: '#/components/schemas/ApiDataSourceDremio'
- $ref: '#/components/schemas/ApiDataSourceStarburst'
- $ref: '#/components/schemas/ApiDataSourceNetezza'
- $ref: '#/components/schemas/ApiDataSourceAzureDataLake'
- $ref: '#/components/schemas/ApiDataSourceGCS'
- $ref: '#/components/schemas/ApiDataSourceS3'
- $ref: '#/components/schemas/ApiDataSourceAzureSynapse'
- $ref: '#/components/schemas/ApiDataSourceMicrosoftFabric'
- $ref: '#/components/schemas/ApiDataSourceVertica'
- $ref: '#/components/schemas/ApiDataSourceTrino'
title: Response Get Data Source Api V1 Data Sources Data Source Id Get
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: Get a data source
tags:
- Data sources
/api/v1/data_sources/{data_source_id}/query:
post:
description: 'Executes a SQL query against the specified data source and returns the results.
This endpoint allows you to run ad-hoc SQL queries for data exploration, validation, or analysis.
The query is executed using the data source''s native query runner with the appropriate credentials.
**Streaming mode**: Use query parameter `?stream=true` or set `X-Stream-Response: true` header.
Streaming is only supported for certain data sources (e.g., Databricks).
When streaming, results are sent incrementally as valid JSON for memory efficiency.
Returns:
- Query results as rows with column metadata (name, type, description)
- Limited to a reasonable number of rows for performance'
operationId: execute_query_api_v1_data_sources__data_source_id__query_post
parameters:
- in: path
name: data_source_id
required: true
schema:
title: Data source ID
type: integer
- description: Stream results as JSON
in: query
name: stream
required: false
schema:
default: false
description: Stream results as JSON
title: Stream
type: boolean
- in: header
name: X-Stream-Response
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: X-Stream-Response
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApiQueryRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiQueryResult'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: Execute a SQL query against a data source
tags:
- Data sources
/api/v1/data_sources/{data_source_id}/summary:
get:
operationId: get_data_source_summary_api_v1_data_sources__data_source_id__summary_get
parameters:
- in: path
name: data_source_id
required: true
schema:
title: Data source id
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiDataSourceSummary'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: Get a data source summary
tags:
- Data sources
/api/v1/data_sources/{data_source_id}/test:
post:
operationId: test_data_source_api_v1_data_sources__data_source_id__test_post
parameters:
- in: path
name: data_source_id
required: true
schema:
title: Data source id
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TestDataSourceAsyncResponse'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: Test a data source connection
tags:
- Data sources
components:
schemas:
ApiDataSourceStarburst:
properties:
accessible:
default: true
title: Accessible
type: boolean
catalog_exclude_list:
anyOf:
- type: string
- type: 'null'
title: Catalog Exclude List
catalog_include_list:
anyOf:
- type: string
- type: 'null'
title: Catalog Include List
created_from:
anyOf:
- type: string
- type: 'null'
title: Created From
data_retention_days:
anyOf:
- type: integer
- type: 'null'
title: Data Retention Days
disable_profiling:
anyOf:
- type: boolean
- type: 'null'
default: false
title: Disable Profiling
disable_schema_indexing:
anyOf:
- type: boolean
- type: 'null'
default: false
title: Disable Schema Indexing
float_tolerance:
anyOf:
- type: number
- type: 'null'
default: 0.0
title: Float Tolerance
group_ids:
anyOf:
- items:
type: integer
type: array
- type: 'null'
title: Group Ids
groups:
anyOf:
- additionalProperties:
type: boolean
type: object
- type: 'null'
title: Groups
hidden:
anyOf:
- type: boolean
- type: 'null'
default: false
title: Hidden
id:
anyOf:
- type: integer
- type: 'null'
title: Id
is_paused:
anyOf:
- type: boolean
- type: 'null'
default: false
title: Is Paused
last_test:
anyOf:
- $ref: '#/components/schemas/ApiDataSourceTestStatus'
- type: 'null'
lineage_schedule:
anyOf:
- type: string
- type: 'null'
title: Lineage Schedule
max_allowed_connections:
anyOf:
- type: integer
- type: 'null'
title: Max Allowed Connections
name:
title: Name
type: string
oauth_dwh_active:
anyOf:
- type: boolean
- type: 'null'
title: Oauth Dwh Active
options:
anyOf:
- $ref: '#/components/schemas/StarburstConfig'
- type: 'null'
profile_exclude_list:
anyOf:
- type: string
- type: 'null'
title: Profile Exclude List
profile_include_list:
anyOf:
- type: string
- type: 'null'
title: Profile Include List
profile_schedule:
anyOf:
- type: string
- type: 'null'
title: Profile Schedule
queue_name:
anyOf:
- type: string
- type: 'null'
title: Queue Name
scheduled_queue_name:
anyOf:
- type: string
- type: 'null'
title: Scheduled Queue Name
schema_indexing_schedule:
anyOf:
- type: string
- type: 'null'
title: Schema Indexing Schedule
schema_max_age_s:
anyOf:
- type: integer
- type: 'null'
title: Schema Max Age S
secret_id:
anyOf:
- type: integer
- type: 'null'
title: Secret Id
source:
anyOf:
- type: string
- type: 'null'
title: Source
temp_schema:
anyOf:
- type: string
- type: 'null'
title: Temp Schema
type:
const: starburst
title: Type
type: string
view_only:
anyOf:
- type: boolean
- type: 'null'
default: false
title: View Only
required:
- name
- type
title: ApiDataSourceStarburst
type: object
ConfigurationCheckStep:
enum:
- connection
- temp_schema
- schema_download
- lineage_download
title: ConfigurationCheckStep
type: string
ApiDataSourcePostgresRds:
properties:
accessible:
default: true
title: Accessible
type: boolean
catalog_exclude_list:
anyOf:
- type: string
- type: 'null'
title: Catalog Exclude List
catalog_include_list:
anyOf:
- type: string
- type: 'null'
title: Catalog Include List
created_from:
anyOf:
- type: string
- type: 'null'
title: Created From
data_retention_days:
anyOf:
- type: integer
- type: 'null'
title: Data Retention Days
disable_profiling:
anyOf:
- type: boolean
- type: 'null'
default: false
title: Disable Profiling
disable_schema_indexing:
anyOf:
- type: boolean
- type: 'null'
default: false
title: Disable Schema Indexing
float_tolerance:
anyOf:
- type: number
- type: 'null'
default: 0.0
title: Float Tolerance
group_ids:
anyOf:
- items:
type: integer
type: array
- type: 'null'
title: Group Ids
groups:
anyOf:
- additionalProperties:
type: boolean
type: object
- type: 'null'
title: Groups
hidden:
anyOf:
- type: boolean
- type: 'null'
default: false
title: Hidden
id:
anyOf:
- type: integer
- type: 'null'
title: Id
is_paused:
anyOf:
- type: boolean
- type: 'null'
default: false
title: Is Paused
last_test:
anyOf:
- $ref: '#/components/schemas/ApiDataSourceTestStatus'
- type: 'null'
lineage_schedule:
anyOf:
- type: string
- type: 'null'
title: Lineage Schedule
max_allowed_connections:
anyOf:
- type: integer
- type: 'null'
title: Max Allowed Connections
name:
title: Name
type: string
oauth_dwh_active:
anyOf:
- type: boolean
- type: 'null'
title: Oauth Dwh Active
options:
anyOf:
- $ref: '#/components/schemas/PostgreSQLAuroraConfig'
- type: 'null'
profile_exclude_list:
anyOf:
- type: string
- type: 'null'
title: Profile Exclude List
profile_include_list:
anyOf:
- type: string
- type: 'null'
title: Profile Include List
profile_schedule:
anyOf:
- type: string
- type: 'null'
title: Profile Schedule
queue_name:
anyOf:
- type: string
- type: 'null'
title: Queue Name
scheduled_queue_name:
anyOf:
- type: string
- type: 'null'
title: Scheduled Queue Name
schema_indexing_schedule:
anyOf:
- type: string
- type: 'null'
title: Schema Indexing Schedule
schema_max_age_s:
anyOf:
- type: integer
- type: 'null'
title: Schema Max Age S
secret_id:
anyOf:
- type: integer
- type: 'null'
title: Secret Id
source:
anyOf:
- type: string
- type: 'null'
title: Source
temp_schema:
anyOf:
- type: string
- type: 'null'
title: Temp Schema
type:
const: postgres_aws_rds
title: Type
type: string
view_only:
anyOf:
- type: boolean
- type: 'null'
default: false
title: View Only
required:
- name
- type
title: ApiDataSourcePostgresRds
type: object
MongoDBConfig:
properties:
auth_source:
anyOf:
- type: string
- type: 'null'
default: admin
title: Auth Source
connect_timeout_ms:
default: 60000
title: Connect Timeout Ms
type: integer
database:
title: Database
type: string
host:
maxLength: 128
title: Host
type: string
password:
format: password
title: Password
type: string
writeOnly: true
port:
default: 27017
title: Port
type: integer
server_selection_timeout_ms:
default: 60000
title: Server Selection Timeout Ms
type: integer
socket_timeout_ms:
default: 300000
title: Socket Timeout Ms
type: integer
username:
title: Username
type: string
required:
- database
- username
- password
- host
title: MongoDBConfig
type: object
ApiQueryResult:
properties:
columns:
anyOf:
- items:
$ref: '#/components/schemas/ApiQueryColumn'
type: array
- type: 'null'
title: Columns
rows:
items:
additionalProperties: true
type: object
title: Rows
type: array
required:
- rows
title: ApiQueryResult
type: object
MySQLConfig:
properties:
db:
title: Database name
type: string
host:
maxLength: 128
title: Host
type: string
password:
format: password
title: Password
type: string
writeOnly: true
port:
default: 3306
title: Port
type: integer
user:
title: User
type: string
required:
- host
- user
- password
- db
title: MySQLConfig
type: object
AzureDataLakeConfig:
properties:
account_name:
title: Account Name
type: string
client_id:
anyOf:
- maxLength: 1024
type: string
- type: 'null'
title: Client Id
client_secret:
anyOf:
- format: password
type: string
writeOnly: true
- type: 'null'
title: Client Secret
materialize_max_rows:
anyOf:
- type: integer
- type: 'null'
title: Materialize Max Rows
materialize_path:
anyOf:
- type: string
- type: 'null'
title: Materialize Path
tenant_id:
anyOf:
- maxLength: 1024
type: string
- type: 'null'
title: Tenant Id
required:
- account_name
- tenant_id
- client_id
title: AzureDataLakeConfig
type: object
SapHanaConfig:
properties:
host:
maxLength: 128
title: Host
type: string
password:
format: password
title: Password
type: string
writeOnly: true
port:
default: 443
title: Port
type: integer
user:
default: DATAFOLD
title: User
type: string
required:
- host
- password
title: SapHanaConfig
type: object
ApiDataSourceAzureSynapse:
properties:
accessible:
default: true
title: Accessible
type: boolean
catalog_exclude_list:
anyOf:
- type: string
- type: 'null'
title: Catalog Exclude List
catalog_include_list:
anyOf:
- type: string
- type: 'null'
title: Catalog Include List
created_from:
anyOf:
- type: string
- type: 'null'
title: Created From
data_retention_days:
# --- truncated at 32 KB (165 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/datafold/refs/heads/main/openapi/datafold-data-sources-api-openapi.yml