API reference

Keeping this page fresh

docs/api/openapi.json is a committed snapshot of the public REST API's OpenAPI 3.1 schema. To refresh it, regenerate the schema from the REST API's public app and save it over this file, then re-append the "## Authentication" section to info.description (it explains how to get a Personal Access Token and is not part of the generated schema). Keep the committed servers entry and the token link pointed at the production hosts (api.appgantry.com / app.appgantry.com): those are the defaults for local builds, and the deploy workflow (docs-deploy.yml) rewrites both per environment so the interactive "Try it" requests and the "get a token" link target the matching hosts (for example api.staging.appgantry.com / app.staging.appgantry.com on the staging docs). A one-command dump for the REST API repo, plus a source-level env-aware servers block, is tracked in AppGantry work item #758. CI runs mkdocs build --strict on every PR, so a malformed schema fails the build.