HomeGuidesRecipesAPI Reference
Alation Help Center
Alation Help Center

Relational Integration API Overview

Relational Integration APIs

Description

This API allows users to create and read technical and logical metadata together for virtual and non-virtual RDBMS data sources. Users with appropriate permissions can create schemas, tables and columns under a particular data source along with their custom fields.

This API's POST methods should not be used to update RDBMS objects. All fields not included in a POST request will be set to a default value.

Permissions

Alation Role: Server Admin

Public Data sources:

POST API - Allowed only for Server admin, Catalog admin and Source admin roles with access level as a data source admin on a public data source.

GET API - Allowed for all user roles on a public data source.

Private Data sources:

POST API - Allowed only for Server admin, Catalog admin and Source admin roles with access level as a data source admin on the private data source.

GET API - Allowed for all user roles with access level as data source viewer or data source admin on the private data source.

OpenAPI 3.0 Specification

The Relational Integration APIs 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/integration_apis/

NOTE:

  1. This API is available in Alation 2021.2 and later.
  2. 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.