Balemoh API

Balemoh is a self-hosted homepage for services discovered in Kubernetes, Docker, and Podman. This API backs the UI and accepts snapshots from federated agents. Start by listing Staging to obtain stable service IDs and review endpoint evidence. Save local display settings, then pin live services to add homepage cards. Manual services start unpinned. Host widget selection is separate, and host telemetry is opt-in. Discovery refreshes preserve gateway-owned display edits and pin choices. The documented server is the local development API. Use your private instance's API origin for integrations; this static documentation website does not serve the API. Catalog, dashboard, host, and icon endpoints have no built-in authentication and rely on your network or reverse-proxy access boundary. Federation imports require a Bearer token registered for the exact source kind and ID in the body. Plugin metadata, queries and widget configuration require the private BFF service credential. Notification inbox operations require the separate operator credential; external publication uses a source-bound publisher credential. These roles cannot substitute for one another. Plugin publication uses its connection-scoped runtime. Check HTTP status and Content-Type. Structured success responses use JSON, but errors can be ErrorResponse JSON or plain text as documented for each operation. Reuse requestId when retrying manual creation. Pin, unpin, and widget selection set the desired state. Refresh current state after a 409 before retrying a lifecycle action or an icon revision update. No-content responses have no body. Examples use synthetic data and reserved example.test addresses. Replace fixed observation timestamps with current UTC before importing federation payloads. Obtain IDs and icon revision digests from API responses. The integration guide provides a complete request sequence; operation and schema sections below cover field meaning, response formats, limits, and failure cases.