Home
HomeGuidesRecipesAPI ReferencePython SDKAI Agent SDKAlation's MCP Server
HomeAlation Help Center
Guides
Alation Help Center

API by Roles

Refer to this table for information on Alation user roles mapped to Alation API endpoints.

Suggest Edits

See Roles Overview in the Alation documentation for definitions of the user roles.

📘

Explorer Role

The Explorer role is available starting in 2023.1, only for Alation Cloud Service customers on the cloud-native architecture.

Explorers can use the Query API (except the CREATE endpoint); otherwise Explorers have the same API permissions as the Viewer role.

Aggregated Context API

(Available from version 2025.1.2)

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
Get relevant objects for RAG
  • /integration/v2/context/
GETYesYesYesYesYesYesYes

AI APIs

(Available from version 2025.3.2)

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
Download Asset
  • ai/api/v1/assets/{asset_id}
GETYesYesYesYesYesYesYes
Create and Retrieve Chat
  • /ai/api/v1/chats
GET, POSTYesYesYesYesYesYesYes
Update a Chat's Metadata
  • /ai/api/v1/chats/{chat_id}
PATCHYesYesYesYesYesYesYes
Get Expected Evaluation Output of a Chat
  • /ai/api/v1/chats/{chat_id}/eval_expected_output
GETYesYesYesYesYesYesYes
Get a Page of Chat's Messages
  • /ai/api/v1/chats/{chat_id}/messages
GETYesYesYesYesYesYesYes
Add or Remove Tags from a Chat
  • /ai/api/v1/chats/{chat_id}/tags/add
  • /ai/api/v1/chats/{chat_id}/tags/remove
POSTYesYesYesYesYesYesYes
Message an Agent (Async) and (Streaming)
  • /ai/api/v1/chats/agent/{agent_config_id}/call
  • /ai/api/v1/chats/agent/{agent_config_id}/stream
POSTYesYesYesYesYesYesYes
Message the Dashboard Search Agent (Async) and (Streaming)
  • /ai/api/v1/chats/agent/default/bi_report_agent/call
  • /ai/api/v1/chats/agent/default/bi_report_agent/stream
POSTNoNoNoNoNoNoYes
Message the Catalog Context Search Agent (Async) and (Streaming)
  • /ai/api/v1/chats/agent/default/catalog_context_search_agent/call
  • /ai/api/v1/chats/agent/default/catalog_context_search_agent/stream
POSTYesYesYesYesYesYesYes
Message the Catalog Search Agent (Async) and (Streaming)
  • /ai/api/v1/chats/agent/default/catalog_search_agent/call
  • /ai/api/v1/chats/agent/default/catalog_search_agent/stream
POSTYesYesYesYesYesYesYes
Message the Chart Generation Agent (Async) and (Streaming)
  • /ai/api/v1/chats/agent/default/charting_agent/call
  • /ai/api/v1/chats/agent/default/charting_agent/stream
POSTYesYesYesYesYesYesYes
Message the Curation Agent (Async) and (Streaming)
  • /ai/api/v1/chats/agent/default/curation_agent/call
  • /ai/api/v1/chats/agent/default/curation_agent/stream
POSTYesYesYesYesYesYesYes
Message the Data Product Query Agent (Async) and (Streaming)
  • /ai/api/v1/chats/agent/default/data_product_query_agent/call
  • /ai/api/v1/chats/agent/default/data_product_query_agent/stream
POSTYesYesYesYesYesYesYes
Message the Data Product Question Manager Agent (Async) and (Streaming)
  • /ai/api/v1/chats/agent/default/data_product_question_manager_agent/call
  • /ai/api/v1/chats/agent/default/data_product_question_manager_agent/stream
POSTYesYesYesYesYesYesYes
Message the Deep Research Agent (Async) and (Streaming)
  • /ai/api/v1/chats/agent/default/deep_research_agent/call
  • /ai/api/v1/chats/agent/default/deep_research_agent/stream
POSTYesYesYesYesYesYesYes
Message the Analytics Agent (Async) and (Streaming)
  • /ai/api/v1/chats/agent/default/query_flow_agent/call
  • /ai/api/v1/chats/agent/default/query_flow_agent/stream
POSTYesYesYesYesYesYesYes
Message the Query Agent (Async) and (Streaming)
  • /ai/api/v1/chats/agent/default/sql_query_agent/call
  • /ai/api/v1/chats/agent/default/sql_query_agent/stream
POSTYesYesYesYesYesYesYes
Query the Alation Context Tool (Async) and (Streaming)
  • /ai/api/v1/chats/tool/default/alation_context_tool/call
  • /ai/api/v1/chats/tool/default/alation_context_tool/stream
POSTYesYesYesYesYesYesYes
Query the Analyze Catalog Question Tool (Async) and (Streaming)
  • /ai/api/v1/chats/tool/default/analyze_catalog_question_tool/call
  • /ai/api/v1/chats/tool/default/analyze_catalog_question_tool/stream
POSTYesYesYesYesYesYesYes
Query the BI Report Search Tool (Async) and (Streaming)
  • /ai/api/v1/chats/tool/default/bi_report_search_tool/call
  • /ai/api/v1/chats/tool/default/bi_report_search_tool/stream
POSTNoNoNoNoNoNoYes
Query the Bulk Retrieval Tool (Async) and (Streaming)
  • /ai/api/v1/chats/tool/default/bulk_retrieval_tool/call
  • /ai/api/v1/chats/tool/default/bulk_retrieval_tool/stream
POSTYesYesYesYesYesYesYes
Query the Delete SQL Evaluation Case Tool (Async) and (Streaming)
  • /ai/api/v1/chats/tool/default/delete_sql_eval_case_tool/call
  • /ai/api/v1/chats/tool/default/delete_sql_eval_case_tool/stream
