Endpoints

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

/api/meta/entity/auditSearch (POST)

• View history of an asset

/api/meta/entity/bulk (DELETE)

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

/api/meta/entity/bulk (POST)

• End-to-end bulk update
• Update multiple assets
• Manage Azure Data Lake Storage assets
• Manage API assets
• Manage AWS S3 assets
• Manage file assets
• Manage Google Cloud Storage assets
• Manage Google Data Studio assets
• Manage Preset assets
• Manage relational assets
• Manage personas
• Manage purposes
• Combine multiple operations
• Create an asset
• Restore an asset
• Update an asset
• Manage announcements
• Certify assets
• Change custom metadata
• Change description
• Change owners
• Add asset READMEs
• Add asset resources
• Tag (classify) assets
• Link terms to assets
• Categorize terms
• Create a hierarchy
• Manage lineage
• Manage popularity
• Manage column profiling

/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 popularity
• 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
• Paging search results
• Sorting search results
• Aggregating search results
• Common search fields
• Querying overview
• Compound queries
• Term-level queries
• Manage personas
• Manage purposes
• Search for assets
• Find certified, but incomplete assets
• Find all columns in a schema
• Find connections
• Find deprecated assets
• Find assets with custom metadata
• Find assets with a tag
• Find assets linked to a term
• Traverse category hierarchy
• Retrieval by name

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

• Delete options (enumerations)
• Delete custom metadata

/api/meta/types/typedefs (GET)

• Retrieve custom metadata

/api/meta/types/typedefs (POST)

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

/api/meta/types/typedefs (PUT)

• Update custom metadata

/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/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/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
• dbt assets
• Fivetran enrichment
• Looker assets
• Postgres assets
• Redshift assets
• Snowflake assets
• Snowflake miner
• Tableau assets

/api/service/workflows/submit (POST)

• Athena assets
• dbt assets
• Fivetran enrichment
• Looker assets
• Postgres assets
• Redshift assets
• Snowflake assets
• Snowflake miner
• Tableau assets