Jump to Content
Home
Guides
Recipes
API Reference
Python SDK
v2023.1.4
v2023.1.5
v2023.1.6
v2023.1.7
v2023.3
v2023.3.2
v2023.3.3
v2023.3.4
v2023.3.5
v2024.1
v2024.1.1
v2024.1.2
v2024.1.3
v2024.1.4
v2024.1.5
v2024.3
v2024.3.1-ja
v2024.3.1
v2024.3.2
v2024.3.4
v2024.3.5
v2025.1
v2025.1.2
Alation Help Center
API Reference
Alation Help Center
v2024.1.1
Home
Guides
Recipes
API Reference
Python SDK
Update documents
Search
These docs are for v2024.1.1. Click to read the latest docs for v2025.1.2.
JUMP TO
Token Authentication and Management API
Refresh & Access Token Overview
APIAccessToken
Creates a new API Access Token.
post
Revokes all the active API Access Tokens for the user.
post
Validates the given API Access Token.
post
RefreshToken
Creates a new RefreshToken for the user.
post
Regenerates a RefreshToken, invalidating the current token in request body.
post
Validate the given RefreshToken.
post
Alation Agent API
Agent
Get a list of Agents
get
Create an Alation Agent
post
Retrieve the Agent connectivity endpoint
get
List available Debian Alation Agent installer versions
get
Download a specific Debian Alation Agent installer version
get
List available RHEL Alation Agent installer versions
get
Download a specific RHEL Alation Agent installer version
get
Delete an Alation Agent
delete
Get an Alation Agent
get
Update an Alation Agent
patch
Resync an Alation Agent
post
Revoke the certificate of the Alation Agent
post
Sign a certificate for the Alation Agent
post
Articles API
Article Overview
Article
GET all articles
get
POST an article
post
DELETE an article
delete
GET an article
get
UPDATE an article
put
Resurrect an article
post
BI Source API
BI Source (GBMv2) Overview
server
GET a list of BI Servers
get
Create a list of BI Servers
post
GET a BI Server
get
Update a BI Server
patch
connection
DELETE a set of connections from a specified BI Server
delete
GET a list of connections from a specified BI Server
get
Create/Update a list of connection objects
post
DELETE a set of connection columns from a specified BI Server
delete
GET a set of connection columns from a specified BI Server
get
Create/Update a list of connection column objects
post
DELETE a connection column
delete
GET a connection column
get
Partially update a connection column
patch
DELETE a connection
delete
GET a connection
get
Partially update a connection
patch
datasource
DELETE a set of datasources from a specified BI Server
delete
GET a set of datasources from a specified BI Server
get
Create/Update a list of Datasources
post
DELETE a set of datasource columns from a specified BI Server
delete
GET a set of datasource columns from a specified BI Server
get
Create/Update a list of Datasource Columns
post
DELETE a Datasource column
delete
GET a Datasource column
get
Partially update a Datasource column
patch
DELETE a Datasource
delete
GET a Datasource
get
Partially update a Datasource
patch
folder
DELETE a set of folders from a specified BI Server
delete
GET a list of folders from a specified BI Server
get
Create/Update a list of folder objects
post
DELETE a BI folder
delete
GET a BI folder
get
Partially update a BI folder
patch
permission
DELETE a set of BI permissions from a specified BI server
delete
GET a list of BI permissions from a specified BI Server
get
Create/Update a list of BI Permissions
post
DELETE a BI permission
delete
GET a BI permission
get
report
DELETE a set of reports from a specified BI Server
delete
GET a list of reports from a specified BI Server
get
Create/Update a list of report objects
post
DELETE a set of report columns from a specified BI Server
delete
GET a set of report columns from a specified BI Server
get
Create/Update a list of report column objects
post
DELETE a Report column
delete
GET a Report column
get
Partially update a Report column
patch
DELETE a Report
delete
GET a Report
get
Partially update a Report
patch
images
DELETE the current image associated to this object using imagetype query
delete
GET an image associated with a BI object from a BI Server
get
POST an image associated with a BI object from a BI Server
post
user
DELETE a set of BI users from a specified BI Server
delete
GET a list of BI users from a specified BI Server
get
Create/Update a list of BI users
post
DELETE a BI user
delete
GET a BI user
get
Connectors API (OCF)
connectors
Get a list of connectors
get
Conversations API
Conversations
Get a list of conversations
get
Create a conversation
post
Delete a conversation
delete
Get a conversation by ID
get
Update a conversation
patch
Posts
Get a list of conversation posts
get
Create a conversation post
post
Delete a conversation post
delete
Get a conversation post by ID
get
Update a conversation post
patch
Conversations API version 2
Conversations v2 Overview
Conversations
Get a list of conversations
get
Create a conversation
post
Delete a conversation
delete
Get a conversation by ID
get
Update a conversation
patch
Assignees
Remove all assignees from a conversation with given ID
delete
Get a list of assignees for a conversation with given ID
get
Remove a conversation assignee by ID
delete
Get a conversation assignee by ID
get
Add one assignee to the conversation
post
Posts
Get a list of conversation posts
get
Create a conversation post
post
Delete a conversation post
delete
Get a conversation post by ID
get
Update a conversation post
patch
Custom Fields API
Custom Field Overview
Custom Field
Bulk Read Custom Fields
get
Bulk Create Custom Fields
post
Read a Builtin Custom Field
get
Read a Custom Field
get
Custom Field Values API
Custom Field Values Overview
Custom Field Value
GET multiple Custom Field Values
get
PUT multiple Custom Field Values
put
PUT multiple Custom Field Values Async
put
Data Dictionary API
Data Dictionary
Get data dictionary task details
get
Get data dictionary task errors
get
Upload a data dictionary
put
Data Health API
Data Health Ingestion
Upsert rules and data health values
post
Data Health Deletion
Delete rules and data health values
delete
Data Health Retrieval
Retrieve information about data quality fields
get
Retrieve information about data quality values
get
Data sources API (Native)
Native Data Sources API Overview
datasource
Get a list of datasources
get
Create a datasource
post
Delete a datasource
delete
Get a datasource
get
Update a datasource
put
datasource metadata extraction
Get a list of available schemas
get
Trigger metadata extraction job
post
Get metadata extraction configurations
get
Update metadata extraction configurations
patch
Update metadata extraction configurations
put
datasource config checks
Verify configuration checks
get
Verify network connection status
get
Verify service account authentication status
get
Verify service account privileges
get
migrate data source to Agent connector
Migrate a data source to Agent
put
migrate native connector data sources to OCF
Bulk migrate data sources to OCF
post
Get a list of available ocf connectors and their native datasources
get
Data Sources API (OCF)
datasource
Get a list of datasources
get
Create a datasource
post
Delete a datasource
delete
Get a datasource
get
Update an OCF datasource
put
datasource metadata extraction
Get a list of available schemas
get
Trigger metadata extraction job
post
Trigger job to sync schemas from data source
post
Get metadata extraction configurations
get
Update metadata extraction configurations
patch
datasource configuration
Get General Configuration for Datasource
get
Update general settings configuration except Auth
patch
datasource config checks
Verify configuration checks
get
Verify network connection status
get
Verify service account authentication status
get
Verify service account privileges
get
Documents API
Documents
Delete documents
delete
Retrieve documents
get
Create documents
post
Update documents
put
Domain API
Domain
Deletes the requested domain(s) and their subdomains. Additionally, it un-assigns all the objects from these domains and subdomains.
delete
Retrieve a list of domains.
get
Create domains in bulk.
post
Retrieve a domain's details
get
Move a domain
patch
Adds the requested objects to a domain.
post
It allows user to browse the domain rules, with some filters.
post
Groups API
Group Overview
Group
GET multiple Groups
get
GET a Group
get
Lineage v2 API
Lineage & Dataflows Overview
Dataflow
Delete a list of Dataflow objects
delete
Get Dataflow object details and related paths
get
Update a list of Dataflow objects
patch
Create/Replace a list of Dataflow objects with lineage infomation
post
Lineage
Delete lineage information
delete
Get lineage information
get
Post lineage information
post
Cross-System Lineage
Delete cross-system lineage records
delete
Get cross-system lineage records
get
Create cross-system lineage records
post
Update cross-system lineage records
put
Delete cross-system lineage record
delete
Get cross-system lineage record
get
Update cross-system lineage record
put
Members Permission API
Members Permission
Add member permissions
post
Replace member permissions
put
Delete member permissions
delete
My Domains API
My Domains
Associate users and groups to domains
put
OAuth 2.0 API V2
Authorization and Verification
Create JSON web token (JWT)
post
Introspect JSON Web Token (JWT)
post
Get JSON Web Key Set
get
Otypes API
Otypes Overview
otype
GET a response from the otypes API endpoint
get
Policy API
Policies
Delete Policies in bulk
delete
List Policies
get
Create Policies in bulk
post
Update Policies in bulk
put
Policy Groups
List Policy Groups
get
Privacy Settings API
Privacy Settings
Manage privacy settings
patch
Relational Integration API
Relational Integration API Overview
Column
Get columns along with its custom fields
get
Create new columns under a particular data source
post
Child columns
Update children of root columns
patch
Fetch children for column
get
Update children of a sub-column
patch
Schema
Get schemas along with its custom fields
get
Create new schemas under a particular data source
post
Table
Get tables along with its custom fields
get
Create new tables under a particular data source
post
SCIM 2.0 API
Authorization and Integration
Create SCIM Token
post
Search API
Search Overview
Search
GET a response from the search API endpoint
get
Synonyms
Suite of operations for management of synonyms for search
get
Suite of operations for management of synonyms for search
delete
Suite of operations for management of synonyms for search
post
Terms API
Terms
Delete Terms
delete
Retrieve Terms
get
Create Terms
post
Update Terms
put
User API
User Overview
User
GET multiple Users
get
GET a User
get
GET authenticated User details
get
Suspend Duplicate User Accounts
Get duplicate user accounts.
get
Suspend duplicate user accounts
post
User API v2
User
GET multiple Users
get
GET a User
get
Workflows API
Requests
List requests
get
Create a request
post
Show request details
get
Review requests
List my review todos
get
Approve a review request
put
Reject a review request
put
Workflows
List workflows
get
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
Update documents
put
{protocol}://{base-url}/integration/v2/document/
Update documents in bulk.
Language
Shell
Node
Ruby
PHP
Python
Credentials
Header
Header
URL
Base URL
https
://
alation_domain
/integration/v2
/document/