POSTYesYesYesYesYesYesYes
Query the Chart Generation Tool (Async) and (Streaming)
  • /ai/api/v1/chats/tool/default/generate_chart_from_sql_and_code_tool/call
  • /ai/api/v1/chats/tool/default/generate_chart_from_sql_and_code_tool/stream
POSTYesYesYesYesYesYesYes
Query the Chart Generation from Asset Tool (Async) and (Streaming)
  • /ai/api/v1/chats/tool/default/generate_chart_tool/call
  • /ai/api/v1/chats/tool/default/generate_chart_tool/stream
POSTYesYesYesYesYesYesYes
Query the Get Catalog Object Tool (Async) and (Streaming)
  • /ai/api/v1/chats/tool/default/get_catalog_object_tool/call
  • /ai/api/v1/chats/tool/default/get_catalog_object_tool/stream
POSTYesYesYesYesYesYesYes
Query the Get Custom Fields Definitions Tool (Async) and (Streaming)
  • /ai/api/v1/chats/tool/default/get_custom_fields_definitions_tool/call
  • /ai/api/v1/chats/tool/default/get_custom_fields_definitions_tool/stream
POSTYesYesYesYesYesYesYes
Query the Get Data Product Raw Specification Tool (Async) and (Streaming)
  • /ai/api/v1/chats/tool/default/get_data_product_spec_tool/call
  • /ai/api/v1/chats/tool/default/get_data_product_spec_tool/stream
POSTYesYesYesYesYesYesYes
Query the Get Data Schema Tool (Async) and (Streaming)
  • /ai/api/v1/chats/tool/default/get_data_schema_tool/call
  • /ai/api/v1/chats/tool/default/get_data_schema_tool/stream
POSTYesYesYesYesYesYesYes
Query the Get Data Sources Tool (Async) and (Streaming)
  • /ai/api/v1/chats/tool/default/get_data_sources_tool/call
  • /ai/api/v1/chats/tool/default/get_data_sources_tool/stream
POSTYesYesYesYesYesYesYes
Query the Get Groups Tool (Async) and (Streaming)
  • /ai/api/v1/chats/tool/default/get_groups_tool/call
  • /ai/api/v1/chats/tool/default/get_groups_tool/stream
POSTYesYesYesYesYesYesYes
Query the Get Search Filter Fields Tool (Async) and (Streaming)
  • /ai/api/v1/chats/tool/default/get_search_filter_fields_tool/call
  • /ai/api/v1/chats/tool/default/get_search_filter_fields_tool/stream
POSTYesYesYesYesYesYesYes
Query the Get Search Filter Values Tool (Async) and (Streaming)
  • /ai/api/v1/chats/tool/default/get_search_filter_values_tool/call
  • /ai/api/v1/chats/tool/default/get_search_filter_values_tool/stream
POSTYesYesYesYesYesYesYes
Query the Get Signature Creation Instructions Tool (Async) and (Streaming)
  • /ai/api/v1/chats/tool/default/get_signature_creation_instructions_tool/call
  • /ai/api/v1/chats/tool/default/get_signature_creation_instructions_tool/stream
POSTYesYesYesYesYesYesYes
Query the Get SQL Evaluation Case Tool (Async) and (Streaming)
  • /ai/api/v1/chats/tool/default/get_sql_eval_case_tool/call
  • /ai/api/v1/chats/tool/default/get_sql_eval_case_tool/stream
POSTYesYesYesYesYesYesYes
Query the Get SQL Evaluation Set Tool (Async) and (Streaming)
  • /ai/api/v1/chats/tool/default/get_sql_eval_set_tool/call
  • /ai/api/v1/chats/tool/default/get_sql_eval_set_tool/stream
POSTYesYesYesYesYesYesYes
Query the Get Users Tool (Async) and (Streaming)
  • /ai/api/v1/chats/tool/default/get_users_tool/call
  • /ai/api/v1/chats/tool/default/get_users_tool/stream
POSTYesYesYesYesYesYesYes
Query the List Assets Tool (Async) and (Streaming)
  • /ai/api/v1/chats/tool/default/list_assets_tool/call
  • /ai/api/v1/chats/tool/default/list_assets_tool/stream
POSTYesYesYesYesYesYesYes
Query the List Available Data Products pertaining to the Query Tool (Async) and (Streaming)
  • /ai/api/v1/chats/tool/default/list_data_products_tool/call
  • /ai/api/v1/chats/tool/default/list_data_products_tool/stream
POSTYesYesYesYesYesYesYes
Query the Retrieve Asset Tool (Async) and (Streaming)
  • /ai/api/v1/chats/tool/default/retrieve_asset_tool/call
  • /ai/api/v1/chats/tool/default/retrieve_asset_tool/stream
POSTYesYesYesYesYesYesYes
Query the Save Asset Tool (Async) and (Streaming)
  • /ai/api/v1/chats/tool/default/save_asset_tool/call
  • /ai/api/v1/chats/tool/default/save_asset_tool/stream
POSTYesYesYesYesYesYesYes
Query the Search Catalog Tool (Async) and (Streaming)
  • /ai/api/v1/chats/tool/default/search_catalog_tool/call
  • /ai/api/v1/chats/tool/default/search_catalog_tool/stream
POSTYesYesYesYesYesYesYes
Query the SQL Evaluation Tool (Async) and (Streaming)
  • /ai/api/v1/chats/tool/default/sql_evaluation_tool/call
  • /ai/api/v1/chats/tool/default/sql_evaluation_tool/stream
