HomeGuidesRecipesAPI ReferencePython SDK
Alation Help Center
API Reference

Trigger metadata extraction job

This API allows admins to trigger metadata extraction with or without parameters. It only works for datasources which are deployed. If parameters are passed then it overrides default parameters. Ensure that you run available_schemas API when you run this API only for the first time.

Path Params
integer
required

id of the datasource

Body Params
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*
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
required
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

Language
Credentials
URL
Choose an example:
application/json