Home
HomeGuidesRecipesAPI ReferencePython SDKAI Agent SDKAlation Data Quality SDKAlation's MCP Server
HomeAlation Help Center
API Reference
Alation Help Center

Update metadata extraction configurations

put
{protocol}://{base-url}/integration/v1/datasource//sync_configuration/metadata_extraction/

This API can be used to update the entire configurations for metadata extraction. Note: Not supported for virtual datasources.

Path Params
integer
required

id of the datasource

Body Params

Metadata extraction configuration object

string

The extraction schedule in crontab format (minute, hour, day of month, month of year, day of week) example: "0 4 4 * 2".

boolean

True if the extraction schedule should not be executed, false to run extraction according to cron_extraction.

limit_schemas
array of strings
required

Schemas to include in metadata extraction. If there are no schemas to include, then set
to an empty array. Both parameters - limit_schemas and exclude_schemas - cannot
have values filled at the same time.

limit_schemas*
exclude_schemas
array of strings
required

Schemas to exclude from metadata extraction. If there are no schemas to exclude,
then set to an empty array. Both parameters - exclude_schemas and limit_schemas -
cannot have values filled at the same time.

exclude_schemas*
boolean
Defaults to false

Boolean flag determining if we need to remove existing schemas. If set to True, we mark existing schemas as deleted which are not present in metadata extraction process. Defaults to False.

Responses

Updated 2 months ago

Did this page help you?
Language
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 2 months ago

Did this page help you?