POSTYesYesYesYesYesYesYes
Query the SQL Execution Tool (Async) and (Streaming)
  • /ai/api/v1/chats/tool/default/sql_execution_tool/call
  • /ai/api/v1/chats/tool/default/sql_execution_tool/stream
POSTYesYesYesYesYesYesYes
Query the Update Catalog Object Tool (Async) and (Streaming)
  • /ai/api/v1/chats/tool/default/update_catalog_object_tool/call
  • /ai/api/v1/chats/tool/default/update_catalog_object_tool/stream
POSTNoNoNoYesYesYesYes
Query the Update SQL Evaluation Case Tool (Async) and (Streaming)
  • /ai/api/v1/chats/tool/default/update_sql_eval_case_tool/call
  • /ai/api/v1/chats/tool/default/update_sql_eval_case_tool/stream
POSTYesYesYesYesYesYesYes
Query the Upload SQL Evaluation Set Tool (Async) and (Streaming)
  • /ai/api/v1/chats/tool/default/upload_sql_eval_set_tool/call
  • /ai/api/v1/chats/tool/default/upload_sql_eval_set_tool/stream
POSTYesYesYesYesYesYesYes
Get or Create Agent Configuration
  • /ai/api/v1/config/agent
GET, POSTYesYesYesYesYesYesYes
Get, Update, or Delete Agent Configuration
  • /ai/api/v1/config/agent/{agent_config_id}
DELETE, GET, PATCHYesYesYesYesYesYesYes
Clone an Agent Configuration
  • /ai/api/v1/config/agent/{agent_config_id}/clone
POSTYesYesYesYesYesYesYes
Clone a Deep-research Agent Configuration
  • /ai/api/v1/config/agent/{agent_config_id}/clone_deep_research
POSTYesYesYesYesYesYesYes
Publish an Agent as a Tool
  • /ai/api/v1/config/agent/{agent_config_id}/publish_as_tool
POSTYesYesYesYesYesYesYes
Unpublish an Agent as a Tool
  • /ai/api/v1/config/agent/{agent_config_id}/unpublish_tool
DELETEYesYesYesYesYesYesYes
Get a Default Agent Configuration
  • /ai/api/v1/config/agent/default/{default_agent_ref}
GETYesYesYesYesYesYesYes
Get LLM Configurations
  • /ai/api/v1/config/llm
GETYesYesYesYesYesYesYes
Get an LLM Configuration
  • /ai/api/v1/config/llm/{llm_config_id}
GETYesYesYesYesYesYesYes
Get Tool Configurations
  • /ai/api/v1/config/tool
GETYesYesYesYesYesYesYes
Get a Tool Configuration
  • /ai/api/v1/config/tool/{tool_config_id}
GETYesYesYesYesYesYesYes
Extract Metrics from SQL
  • /ai/api/v1/data_product/{data_product_id}/extract_metrics
POSTYesYesYesYesYesYesYes
Initiate Revise Data Product Workflow
  • /ai/api/v1/data_product/{data_product_id}/revise_data_product
POSTYesYesYesYesYesYesYes
Get All Revise Data Product Results
  • /ai/api/v1/data_product/{data_product_id}/revise_data_product/results
GETYesYesYesYesYesYesYes
Get Revise Data Product Result
  • /ai/api/v1/data_product/{data_product_id}/revise_data_product/results/{result_id}
GETYesYesYesYesYesYesYes
Validate SQL
  • /ai/api/v1/data_product/{data_product_id}/validate_sql
POSTYesYesYesYesYesYesYes
Create Data Product
  • /ai/api/v1/data_product/create_data_product
POSTYesYesYesYesYesYesYes
Get a Data Product Task
  • /ai/api/v1/data_product/get_data_product/{task_id}
GETYesYesYesYesYesYesYes
Get a Data Product Metrics Extraction Task
  • /ai/api/v1/data_product/get_metrics/{task_id}
GETYesYesYesYesYesYesYes
Update Data Product Description
  • /ai/api/v1/data_product/update_data_product_description
POSTYesYesYesYesYesYesYes
Get, Update, or Delete Evaluation Case
  • /ai/api/v1/evaluation_cases/{eval_case_id}
DELETE, GET, PATCHYesYesYesYesYesYesYes
Get or Delete the results of an Evaluation Run
  • /ai/api/v1/evaluation_results/{eval_result_id}
DELETE, GETYesYesYesYesYesYesYes
Download a CSV of the Generic Evaluation Run
  • /ai/api/v1/evaluation_results/{eval_result_id}/csv
GETYesYesYesYesYesYesYes
Get or Create Generic Evaluation Sets
  • /ai/api/v1/evaluation_sets
POST, GETYesYesYesYesYesYesYes
Get, Update, or Delete Generic Evaluation Set by ID
  • /ai/api/v1/evaluation_sets/{eval_set_id}
DELETE, GET, PATCHYesYesYesYesYesYesYes
Create Generic Evaluation Cases
  • /ai/api/v1/evaluation_sets/{eval_set_id}/cases
POSTYesYesYesYesYesYesYes
Create Generic Evaluation Cases from a JSON file
  • /ai/api/v1/evaluation_sets/{eval_set_id}/cases/json
POSTYesYesYesYesYesYesYes
Get Results for an Evaluation Run
  • /ai/api/v1/evaluation_sets/{eval_set_id}/results
GETYesYesYesYesYesYesYes
Run Generic Evaluation on an Evaluation Set.
  • /ai/api/v1/evaluation_sets/{eval_set_id}/run
POSTYesYesYesYesYesYesYes
Get or Submit Feedback for a Data Product
  • /ai/api/v1/feedback
GET, POSTYesYesYesYesYesYesYes
Get, Update, or Delete a Single Feedback for a Data Product
  • /ai/api/v1/feedback/{feedback_id}
