Introduction
Documentation for the hzel container management platform.
hzel docs
hzel is a container management platform built on Proxmox VE. It provides a clean REST API and dashboard for provisioning, managing, and accessing unprivileged LXC containers — with a focus on security, auditability, and a straightforward developer experience.
What's in these docs
| Section | What's inside |
|---|---|
| Guides | Quickstart, authentication flows, PAT setup |
| Concepts | Platform architecture, container lifecycle, security model |
| Reference | WebSocket endpoints, API error codes |
Tip
New here? Head to the Quickstart to make your first API call in under two minutes.
Base URL
All API requests target:
https://api.hzel.org/api/v1How it works
- Authenticate via OAuth or a Personal Access Token.
- Call the REST API to create and manage containers.
- Stream terminal sessions and command output over WebSockets.
- Every action is ownership-checked and audit-logged.
Read the Architecture overview to understand how the layers fit together.