API reference
Fleetdock Manager HTTP API — authentication, endpoints, schemas, and an interactive playground.
The Fleetdock Manager exposes a REST API for provisioning databases, running backups, managing users, and coordinating agents. Endpoints are grouped by resource in the sidebar (Health, Auth, Instances, Backups, and so on). The active API version applies globally across the docs — when multiple versions are available, use the version selector in the sidebar.
Base URL
Point requests at your Manager host — the same origin that serves the dashboard:
https://db.example.comRunning the Go API directly for development, without the bundled proxy, it is
http://localhost:8080.
Authentication
Most /v1 routes require a Bearer token in the Authorization header:
- JWT — obtained from
POST /v1/auth/loginwith email and password. - API token — long-lived tokens prefixed with
fleetd_, created under Profile → API tokens.
Agent routes under /agent/v1 use agent bearer tokens prefixed with fleeta_.
Public routes (health checks, install script, and this documentation) do not require authentication.
Interactive playground
Each endpoint page includes a playground where you can send requests. When testing against a Manager that does not allow browser CORS, requests are proxied through this site.
Set the server URL in the playground to your Manager before sending authenticated requests.
OpenAPI spec
The machine-readable spec is available at GET /openapi.yaml on any running Manager, and
is mirrored in the
Fleetdock repository.
To refresh the copy used by this site from a local monorepo checkout:
pnpm sync:openapi