Skip to content

Reference#

Look up exact values for endpoints, formats, rules, roles and error responses. For the ideas behind them, see the concepts. For step-by-step tasks, see the guides. For definitions of terms, see the glossary.

Replace https://<atlas-host> in examples with your ATLAS address.

Page Contents
Gateway Endpoints, authentication, headers, request and response behaviour, parameter handling and limits
API keys Key format, acting context, expiry rules, who can create and revoke keys, and how keys are refused
Roles and permissions What each role can do, how roles come from your identity provider, and why a member can be suspended
Budgets Budget rules, limits and enforcement, pricing and currency, the business time zone and billing statements
Errors The error formats that the web app and the gateway return, and what the common errors mean
Glossary Definitions of the terms used across the documentation