Skip to documentation
Registry APIReference

Fleet Registry API

Use the canonical Registry v1 HTTP API and understand what its generated reference does—and does not—cover.

On this page

Generated reference

The Registry generates its OpenAPI 3.1 document from production route registrations and build-generated contracts derived from handler bodies and request/response Go types. At startup, the running service assembles the final document from the routes enabled in that binary. Use the interactive reference to explore operations and the raw specification for tooling.

Base path and discovery

HTTP
GET /.well-known/fleet-registry
GET /api/v1/openapi.json
GET /api/v1/docs/

/api/v1 is the canonical base advertised by Registry discovery. /v1 is a compatibility alias for shipped clients, not the preferred base for new integrations.

Authentication and authorization

Public Repository reads may be anonymous. Reading private Repositories and mutating ordinary content, metadata, or administration resources require an authenticated principal with the needed permission; authentication-flow endpoints have their own credential requirements. The generated specification advertises Bearer tokens, the browser session cookie, and Basic authentication; use a Bearer token for programmatic clients unless your deployment specifies otherwise.

Scope and stability

This is the Registry API, not a complete Platform API. The generator covers registered v1 routes; public v2 trace and review surfaces are not represented. Routes containing /internal/ are operator or worker surfaces and are not a supported caller contract even if a capability-enabled deployment exposes them in the generated document.

/api/v1 is the canonical HTTP API, with both JSON operations and streamed bundle/object responses. The Go SDK is not yet a stable v1 public contract. Docker Registry /v2/ and /mcp are separate protocols and are outside this reference.