Use the HTTP API guide for authentication and a first request. For terminal or agent access, see CLI, SSH or MCP.
Management responses contain version and either data or error. Changes can return an operation; follow its ID with Read an operation.
Use All commands to look up a command name or All endpoints for an HTTP method and path. The OpenAPI document provides machine-readable types.
| Resource | What it is |
|---|
| Computers | A Computer is a persistent Linux virtual machine with root access, running in a pool. |
|---|
| Snapshots | A snapshot records a Computer's disk at a point in time for restoration or copying. |
|---|
| Run and export | Guest execution runs commands and transfers files inside a Computer. |
|---|
| Templates | A template is a named image for creating Computers. |
|---|
| Resource | What it is |
|---|
| Pools | A pool supplies shared CPU, RAM and storage to its Computers. |
|---|
| Pool snapshots | A pool snapshot is a set of Computer disk snapshots captured separately. |
|---|
| Capacity | Capacity is purchased CPU, RAM and storage allocated to pools. |
|---|
| Resource | What it is |
|---|
| Domains | A domain connects names you control to Computer websites through DNS records. |
|---|
| Static addresses | A static IPv4 address belongs to an organization and can be attached to a Computer, pool or account. |
|---|
| Resource | What it is |
|---|
| Organizations | An organization owns pools and Computers and pays for their capacity. |
|---|
| Teams | A team is a group of organization members who can own Computers and share access to resources. |
|---|
| Billing | An organization pays for monthly capacity through its subscription, and hourly capacity and excess internet egress through its prepaid wallet. |
|---|
| Integrations | An integration gives Computers access to a service through Heaven. |
|---|
| Resource | What it is |
|---|
| Account | Your account identifies you across organizations and sign-ins. |
|---|
| SSH keys | An SSH key authenticates SSH connections and signed API requests with your permissions. |
|---|
| API keys | An API key lets a program act as you within one organization, limited to its allowed commands and resources. |
|---|
| Connect codes | A connect code lets an agent request sign-in. |
|---|
| Resource | What it is |
|---|
| Operations | An operation records an accepted change, its progress and result. |
|---|
| Key permissions | A command permission lets an API key run an action within your access and the key's resource scope. |
|---|
| Feedback | Feedback sends a private message to the Heaven team. |
|---|