API by Roles

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.

OAuth 2.0 APIs for Managing Clients and User Authorization

(Available from version 2025.3.3)

API Endpoint Method Viewer Explorer Composer Steward Source Admin Catalog Admin Server Admin

API Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
OAuth authorization `/oauth/v1/authorize`	GET	Yes	Yes	Yes	Yes	Yes	Yes	Yes
OAuth token management `/oauth/v1/token`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
OAuth client administration `/integration/core/v1/oauth/clients` `/integration/core/v1/oauth/clients/{client_id}` `/integration/core/v1/oauth/clients/{client_id}/rotate-secret`	GET, POST, PATCH, DELETE, POST	No	No	No	No	No	No	Yes

OAuth authorization

/oauth/v1/authorize

GET

Yes

OAuth token management

/oauth/v1/token

POST

Yes

OAuth client administration

/integration/core/v1/oauth/clients

/integration/core/v1/oauth/clients/{client_id}

/integration/core/v1/oauth/clients/{client_id}/rotate-secret

GET, POST, PATCH, DELETE, POST

Yes

Aggregated Context API

(Available from version 2025.1.2)

API Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
Get relevant objects for RAG `/integration/v2/context/`	GET	Yes	Yes	Yes	Yes	Yes	Yes	Yes

AI APIs

(Available from version 2025.3.2)

API Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
Download Asset `ai/api/v1/assets/{asset_id}`	GET	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Create and Retrieve Chat `/ai/api/v1/chats`	GET, POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Update a Chat's Metadata `/ai/api/v1/chats/{chat_id}`	PATCH	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Get Expected Evaluation Output of a Chat `/ai/api/v1/chats/{chat_id}/eval_expected_output`	GET	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Get a Page of Chat's Messages `/ai/api/v1/chats/{chat_id}/messages`	GET	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Add or Remove Tags from a Chat `/ai/api/v1/chats/{chat_id}/tags/add` `/ai/api/v1/chats/{chat_id}/tags/remove`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Message an Agent (Async) and (Streaming) `/ai/api/v1/chats/agent/{agent_config_id}/call` `/ai/api/v1/chats/agent/{agent_config_id}/stream`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
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`	POST	No	No	No	No	No	No	Yes
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`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
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`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
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`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
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`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
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`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
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`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
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`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
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`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
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`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
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`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
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`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
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`	POST	No	No	No	No	No	No	Yes
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`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
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`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
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`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
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`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
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`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
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`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
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`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
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`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
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`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
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`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
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`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
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`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
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`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
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`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
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`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
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`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
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`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
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`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
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`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
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`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
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`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
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`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
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`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
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`	POST	No	No	No	Yes	Yes	Yes	Yes
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`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
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`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Get or Create Agent Configuration `/ai/api/v1/config/agent`	GET, POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Get, Update, or Delete Agent Configuration `/ai/api/v1/config/agent/{agent_config_id}`	DELETE, GET, PATCH	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Clone an Agent Configuration `/ai/api/v1/config/agent/{agent_config_id}/clone`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Clone a Deep-research Agent Configuration `/ai/api/v1/config/agent/{agent_config_id}/clone_deep_research`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Publish an Agent as a Tool `/ai/api/v1/config/agent/{agent_config_id}/publish_as_tool`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Unpublish an Agent as a Tool `/ai/api/v1/config/agent/{agent_config_id}/unpublish_tool`	DELETE	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Get a Default Agent Configuration `/ai/api/v1/config/agent/default/{default_agent_ref}`	GET	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Get LLM Configurations `/ai/api/v1/config/llm`	GET	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Get an LLM Configuration `/ai/api/v1/config/llm/{llm_config_id}`	GET	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Get Tool Configurations `/ai/api/v1/config/tool`	GET	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Get a Tool Configuration `/ai/api/v1/config/tool/{tool_config_id}`	GET	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Extract Metrics from SQL `/ai/api/v1/data_product/{data_product_id}/extract_metrics`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Initiate Revise Data Product Workflow `/ai/api/v1/data_product/{data_product_id}/revise_data_product`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Get All Revise Data Product Results `/ai/api/v1/data_product/{data_product_id}/revise_data_product/results`	GET	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Get Revise Data Product Result `/ai/api/v1/data_product/{data_product_id}/revise_data_product/results/{result_id}`	GET	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Validate SQL `/ai/api/v1/data_product/{data_product_id}/validate_sql`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Create Data Product `/ai/api/v1/data_product/create_data_product`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Get a Data Product Task `/ai/api/v1/data_product/get_data_product/{task_id}`	GET	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Get a Data Product Metrics Extraction Task `/ai/api/v1/data_product/get_metrics/{task_id}`	GET	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Update Data Product Description `/ai/api/v1/data_product/update_data_product_description`	PUT	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Get, Update, or Delete Evaluation Case `/ai/api/v1/evaluation_cases/{eval_case_id}`	DELETE, GET, PATCH	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Get or Delete the results of an Evaluation Run `/ai/api/v1/evaluation_results/{eval_result_id}`	DELETE, GET	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Download a CSV of the Generic Evaluation Run `/ai/api/v1/evaluation_results/{eval_result_id}/csv`	GET	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Get or Create Generic Evaluation Sets `/ai/api/v1/evaluation_sets`	POST, GET	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Get, Update, or Delete Generic Evaluation Set by ID `/ai/api/v1/evaluation_sets/{eval_set_id}`	DELETE, GET, PATCH	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Create Generic Evaluation Cases `/ai/api/v1/evaluation_sets/{eval_set_id}/cases`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Create Generic Evaluation Cases from a JSON file `/ai/api/v1/evaluation_sets/{eval_set_id}/cases/json`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Get Results for an Evaluation Run `/ai/api/v1/evaluation_sets/{eval_set_id}/results`	GET	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Run Generic Evaluation on an Evaluation Set. `/ai/api/v1/evaluation_sets/{eval_set_id}/run`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Get or Submit Feedback for a Data Product `/ai/api/v1/feedback`	GET, POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Get, Update, or Delete a Single Feedback for a Data Product `/ai/api/v1/feedback/{feedback_id}`	DELETE, GET, PATCH	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Run a SQL Evaluation on a Data Product's Evaluation Set `/ai/api/v1/run_sql_evaluation/{data_product_id}`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Get a SQL Evaluation Set for a Data Product `/ai/api/v1/sql_evaluation_results/{data_product_id}`	GET	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Get or Delete a SQL Evaluation Result for a Data Product `/ai/api/v1/sql_evaluation_results/{data_product_id}/{eval_result_id}`	DELETE, GET	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Download a CSV SQL Evaluation Result for a Data Product `/ai/api/v1/sql_evaluation_results/{data_product_id}/{eval_result_id}/csv`	GET	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Get or Create SQL Evaluation Sets for a Data Product `/ai/api/v1/sql_evaluation_set/{data_product_id}`	GET, POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Get, Update, or Delete SQL Evaluation Case `/ai/api/v1/sql_evaluation_set/{data_product_id}/{eval_case_id}`	DELETE, GET, PATCH	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Create SQL Evaluation Cases from a CSV `/ai/api/v1/sql_evaluation_set/{data_product_id}/csv`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Get Details About a Specific Task `/ai/api/v1/task/{task_id}`	GET	Yes	Yes	Yes	Yes	Yes	Yes	Yes

Alation Agent API

(Available from version 2023.1.4)

API Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
Get and create Agents `/integration/v1/agent/`	GET, POST	No	No	No	No	No	No	Yes
List available Agent installers `/integration/v1/agent/installers/debian/` `/integration/v1/agent/installers/rhel/`	GET	No	No	No	No	No	No	Yes
Download Agent installers `/integration/v1/agent/installers/debian/{version}/` `/integration/v1/agent/installers/rhel/{version}/`	GET	No	No	No	No	No	No	Yes
List available Authentication Service add-ons `/integration/v1/agent/addons/auth/`	GET	No	No	No	No	No	No	Yes
Download Authentication Service add-on `/integration/v1/agent/addons/auth/{version}`	GET	No	No	No	No	No	No	Yes
Get the Agent connectivity endpoint `/integration/v1/agent/endpoint/`	GET	No	No	No	No	No	No	Yes
Get, update, resync, and delete an Agent `/integration/v1/agent/{agent_id}` `/integration/v1/agent/{agent_id}/resync/`	GET, POST, PATCH, DELETE	No	No	No	No	No	No	Yes
Revoke or sign an Agent's certificate `/integration/v1/agent/{agent_id}/revoke_certificate/` `/integration/v1/agent/{agent_id}/sign_certificate/`	POST	No	No	No	No	No	No	Yes

API Tokens Authentication & Management

(Available from version 2020.3)

API Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
Create a Refresh Token `/integration/v1/createRefreshToken/`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Regenerate a Refresh Token `/integration/v1/regenRefreshToken/`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Create an API Access Token `/integration/v1/createAPIAccessToken/`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Revoke an API Access Token `/integration/v1/revokeAPIAccessTokens/`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Validate an API Access Token `/integration/v1/validateAPIAccessToken/`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Validate a Refresh Token `/integration/v1/validateRefreshToken/`	POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes

API Resource API

API Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
Retrieve an API Resource `/integration/v1/api_resource/<HTTP_method>:<url>/`	GET	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Create, update, or delete an API Resource `/integration/v1/api_resource/<HTTP_method>:<url>/`	POST, PUT, PATCH, DELETE	No	No	No	No	No	No	Yes

Articles API

API Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
Create a new Article `/integration/v1/article/`	POST	No	No	Yes	Yes	Yes	Yes	Yes
Article Detail `/integration/v1/article/<article_id>/`	GET	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Get all Articles `/integration/v1/article/?<params>`	GET	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Update an Article `/integration/v1/article/<article_id>/`	PUT	No	No	Yes	Yes	Yes	Yes	Yes
Delete an Article API `/integration/v1/article/<article_id>/`	DELETE	No	No	Yes	Yes	Yes	Yes	Yes
Restore an Article API `/integration/v1/article/<article_id>/resurrect/`	POST	No	No	Yes	Yes	Yes	Yes	Yes

BI Source API (GBM V2)

API Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
API operations with BI server objects `/integration/v2/bi/server/`	GET, POST, PATCH	No	No	No	No	No	No	Yes
API operations with BI folder objects `/integration/v2/bi/server/{server_id}/folder/`	GET, POST, PATCH, DELETE	No	No	No	No	No	No	Yes
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, DELETE	No	No	No	No	No	No	Yes
API operations with BI datasource objects `/integration/v2/bi/server/{server_id}/datasource/` `/integration/v2/bi/server/{server_id}/datasource/column`	GET, POST, PATCH, DELETE	No	No	No	No	No	No	Yes
API operations with BI object permissions `/integration/v2/bi/server/{server_id}/permission`	GET, POST, DELETE	No	No	No	No	No	No	Yes
Fetch, create, or delete Images `/integration/v2/bi/server/{server_id}/report/{id}/image`	GET, PUT, PATCH, DELETE	No	No	No	No	No	No	Yes
API operations with BI user object `/integration/v2/bi/server/{server_id}/user`	GET, PUT, PATCH, DELETE	No	No	No	No	No	No	Yes

Per-Object Parameters API

(Available from version 2026.4.1.0)

API Endpoint	Method	Source Admin	Catalog Admin	Server Admin
Submit a bulk update of per-object parameters `/api/v2/bulk/per-object-parameters/`	POST	Yes	Yes	Yes
Poll the status of a bulk update job `/api/v2/bulk/per-object-parameters/job/{job_id}/`	GET	Yes	Yes	Yes

Connectors (OCF) API

(Available from version 2022.4)

API Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
Get a List of Connectors `/integration/v2/connectors/`	GET	No	No	No	No	No	No	Yes

Conversations API

(Available from version 2023.1)

API Endpoint Method Viewer Explorer Composer Steward Source Admin Catalog Admin Server Admin

API Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server 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, DELETE	Yes	Yes	Yes	Yes	Yes	Yes	Yes

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, DELETE

Yes

Custom Field API

(Available from version 2020.3)

API Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
Get all the active Custom Fields `/integration/v2/custom_field/`	GET	No	No	No	No	No	Yes	Yes
Create Custom Fields in Bulk `/integration/v2/custom_field/`	POST	No	No	No	No	No	Yes	Yes
Get Built-in Custom Fields `/integration/v2/custom_field/builtin/{builtin_name}/`	GET	No	No	No	No	No	Yes	Yes
Get Custom Field by ID `/integration/v2/custom_field/{id}/`	GET	No	No	No	No	No	Yes	Yes

Custom Field Values API

(Available from version 2020.3)

API Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
Get Custom Field values `/integration/v2/custom_field_value/`	GET	No	No	No	No	No	Yes	Yes
Update Custom Field values `/integration/v2/custom_field_value/`	PUT	No	No	No	No	No	Yes	Yes
Update Custom Field values for many objects types `/integration/v2/custom_field_value/async/`	PUT	No	No	No	No	No	Yes	Yes

Custom Fields

API Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
`/api/v1/bulk_metadata/data_dictionary/<otype>?custom_fields=<fields_json>`	GET	Yes	Yes	Yes	Yes	Yes	Yes	Yes

Custom Template API

API Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
Custom Template details `/integration/v1/custom_template/<custom_template_id>`	GET	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Get all Custom Templates `/integration/v1/custom_template/?<params>`	GET	Yes	Yes	Yes	Yes	Yes	Yes	Yes

Data Dictionary API

(Available from version 2023.3)

API Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server 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, PUT	No	No	Yes***	Yes***	Yes***	Yes	Yes

*** 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 Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
Get data health fields or values `/integration/v1/data_quality/fields/` `/integration/v1/data_quality/values/`	GET	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Create or delete data health rules `/integration/v1/data_quality/`	POST, DELETE	No	No	No	No	Yes	Yes	Yes

Data Sources API (Native) - Data Source

(Available from version 2020.4)

API Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
Create a data source `/integration/v1/datasource/`	POST	No	No	No	No	Yes**	Yes**	Yes
Delete or update a data source `/integration/v1/datasource/<ds_id>/`	PUT, DELETE	No	No	Yes*	Yes*	Yes*	Yes*	Yes
Retrieve single or multiple data sources `/integration/v1/datasource/` `/integration/v1/datasource/<ds_id>/`	GET	Yes	Yes	Yes	Yes	Yes	Yes	Yes

* 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 Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
Get a list of available schemas `/integration/v1/datasource/<ds_id>/available_schemas/`	GET	No	No	No	No	No	No	Yes
Sync schemas `/integration/v2/datasource/{datasource_id}/refresh_available_schemas/`	POST	No	No	No	No	No	No	Yes
Kick off metadata extraction job `/integration/v1/datasource/<ds_id>/metadata_extraction_job/`	POST	Yes*	Yes*	Yes*	Yes*	Yes*	Yes*	Yes*
Get or update metadata extraction configurations `/integration/v1/datasource/<ds_id>/sync_configuration/metadata_extraction/`	GET, PUT, PATCH	No	No	No	No	No	No	Yes

* 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 Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
Verify data source configuration `/integration/v1/datasource/<ds_id>/configuration_check/`	GET	No	No	Yes*	Yes*	Yes*	Yes*	Yes
Verify network connection status `/integration/v1/datasource/<ds_id>/configuration_check/network_connection/`	GET	No	No	Yes*	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/`	GET	No	No	Yes*	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 Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
Bulk migrate data sources to OCF (Available from version 2023.1.5) `/integration/v1/datasource/bulk_migrate`	POST	No	No	No	No	No	No	Yes
Get a list of OCF connectors and their native data sources (Available from version 2023.3) `/integration/v1/datasource/{db_type}/connectors`	GET	No	No	No	No	Yes**	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 Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
Create a data source `/integration/v2/datasource/`	POST	No	No	No	No	Yes**	Yes**	Yes
Delete or update a data source `/integration/v2/datasource/<ds_id>/`	PUT, DELETE	No	No	Yes*	Yes*	Yes*	Yes*	Yes
Retrieve data sources `/integration/v2/datasource/` `/integration/v2/datasource/<ds_id>/`	GET	Yes	Yes	Yes	Yes	Yes	Yes	Yes

