Documentation
Welcome to Helix Cloud Console — a unified control plane for managing distributed services across regions, teams and environments. This page summarises the platform; the full reference lives in the developer portal.
Overview
Helix is built around three primitives:
- Workspaces — top-level isolation boundary (one per organisation or business unit)
- Projects — group services, environments and resources together
- Resources — the actual deployments, databases, secrets, queues and edge nodes
Everything in the console is also accessible via the REST API and the helix CLI.
Architecture
The platform runs as a multi-region mesh of stateless control nodes backed by a globally-replicated metadata store. Customer data never leaves the region it was created in unless cross-region replication is explicitly enabled.
| Component | Purpose |
|---|---|
| Control plane | API, auth, audit log |
| Data plane | Per-region workers running customer workloads |
| Metadata store | Globally-replicated configuration & state |
| Edge | Low-latency cache nodes in 32 PoPs |
API
All endpoints live under /api/v1/ and accept JSON. Authentication uses bearer tokens issued by the login flow. URLs are extension-less.
GET /api/v1/health
Accept: application/json
Authorization: Bearer hxk_live_...
Common endpoints:
POST /api/v1/auth/login— exchange credentials for a session tokenPOST /api/v1/auth/reset— request a password reset emailGET /api/v1/health— service status & component healthGET /api/v1/users/me— current user profile
Tokens expire after 30 minutes of inactivity. Use the SDK to refresh them automatically.
Security
- Sessions are derived client-side via PBKDF2-SHA256 (600 000 iterations) and decrypted with AES-256-GCM. The console payload itself is encrypted at rest — without the correct passphrase, no UI is rendered, even on direct navigation to
/dashboard/. - All traffic is served over TLS 1.3.
- Audit log entries are retained for 90 days on the Free plan and 1 year on Plus / Enterprise.
SDKs
Official SDKs are available for Go, Python, TypeScript and Rust. They handle retries, pagination and token refresh automatically.
npm install @helix-cloud/sdk
pip install helix-cloud
go get github.com/helix-cloud/sdk-go
FAQ
Where is my data stored? In the region you select when creating the workspace. We support eu-central-1, eu-west-2, us-east-1, us-west-2, ap-southeast-1 and ap-northeast-1.
How is billing calculated? Per active resource per hour, with 1-minute granularity for long-running workloads. Live usage is visible in the console.
Is there a free tier? Yes — up to 3 small resources, 1 workspace and 5 GB of egress per month.
How do I contact support? Email support@helix.cloud or use the in-console chat (Plus and Enterprise plans).