Jump to Content
Alation APIs
HomeGuidesRecipesAPI ReferencePython SDK
Alation Help CenterAlation APIs
API Reference
Alation Help Center
HomeGuidesRecipesAPI ReferencePython SDK

OAuth 2.0 API V2

  • Authorization and Verification
    • Create JSON web token (JWT)post
    • Introspect JSON Web Token (JWT)post
    • Get JSON Web Key Setget

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

Aggregated Context API (Beta)

  • Context
    • Get relevant objects for RAGget

Articles API

  • Article Overview
  • Article
    • GET all articlesget
    • POST an articlepost
    • DELETE an articledelete
    • GET an articleget
    • UPDATE an articleput
    • Resurrect an articlepost

Alation Agent API

  • Agent
    • Get a list of Agentsget
    • Create an Alation Agentpost
    • Retrieve the Agent connectivity endpointget
    • List available Debian Alation Agent installer versionsget
    • Download a specific Debian Alation Agent installer versionget
    • List available RHEL Alation Agent installer versionsget
    • Download a specific RHEL Alation Agent installer versionget
    • Delete an Alation Agentdelete
    • Get an Alation Agentget
    • Update an Alation Agentpatch
    • Resync an Alation Agentpost
    • Revoke the certificate of the Alation Agentpost
    • Sign a certificate for the Alation Agentpost
  • Authentication Service
    • List available Authentication Service addon versionsget
    • Download a specific Authentication Service addon versionget

BI Source API

  • BI Source (GBMv2) Overview
  • server
    • GET a list of BI Serversget
    • Create a list of BI Serverspost
    • GET a BI Serverget
    • Update a BI Serverpatch
    • Migrate curation data for a BI Serverpost
  • folder
    • DELETE a set of folders from a specified BI Serverdelete
    • GET a list of folders from a specified BI Serverget
    • Create/Update a list of folder objectspost
    • DELETE a BI folderdelete
    • GET a BI folderget
    • Partially update a BI folderpatch
  • connection
    • DELETE a set of connections from a specified BI Serverdelete
    • GET a list of connections from a specified BI Serverget
    • Create/Update a list of connection objectspost
    • DELETE a set of connection columns from a specified BI Serverdelete
    • GET a set of connection columns from a specified BI Serverget
    • Create/Update a list of connection column objectspost
    • DELETE a connection columndelete
    • GET a connection columnget
    • Partially update a connection columnpatch
    • DELETE a connectiondelete
    • GET a connectionget
    • Partially update a connectionpatch
  • report
    • DELETE a set of reports from a specified BI Serverdelete
    • GET a list of reports from a specified BI Serverget
    • Create/Update a list of report objectspost
    • DELETE a set of report columns from a specified BI Serverdelete
    • GET a set of report columns from a specified BI Serverget
    • Create/Update a list of report column objectspost
    • DELETE a Report columndelete
    • GET a Report columnget
    • Partially update a Report columnpatch
    • DELETE a Reportdelete
    • GET a Reportget
    • Partially update a Reportpatch
  • datasource
    • DELETE a set of datasources from a specified BI Serverdelete
    • GET a set of datasources from a specified BI Serverget
    • Create/Update a list of Datasourcespost
    • DELETE a set of datasource columns from a specified BI Serverdelete
    • GET a set of datasource columns from a specified BI Serverget
    • Create/Update a list of Datasource Columnspost
    • DELETE a Datasource columndelete
    • GET a Datasource columnget
    • Partially update a Datasource columnpatch
    • DELETE a Datasourcedelete
    • GET a Datasourceget
    • Partially update a Datasourcepatch
  • permission
    • DELETE a set of BI permissions from a specified BI serverdelete
    • GET a list of BI permissions from a specified BI Serverget
    • Create/Update a list of BI Permissionspost
    • DELETE a BI permissiondelete
    • GET a BI permissionget
  • images
    • DELETE the current image associated to this object using imagetype querydelete
    • GET an image associated with a BI object from a BI Serverget
    • POST an image associated with a BI object from a BI Serverpost
  • user
    • DELETE a set of BI users from a specified BI Serverdelete
    • GET a list of BI users from a specified BI Serverget
    • Create/Update a list of BI userspost
    • DELETE a BI userdelete
    • GET a BI userget

Connectors API (OCF)

  • connectors
    • Get a list of connectorsget

Conversations API

  • Conversations
    • Get a list of conversationsget
    • Create a conversationpost
    • Delete a conversationdelete
    • Get a conversation by IDget
    • Update a conversationpatch
  • Posts
    • Get a list of conversation postsget
    • Create a conversation postpost
    • Delete a conversation postdelete
    • Get a conversation post by IDget
    • Update a conversation postpatch

Conversations API version 2

  • Conversations v2 Overview
  • Conversations
    • Get a list of conversationsget
    • Create a conversationpost
    • Delete a conversationdelete
    • Get a conversation by IDget
    • Update a conversationpatch
  • Assignees
    • Remove all assignees from a conversation with given IDdelete
    • Get a list of assignees for a conversation with given IDget
    • Remove a conversation assignee by IDdelete
    • Get a conversation assignee by IDget
    • Add one assignee to the conversationpost
  • Posts
    • Get a list of conversation postsget
    • Create a conversation postpost
    • Delete a conversation postdelete
    • Get a conversation post by IDget
    • Update a conversation postpatch

Custom Fields API

  • Custom Field Overview
  • Custom Field
    • Bulk Read Custom Fieldsget
    • Bulk Create Custom Fieldspost
    • Read a Builtin Custom Fieldget
    • Read a Custom Fieldget

