HomeGuidesRecipesAPI Reference
Alation Help Center

Open API Index

This page lists all Alation API's with Open API 3.0 specifications and available on an Alation instance. To see the specification, replace {AlationInstanceURL} below with your Alation instance's URL and visit the link:

APIURL
API Authentication{AlationInstanceURL}/openapi/api_authentication/
Articles{AlationInstanceURL}/openapi/articles/
Business Intelligence{AlationInstanceURL}/openapi/gbmv2/
Connectors (OCF){AlationInstanceURL}/openapi/connectors/
Conversations v2{AlationInstanceURL}/openapi/conversations/
Cross-System Lineage{AlationInstanceURL}/openapi/cross_system_lineage_info
Custom Fields{AlationInstanceURL}/openapi/custom_field/
Custom Field Values{AlationInstanceURL}/openapi/custom_field_value/
Custom Field Values Async{AlationInstanceURL}/openapi/custom_field_value_async/
Data Dictionary{AlationInstanceURL}/openapi/data_dictionary/
Data Health{AlationInstanceURL}/openapi/data_quality/
Data Sources (Native){AlationInstanceURL}/openapi/datasources/
Data Sources (OCF){AlationInstanceURL}/openapi/ocf_datasources/
Domains{AlationInstanceURL}/openapi/domain/
Groups{AlationInstanceURL}/openapi/group/
Lineage and Dataflow{AlationInstanceURL}/openapi/lineage/
Members Permission{AlationInstanceURL}/openapi/members_permission/
OAuth (cloud native architecture only){AlationInstanceURL}/openapi/oauthv2/
oTypes{AlationInstanceURL}/openapi/otypes/
Policy and Policy Groups{AlationInstanceURL}/openapi/policy/
Privacy Settings{AlationInstanceURL}/openapi/privacy_settings/
SCIM 2.0{AlationInstanceURL}/openapi/scimv2/
Search{AlationInstanceURL}/openapi/search/
RDBMS Integration{AlationInstanceURL}/openapi/integration_apis/
Terms{AlationInstanceURL}/openapi/terms/
Users{AlationInstanceURL}/openapi/user/
Users v2{AlationInstanceURL}/openapi/userv2/
Workflows{AlationInstanceURL}/openapi/workflows/

πŸ“˜

Note

From Alation 2021.2 onwards the alation.feature_flags.enable_swagger parameter in alation_conf has been set to true by default. So all the Swagger UI pages mentioned here would be accessible unless stated otherwise. However if you want to undo this, set the flag to false using alation_conf.