* 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 Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
Get a list of available schemas `/integration/v2/datasource/{datasource_id}/available_schemas/`	GET	No	No	No	No	No	No	Yes
Kick off metadata extraction job `/integration/v2/datasource/{datasource_id}/metadata_extraction_job/`	POST	Yes*	Yes*	Yes*	Yes*	Yes*	Yes*	Yes*
Get or update metadata extraction configurations `/integration/v2/datasource/{datasource_id}/sync_configuration/metadata_extraction/`	GET, PATCH	No	No	No	No	No	No	Yes

* 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 Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
Verify data source configuration `/integration/v2/datasource/<ds_id>/configuration_check/`	GET	No	No	Yes*	Yes*	Yes*	Yes*	Yes
Verify network connection status `/integration/v2/datasource/<ds_id>/configuration_check/network_connection/`	GET	No	No	Yes*	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/`	GET	No	No	Yes*	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 Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
Get and update general configuration settings for an OCF data source `/integration/v2/datasource/{datasource_id}/configuration/`	GET, PATCH	Yes*	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 Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
Get Metadata for an object `/catalog/<otype>/?<params>`	GET	No	No	No	No	No	No	Yes

Data Source Schemas

API Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
Get Schemas in a Data Source `/catalog/datasource/<datasource_id>/schema/?<params>`	GET	No	No	No	No	No	No	Yes

Data Quality API

(Available from version 2025.3.2)

API Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
Create, Update, Retrieve, and Delete Monitors `/integration/v1/native_data_quality/monitor`	POST, PUT, GET, DELETE	No	No	No	Yes	Yes	Yes	Yes
Trigger a Monitor Run `/integration/v1/native_data_quality/monitor/{monitor_id}/check-run`	POST	No	No	No	Yes	Yes	Yes	Yes

Data Quality Incidents API

(Available from version 2026.3.1.0)

API Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
Link an External Incident Tracking Ticket (like JIRA or ServiceNow) to a monitor `/incident/link`	POST	No	No	No	Yes	Yes	Yes	Yes

Documents API

(Available from version 2024.1)

API Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
Get documents `/integration/v2/document/`	GET	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Create, update, and delete documents `/integration/v2/document/`	POST, PUT, DELETE	No	No	No	No	No	Yes	Yes

Domains API

API Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server 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, DELETE	No	No	No	No	No	Yes	Yes

Flags API

API Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
Create a new Flag `/integration/flag/`	POST	No	No	Yes	Yes	Yes	Yes	Yes
Get Flag details `/integration/flag/<flag_id>`	GET	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Get All Flags `/integration/flag/?<params>`	GET	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Update a Flag `/integration/flag/<flag_id>/`	PUT	No	No	Yes	Yes	Yes	Yes	Yes
Delete a Flag `/integration/flag/<flag_id>/`	DELETE	No	No	Yes	Yes	Yes	Yes	Yes

Folder API

(Available from version 2024.1.3)

API Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
Get folders `/integration/v2/folder/`	GET	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Create, update, and delete folders `/integration/v2/folder/`	POST, PUT, DELETE	No	No	No	No	No	Yes	Yes

Groups API

(Available from version 2020.3)

API Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
Get all Groups `/integration/v1/group/`	GET	No	No	No	No	No	No	Yes
Get a Group `/integration/v1/group/{id}/`	GET	No	No	No	No	No	No	Yes

Homepage Preferences API

API Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
Update group homepage preferences `/integration/v1/home/{homepage_id}/user/preference`	PUT	No	No	No	No	No	Yes	Yes

Jobs API

API Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
Get job status `/api/v1/bulk_metadata/job/?<params>`	GET	Yes	Yes	Yes	Yes	Yes	Yes	Yes

Lineage API v2

API Endpoint Method Viewer Explorer Composer Steward Source Admin Catalog Admin Server Admin

API Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
Get, create, and delete lineage `/integration/v2/lineage/`	GET, POST, DELETE	No	No	No	No	Yes	Yes	Yes
Get, create, update, and delete dataflows `/integration/v2/dataflow/`	GET, POST, PATCH, DELETE	No	No	No	No	Yes	Yes	Yes
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, DELETE	No	No	No	No	Yes	Yes	Yes

Get, create, and delete lineage

/integration/v2/lineage/

GET, POST, DELETE

Yes

Get, create, update, and delete dataflows

/integration/v2/dataflow/

GET, POST, PATCH, DELETE

Yes

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, DELETE

Yes

Lineage API v3

API Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
Delete lineage `/integration/v3/lineage/`	DELETE	No	No	No	No	Yes	Yes	Yes

Logging API

API Endpoint Method Viewer Explorer Composer Steward Source Admin Catalog Admin Server Admin

API Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
Prepare Audit Logs for Download `/integration/v1/logs/audit/export/` Download Logs `/integration/v1/logs/audit/download/`	GET, POST	No	No	No	No	No	No	Yes

Prepare Audit Logs for Download

/integration/v1/logs/audit/export/

Download Logs

/integration/v1/logs/audit/download/

GET, POST

Yes

Members Permission API

API Endpoint Method Viewer Explorer Composer Steward Source Admin Catalog Admin Server Admin

API Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
Add and replace member permissions `/integration/v1/members_permission/` Delete member permissions `/integration/v1/members_permission/{resource_type}/{resource_id}/members/`	POST, PUT, DELETE	No	No	No	No	Yes*	Yes*	Yes

Add and replace member permissions

/integration/v1/members_permission/

Delete member permissions

/integration/v1/members_permission/{resource_type}/{resource_id}/members/

POST, PUT, DELETE

Yes*

Yes

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

My Domains API

API Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
Update users and groups assigned to domains `/integration/v1/my_domains/`	PUT	No	No	No	No	No	Yes	Yes

NoSQL API v1

API Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
Upload your Metadata into the NoSQL catalog `/integration/v1/data/<datasource_id>/parse_docstore/`	POST	No	No	No	No	No	No	Yes
Delete sub-objects in a NoSQL catalog `/integration/v1/data/<datasource_id>/parse_docstore/?remove_not_seen=true`	POST	No	No	No	No	No	No	Yes

NoSQL API v2

API Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
Create, retrieve, update, and delete NoSQL metadata `/integration/v2/doc_schema/{datasource_id}/`	GET, POST, PATCH, DELETE	No	No	No	No	No	No	Yes

OAuth 2.0 API v2

(Available from version 2023.3)

API Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
`/oauth/v2/token/` `/oauth/v2/introspect/` `/oauth/v2/.well-known/jwks.json/`	GET, POST	Yes	Yes	Yes	Yes	Yes	Yes	Yes

OTypes API

(Available from version 2021.1)

API Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
`/integration/v1/otypes/`	GET	Yes	Yes	Yes	Yes	Yes	Yes	Yes

Policy API

(Available from version 2023.1.5)

API Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
Get existing policies `/integration/v1/business_policies/`	GET	No	No	No	No	No	Yes	Yes
Create policies in bulk `/integration/v1/business_policies/`	POST	No	No	No	No	No	Yes	Yes
Update policies in bulk `/integration/v1/business_policies/`	PUT	No	No	No	No	No	Yes	Yes
Delete policies in bulk `/integration/v1/business_policies/`	DELETE	No	No	No	No	No	Yes	Yes

Policy Groups API

(Available from version 2022.4)

API Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
`/integration/v1/policy_group`	GET	No	No	No	No	No	Yes	Yes

Privacy Settings API

API Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
Manage privacy settings `/integration/v1/privacy_settings/`	PATCH	No	No	No	No	Yes*	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 Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
`/integration/v1/<otype>/<id>/db_account/?<params>`	GET	No	No	No	No	No	No	Yes

Query API (Compose)

API Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
Create a new query `/integration/v1/query/`	POST	No	No	Yes	Yes	Yes	Yes	Yes
Get query details `/integration/v1/query/?<params>` `/integration/v1/query/<query_id>/` `/integration/v1/query/<query_id>/sql/`	GET	No	Yes	Yes	Yes	Yes	Yes	Yes
Get latest query result details `/integration/v1/query/<query_id>/result/latest/`	GET	No	Yes	Yes	Yes	Yes	Yes	Yes
Get query results in CSV `/integration/v1/result/<execution_result_id>/csv/`	GET	No	No	Yes	Yes	Yes	Yes	Yes
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>`	GET	No	Yes	Yes	Yes	Yes	Yes	Yes
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>`	GET	No	Yes	Yes	Yes	Yes	Yes	Yes
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>`	GET	No	Yes	Yes	Yes	Yes	Yes	Yes
Get scheduled runs `/integration/v1/query/scheduled_run/?<params>` `/integration/v1/query/<query_id>/scheduled_run/?<params>`	GET	No	No	Yes	Yes	Yes	Yes	Yes

