Skip to main content
POST
/
api
/
v1
/
data_sources
Create a data source
curl --request POST \
  --url https://app.datafold.com/api/v1/data_sources \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "type": "<string>",
  "accessible": true,
  "catalog_exclude_list": "<string>",
  "catalog_include_list": "<string>",
  "created_from": "<string>",
  "data_retention_days": 123,
  "disable_profiling": false,
  "disable_schema_indexing": false,
  "float_tolerance": 0,
  "group_ids": [
    123
  ],
  "groups": {},
  "hidden": false,
  "id": 123,
  "is_paused": false,
  "last_test": {
    "results": [
      {
        "result": null
      }
    ],
    "tested_at": "2023-11-07T05:31:56Z"
  },
  "lineage_schedule": "<string>",
  "max_allowed_connections": 123,
  "oauth_dwh_active": true,
  "options": {
    "jsonKeyFile": "<string>",
    "projectId": "<string>",
    "extraProjectsToIndex": "project1\nproject2",
    "jsonOAuthKeyFile": "<string>",
    "location": "US",
    "totalMBytesProcessedLimit": 123,
    "useStandardSql": true,
    "userDefinedFunctionResourceUri": "gs://bucket/date_utils.js"
  },
  "profile_exclude_list": "<string>",
  "profile_include_list": "<string>",
  "profile_schedule": "<string>",
  "queue_name": "<string>",
  "scheduled_queue_name": "<string>",
  "schema_indexing_schedule": "<string>",
  "schema_max_age_s": 123,
  "secret_id": 123,
  "source": "<string>",
  "temp_schema": "<string>",
  "view_only": false
}
'
{
  "name": "<string>",
  "type": "<string>",
  "accessible": true,
  "catalog_exclude_list": "<string>",
  "catalog_include_list": "<string>",
  "created_from": "<string>",
  "data_retention_days": 123,
  "disable_profiling": false,
  "disable_schema_indexing": false,
  "float_tolerance": 0,
  "group_ids": [
    123
  ],
  "groups": {},
  "hidden": false,
  "id": 123,
  "is_paused": false,
  "last_test": {
    "results": [
      {
        "result": null
      }
    ],
    "tested_at": "2023-11-07T05:31:56Z"
  },
  "lineage_schedule": "<string>",
  "max_allowed_connections": 123,
  "oauth_dwh_active": true,
  "options": {
    "projectId": "<string>",
    "extraProjectsToIndex": "project1\nproject2",
    "jsonOAuthKeyFile": "<string>",
    "location": "US",
    "totalMBytesProcessedLimit": 123,
    "useStandardSql": true,
    "userDefinedFunctionResourceUri": "gs://bucket/date_utils.js"
  },
  "profile_exclude_list": "<string>",
  "profile_include_list": "<string>",
  "profile_schedule": "<string>",
  "queue_name": "<string>",
  "scheduled_queue_name": "<string>",
  "schema_indexing_schedule": "<string>",
  "schema_max_age_s": 123,
  "secret_id": 123,
  "source": "<string>",
  "temp_schema": "<string>",
  "view_only": false
}

Authorizations

​
Authorization
string
header
required

Use the 'Authorization' header with the format 'Key '

Body

application/json
​
name
string
required
​
type
string
required
Allowed value: "bigquery"
​
accessible
boolean
default:true
​
catalog_exclude_list
string | null
​
catalog_include_list
string | null
​
created_from
string | null
​
data_retention_days
integer | null
​
disable_profiling
boolean | null
default:false
​
disable_schema_indexing
boolean | null
default:false
​
float_tolerance
number | null
default:0
​
group_ids
integer[] | null
​
groups
Groups · object
​
hidden
boolean | null
default:false
​
id
integer | null
​
is_paused
boolean | null
default:false
​
last_test
ApiDataSourceTestStatus · object
​
lineage_schedule
string | null
​
max_allowed_connections
integer | null
​
oauth_dwh_active
boolean | null
​
options
BigQueryConfig · object
​
profile_exclude_list
string | null
​
profile_include_list
string | null
​
profile_schedule
string | null
​
queue_name
string | null
​
scheduled_queue_name
string | null
​
schema_indexing_schedule
string | null
​
schema_max_age_s
integer | null
​
secret_id
integer | null
​
source
string | null
​
temp_schema
string | null
​
view_only
boolean | null
default:false

Response

Successful Response

​
name
string
required
​
type
string
required
Allowed value: "bigquery"
​
accessible
boolean
default:true
​
catalog_exclude_list
string | null
​
catalog_include_list
string | null
​
created_from
string | null
​
data_retention_days
integer | null
​
disable_profiling
boolean | null
default:false
​
disable_schema_indexing
boolean | null
default:false
​
float_tolerance
number | null
default:0
​
group_ids
integer[] | null
​
groups
Groups · object
​
hidden
boolean | null
default:false
​
id
integer | null
​
is_paused
boolean | null
default:false
​
last_test
ApiDataSourceTestStatus · object
​
lineage_schedule
string | null
​
max_allowed_connections
integer | null
​
oauth_dwh_active
boolean | null
​
options
BigQueryConfig · object
​
profile_exclude_list
string | null
​
profile_include_list
string | null
​
profile_schedule
string | null
​
queue_name
string | null
​
scheduled_queue_name
string | null
​
schema_indexing_schedule
string | null
​
schema_max_age_s
integer | null
​
secret_id
integer | null
​
source
string | null
​
temp_schema
string | null
​
view_only
boolean | null
default:false