Project · developer-tool
hpos-api-rust
- How you run it
- not recorded
- Holochain version
- not recorded
- Activity
- stalled
- Checked
- 27 October 2026
What is hpos-api-rust and what is it for?
hpos-api-rust is a small web API, written in Rust, that sits inside the HPOS host system and lets software talk to the Holochain services running on a host's machine. It exists so that something acting for the host — the host's own tooling or Holo's hosting services — can list the Holochain apps a device is hosting, read their usage, turn them on or off, and place calls into their zomes.
hpos-api-rust is a Rust project in the Holo Host organisation, built alongside other parts of the HPOS host stack rather than as a standalone application. Its build manifest takes its dependencies from the sibling HPOS service and configuration crates, and its documentation describes a binary whose environment is set by the host system — for example the HPOS configuration path that hpos-init supplies. The material available records no founding motive or release history, so none is described here.
In plain terms it is a small control panel expressed as an HTTP API. HPOS runs Holochain services on a host's device; this project exposes them under an /api/v2/ path so another program can ask which Holochain apps the device is hosting, how much they have been used, what they have earned, whether each is enabled or paused, and can read an app's logs or make a call into one of its zomes. Authentication relies on the hp-admin-crypto mechanism.
One documented example: a request to the hosted-apps endpoint with a seven-day usage interval returns each hosted app's details, including its source-chain count, days hosted, earnings and bandwidth, CPU and disk usage. The repository README carries the endpoint list and the configuration the binary expects. The catalog records this project's activity as stalled, and nothing in the material read describes it as something an individual installs and uses today; it is a component of the Holo hosting stack.
How to get it
As a library
- No end-user installation is documented; the project is described as a service that runs as part of HPOS, not software a person downloads and runs on its own.
- Running the binary requires environment variables supplied by the host system, including HPOS_CONFIG_PATH (set by hpos-init), HOLOCHAIN_DEFAULT_PASSWORD and CORE_HAPP_FILE.
- The README documents running the integration test suite with: RUST_LOG=hpos-api-rust=trace,integration=trace cargo test -- --nocapture --test-threads=1
Questions people ask
- What can a caller do with the hpos-api-rust API?
- It exposes HPOS's Holochain services under an /api/v2/ path: callers can list hosted apps with usage statistics, enable or disable an app, read an app's logs, and make a zome call into a running Holochain instance. source
- How do callers authenticate?
- The README states that the API relies on the hp-admin-crypto authentication mechanism. source
- What configuration does the service need?
- It requires environment variables from its host, including HPOS_CONFIG_PATH (set by hpos-init), HOLOCHAIN_DEFAULT_PASSWORD and CORE_HAPP_FILE, as listed in the README's service section. source
From 2 public sources, checked 23 September 2026.
Try hpos-api-rust
- Code on GitHubOpen on GitHub ↗Last change 2 July 2025.
- ReleaseNo GitHub release recorded.
- The project's own files do not say how it is run.
Details & sources
- Source
- Holo-Host/hpos-api-rust
Evidence
- Last change
- api.github.com/repos/Holo-Host/hpos-api-rustlisted by a third party · seen since 20 October 2026 · github.repository@1
- Activity
- api.github.com/repos/Holo-Host/hpos-api-rustlisted by a third party · seen since 20 October 2026 · liveness@1
Compatibility
- hdk
- —
- hdi
- 0.5.0-rc.0 · Cargo.lock @ 8206509
- holochain-client
- —
- happ.yaml
- absent
- web-happ.yaml
- absent