DELETE, GET, PATCHYesYesYesYesYesYesYes
Run a SQL Evaluation on a Data Product's Evaluation Set
  • /ai/api/v1/run_sql_evaluation/{data_product_id}
POSTYesYesYesYesYesYesYes
Get a SQL Evaluation Set for a Data Product
  • /ai/api/v1/sql_evaluation_results/{data_product_id}
GETYesYesYesYesYesYesYes
Get or Delete a SQL Evaluation Result for a Data Product
  • /ai/api/v1/sql_evaluation_results/{data_product_id}/{eval_result_id}
DELETE, GETYesYesYesYesYesYesYes
Download a CSV SQL Evaluation Result for a Data Product
  • /ai/api/v1/sql_evaluation_results/{data_product_id}/{eval_result_id}/csv
GETYesYesYesYesYesYesYes
Get or Create SQL Evaluation Sets for a Data Product
  • /ai/api/v1/sql_evaluation_set/{data_product_id}
GET, POSTYesYesYesYesYesYesYes
Get, Update, or Delete SQL Evaluation Case
  • /ai/api/v1/sql_evaluation_set/{data_product_id}/{eval_case_id}
DELETE, GET, PATCHYesYesYesYesYesYesYes
Create SQL Evaluation Cases from a CSV
  • /ai/api/v1/sql_evaluation_set/{data_product_id}/csv
POSTYesYesYesYesYesYesYes
Get Details About a Specific Task
  • /ai/api/v1/task/{task_id}
GETYesYesYesYesYesYesYes

Alation Agent API

(Available from version 2023.1.4)

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
Get and create Agents
  • /integration/v1/agent/
GET, POSTNoNoNoNoNoNoYes
List available Agent installers
  • /integration/v1/agent/installers/debian/
  • /integration/v1/agent/installers/rhel/
GETNoNoNoNoNoNoYes
Download Agent installers
  • /integration/v1/agent/installers/debian/{version}/
  • /integration/v1/agent/installers/rhel/{version}/
GETNoNoNoNoNoNoYes
List available Authentication Service add-ons
  • /integration/v1/agent/addons/auth/
GETNoNoNoNoNoNoYes
Download Authentication Service add-on
  • /integration/v1/agent/addons/auth/{version}
GETNoNoNoNoNoNoYes
Get the Agent connectivity endpoint
  • /integration/v1/agent/endpoint/
GETNoNoNoNoNoNoYes
Get, update, resync, and delete an Agent
  • /integration/v1/agent/{agent_id}
  • /integration/v1/agent/{agent_id}/resync/
GET, POST, PATCH, DELETENoNoNoNoNoNoYes
Revoke or sign an Agent's certificate
  • /integration/v1/agent/{agent_id}/revoke_certificate/
  • /integration/v1/agent/{agent_id}/sign_certificate/
POSTNoNoNoNoNoNoYes

API Tokens Authentication & Management

(Available from version 2020.3)

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
Create a Refresh Token
  • /integration/v1/createRefreshToken/
POSTYesYesYesYesYesYesYes
Regenerate a Refresh Token
  • /integration/v1/regenRefreshToken/
POSTYesYesYesYesYesYesYes
Create an API Access Token
  • /integration/v1/createAPIAccessToken/
POSTYesYesYesYesYesYesYes
Revoke an API Access Token
  • /integration/v1/revokeAPIAccessTokens/
POSTYesYesYesYesYesYesYes
Validate an API Access Token
  • /integration/v1/validateAPIAccessToken/
POSTYesYesYesYesYesYesYes
Validate a Refresh Token
  • /integration/v1/validateRefreshToken/
POSTYesYesYesYesYesYesYes

API Resource API

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
Retrieve an API Resource
  • /integration/v1/api_resource/<HTTP_method>:<url>/
GETYesYesYesYesYesYesYes
Create, update, or delete an API Resource
  • /integration/v1/api_resource/<HTTP_method>:<url>/
POST, PUT, PATCH, DELETENoNoNoNoNoNoYes

Articles API

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
Create a new Article
  • /integration/v1/article/
POSTNoNoYesYesYesYesYes
Article Detail
  • /integration/v1/article/<article_id>/
GETYesYesYesYesYesYesYes
Get all Articles
  • /integration/v1/article/?<params>
GETYesYesYesYesYesYesYes
Update an Article
  • /integration/v1/article/<article_id>/
PUTNoNoYesYesYesYesYes
Delete an Article API
  • /integration/v1/article/<article_id>/
DELETENoNoYesYesYesYesYes
Restore an Article API
  • /integration/v1/article/<article_id>/resurrect/
POSTNoNoYesYesYesYesYes

BI Source API (GBM V2)

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
API operations with BI server objects
  • /integration/v2/bi/server/
GET, POST, PATCHNoNoNoNoNoNoYes
API operations with BI folder objects
  • /integration/v2/bi/server/{server_id}/folder/
GET, POST, PATCH, DELETENoNoNoNoNoNoYes
API operations with BI report and column objects
  • /integration/v2/bi/server/{server_id}/report/
  • /integration/v2/bi/server/{server_id}/report/column
GET, POST, PATCH, DELETENoNoNoNoNoNoYes
API operations with BI datasource objects
  • /integration/v2/bi/server/{server_id}/datasource/
  • /integration/v2/bi/server/{server_id}/datasource/column
GET, POST, PATCH, DELETENoNoNoNoNoNoYes
API operations with BI object permissions
  • /integration/v2/bi/server/{server_id}/permission
GET, POST, DELETENoNoNoNoNoNoYes
Fetch, create, or delete Images
  • /integration/v2/bi/server/{server_id}/report/{id}/image
