Jump to Content

Home

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

Token Authentication and Management API

Refresh & Access Token Overview
APIAccessToken
RefreshToken

OAuth 2.0 APIs for Service Authorization

Overview (Service User Authorization)
Authorization and Verification

OAuth 2.0 APIs for Managing Clients and User Authorization

Overview (User Authorization)
OAuth Authorization
- Initiate the OAuth Authorization Code flow.get
OAuth Token Management
- Obtain access and refresh tokens.post
OAuth Client Administration

Aggregated Context API

Context
- Get relevant context from the Alation catalogget

Alation Agent API

Agent
Authentication Service
- List available Authentication Service addon versionsget
- Download a specific Authentication Service addon versionget

Alation AI API

Alation AI API Overview
Admin
- Read configuration valuespost
- Update configuration valuespost
Assets
Auth Config
BI
- Reconstruct semantic layer viewsget
Chats
Config
Context
- Generate signature and retrieve context using semantic searchpost
- Generate signature and retrieve context using bulk enumerationpost
Data Product
Evaluation
Feedback
OAuth
- Start OAuth authorization flowpost
- Handle OAuth callbackget
OAuth App
- Register OAuth client for scheduled workflowspost
Scheduled Workflows
SQL Evaluation
Task
- Get a Taskget
Usage
- Get aggregated usage data.get
- Get Alamigo interactions.get
Workflows
SQL Evaluation V2
LLM Credentials
BI Report
- Generate BI report descriptionpost

Articles API

Article Overview
Article

Assets API

Sync Assets
Assets

BI Source API

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

Bulk Per-Object Parameters API

Per-Object Parameters
- Bulk update per-object parameterspost
- Get bulk per-object parameters job statusget

CDE

CDE API Overview
Authentication
- Create Public CDE API tokenpost
Critical Data Element (CDE)
Job
Standard
User
- Filter Users by criteriaget

Central Authentication APIs

Credentials Management
Data Product Configuration
Data Product Discovery
- Get enabled authentication schemesget
- Get authentication capabilitiesget
System Discovery
- Get authentication system capabilitiesget

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 Products API

Data Products Overview
Data Products
Data Product Versions
Data Marketplaces
Data Products Publishing
Data Products Search
- Search for data products in a marketplacepost
Permissions

Native Data Quality API

Monitors
Checks
- Retrieve checksget
- Update check propertiespatch

Native Data Quality Incidents API

Incidents
- Link an external incident to a data quality monitorpost

Datasources API

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

Data Sources API (OCF)

OCF Data Sources API Overview
datasource
datasource metadata extraction
datasource configuration
- Get General Configuration for Datasourceget
- Update general settings configuration including vault settingspatch
datasource config checks
datasource purge
- Purge soft-deleted schemas from a datasourcepost

Documents API

Documents

Domain API

Domain

Folder API

Folders

Filesystem File API

Filesystem File

Groups API

Group Overview
Group
- GET multiple Groupsget
- GET a Groupget

Homepage Preferences API

Homepage Preferences

Lineage API v2

Lineage & Dataflows Overview
Dataflow
Lineage
Cross-System Lineage

Lineage API v3

Lineage
- Delete lineagedel

Logging API

Logging
- Prepare Audit logs for downloadpost
- Download prepared Audit logsget

My Domains API

My Domains
- Associate users and groups to domainsput

Members Permission API

Members Permission

NoSQL API v2

NoSQL

Otypes API

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

Policy API

Policies
Policy Groups
- List Policy Groupsget

Privacy Settings API

Resource Privacy Settings
- Manage resource privacy settingspatch

Relational Integration API

Relational Integration API Overview
Schema
Table
Column
Joins
Child columns
File Attribute
Profile Purge
- Get profile purge job statusget
- Purge all profile data for a datasourcepost

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

Template Visual Config API

Visual Config

Unified OCF Source Operations API

unified OCF operations
- Trigger async test connection for any OCF sourcepost
- Trigger async test-and-fetch (preflight check) for any OCF sourcepost

User Public API

User Overview
User
- GET multiple Usersget
- GET a Userget

User API v2

User
- GET multiple Usersget
- GET a Userget

Workflows API

Workflows
- List workflowsget
Requests
Review requests

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 API

Metadata ✦

Relational Get APIs
Get Data Sources
Get Schemas
Relational Integration v1

NoSQL API ✦

NoSQL API v1 (Legacy)

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

Article Overview

Updated 6 months ago

Generate BI report description

Article

Did this page help you?

Updated 6 months ago

Generate BI report description

Article

Did this page help you?

- Articles API

Terms and Conditions | Privacy Policy | Cookie Policy