Technical Reference
Look-up material for Brokkr: endpoints, flags, fields, codes, and defaults. Each page is a catalog rather than a walkthrough — for step-by-step procedures see the How-To Guides, and for the reasoning behind a design see Explanation.
API and CLI
Section titled “API and CLI”- API Reference — the full endpoint catalog: every route, method, and authorization requirement. The broker also serves an interactive Swagger UI at
/swagger-uiand the OpenAPI spec at/docs/openapi.json. - CLI Reference — every
brokkr-brokerandbrokkr-agentsubcommand and flag - Stable Error Codes — the
codestrings returned by 4xx/5xx responses, and how SDKs surface them - WebSocket Protocol — message catalog and channel behavior for the WS surfaces
Configuration and deployment
Section titled “Configuration and deployment”- Environment Variables — every
BROKKR__*setting, its default, and its config-file equivalent - Network Ports — listening ports and the connection matrix between components
- Container Images — published repositories, tag formats, and image structure
Resources
Section titled “Resources”- Generators — the generator (tenant) resource, its registration surface, and the system generator
- Templates — stack template fields, parameter schemas, and matching rules
- Work Orders — the work-order lifecycle, states, and claim semantics
- Webhooks — subscription fields, event payloads, filters, and delivery behavior
- Agent Annotations & Labels — reserved keys and validation rules
- Multi-Tenancy — how tenant scope is expressed and enforced across resources
- Soft Deletion — which resources soft-delete, and what that implies for names and queries
Observability
Section titled “Observability”- Health Endpoints — the broker’s liveness and readiness endpoints and their semantics
- Deployment Health — the per-deployment-object health model agents report
- Fleet Observability — the per-agent fleet record, its REST endpoints, and the live-push stream
- Monitoring & Observability — the Prometheus metrics catalog for broker and agent
- Diagnostics — the on-demand diagnostic request/result contract
- Audit Logs — audit entry schema, emitted actions, query API, and retention
Rust API Documentation
Section titled “Rust API Documentation”Module, type, and function documentation generated from the Brokkr source is available in the Rust API Documentation.