API Spec

The full OpenAPI 3.1 specification for the Fleet Manager REST API is available as a single file:

It is the same document the API Reference pages are rendered from, so what you download always matches what you read here.

What you can do with it

Generate a client. Point openapi-generator, openapi-typescript or the generator for your language at the file and get a typed SDK.
Import it into Postman or Insomnia to get every endpoint, with request and response shapes, as a ready-made collection.
Lint your integration against the contract in CI, so a change on either side is caught before it ships.

# Example: generate a Python client
curl -O https://<your-docs-host>/openapi.json
openapi-generator generate -i openapi.json -g python -o ./fleet-manager-client

What it contains

Every endpoint under /api/v1 that is part of the public API: devices, groups, applications, deployments, repositories, certificates, users, API keys, tenants, audit logs, telemetry and alerts.

Internal operational endpoints (health and readiness probes) are deliberately excluded — they are not part of the supported surface and are not guaranteed to remain stable.

Authentication

Every endpoint requires either a bearer token or an API key. See API Keys for creating a key, and Roles & Access for which permissions each role holds.

Versioning

The specification carries the platform version in info.version. The API itself is versioned by path (/api/v1), and that prefix will not change incompatibly without a new version segment. Download the spec again after upgrading to pick up newly added endpoints and fields.