Osprey REST API Reference

Base URL: /api/v1

This document is the authoritative reference for the Osprey REST API. All endpoints, request/response schemas, authentication flows, and error codes are documented here.

Edition: 1.4.5. Match the reference to the version returned by GET /api/v1/version; this reference can describe features absent from older installations. The maintained OpenAPI file covers twenty observation operations, not the whole API; the published 1.4.3 file covers eight.

The reference is bundled with full installation builds at /api-reference/, with the partial specification at /api-reference/openapi.json. These static documentation files are accessible without signing in; they contain no installation data and grant no API permissions.

For maintainers: this source is a release-blocking input to the frontend and package builds. Publication checks reject duplicate heading anchors, unresolved internal links, missing documented/registered OpenAPI routes, unsupported response-field shapes and internal-only content (including ticket references and non-public examples). A documentation edit can therefore fail the build; keep headings unique, links valid and examples suitable for publication.