Important notes

Important notes

This site only contains documentation about the APIs, and is not built from the APIs themselves.

All changes noted in the API Changelog are changes to this documentation, and not to the underlying APIs of Atlan.

For clarity:

  • We may occasionally make mistakes in the documentation 🙈
  • When we discover these, we go back to correct them as quickly as we can 🧑‍💻
  • The site may show these as breaking changes in the API 🚨, but in reality we're only fixing broken documentation 📚
  • (Without fixing documentation where it's wrong, what you see in the documentation wouldn't actually work)
  • For the avoidance of doubt: the APIs themselves are not changing 😅

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