APIs by Roles

Refer to this table for information which Alation roles can use Alation API.

API Endpoint

Method

Viewer

Composer

Steward

Source Admin

Catalog Admin

Server Admin

API Tokens Authentication & Management (Available from version 2020.3)

Create a Refresh Token

/integration/v1/createRefreshToken/

POST

Yes

Yes

Yes

Yes

Yes

Yes

Regenerate a Refresh Token

/integration/v1/regenRefreshToken/

POST

Yes

Yes

Yes

Yes

Yes

Yes

Create an API Access Token

/integration/v1/createAPIAccessToken/

POST

Yes

Yes

Yes

Yes

Yes

Yes

Revoke an API Access Token

/integration/v1/revokeAPIAccessTokens/

POST

Yes

Yes

Yes

Yes

Yes

Yes

Validate an API Access Token

/integration/v1/validateAPIAccessToken/

POST

Yes

Yes

Yes

Yes

Yes

Yes

Validate a RefreshToken

/integration/v1/validateRefreshToken/

POST

Yes

Yes

Yes

Yes

Yes

Yes

API Resource API

Retrieve an API Resource

/integration/v1/api_resource/<HTTP_method>:<url>/

GET

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

Yes

Articles API

Create a new Article

/integration/v1/article/

POST

No

Yes

Yes

Yes

Yes

Yes

Article Detail

/integration/v1/article/<article_id>/

GET

Yes

Yes

Yes

Yes

Yes

Yes

Get all Articles

/integration/v1/article/?<params>

GET

Yes

Yes

Yes

Yes

Yes

Yes

Update an Article

/integration/v1/article/<article_id>/

PUT

No

Yes

Yes

Yes

Yes

Yes

Delete an Article API

/integration/v1/article/<article_id>/

DELETE

No

Yes

Yes

Yes

Yes

Yes

Restore an Article API

/integration/v1/article/<article_id>/resurrect/

POST

No

Yes

Yes

Yes

Yes

Yes

Connectors (OCF) API (Available from version 2022.4)

Get a List of Connectors

/integration/v2/connectors/

GET

No

No

No

No

No

Yes

Custom Field API (Available from version 2020.3)

Get all the active Custom Fields

/integration/v2/custom_field/

GET

No

No

No

No

No

Yes

Get Built-in Custom Fields

/integration/v2/custom_field/builtin/{builtin_name}/

GET

No

No

No

No

No

Yes

Get Custom Field by ID

/integration/v2/custom_field/{id}/

GET

No

No

No

No

No

Yes

Custom Field Values API (Available from version 2020.3)

Get Custom Field values for DataFlow objects and BI objects (GBM V2)

/integration/v2/custom_field_value/

GET

No

No

No

No

No

Yes

Update Custom Field values for DataFlow objects and BI objects (GBM V2)

/integration/v2/custom_field_value/

PUT

No

No

No

No

No

Yes

Update Custom Field values for many objects types(GBM V2)

/integration/v2/custom_field_value/async/

PUT

No

No

No

No

No

Yes

Custom Fields

/api/v1/bulk_metadata/data_dictionary/<otype>?custom_fields=<fields_json>

GET

Yes

Yes

Yes

Yes

Yes

Yes

Custom Template API

Custom Template details

/integration/v1/custom_template/<custom_template_id>

GET

Yes

Yes

Yes

Yes

Yes

Yes

Get all Custom Templates

/integration/v1/custom_template/?<params>

GET

Yes

Yes

Yes

Yes

Yes

Yes

Dataflow API (Available from version 2020.3)

Upload Dataflow

/integration/v2/dataflow/

POST, PATCH

No

No

No

No

No

Yes

Delete Dataflow

/integration/v2/dataflow/?<params>

DELETE

No

No

No

No

No

Yes

Get a Dataflow

/integration/v2/dataflow/?<params>

GET

No

No

No

No

No

Yes

Data Health API (Available from version 2022.3)

Get data health fields or values

/integration/v1/data_quality/fields/

/integration/v1/data_quality/values/

GET

Yes

Yes

Yes

Yes

Yes

Yes

Create or delete data health rules

/integration/v1/data_quality/

POST, DELETE

No

No

No

Yes

Yes

Yes

Data Sources API (Native) - Data Source (Available from version 2020.4)

Create a data source

/integration/v1/datasource/

POST

No

No

No

Yes**

Yes**

Yes

Delete or update a data source

/integration/v1/datasource/<ds_id>/

PUT, DELETE

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

Data Sources API (Native) - Metadata Extraction (Available from version 2020.4)

Get a list of available schemas

/integration/v1/datasource/<ds_id>/available_schemas/

GET

No

No

No

No

No

Yes

