API

The schema below is generated from the same API annotations as this Engine release. Engine release versions and the /api/v1 API namespace are separate version identifiers.

Authentication

Create or obtain an API token from an administrator account and send it in the Authorization header:

Authorization: Token YOUR_API_TOKEN

Send API requests directly to the customer’s Engine server over HTTPS. Do not paste production tokens into this public documentation site. Interactive execution is disabled here intentionally.

See Examples and automation for safe curl patterns, response handling, stream control, and database backup examples.

Use the API Reference in the sidebar for route-by-route descriptions, authentication requirements, parameters, and response schemas. These pages are generated from route/docs/swagger.json during every documentation build.