Skip to content

Computers

A Computer is a persistent Linux virtual machine with root access, running in a pool.

Read

#
RequestWhat it does
List or read ComputersList accessible Computers or read a named Computer.
Read a Computer's usageRead CPU, memory, disk and network history for one Computer.
Read the boot consoleRead a Computer's boot console output.

Create and delete

#
RequestWhat it does
Create a ComputerCreate persistent Linux Computers with root access in a pool.
Delete ComputersDelete Computers and their disks and snapshots without a confirmation prompt.

Power

#
RequestWhat it does
Start a ComputerStart a stopped Computer from its disk.
Stop a ComputerShut down a Computer and end its running processes.
Restart a ComputerReboot a Computer or start it if it is stopped.
Pause a ComputerPause a Computer so you can resume it with its memory and processes.
Resume a ComputerContinue a paused Computer from its preserved memory and processes.
Reinstall a ComputerReplace a Computer's disk with a fresh image and start it with its setup script.

Name, pool and size

#
RequestWhat it does
Rename a ComputerChange a Computer's name and its website, SSH and mail addresses.
Move a ComputerMove a Computer to another pool in the same account and on the same server.
Resize a ComputerChange a Computer's CPU, memory or disk size without restarting it.
Tag a ComputerAdd or remove a Computer's tags.
List tagsList tags in use on an organization's Computers in name order.
Comment on a ComputerReplace or clear a Computer's comment.

Terminal and desktop

#
RequestWhat it does
Open the browser terminalGet a browser terminal link for a Computer you own or have root access to.
Open the desktopGet a browser desktop link for a running Computer you own or have root access to.

Sharing

#
RequestWhat it does
Read who has accessRead a Computer's HTTPS address, website access, shares and share-link status.
Share a ComputerShare a Computer with specific people, a team or the whole organization.
Stop sharing a ComputerRemove or reduce the access granted by a Computer share.
Create a share linkCreate a link that opens a Computer's main website without requiring the visitor to sign in.
Remove a share linkRevoke a Computer's website share link and end the browser sessions opened through it.
Transfer a ComputerTransfer ownership of a Computer.
Give support root accessAllow or revoke Heaven support's root access to a Computer.

Website and ports

#
RequestWhat it does
Set who reaches the websiteSet who can open a Computer's main HTTPS website and which HTTP port it serves.
List public portsList published TCP ports and the remaining allowance, including how many new ports a pool can add in a 24-hour window.
Publish a portPublish a Computer's TCP service on an assigned public port.
Close a portClose a published TCP port to new connections.

Email

#
RequestWhat it does
Read mail settingsRead whether a Computer can receive mail, its policy for outgoing recipients and whether sending is suspended.
Change mail settingsChange a Computer's incoming mail settings or choose who it can send mail to.
Read a message's deliveryRead the delivery status of an outgoing message by the ID returned when the Computer sent it.