Open API Index
This page lists all Alation APIs that have Open API 3.0 specifications and are available on an Alation instance. To see the specification, replace {AlationInstanceURL} below with your Alation instance's URL and visit the link:
| API | URL |
|---|---|
| Alation Agent | {AlationInstanceURL}/openapi/agent/ |
| 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/ |
| Custom Fields | {AlationInstanceURL}/openapi/custom_field/ |
| Custom Field Values | {AlationInstanceURL}/openapi/custom_field_value/ |
| 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/ |
| Documents | {AlationInstanceURL}/openapi/document/ |
| Domains | {AlationInstanceURL}/openapi/domain/ |
| Folder | {AlationInstanceURL}/openapi/folder/ |
| Groups | {AlationInstanceURL}/openapi/group/ |
| Homepage Preferences | {AlationInstanceURL}/openapi/homepage/ |
| Lineage and Dataflow | {AlationInstanceURL}/openapi/lineage/ |
| Members Permission | {AlationInstanceURL}/openapi/members_permission/ |
| My Domains | {AlationInstanceURL}/openapi/my_domains/ |
| NoSQL v2 | {AlationInstanceURL}/openapi/nosql/ |
| OAuth (cloud native architecture only) | {AlationInstanceURL}/openapi/oauth2_v2/ |
| oTypes | {AlationInstanceURL}/openapi/otypes/ |
| Policy and Policy Groups | {AlationInstanceURL}/openapi/policy/ |
| Privacy Settings | {AlationInstanceURL}/openapi/privacy_settings/ |
| 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_swaggerparameter in alation_conf has been set totrueby default. So all the Swagger UI pages mentioned here would be accessible by default. If you want to undo this, set the flag tofalseusing alation_conf.
Updated 5 months ago