HomeGuidesRecipesAPI Reference
Alation Help Center

Custom Field Overview

Custom Field API (V2)


This API allows admin users to read and create Custom Fields on an Alation instance. This corresponds to information that would be seen in Customize Catalog for Custom Fields.

OpenAPI 3.0 Specification

The Custom Field API uses the OpenAPI 3.0 Specification (OAS). OAS is a broadly adopted industry standard for describing APIs.

To see the specification, replace {AlationInstanceURL} below with your Alation instance's URL and visit the link:



  1. The OpenAPI UI is not enabled by default on an Alation instance. Please set the flag alation.feature_flags.enable_swagger to True using alation_conf.