Endpoints

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

/api/meta/entity/auditSearch (POST)

• Review changes to an asset

/api/meta/entity/bulk (DELETE)

• Delete an asset
• Manage lineage
• Manage personas
• Manage policies
• Manage purposes

/api/meta/entity/bulk (POST)

• Add asset resources
• Categorize terms
• Certify assets
• Change custom metadata
• Change description
• Change owners
• Combine multiple operations
• Create a hierarchy
• Create an asset
• Create objects
• End-to-end bulk update
• Link domains to assets
• Link terms to assets
• Manage API assets
• Manage AWS S3 assets
• Manage Airflow assets
• Manage App assets
• Manage Azure Data Lake Storage assets
• Manage Azure Event Hub assets
• Manage DocumentDB assets
• Manage Google Cloud Storage assets
• Manage Google Data Studio assets
• Manage Insights assets
• Manage Kafka assets
• Manage Preset assets
• Manage QuickSight assets
• Manage Superset assets
• Manage announcements
• Manage asset READMEs
• Manage column profiling
• Manage cube assets
• Manage data domains
• Manage data products
• Manage file assets
• Manage lineage
• Manage personas
• Manage policies
• Manage popularity
• Manage purposes
• Manage relational assets
• Restore an asset
• Tag (classify) assets
• Update an asset
• Update multiple assets

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

• Retrieve an asset

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

• Change custom metadata

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

• Change custom metadata

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

• Retrieve an asset

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

• Tag (classify) assets

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

• Tag (classify) assets

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

• Manage column profiling
• Manage popularity

/api/meta/lineage/getlineage (POST)

• Traverse lineage

/api/meta/lineage/list (POST)

• Traverse lineage

/api/meta/search/indexsearch (POST)

• Aggregating search results
• Common search fields
• Compound queries
• End-to-end bulk update
• Find and apply suggestions
• Limiting details
• Manage personas
• Manage policies
• Manage purposes
• Paging search results
• Querying overview
• Retrieval by name
• Search examples
• Search for assets
• Sorting search results
• Term-level queries
• Traverse category hierarchy

/api/meta/search/searchlog (POST)

• Review accesses of an asset

/api/meta/task/search (POST)

• Monitor propagation

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

• Delete custom metadata

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

• Manage Atlan tags
• Manage options (enumerations)

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

• Manage Atlan tags
• Manage options (enumerations)

/api/meta/types/typedefs (GET)

• Retrieve custom metadata

/api/meta/types/typedefs (POST)

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

/api/meta/types/typedefs (PUT)

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

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

• Manage Atlan tags

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

• Manage options (enumerations)

/api/service/apikeys (GET)

• API token management

/api/service/apikeys (POST)

• API token management

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

• API token management

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

• API token management

/api/service/events/login (GET)

• Access events

/api/service/events/main (GET)

• Access events

/api/service/files/presignedUrl (POST)

• File management

/api/service/groups (GET)

• Retrieve users and groups

/api/service/groups (POST)

• Create users and groups

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

• Update users and groups

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

• Delete users and groups

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

• Retrieve users and groups

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

• Update 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)

• Retrieve users and groups

/api/service/users (POST)

• Create users and groups

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

• Update users and groups

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

• Retrieve users and groups

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

• Update users and groups

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

• Update users and groups

/api/service/workflows/indexsearch (POST)

• Athena assets
• BigQuery assets
• Confluent Kafka assets
• Databricks assets
• Databricks miner
• DynamoDB assets
• Fivetran enrichment
• Glue assets
• Looker assets
• MongoDB assets
• Oracle assets
• Postgres assets
• PowerBI assets
• Redshift assets
• SQL Server assets
• Sigma assets
• Snowflake assets
• Snowflake miner
• Tableau assets
• dbt assets

/api/service/workflows/submit (POST)

• Athena assets
• BigQuery assets
• Confluent Kafka assets
• Databricks assets
• Databricks miner
• DynamoDB assets
• Fivetran enrichment
• Glue assets
• Looker assets
• MongoDB assets
• Oracle assets
• Postgres assets
• PowerBI assets
• Redshift assets
• SQL Server assets
• Sigma assets
• Snowflake assets
• Snowflake miner
• Tableau assets
• dbt assets

/api/sql/query/stream (POST)

• Run queries on an asset

---