API

Use this reference for the current Engine release. The /api/v1 namespace is separate from the Engine release version.

Authentication

Obtain an administrator API token and send it in the header:

Authorization: Token YOUR_API_TOKEN

An explicit Authorization header takes priority. Invalid credentials or unsupported schemes are rejected, even if the browser is signed in. Omit the header only when using an existing same-origin management session.

Changed in Engine 1.0+

Repeated invalid tokens from one IP can trigger a temporary rate limit. Follow the response’s Retry-After header before retrying.

View valid-token usage in Manage Accounts or below API Token in Account Settings.

Use the API Safely

Send requests directly to your Engine server over HTTPS. Never paste production tokens into this public site. Interactive requests are disabled here.

See Examples and Automation for curl, stream control, and backup examples. Open the API Reference for routes, permissions, parameters, and responses.