HomeGuidesRecipesAPI Reference
Alation Help Center

Group Overview

Group API

Description

This API allows admin users to read basic Group metadata on an Alation instance.

OpenAPI 3.0 Specification

The Group 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:

{AlationInstanceURL}/openapi/group/

NOTE:

  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.