Custom Field Values API

  • Custom Field Values Overview
  • Custom Field Value
    • GET multiple Custom Field Valuesget
    • PUT multiple Custom Field Valuesput
    • PUT multiple Custom Field Values Asyncput

Data Dictionary API

  • Data Dictionary
    • Get data dictionary task detailsget
    • Get data dictionary task errorsget
    • Upload a data dictionaryput

Data Health API

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

Datasources API

  • Native Data Sources API Overview
  • datasource
    • Get a list of datasourcesget
    • Create a datasourcepost
    • Delete a datasourcedelete
    • Get a datasourceget
    • Update a datasourceput
  • datasource config checks
    • Verify configuration checksget
    • Verify network connection statusget
    • Verify service account authentication statusget
    • Verify service account privilegesget
  • datasource metadata extraction
    • Get a list of available schemasget
    • Trigger metadata extraction jobpost
    • Get metadata extraction configurationsget
    • Update metadata extraction configurationspatch
    • Update metadata extraction configurationsput
  • 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)

  • datasource
    • Get a list of datasourcesget
    • Create a datasourcepost
    • Delete a datasourcedelete
    • Get a datasourceget
    • Update an OCF datasourceput
  • datasource metadata extraction
    • Get a list of available schemasget
    • Trigger metadata extraction jobpost
    • Trigger job to sync schemas from data sourcepost
    • Get metadata extraction configurationsget
    • Update metadata extraction configurationspatch
  • datasource configuration
    • Get General Configuration for Datasourceget
    • Update general settings configuration except Authpatch
  • datasource config checks
    • Verify configuration checksget
    • Verify network connection statusget
    • Verify service account authentication statusget
    • Verify service account privilegesget

Documents API

  • Documents
    • Delete documentsdelete
    • Retrieve documentsget
    • Create documentspost
    • Update documentsput

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 detailsget
    • Move a domainpatch
    • Adds the requested objects to a domain.post
    • It allows user to browse the domain rules, with some filters.post

Folder API

  • Folders
    • Delete foldersdelete
    • Retrieve foldersget
    • Create folderspost
    • Update foldersput

Groups API

  • Group Overview
  • Group
    • GET multiple Groupsget
    • GET a Groupget

Homepage Preferences API

  • Homepage Preferences
    • Update group homepage preferencesput

Lineage API v2

  • Lineage & Dataflows Overview
  • Dataflow
    • Delete a list of Dataflow objectsdelete
    • Get Dataflow object details and related pathsget
    • Update a list of Dataflow objectspatch
    • Create/Replace a list of Dataflow objects with lineage infomationpost
  • Lineage
    • Delete lineage informationdelete
    • Get lineage informationget
    • Post lineage informationpost
  • Cross-System Lineage
    • Delete cross-system lineage recordsdelete
    • Get cross-system lineage recordsget
    • Create cross-system lineage recordspost
    • Update cross-system lineage recordsput
    • Delete cross-system lineage recorddelete
    • Get cross-system lineage recordget
    • Update cross-system lineage recordput

Lineage API v3

  • Lineage
    • Delete lineage (beta)delete

My Domains API

  • My Domains
    • Associate users and groups to domainsput

Members Permission API

  • Members Permission
    • Add members to a resource.post
    • Replace members of a resource.put
    • Remove members from a resource.delete

NoSQL API v2

  • NoSQL
    • Delete NoSQL data objectsdelete
    • Retrieve NoSQL dataget
    • Update NoSQL data objectspatch
    • Create NoSQL metadatapost

Otypes API

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

Policy API

  • Policies
    • Delete Policies in bulkdelete
    • List Policiesget
    • Create Policies in bulkpost
    • Update Policies in bulkput
  • Policy Groups
    • List Policy Groupsget

Privacy Settings API

  • Resource Privacy Settings
    • Manage resource privacy settingspatch

Relational Integration API

  • Relational Integration API Overview
  • 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
  • Column
    • Get columns along with its custom fieldsget
    • Create new columns under a particular data sourcepost
  • Child columns
    • Update children of root columnspatch
    • Fetch children for columnget
    • Update children of a sub-columnpatch
  • Joins
    • Get joins by column (attribute) IDget
    • Get joins by table IDget
    • Get joins by column (attribute) nameget
    • Get joins by table nameget
    • Get joins by data sourceget

SCIM 2.0 API

  • Authorization and Integration
    • Create SCIM Tokenpost

Search API

  • Search Overview
  • Search
    • GET a response from the search API endpointget
  • Synonyms
    • Retrieves synonym manifestget
    • Clears current synonym manifestdelete
    • Replaces current synonym manifestpost

Terms API

  • Terms
    • Delete termsdelete
    • Retrieve termsget
    • Create termspost
    • Update termsput

Template Visual Config API

  • Visual Config
    • Create a new visual configpost
    • List all visual configsget
    • Get a specific visual configget
    • Update an existing visual configput
    • Delete a visual configdelete
    • Get a list of visual configs per object typeget

User API

  • User Overview
  • User
    • GET multiple Usersget
    • GET a Userget
    • GET authenticated User detailsget
  • 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

  • Workflows
    • List workflowsget
  • Requests
    • List requestsget
    • Create a requestpost
    • Show request detailsget
  • Review requests
    • List my review todosget
    • Approve a review requestput
    • Reject a review requestput

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

datasource metadata extraction

Datasource MDE API

Intro information is available here

  • Table of Contents
    • Datasource MDE API
Terms and Conditions | Privacy Policy | Cookie Policy | Your Privacy Choices