API reference

Interactive reference for the AppGantry public REST API. Generated from FastAPI's OpenAPI 3.1 schema and rendered with Scalar. For the prose introduction, see API conventions.

This reference covers the public REST API served from api.appgantry.com. Internal operator surfaces are not published here.

Keeping this page fresh

docs/api/openapi.json is committed into the webapp repo and refreshed by running uv run python scripts/dump_openapi.py in the REST API repo, then copying openapi/openapi.public.json over this file. CI runs mkdocs build --strict on every PR, so a malformed schema fails the build.