API reference

Administration → API → Reference.

This page presents the endpoints exposed by your instance, read from its own schema. It replaces the /docs and /redoc pages of earlier versions, which were served without authentication.

The instance endpoints, grouped by domain, read from its own schema.

What the page holds

The schema describes the whole API: the endpoints, their parameters, the shape of request bodies and of responses. It is produced by the instance itself, so it always matches the version you have installed, with no risk of drifting from separately published documentation.

Requests sent from this page use your current session. They carry your own permissions: what you cannot do in the interface, you cannot do from this page either.

Try-outs are real

Trying an endpoint runs an actual request against your instance, with your rights. A call that creates, changes or deletes does so for real.

Fetching the schema from a tool

The schema is available at /openapi.json, at the root of the instance, and requires authentication. Two identities are accepted:

• a user session, which is what this page uses;
• an API key, through the X-API-Key header, so an integrator can load the schema into their own tooling.

API keys are created under Administration → API → Keys.

The address does not open in a browser

A plain browser navigation carries no authentication header, so the address answers with a refusal if you type it in the address bar. Use a tool able to set the header, or this page.