Admin API conventions
What holds for every admin endpoint whatever resource it addresses.
| Page | Holds |
|---|---|
| Authentication | the one header the server reads, the key forms, rotation, and the failure backoff. |
| Response envelopes | the success and error bodies, paging and sorting per endpoint, and the common errors. |
| Lifecycle over the API | what a write does to status and version, and which writes reach the engine. |
| Status changes | activating and archiving, the dry_run pre-flight, and reload=defer. |
| Export and promotion | export and import, on_conflict, change grouping, and secrets in a bundle. |
Related
- Admin API: every admin resource, and the contracts they share.
- OpenAPI specification: the generated contract, and where to fetch it.
- Errors and response envelopes: every code these endpoints return.
- Entity endpoints: the resources these contracts apply to.
Last verified 14 September 2026