Jump to Content

Home Guides Recipes API Reference Python SDK AI Agent SDK Alation Data Quality SDK Alation's MCP Server

Home Alation Help Center

API Reference

Alation Help Center

Home Guides Recipes API Reference Python SDK AI Agent SDK Alation Data Quality SDK Alation's MCP Server

These docs are for v2024.1.1. Click to read the latest docs for v2026.9.0-1.

Token Authentication and Management API

Refresh & Access Token Overview
APIAccessToken
RefreshToken

Alation Agent API

Agent

Articles API

Article Overview
Article

BI Source API

BI Source (GBMv2) Overview
server
connection
datasource
folder
permission
report
images
user

Connectors API (OCF)

connectors
- Get a list of connectorsget

Conversations API

Conversations
Posts

Conversations API version 2

Conversations v2 Overview
Conversations
Assignees
Posts

Custom Fields API

Custom Field Overview
Custom Field

Custom Field Values API

Custom Field Values Overview
Custom Field Value

Data Dictionary API

Data Dictionary

Data Health API

Data Health Ingestion
- Upsert rules and data health valuespost
Data Health Deletion
- Delete rules and data health valuesdel
Data Health Retrieval
- Retrieve information about data quality fieldsget
- Retrieve information about data quality valuesget

Data sources API (Native)

Native Data Sources API Overview
datasource
datasource metadata extraction
datasource config checks
migrate data source to Agent connector
- Migrate a data source to Agentput
migrate native connector data sources to OCF
- Bulk migrate data sources to OCFpost
- Get a list of available ocf connectors and their native datasourcesget

Data Sources API (OCF)

datasource
datasource metadata extraction
datasource configuration
- Get General Configuration for Datasourceget
- Update general settings configuration except Authpatch
datasource config checks

Documents API

Documents

Domain API

Domain

Groups API

Group Overview
Group
- GET multiple Groupsget
- GET a Groupget

Lineage v2 API

Lineage & Dataflows Overview
Dataflow
Lineage
Cross-System Lineage

Members Permission API

Members Permission

My Domains API

My Domains
- Associate users and groups to domainsput

OAuth 2.0 API V2

Authorization and Verification

Otypes API

Otypes Overview
otype
- GET a response from the otypes API endpointget

Policy API

Policies
Policy Groups
- List Policy Groupsget

Privacy Settings API

Privacy Settings
- Manage privacy settingspatch

Relational Integration API

Relational Integration API Overview
Column
- Get columns along with its custom fieldsget
- Create new columns under a particular data sourcepost
Child columns
Schema
- Get schemas along with its custom fieldsget
- Create new schemas under a particular data sourcepost
Table
- Get tables along with its custom fieldsget
- Create new tables under a particular data sourcepost

SCIM 2.0 API

Authorization and Integration
- Create SCIM Tokenpost

Search API

Search Overview
Search
- GET a response from the search API endpointget
Synonyms

Terms API

Terms

User API

User Overview
User
Suspend Duplicate User Accounts
- Get duplicate user accounts.get
- Suspend duplicate user accountspost

User API v2

User
- GET multiple Usersget
- GET a Userget

Workflows API

Requests
Review requests
Workflows
- List workflowsget

Admin ✦

Table Metadata Sync Trigger

API Resources ✦

API Resources

Custom Fields (Legacy) ✦

Find Objects by Custom Field

Custom Template ✦

Custom Template

Flags and Tags ✦

Trust Check Flags API
Tags API

Jobs ✦

Jobs APIs

Metadata ✦

Relational Get APIs
Get Data Sources
Get Schemas
Relational Integration v1

NoSQL API ✦

NoSQL Apis

Open With ✦

Open With (DataOS)
- Alation Data Explorer
- Open-With Registration

Query ✦

Queries API
Queriers APIs
Query Log Upload API

Upload Logical Metadata API ✦

ULM Overview
ULM with Article ID

Virtual Systems ✦

Virtual File System APIs
Virtual Data Source
Virtual BI Server

Virtual BI Server

For more information, please see the BI Source API.

Updated 7 months ago

Virtual Data Source

Did this page help you?

Updated 7 months ago

Virtual Data Source

Did this page help you?

Terms and Conditions | Privacy Policy | Cookie Policy