HomeGuidesRecipesAPI ReferencePython SDK
Alation Help Center
API Reference

Upload a data dictionary

Updates catalog object with the metadata provided in the data dictionary file. This endpoint can only be used by the Composer role and above by default. Setting the parameter alation.feature_flags.disable_perm_check_on_upload_dd to true in alation_conf disables permission checks during the upload process, which may improve performance, and also makes it so only Catalog Admins and Server Admins can use this endpoint.

Recipes
🦉
Upload Data Dictionaries
Open Recipe

Before using this API, the alation_conf parameter alation.feature_flags.dev_enable_data_dictionary_redesign should be set to true. This parameter is set to true by default starting in 2023.3.2. For help using alation_conf, see Using alation_conf.

You can include columns in the data dictionary upload file, as long as you also include one of the higher-level objects (data source, schema, or table).

See Importing a Data Dictionary in the Alation docs for details on how to format the data dictionary file.

Language
Credentials
Header
URL