Endpoints

Following is a list of all API endpoints and the use cases they enable:

/api/meta/entity/auditSearch (POST)

• Viewing the history of an asset

/api/meta/entity/bulk (DELETE)

• Managing personas
• Managing policies
• Managing purposes
• Deleting assets
• Manage lineage

/api/meta/entity/bulk (POST)

• End-to-end bulk update
• Operate on multiple assets
• Manage Azure Data Lake Storage assets
• Manage Airflow assets
• Manage API assets
• Manage App assets
• Manage AWS S3 assets
• Manage Azure Event Hub assets
• Manage cube assets
• Manage file assets
• Manage Google Cloud Storage assets
• Manage Google Data Studio assets
• Manage Kafka assets
• Manage Preset assets
• Manage RDMS assets
• Manage Superset assets
• Managing personas
• Managing policies
• Managing purposes
• Combining multiple operations
• Creating an asset
• Restoring assets
• Updating an asset
• Manage announcements
• Certify assets
• Manage custom metadata on assets
• Manage asset descriptions
• Link data domain and assets
• Manage asset owners
• Asset READMEs
• Asset resources/links
• Manage asset tags
• Link terms and assets
• Categorize terms
• Glossary category hierarchy
• Creating glossary objects
• Manage lineage
• Manage popularity insights
• Manage column profiling
• Managing data domains
• Managing data products

/api/meta/entity/guid/{guid} (GET)

• Retrieving assets

/api/meta/entity/guid/{guid}/businessmetadata (POST)

• Manage custom metadata on assets

/api/meta/entity/guid/{guid}/businessmetadata/{name} (POST)

• Manage custom metadata on assets

/api/meta/entity/uniqueAttribute/type/{typeName}/attr:qualifiedName={qualifiedName} (GET)

• Retrieving assets

/api/meta/entity/uniqueAttribute/type/{typeName}/classification/{name}?attr:qualifiedName={qualifiedName} (DELETE)

• Manage asset tags

/api/meta/entity/uniqueAttribute/type/{typeName}/classifications?attr:qualifiedName={qualifiedName} (POST)

• Manage asset tags

/api/meta/entity/uniqueAttribute/type/{typeName}?attr:qualifiedName={qualifiedName} (GET)

• Manage popularity insights
• Manage column profiling

/api/meta/lineage/getlineage (POST)

• Traverse lineage

/api/meta/lineage/list (POST)

• Traverse lineage

/api/meta/search/indexsearch (POST)

• End-to-end bulk update
• Limiting search result details
• Paging search results
• Sorting search results
• Aggregating search results
• Common search fields
• Querying overview
• Compound queries
• Term-level queries overview
• Managing personas
• Managing policies
• Managing purposes
• Searching for assets
• Find and apply suggestions to an asset
• Search examples
• Traverse glossary categories
• Fetch glossary objects by name

/api/meta/search/searchlog (POST)

• Asset search logs

/api/meta/task/search (POST)

• Monitor tag propagation

/api/meta/types/typedef/name/{name} (DELETE)

• Delete custom metadata

/api/meta/types/typedef/name/{name} (GET)

• Manage options (enumerations)
• Manage Atlan tags

/api/meta/types/typedef/{name} (DELETE)

• Manage options (enumerations)
• Manage Atlan tags

/api/meta/types/typedefs (GET)

• Retrieve custom metadata

/api/meta/types/typedefs (POST)

• Manage custom metadata badges
• Create custom metadata
• Manage options (enumerations)
• Manage Atlan tags

/api/meta/types/typedefs (PUT)

• Manage options (enumerations)
• Update custom metadata
• Manage Atlan tags

/api/meta/types/typedefs/?type=CLASSIFICATION (GET)

• Manage Atlan tags

/api/meta/types/typedefs/?type=ENUM (GET)

• Manage options (enumerations)

/api/service/apikeys (GET)

• Managing API tokens

/api/service/apikeys (POST)

• Managing API tokens

/api/service/apikeys/{guid} (DELETE)

• Managing API tokens

/api/service/apikeys/{guid} (POST)

• Managing API tokens

/api/service/events/login (GET)

• Retrieve access events

/api/service/events/main (GET)

• Retrieve access events

/api/service/files/presignedUrl (POST)

• Manage files in Atlan's tenant object store

/api/service/groups (GET)

• Retrieving users and groups

/api/service/groups (POST)

• Creating users and groups

/api/service/groups/{guid} (POST)

• Updating users and groups

/api/service/groups/{guid}/delete (POST)

• Deleting users and groups

/api/service/groups/{guid}/members (GET)

• Retrieving users and groups

/api/service/groups/{guid}/members/remove (POST)

• Updating users and groups

/api/service/idp/{sso_alias}/mappers (GET)

• Manage SSO group mapping

/api/service/idp/{sso_alias}/mappers (POST)

• Manage SSO group mapping

/api/service/idp/{sso_alias}/mappers/{group_map_id} (GET)

• Manage SSO group mapping

/api/service/idp/{sso_alias}/mappers/{group_map_id} (POST)

• Manage SSO group mapping

/api/service/idp/{sso_alias}/mappers/{group_map_id}/delete (POST)

• Manage SSO group mapping

/api/service/users (GET)

• Retrieving users and groups

/api/service/users (POST)

• Creating users and groups

/api/service/users/{guid} (POST)

• Updating users and groups

/api/service/users/{guid}/groups (GET)

• Retrieving users and groups

/api/service/users/{guid}/groups (POST)

• Updating users and groups

/api/service/users/{guid}/update (POST)

• Updating users and groups

/api/service/workflows/indexsearch (POST)

• Athena assets package
• BigQuery assets package
• Confluent Kafka assets package
• dbt assets package
• DynamoDB assets package
• Fivetran enrichment package
• Glue assets package
• Looker assets package
• Postgres assets package
• Power BI assets package
• Redshift assets package
• Sigma assets package
• Snowflake assets package
• Snowflake miner package
• SQL Server package
• Tableau assets package

/api/service/workflows/submit (POST)

• Athena assets package
• BigQuery assets package
• Confluent Kafka assets package
• dbt assets package
• DynamoDB assets package
• Fivetran enrichment package
• Glue assets package
• Looker assets package
• Postgres assets package
• Power BI assets package
• Redshift assets package
• Sigma assets package
• Snowflake assets package
• Snowflake miner package
• SQL Server package
• Tableau assets package

/api/sql/query/stream (POST)

• Running SQL queries on an asset

---