Atlan is a modern data workspace that makes collaboration among diverse users (like managers, analysts and engineers) easier, increasing efficiency and agility in data projects ✨
Atlan is built on an OpenAPI architecture, hence everything that is visible on the product is powered by APIs. We are gradually opening up more APIs for our users. If you are looking for an API that you don't see here, please reach out to us.
How we've organized the documentation
In most cases, our API does not have separate endpoints for different types of assets. For example, we do not have different endpoints for data sources and business intelligence objects.
Instead, we have many endpoints that you can use to manage many different types of assets.
So we have organized the documentation into two general areas:
- The tags you see along the left provide succinct examples of common operations. These uses case examples provide the minimal set of information required to be complete.
- The very last Canonical tag provides the full documentation of API endpoints that are used for many different use cases. Here you can find the extensive list of options that you can apply, if you want to extend beyond the common use cases.
You can also distinguish between these two approaches by looking at the URL of each endpoint:
- The use case examples will all end with a
#operationId
. You can actually drop this from the URL, as it is not needed by the API. It is only needed by the formal specification we use to document the operations, to keep each one unique. - The canonical endpoints will have no
#operationId
at the end of their URL.
This is the documentation for version 2.0.0
of the API. Last update on Jul 4, 2022.
https://tenant.atlan.com