GET, PUT, PATCH, DELETENoNoNoNoNoNoYes
API operations with BI user object
  • /integration/v2/bi/server/{server_id}/user
GET, PUT, PATCH, DELETENoNoNoNoNoNoYes

Connectors (OCF) API

(Available from version 2022.4)

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
Get a List of Connectors
  • /integration/v2/connectors/
GETNoNoNoNoNoNoYes

Conversations API

(Available from version 2023.1)

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
Get, create, update, and delete conversations and posts
  • /integration/v1/conversations/
  • /integration/v1/conversations/<conversation_id>/posts/
Get, add, and delete assignees to conversation
  • /integration/v1/conversations/<conversation_id>/assignees/
  • /integration/v1/conversations/<conversation_id>/assignees/<assignee_otype>/<assignee_id>
GET, POST, PATCH, DELETEYesYesYesYesYesYesYes

Custom Field API

(Available from version 2020.3)

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
Get all the active Custom Fields
  • /integration/v2/custom_field/
GETNoNoNoNoNoYesYes
Create Custom Fields in Bulk
  • /integration/v2/custom_field/
POSTNoNoNoNoNoYesYes
Get Built-in Custom Fields
  • /integration/v2/custom_field/builtin/{builtin_name}/
GETNoNoNoNoNoYesYes
Get Custom Field by ID
  • /integration/v2/custom_field/{id}/
GETNoNoNoNoNoYesYes

Custom Field Values API

(Available from version 2020.3)

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
Get Custom Field values
  • /integration/v2/custom_field_value/
GETNoNoNoNoNoYesYes
Update Custom Field values
  • /integration/v2/custom_field_value/
PUTNoNoNoNoNoYesYes
Update Custom Field values for many objects types
  • /integration/v2/custom_field_value/async/
PUTNoNoNoNoNoYesYes

Custom Fields

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
  • /api/v1/bulk_metadata/data_dictionary/<otype>?custom_fields=<fields_json>
GETYesYesYesYesYesYesYes

Custom Template API

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
Custom Template details
  • /integration/v1/custom_template/<custom_template_id>
GETYesYesYesYesYesYesYes
Get all Custom Templates
  • /integration/v1/custom_template/?<params>
GETYesYesYesYesYesYesYes

Data Dictionary API

(Available from version 2023.3)

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
Get data dictionary task details and errors
  • /integration/v1/data_dictionary/tasks/{task_id}/
  • /integration/v1/data_dictionary/tasks/{task_id}/errors/ Upload data dictionary
  • /integration/v1/data_dictionary/{object_type}/{object_id}/upload/
GET, PUTNoNoYes***Yes***Yes***YesYes

*** When the parameter alation.feature_flags.disable_perm_check_on_upload_dd is set to false in alation_conf (false is the default).

Data Health API

(Available from version 2022.3)

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
Get data health fields or values
  • /integration/v1/data_quality/fields/
  • /integration/v1/data_quality/values/
GETYesYesYesYesYesYesYes
Create or delete data health rules
  • /integration/v1/data_quality/
POST, DELETENoNoNoNoYesYesYes

Data Sources API (Native) - Data Source

(Available from version 2020.4)

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
Create a data source
  • /integration/v1/datasource/
POSTNoNoNoNoYes**Yes**Yes
Delete or update a data source
  • /integration/v1/datasource/<ds_id>/
PUT, DELETENoNoYes*Yes*Yes*Yes*Yes
Retrieve single or multiple data sources
  • /integration/v1/datasource/
  • /integration/v1/datasource/<ds_id>/
GETYesYesYesYesYesYesYes

* API user must be given Data Source Admin access to the data source in the Alation catalog.
** When Catalog Admin and Source Admin roles are permitted to add data sources (with the alation_conf flag alation.roles.allow_source_and_catalog_admins_to_create_ds set to true).

Data Sources API (Native) - Metadata Extraction

(Available from version 2020.4)

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
Get a list of available schemas
  • /integration/v1/datasource/<ds_id>/available_schemas/
GETNoNoNoNoNoNoYes
Sync schemas
  • /integration/v2/datasource/{datasource_id}/refresh_available_schemas/
POSTNoNoNoNoNoNoYes
Kick off metadata extraction job
  • /integration/v1/datasource/<ds_id>/metadata_extraction_job/
POSTYes*Yes*Yes*Yes*Yes*Yes*Yes*
Get or update metadata extraction configurations
  • /integration/v1/datasource/<ds_id>/sync_configuration/metadata_extraction/
GET, PUT, PATCHNoNoNoNoNoNoYes

* API user must be given Data Source Admin access to the data source in the Alation catalog.

Data Sources API (Native) - Config Checks

(Available from version 2020.4)

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
Verify data source configuration
  • /integration/v1/datasource/<ds_id>/configuration_check/
GETNoNoYes*Yes*Yes*Yes*Yes
Verify network connection status
  • /integration/v1/datasource/<ds_id>/configuration_check/network_connection/
GETNoNoYes*Yes*Yes*Yes*Yes
Verify service account authentication status and privileges
  • /integration/v1/datasource/<ds_id>/configuration_check/service_account_authentication/
  • /integration/v1/datasource/<ds_id>/configuration_check/service_account_privileges/
GETNoNoYes*Yes*Yes*Yes*Yes

* API user must be given Data Source Admin access to the data source in the Alation catalog.

Data Sources API (Native) - Migrate Native to OCF

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
Bulk migrate data sources to OCF
(Available from version 2023.1.5)
  • /integration/v1/datasource/bulk_migrate
POSTNoNoNoNoNoNoYes
Get a list of OCF connectors and their native data sources
(Available from version 2023.3)
  • /integration/v1/datasource/{db_type}/connectors