Kick off metadata extraction job

/integration/v1/datasource/<ds_id>/metadata_extraction_job/

POST

No

No

No

No

No

Yes

Get or update metadata extraction configurations

/integration/v1/datasource/<ds_id>/sync_configuration/metadata_extraction/

GET, PUT, PATCH

No

No

No

No

No

Yes

Data Sources API (Native) - Config Checks (Available from version 2020.4)

Verify data source configuration

/integration/v1/datasource/<ds_id>/configuration_check/

GET

No

Yes*

Yes*

Yes*

Yes*

Yes

Verify network connection status

/integration/v1/datasource/<ds_id>/configuration_check/network_connection/

GET

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

Yes*

Yes*

Yes*

Yes*

Yes

Data Sources API (OCF) (Available from version 2022.4)

Create a data source

/integration/v2/datasource/

POST

No

No

No

Yes**

Yes**

Yes

Retrieve data sources

/integration/v2/datasource/

/integration/v2/datasource/<ds_id>/

GET

Yes

Yes

Yes

Yes

Yes

Yes

Data Sources API (OCF) - Metadata Extraction (Available from version 2022.4)

Get a list of available schemas

/integration/v2/datasource/{datasource_id}/available_schemas/

GET

No

No

No

No

No

Yes

Kick off metadata extraction job

/integration/v2/datasource/{datasource_id}/metadata_extraction_job/

POST

No

No

No

No

No

Yes

Get or update metadata extraction configurations

/integration/v2/datasource/{datasource_id}/sync_configuration/metadata_extraction/

GET, PATCH

No

No

No

No

No

Yes

Data Source Browsing

Get Metadata for an object

/catalog/<otype>/?<params>

GET

No

No

No

No

No

Yes

Data Source Schemas

Get Schemas in a Data Source

/catalog/datasource/<datasource_id>/schema/?<params>

GET

No

No

No

No

No

Yes

Domains API

API operations to create and GET objects in a domain

https://alation_domain/integration/v2/domain/

GET POST

No

No

No

No

Yes

Yes

Flags API

Create a new Flag

/integration/flag/

POST

No

Yes

Yes

Yes

Yes

Yes

Get Flag details

/integration/flag/<flag_id>

GET

Yes

Yes

Yes

Yes

Yes

Yes

Get All Flags

/integration/flag/?<params>

GET

Yes

Yes

Yes

Yes

Yes

Yes

Update a Flag

/integration/flag/<flag_id>/

PUT

No

Yes

Yes

Yes

Yes

Yes

Delete a Flag

/integration/flag/<flag_id>/

DELETE

No

Yes

Yes

Yes

Yes

Yes

Groups API (Available from version 2020.3)

Get all Groups

/integration/v1/group/

GET

No

No

No

No

No

Yes

Get a Group

/integration/v1/group/{id}/

GET

No

No

No

No

No

Yes

Job Status

/api/v1/bulk_metadata/job/?<params>

GET

Yes

Yes

Yes

Yes

Yes

Yes

Lineage V2 API (Available from version 2020.3 (POST, DELETE) and 2020.4 (GET))

Get Lineage API

/integration/v2/lineage/

GET

No

No

No

No

No

Yes

Upload Lineage API

/integration/v2/lineage/

POST

No

No

No

No

No

Yes

Delete Lineage Info API

/integration/v2/lineage/?<params>

DELETE

No

No

No

No

No

Yes

NoSQL API

Upload your Metadata into the NoSQL catalog

/integration/v1/data/<datasource_id>/parse_docstore/

POST

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

Yes

OTypes API (Available from version 2021.1)

/integration/v1/otypes/

GET

Yes

Yes

Yes

Yes

Yes

Yes

Policy Groups API (Available from version 2022.4)

/integration/v1/policy_group/

GET

No

No

No

No

Yes

Yes

Queriers API (Find Top DB Accounts)

/integration/v1/<otype>/<id>/db_account/?<params>

GET

No

No

No

No

No

Yes

Query API (Compose)

Create a new Query

/integration/v1/query/

POST

No

Yes

Yes

Yes

Yes

Yes

Get Query SQL

/integration/v1/query/<query_id>/sql/

GET

No

Yes

Yes

Yes

Yes

Yes

Query Result details

/integration/v1/result/<execution_result_id>/csv/

GET

No

Yes

Yes

Yes

Yes

Yes

Query latest Result details

/integration/v1/query/<query_id>/result/latest/

GET

No

Yes

Yes

Yes

Yes

Yes

Query details

/integration/v1/query/<query_id>/

GET

No

Yes

Yes

Yes

Yes

Yes

Get all Queries

/integration/v1/query/?<params>

GET

No

Yes

Yes

Yes

Yes