Query Log Upload API (Push QLI)

API Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
`/api/v1/bulk_metadata/query_log_ingestion/<ds_id>/`	POST	No	No	No	No	No	No	Yes

Relational Integration API

(Available from version 2021.2)

API Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
Create an object `/integration/v2/schema/` `/integration/v2/table/` `/integration/v2/column/`	POST	No	No	No	No	Yes*	Yes*	Yes
Update an existing object `/integration/v2/schema/` `/integration/v2/table/` `/integration/v2/column/`	PATCH	No	No	No	No	Yes*	Yes*	Yes
Update an existing object `/integration/v2/schema/` `/integration/v2/table/` `/integration/v2/column/`	PATCH	No	No	No	No	Yes*	Yes*	Yes
Update child columns `/integration/v2/column/children/`	PATCH	No	No	No	No	Yes*	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}/`	GET	Yes (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 Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
Get any data object details or delete a data object `/integration/v1/<otype>/<id>/`	GET DELETE	No	No	No	No	No	No	Yes
Get all data objects of a type `/integration/v1/<otype>/?<params>`	GET	No	No	No	No	No	No	Yes

SCIM 2.0 API

(Available from version 2023.3.3)

API Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
`/scim/v2/token/`	POST	No	No	No	No	No	No	Yes

Search API

(Available from version 2021.1)

API Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
`/integration/v1/search/`	GET	Yes	Yes	Yes	Yes	Yes	Yes	Yes

Search Synonym API

(Available from version 2023.3.2)

API Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
Get the current search synonym list `/integration/v1/search-synonym/`	GET	No	No	No	No	No	Yes	Yes
Create search synonyms `/integration/v1/search-synonym/`	POST	No	No	No	No	No	Yes	Yes
Delete search synonyms `/integration/v1/search-synonym/`	DELETE	No	No	No	No	No	Yes	Yes

Table Metadata Sync Trigger API

API Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
`/api/v1/table/sync/`	POST	No	No	No	No	No	No	Yes

Tags API

API Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
Create a new Tag `/integration/tag/<tag_name>/subject/`	POST	No	No	Yes	Yes	Yes	Yes	Yes
Get all Tags `/integration/tag/?<params>`	GET	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Get Tag details `/integration/tag/<id>/`	GET	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Get all objects with a certain Tag `/integration/tag/<tag_name>/subject/?<params>`	GET	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Delete a Tag `/integration/tag/<tag_name>/subject/<otype>/<oid>/`	DELETE	No	No	Yes	Yes	Yes	Yes	Yes

Template Visual Config API

(Available from version 2024.3.4)

API Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
Get all visual configs `/integration/visual_config/`	GET	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Get a specific visual config `/integration/visual_config/{id}/`	GET	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Get visual configs for an object type `/integration/visual_config/{otype}/`	GET	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Create visual configs `/integration/visual_config/`	POST	No	No	No	No	No	Yes	Yes
Update and delete visual configs `/integration/visual_config/{id}/`	PUT, DELETE	No	No	No	No	No	Yes	Yes

Terms API

(Available from version 2022.3)

API Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
Get terms `/integration/v2/term/`	GET	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Create, update, and delete terms `/integration/v2/term/`	POST, PUT, DELETE	No	No	No	No	No	Yes	Yes

Upload Logical Metadata

API Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
`/api/v1/bulk_metadata/custom_fields/<template_name>/<object_type>?<params>`	POST	No	No	Yes	Yes	Yes	Yes	Yes

Upload Virtual Data Source

API Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
Add Technical Metadata `/api/v1/bulk_metadata/extraction/<ds_id>?<params>`	POST	No	No	No	No	Yes	No	Yes
Update Technical Metadata Object `/api/v1/bulk_metadata/extraction/<ds_id>?<params>`	POST	No	No	No	No	Yes	No	Yes
Delete Technical Metadata `/api/v1/bulk_metadata/extraction/<ds_id>?remove_not_seen=true`	POST	No	No	No	No	Yes	No	Yes

Upload Virtual File System

API Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
`/api/v1/bulk_metadata/file_upload/<filesystem_id>/`	POST	No	No	No	No	No	No	Yes

Unified OCF Source Operations API

(Available from version 2026.4.1.0)

API Endpoint	Method	Source Admin	Catalog Admin	Server Admin
Test Connection `/integration/v2/{source_type}/{source_id}/test_connection/`	POST	Yes	Yes	Yes
Test and Fetch (Preflight Checks) `/integration/v2/{source_type}/{source_id}/test_and_fetch/`	GET	Yes	Yes	Yes

User API v1

(Available from version 2020.3)

API Endpoint	Method	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
Get multiple Users `/integration/v1/user/`	GET	No	No	No	No	No	Yes
Get a User `/integration/v1/user/{id}/`	GET	No	No	No	No	No	Yes
Get authenticated User (Available from version 2022.4) `/integration/v1/userinfo/`	GET	Yes	Yes	Yes	Yes	Yes	Yes
Get duplicate user accounts (Available from version 2022.4.3) `/integration/v1/generate_dup_users_accts_csv_file/`	GET	No	No	No	No	No	Yes
Suspend duplicate user accounts (Available from version 2022.4.3) `/integration/v1/remove_dup_users_accts/`	POST	No	No	No	No	No	Yes

User API v2

(Available from version 2022.4.3)

API Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
Get multiple Users `/integration/v2/user/`	GET	No	No	No	No	No	No	Yes
Get a User `/integration/v2/user/{id}/`	GET	No	No	No	No	No	No	Yes

Workflows API

(Available from version 2023.1.4)

API Endpoint	Method	Viewer	Explorer	Composer	Steward	Source Admin	Catalog Admin	Server Admin
Get workflows `/integration/v2/workflows`	GET	Yes	Yes	Yes	Yes	Yes	Yes	Yes
List requests (Available from version 2023.3) `/integration/v2/workflow_executions/`	GET	Yes	Yes	Yes	Yes	Yes	Yes	Yes
Create request (Available from version 2023.3) `/integration/v2/workflow_executions/`	POST	No	No	Yes	Yes	Yes	Yes	Yes
Show request details (Available from version 2023.3) `/integration/v2/workflow_executions/{workflow_execution_id}`	GET	Yes	Yes	Yes	Yes	Yes	Yes	Yes
List review todos (Available from version 2023.1.7) `/integration/v2/workflow_stepexecutions/todos/`	GET	No	No	Yes	Yes	Yes	Yes	Yes
Approve review (Available from version 2023.1.7) `/integration/v2/workflow_stepexecutions/{workflow_stepexecution_id}/approve/`	PUT	No	No	Yes	Yes	Yes	Yes	Yes
Reject review (Available from version 2023.1.7) `/integration/v2/workflow_stepexecutions/{workflow_stepexecution_id}/reject/`	PUT	No	No	Yes	Yes	Yes	Yes	Yes