GETNoNoNoNoYes**Yes**Yes

** When Catalog Admin and Source Admin roles are permitted to add data sources (with the alation_conf flag alation.roles.allow_source_and_catalog_admins_to_create_ds set to true).

Data Sources API (OCF)

(Available from version 2022.4)

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
Create a data source
  • /integration/v2/datasource/
POSTNoNoNoNoYes**Yes**Yes
Delete or update a data source
  • /integration/v2/datasource/<ds_id>/
PUT, DELETENoNoYes*Yes*Yes*Yes*Yes
Retrieve data sources
  • /integration/v2/datasource/
  • /integration/v2/datasource/<ds_id>/
GETYesYesYesYesYesYesYes

* API user must be given Data Source Admin access to the data source in the Alation catalog.

** When Catalog Admin and Source Admin roles are permitted to add data sources (with the alation_conf flag alation.roles.allow_source_and_catalog_admins_to_create_ds set to true).

Data Sources API (OCF) - Metadata Extraction

(Available from version 2022.4)

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
Get a list of available schemas
  • /integration/v2/datasource/{datasource_id}/available_schemas/
GETNoNoNoNoNoNoYes
Kick off metadata extraction job
  • /integration/v2/datasource/{datasource_id}/metadata_extraction_job/
POSTYes*Yes*Yes*Yes*Yes*Yes*Yes*
Get or update metadata extraction configurations
  • /integration/v2/datasource/{datasource_id}/sync_configuration/metadata_extraction/
GET, PATCHNoNoNoNoNoNoYes

* API user must be given Data Source Admin access to the data source in the Alation catalog.

Data Sources API (OCF) - Config Checks

(Available from version 2023.1)

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
Verify data source configuration
  • /integration/v2/datasource/<ds_id>/configuration_check/
GETNoNoYes*Yes*Yes*Yes*Yes
Verify network connection status
  • /integration/v2/datasource/<ds_id>/configuration_check/network_connection/
GETNoNoYes*Yes*Yes*Yes*Yes
Verify service account authentication status and privileges
  • /integration/v2/datasource/<ds_id>/configuration_check/service_account_authentication/
  • /integration/v2/datasource/<ds_id>/configuration_check/service_account_privileges/
GETNoNoYes*Yes*Yes*Yes*Yes

* API user must be given Data Source Admin access to the data source in the Alation catalog.

Data Sources API (OCF) - Configuration

(Available from version 2023.1.7)

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
Get and update general configuration settings for an OCF data source
  • /integration/v2/datasource/{datasource_id}/configuration/
GET, PATCHYes*Yes*Yes*Yes*Yes*Yes*Yes*

* API user must be given Data Source Admin access to the data source in the Alation catalog.

Data Source Browsing

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
Get Metadata for an object
  • /catalog/<otype>/?<params>
GETNoNoNoNoNoNoYes

Data Source Schemas

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
Get Schemas in a Data Source
  • /catalog/datasource/<datasource_id>/schema/?<params>
GETNoNoNoNoNoNoYes

Data Quality API

(Available from version 2025.3.2)

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
Create, Update, Retrieve, and Delete Monitors
  • /integration/v1/native_data_quality/monitor
POST, PUT, GET, DELETENoNoNoYesYesYesYes
Trigger a Monitor Run
  • /integration/v1/native_data_quality/monitor/{monitor_id}/check-run
POSTNoNoNoYesYesYesYes

Documents API

(Available from version 2024.1)

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
Get documents
  • /integration/v2/document/
GETYesYesYesYesYesYesYes
Create, update, and delete documents
  • /integration/v2/document/
POST, PUT, DELETENoNoNoNoNoYesYes

Domains API

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
Get, create, update, and delete domains and add objects to domains
  • /integration/v2/domain/
  • /integration/v2/domain/{domain_id}/
  • /integration/v2/domain/membership/
  • /integration/v2/domain/membership/view_rules/
GET, POST, PATCH, DELETENoNoNoNoNoYesYes

Flags API

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
Create a new Flag
  • /integration/flag/
POSTNoNoYesYesYesYesYes
Get Flag details
  • /integration/flag/<flag_id>
GETYesYesYesYesYesYesYes
Get All Flags
  • /integration/flag/?<params>
GETYesYesYesYesYesYesYes
Update a Flag
  • /integration/flag/<flag_id>/
PUTNoNoYesYesYesYesYes
Delete a Flag
  • /integration/flag/<flag_id>/
DELETENoNoYesYesYesYesYes

Folder API

(Available from version 2024.1.3)

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
Get folders
  • /integration/v2/folder/
GETYesYesYesYesYesYesYes
Create, update, and delete folders
  • /integration/v2/folder/
POST, PUT, DELETENoNoNoNoNoYesYes

Groups API

(Available from version 2020.3)

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
Get all Groups
  • /integration/v1/group/
GETNoNoNoNoNoNoYes
Get a Group
  • /integration/v1/group/{id}/
GETNoNoNoNoNoNoYes

Homepage Preferences API

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
Update group homepage preferences
  • /integration/v1/home/{homepage_id}/user/preference
PUTNoNoNoNoNoYesYes

Jobs API

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
Get job status
  • /api/v1/bulk_metadata/job/?<params>
GETYesYesYesYesYesYesYes

Lineage API v2

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
Get, create, and delete lineage
  • /integration/v2/lineage/
GET, POST, DELETENoNoNoNoYesNoYes
Get, create, update, and delete dataflows
  • /integration/v2/dataflow/
GET, POST, PATCH, DELETENoNoNoNoYesNoYes
Get, create, update, and delete multiple cross-system lineage records
  • /integration/v2/cross_system_lineage/
