Computers
A Computer is a persistent Linux virtual machine with root access, running in a pool.
On this page
Read
#| Request | What it does |
|---|---|
| List or read Computers | List accessible Computers or read a named Computer. |
| Read a Computer's usage | Read CPU, memory, disk and network history for one Computer. |
| Read the boot console | Read a Computer's boot console output. |
Create and delete
#| Request | What it does |
|---|---|
| Create a Computer | Create persistent Linux Computers with root access in a pool. |
| Delete Computers | Delete Computers and their disks and snapshots without a confirmation prompt. |
Power
#| Request | What it does |
|---|---|
| Start a Computer | Start a stopped Computer from its disk. |
| Stop a Computer | Shut down a Computer and end its running processes. |
| Restart a Computer | Reboot a Computer or start it if it is stopped. |
| Pause a Computer | Pause a Computer so you can resume it with its memory and processes. |
| Resume a Computer | Continue a paused Computer from its preserved memory and processes. |
| Reinstall a Computer | Replace a Computer's disk with a fresh image and start it with its setup script. |
Name, pool and size
#| Request | What it does |
|---|---|
| Rename a Computer | Change a Computer's name and its website, SSH and mail addresses. |
| Move a Computer | Move a Computer to another pool in the same account and on the same server. |
| Resize a Computer | Change a Computer's CPU, memory or disk size without restarting it. |
| Tag a Computer | Add or remove a Computer's tags. |
| List tags | List tags in use on an organization's Computers in name order. |
| Comment on a Computer | Replace or clear a Computer's comment. |
Terminal and desktop
#| Request | What it does |
|---|---|
| Open the browser terminal | Get a browser terminal link for a Computer you own or have root access to. |
| Open the desktop | Get a browser desktop link for a running Computer you own or have root access to. |
Sharing
#| Request | What it does |
|---|---|
| Read who has access | Read a Computer's HTTPS address, website access, shares and share-link status. |
| Share a Computer | Share a Computer with specific people, a team or the whole organization. |
| Stop sharing a Computer | Remove or reduce the access granted by a Computer share. |
| Create a share link | Create a link that opens a Computer's main website without requiring the visitor to sign in. |
| Remove a share link | Revoke a Computer's website share link and end the browser sessions opened through it. |
| Transfer a Computer | Transfer ownership of a Computer. |
| Give support root access | Allow or revoke Heaven support's root access to a Computer. |
Website and ports
#| Request | What it does |
|---|---|
| Set who reaches the website | Set who can open a Computer's main HTTPS website and which HTTP port it serves. |
| List public ports | List published TCP ports and the remaining allowance, including how many new ports a pool can add in a 24-hour window. |
| Publish a port | Publish a Computer's TCP service on an assigned public port. |
| Close a port | Close a published TCP port to new connections. |
| Request | What it does |
|---|---|
| Read mail settings | Read whether a Computer can receive mail, its policy for outgoing recipients and whether sending is suspended. |
| Change mail settings | Change a Computer's incoming mail settings or choose who it can send mail to. |
| Read a message's delivery | Read the delivery status of an outgoing message by the ID returned when the Computer sent it. |