Preview compatibility

The public API is in Preview. Use the published reference to build and test an integration, but verify the behavior in your environment before you rely on it in production.

What is published

The HTTP reference is composed from reviewed public the Atlan API snapshots with recorded provenance and checksums. The SDK reference is generated from the resource map that a released SDK ships, pinned to one SDK release. This keeps the site deterministic and makes the documented path and operation shape reviewable. The aireg CLI’s command reference is maintained with its source in Registry OSS, the open-source project. The generated reference is not a live console. Your API response, installed SDK, and installed aireg are authoritative when they are newer than this site.

What Preview does not promise

Preview does not add a public breaking-change schedule, support window, or deprecation guarantee. Do not assume that a route, flag, response field, or integration remains unchanged without checking the current reference and your environment. When you update an API, SDK, or aireg integration, first run a read-only check:

aireg --version
aireg adapter list
aireg doctor
curl -sS --fail-with-body \
  -H "Authorization: Bearer ${ATLAN_TOKEN}" \
  "${ATLAN_GATEWAY_URL}/registry/v1/auth/whoami"

Then re-run the smallest relevant workflow in a disposable workspace. Keep production automation pinned to the release and behavior your team has validated. A GitHub workflow that installs aireg with its installer gets the current release on every run, and aireg adapter install atlan gets the current Atlan adapter, so a new release can change publish behavior without a workflow edit. The Sync skills from GitHub pins both versions and verifies the CLI checksum. Re-run a disposable publish when upgrading either one. See Sync skills from GitHub.

Choose reference

Use Connect to Atlan Trident to validate a direct HTTP credential and workspace scope.
Use the Operations for the client’s resources and methods.
Use CLI with Atlan for the aireg commands Atlan Trident uses, and the aireg command reference for every command and option.
Use Errors and retries when a changed response leaves a write outcome uncertain.

Get started

Authenticate requests

Send and inspect traces

Record and replay sessions

Use MCP app resources

References

Endpoints

What is published

What Preview does not promise

Choose reference