Get, update, and delete a specific cross-system lineage record
  • /integration/v2/cross_system_lineage/{csl_id}
GET, POST, PATCH, DELETENoNoNoNoYesYesYes

Lineage API v3

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
Delete lineage
  • /integration/v3/lineage/
DELETENoNoNoNoYesNoYes

Logging API

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
Prepare Audit Logs for Download
  • /integration/v1/logs/audit/export/
Download Logs
  • /integration/v1/logs/audit/download/
GET, POSTNoNoNoNoNoNoYes

Members Permission API

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
Add and replace member permissions
  • /integration/v1/members_permission/
Delete member permissions
  • /integration/v1/members_permission/{resource_type}/{resource_id}/members/
POST, PUT, DELETENoNoNoNoYes*Yes*Yes

* API user must be given Data Source Admin access to the data source in the Alation catalog.

My Domains API

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
Update users and groups assigned to domains
  • /integration/v1/my_domains/
PUTNoNoNoNoNoYesYes

NoSQL API v1

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
Upload your Metadata into the NoSQL catalog
  • /integration/v1/data/<datasource_id>/parse_docstore/
POSTNoNoNoNoNoNoYes
Delete sub-objects in a NoSQL catalog
  • /integration/v1/data/<datasource_id>/parse_docstore/?remove_not_seen=true
POSTNoNoNoNoNoNoYes

NoSQL API v2

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
Create, retrieve, update, and delete NoSQL metadata
  • /integration/v2/doc_schema/{datasource_id}/
GET, POST, PATCH, DELETENoNoNoNoNoNoYes

OAuth 2.0 API v2

(Available from version 2023.3)

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
  • /oauth/v2/token/
  • /oauth/v2/introspect/
  • /oauth/v2/.well-known/jwks.json/
GET, POSTYesYesYesYesYesYesYes

OTypes API

(Available from version 2021.1)

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
  • /integration/v1/otypes/
GETYesYesYesYesYesYesYes

Policy API

(Available from version 2023.1.5)

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
Get existing policies
  • /integration/v1/business_policies/
GETNoNoNoNoNoYesYes
Create policies in bulk
  • /integration/v1/business_policies/
POSTNoNoNoNoNoYesYes
Update policies in bulk
  • /integration/v1/business_policies/
PUTNoNoNoNoNoYesYes
Delete policies in bulk
  • /integration/v1/business_policies/
DELETENoNoNoNoNoYesYes

Policy Groups API

(Available from version 2022.4)

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
  • /integration/v1/policy_group
GETNoNoNoNoNoYesYes

Privacy Settings API

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
Manage privacy settings
  • /integration/v1/privacy_settings/
PATCHNoNoNoNoYes*Yes*Yes

* API user must be given Data Source Admin access to the data source in the Alation catalog.

Queriers API (Find Top DB Accounts)

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
  • /integration/v1/<otype>/<id>/db_account/?<params>
GETNoNoNoNoNoNoYes

Query API (Compose)

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
Create a new query
  • /integration/v1/query/
POSTNoNoYesYesYesYesYes
Get query details
  • /integration/v1/query/?<params>
  • /integration/v1/query/<query_id>/
  • /integration/v1/query/<query_id>/sql/
GETNoYesYesYesYesYesYes
Get latest query result details
  • /integration/v1/query/<query_id>/result/latest/
GETNoYesYesYesYesYesYes
Get query results in CSV
  • /integration/v1/result/<execution_result_id>/csv/
GETNoNoYesYesYesYesYes
Get execution session details
  • /integration/v1/query/execution_session/?<params>
  • /integration/v1/query/execution_session/<session_id>/
  • /integration/v1/query/<query_id>/execution_session/?<params>
GETNoYesYesYesYesYesYes
Get execution batch details
  • /integration/v1/query/execution_batch/?<params>
  • /integration/v1/query/execution_batch/<batch_id>/
  • /integration/v1/query/<query_id>/execution_batch/?<params>
GETNoYesYesYesYesYesYes
Get execution event details
  • /integration/v1/query/execution_event/?<params>
  • /integration/v1/query/execution_event/<batch_id>/
  • /integration/v1/query/<query_id>/execution_event/?<params>
GETNoYesYesYesYesYesYes
Get scheduled runs
  • /integration/v1/query/scheduled_run/?<params>
  • /integration/v1/query/<query_id>/scheduled_run/?<params>
GETNoNoYesYesYesYesYes

Query Log Upload API (Push QLI)

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
  • /api/v1/bulk_metadata/query_log_ingestion/<ds_id>/
POSTNoNoNoNoNoNoYes

Relational Integration API

(Available from version 2021.2)

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
Create an object
  • /integration/v2/schema/
  • /integration/v2/table/
  • /integration/v2/column/
POSTNoNoNoNoYes*Yes*Yes
Update an existing object
  • /integration/v2/schema/
  • /integration/v2/table/
  • /integration/v2/column/
PATCHNoNoNoNoYes*Yes*Yes
Update an existing object
  • /integration/v2/schema/
  • /integration/v2/table/
  • /integration/v2/column/
PATCHNoNoNoNoYes*Yes*Yes
Update child columns
  • /integration/v2/column/children/
PATCHNoNoNoNoYes*Yes*Yes
Get joins
  • /integration/v2/join_predicates/attribute/{attribute_id}/
  • /integration/v2/join_predicates/attribute/{table_id}/
  • /integration/v2/join_predicates/attribute/{datasource_id}.{schema_name}.{table_name}.{attribute_name}/
  • /integration/v2/join_predicates/attribute/{datasource_id}.{schema_name}.{table_name}/
  • /integration/v2/join_predicates/attribute/{datasource_id}/