Yes

Get all Execution Sessions

/integration/v1/query/execution_session/?<params>

GET

No

Yes

Yes

Yes

Yes

Yes

Get Execution Session details

/integration/v1/query/execution_session/<session_id>/

GET

No

Yes

Yes

Yes

Yes

Yes

Get all Execution Sessions for a Query

/integration/v1/query/<query_id>/execution_session/?<params>

GET

No

Yes

Yes

Yes

Yes

Yes

Get all Execution Batches

/integration/v1/query/execution_batch/?<params>

GET

No

Yes

Yes

Yes

Yes

Yes

Get ExecutionBatch Detail

/integration/v1/query/execution_batch/<batch_id>/

GET

No

Yes

Yes

Yes

Yes

Yes

Get all Execution Batches for a Query

/integration/v1/query/<query_id>/execution_batch/?<params>

GET

No

Yes

Yes

Yes

Yes

Yes

Get all Execution Events

/integration/v1/query/execution_event/?<params>

GET

No

Yes

Yes

Yes

Yes

Yes

Get Execution Event details

/integration/v1/query/execution_event/<batch_id>/

GET

No

Yes

Yes

Yes

Yes

Yes

Get all Execution Events for a Query

/integration/v1/query/<query_id>/execution_event/?<params>

GET

No

Yes

Yes

Yes

Yes

Yes

Get all Scheduled Runs

/integration/v1/query/scheduled_run/?<params>

GET

No

Yes

Yes

Yes

Yes

Yes

Get all Scheduled Runs for a Query

/integration/v1/query/<query_id>/scheduled_run/?<params>

GET

No

Yes

Yes

Yes

Yes

Yes

Query Log Upload API (Push QLI)

/api/v1/bulk_metadata/query_log_ingestion/<ds_id>/

POST

No

No

No

No

No

Yes

Relational Integration API (Available from version 2021.2)

Retrieve an object

/integration/v2/schema/

/integration/v2/table/

/integration/v2/column/

GET

Yes

Yes

Yes

Yes

Yes

Yes

Create or update an object

/integration/v2/schema/

/integration/v2/table/

/integration/v2/column/

POST

No

No

No

Yes*

Yes*

Yes

Relational Integration v1

Get any data object details or delete a data object

/integration/v1/<otype>/<id>/

GET

DELETE

No

No

No

No

No

Yes

Get all data objects of a type

/integration/v1/<otype>/?<params>

GET

No

No

No

No

No

Yes

Search API (Available from version 2021.1)

/integration/v1/search/

GET

Yes

Yes

Yes

Yes

Yes

Yes

Table Metadata Sync Trigger API

/api/v1/table/sync/

POST

No

No

No

No

No

Yes

Tags API

Create a new Tag

/integration/tag/<tag_name>/subject/

POST

No

Yes

Yes

Yes

Yes

Yes

Get all Tags

/integration/tag/?<params>

GET

Yes

Yes

Yes

Yes

Yes

Yes

Get Tag details

/integration/tag/<id>/

GET

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

Delete a Tag

/integration/tag/<tag_name>/subject/<otype>/<oid>/

DELETE

No

Yes

Yes

Yes

Yes

Yes

Terms API (Available from version 2022.3)

Get terms

/integration/v2/term/

GET

Yes

Yes

Yes

Yes

Yes

Yes

Create or delete terms

/integration/v2/term/

POST, DELETE

No

No

No

No

Yes

Yes

Upload Logical Metadata

/api/v1/bulk_metadata/custom_fields/<template_name>/<object_type>?<params>

POST

No

Yes

Yes

Yes

Yes

Yes

Upload Virtual Data Source

Add Technical Metadata

/api/v1/bulk_metadata/extraction/<ds_id>?<params>

POST

No

No

No

Yes

No

Yes

Update Technical Metadata Object

/api/v1/bulk_metadata/extraction/<ds_id>?<params>

POST

No

No

No

Yes

No

Yes

Delete Technical Metadata

/api/v1/bulk_metadata/extraction/<ds_id>?remove_not_seen=true

POST

No

No

No

Yes

No

Yes

Upload Virtual File System

/api/v1/bulk_metadata/file_upload/<filesystem_id>/

POST

No

No

No

No

No

Yes

User API (Available from version 2020.3)

Get all 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

Virtual BI Server Sources APIs (GBM V2)

API operations with BI server objects

/integration/v2/bi/server/

GET POST PATCH

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

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

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

Yes

API operations with BI object permissions

/integration/v2/bi/server/{server_id}/permission

GET POST DELETE

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

Yes

API operations with BI user object

/integration/v2/bi/server/{server_id}/user

GET PUT PATCH DELETE

No

No

No

No

No

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).