API Reference

Reference documentation for the OSS Panel HTTP API — authentication, endpoints, request and response shapes, and error semantics.

Everything the panel's own interface does, it does through this API. Servers, sites, applications, deployments, SSL, databases and backups are all reachable from a script holding a token.

Looking for setup and operational guidance instead? See the OSS Panel guide.

Conventions

These hold across every endpoint.

Base URL — https://<your-panel-host>/api.

Response envelope — a named top-level key, never a generic data wrapper:

{"user": {"id": 1, "username": "admin"}}
{"applications": [{"id": 1, "name": "shop"}]}

Timestamps — DD-MM-YYYY HH:mm:ss, each with a _human sibling: created_at_human: "3 minutes ago".

Pagination — page-based. Pass ?page=N&per_page=20; the response carries meta: {current_page, per_page, total, last_page}.

Localisation — send Accept-Language to get error messages and permission titles in one of the eight supported locales.