GETYes (also requires view access to the specific data source)

* API user must be given Data Source Admin access to the data source in the Alation catalog.

Relational Integration v1

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
Get any data object details or delete a data object
  • /integration/v1/<otype>/<id>/
GET DELETENoNoNoNoNoNoYes
Get all data objects of a type
  • /integration/v1/<otype>/?<params>
GETNoNoNoNoNoNoYes

SCIM 2.0 API

(Available from version 2023.3.3)

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
  • /scim/v2/token/
POSTNoNoNoNoNoNoYes

Search API

(Available from version 2021.1)

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
  • /integration/v1/search/
GETYesYesYesYesYesYesYes

Search Synonym API

(Available from version 2023.3.2)

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
Get the current search synonym list
  • /integration/v1/search-synonym/
GETNoNoNoNoNoYesYes
Create search synonyms
  • /integration/v1/search-synonym/
POSTNoNoNoNoNoYesYes
Delete search synonyms
  • /integration/v1/search-synonym/
DELETENoNoNoNoNoYesYes

Table Metadata Sync Trigger API

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
  • /api/v1/table/sync/
POSTNoNoNoNoNoNoYes

Tags API

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
Create a new Tag
  • /integration/tag/<tag_name>/subject/
POSTNoNoYesYesYesYesYes
Get all Tags
  • /integration/tag/?<params>
GETYesYesYesYesYesYesYes
Get Tag details
  • /integration/tag/<id>/
GETYesYesYesYesYesYesYes
Get all objects with a certain Tag
  • /integration/tag/<tag_name>/subject/?<params>
GETYesYesYesYesYesYesYes
Delete a Tag
  • /integration/tag/<tag_name>/subject/<otype>/<oid>/
DELETENoNoYesYesYesYesYes

Template Visual Config API

(Available from version 2024.3.4)

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
Get all visual configs
  • /integration/visual_config/
GETYesYesYesYesYesYesYes
Get a specific visual config
  • /integration/visual_config/{id}/
GETYesYesYesYesYesYesYes
Get visual configs for an object type
  • /integration/visual_config/{otype}/
GETYesYesYesYesYesYesYes
Create visual configs
  • /integration/visual_config/
POSTNoNoNoNoNoYesYes
Update and delete visual configs
  • /integration/visual_config/{id}/
PUT, DELETENoNoNoNoNoYesYes

Terms API

(Available from version 2022.3)

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
Get terms
  • /integration/v2/term/
GETYesYesYesYesYesYesYes
Create, update, and delete terms
  • /integration/v2/term/
POST, PUT, DELETENoNoNoNoNoYesYes

Upload Logical Metadata

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
  • /api/v1/bulk_metadata/custom_fields/<template_name>/<object_type>?<params>
POSTNoNoYesYesYesYesYes

Upload Virtual Data Source

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
Add Technical Metadata
  • /api/v1/bulk_metadata/extraction/<ds_id>?<params>
POSTNoNoNoNoYesNoYes
Update Technical Metadata Object
  • /api/v1/bulk_metadata/extraction/<ds_id>?<params>
POSTNoNoNoNoYesNoYes
Delete Technical Metadata
  • /api/v1/bulk_metadata/extraction/<ds_id>?remove_not_seen=true
POSTNoNoNoNoYesNoYes

Upload Virtual File System

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
  • /api/v1/bulk_metadata/file_upload/<filesystem_id>/
POSTNoNoNoNoNoNoYes

User API v1

(Available from version 2020.3)

API EndpointMethodExplorerComposerStewardSource AdminCatalog AdminServer Admin
Get multiple Users
  • /integration/v1/user/
GETNoNoNoNoNoYes
Get a User
  • /integration/v1/user/{id}/
GETNoNoNoNoNoYes
Get authenticated User
(Available from version 2022.4)
  • /integration/v1/userinfo/
GETYesYesYesYesYesYes
Get duplicate user accounts
(Available from version 2022.4.3)
  • /integration/v1/generate_dup_users_accts_csv_file/
GETNoNoNoNoNoYes
Suspend duplicate user accounts
(Available from version 2022.4.3)
  • /integration/v1/remove_dup_users_accts/
POSTNoNoNoNoNoYes

User API v2

(Available from version 2022.4.3)

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
Get multiple Users
  • /integration/v2/user/
GETNoNoNoNoNoNoYes
Get a User
  • /integration/v2/user/{id}/
GETNoNoNoNoNoNoYes

Workflows API

(Available from version 2023.1.4)

API EndpointMethodViewerExplorerComposerStewardSource AdminCatalog AdminServer Admin
Get workflows
  • /integration/v2/workflows
GETYesYesYesYesYesYesYes
List requests
(Available from version 2023.3)
  • /integration/v2/workflow_executions/
GETYesYesYesYesYesYesYes
Create request
(Available from version 2023.3)
  • /integration/v2/workflow_executions/
POSTNoNoYesYesYesYesYes
Show request details
(Available from version 2023.3)
  • /integration/v2/workflow_executions/{workflow_execution_id}
GETYesYesYesYesYesYesYes
List review todos
(Available from version 2023.1.7)
  • /integration/v2/workflow_stepexecutions/todos/
GETNoNoYesYesYesYesYes
Approve review
(Available from version 2023.1.7)
  • /integration/v2/workflow_stepexecutions/{workflow_stepexecution_id}/approve/
PUTNoNoYesYesYesYesYes
Reject review
(Available from version 2023.1.7)
  • /integration/v2/workflow_stepexecutions/{workflow_stepexecution_id}/reject/
PUTNoNoYesYesYesYesYes

Updated 2 days ago