# All endpoints

URL: https://heaven.dev/docs/reference/endpoints
Updated: 2026-11-21

Heaven API requests sharing a path select a command with `action` in the JSON body or `view` in the query.

See the [HTTP API guide](https://heaven.dev/docs/http-api) for authentication or the [OpenAPI document](https://heaven.dev/docs/openapi.json) for machine-readable definitions.

## Computers

| Endpoint | Action | Request |
| --- | --- | --- |
| `GET /v1/computer/` |  | [List or read Computers](https://heaven.dev/docs/reference/computers/view) |
| `GET /v1/computer/?view=usage` |  | [Read a Computer's usage](https://heaven.dev/docs/reference/computers/usage) |
| `GET /v1/computer/?view=logs` |  | [Read the boot console](https://heaven.dev/docs/reference/computers/logs) |
| `POST /v1/computer/create` |  | [Create a Computer](https://heaven.dev/docs/reference/computers/create) |
| `POST /v1/computer/delete` |  | [Delete Computers](https://heaven.dev/docs/reference/computers/delete) |
| `POST /v1/computer/modify` | `start` | [Start a Computer](https://heaven.dev/docs/reference/computers/start) |
| `POST /v1/computer/modify` | `stop` | [Stop a Computer](https://heaven.dev/docs/reference/computers/stop) |
| `POST /v1/computer/modify` | `restart` | [Restart a Computer](https://heaven.dev/docs/reference/computers/restart) |
| `POST /v1/computer/modify` | `pause` | [Pause a Computer](https://heaven.dev/docs/reference/computers/pause) |
| `POST /v1/computer/modify` | `resume` | [Resume a Computer](https://heaven.dev/docs/reference/computers/resume) |
| `POST /v1/computer/modify` | `reset` | [Reinstall a Computer](https://heaven.dev/docs/reference/computers/reset) |
| `POST /v1/computer/modify` | `rename` | [Rename a Computer](https://heaven.dev/docs/reference/computers/rename) |
| `POST /v1/computer/modify` | `move` | [Move a Computer](https://heaven.dev/docs/reference/computers/move) |
| `POST /v1/computer/modify` | `resize` | [Resize a Computer](https://heaven.dev/docs/reference/computers/resize) |
| `POST /v1/computer/modify` | `tag` | [Tag a Computer](https://heaven.dev/docs/reference/computers/tag) |
| `GET /v1/computer/?view=tag` |  | [List tags](https://heaven.dev/docs/reference/computers/tag-view) |
| `POST /v1/computer/modify` | `comment` | [Comment on a Computer](https://heaven.dev/docs/reference/computers/comment) |
| `GET /v1/computer/?view=terminal` |  | [Open the browser terminal](https://heaven.dev/docs/reference/computers/terminal) |
| `GET /v1/computer/?view=desktop` |  | [Open the desktop](https://heaven.dev/docs/reference/computers/desktop) |
| `GET /v1/computer/?view=access` |  | [Read who has access](https://heaven.dev/docs/reference/computers/access) |
| `POST /v1/computer/modify` | `share add` | [Share a Computer](https://heaven.dev/docs/reference/computers/share-add) |
| `POST /v1/computer/modify` | `share remove` | [Stop sharing a Computer](https://heaven.dev/docs/reference/computers/share-remove) |
| `POST /v1/computer/modify` | `share link add` | [Create a share link](https://heaven.dev/docs/reference/computers/share-link-add) |
| `POST /v1/computer/modify` | `share link remove` | [Remove a share link](https://heaven.dev/docs/reference/computers/share-link-remove) |
| `POST /v1/computer/modify` | `transfer` | [Transfer a Computer](https://heaven.dev/docs/reference/computers/transfer) |
| `POST /v1/computer/modify` | `grant-support-root` | [Give support root access](https://heaven.dev/docs/reference/computers/grant-support-root) |
| `POST /v1/computer/modify` | `website` | [Set who reaches the website](https://heaven.dev/docs/reference/computers/website) |
| `GET /v1/computer/?view=port` |  | [List public ports](https://heaven.dev/docs/reference/computers/port-view) |
| `POST /v1/computer/modify` | `port add` | [Publish a port](https://heaven.dev/docs/reference/computers/port-add) |
| `POST /v1/computer/modify` | `port remove` | [Close a port](https://heaven.dev/docs/reference/computers/port-remove) |
| `GET /v1/computer/?view=mail` |  | [Read mail settings](https://heaven.dev/docs/reference/computers/mail-view) |
| `POST /v1/computer/modify` | `mail` | [Change mail settings](https://heaven.dev/docs/reference/computers/mail) |
| `GET /v1/computer/?view=mail+status` |  | [Read a message's delivery](https://heaven.dev/docs/reference/computers/mail-status) |

## Snapshots

| Endpoint | Action | Request |
| --- | --- | --- |
| `GET /v1/computer/snapshot/` |  | [List or read snapshots](https://heaven.dev/docs/reference/snapshots/view) |
| `POST /v1/computer/snapshot/create` |  | [Snapshot a Computer](https://heaven.dev/docs/reference/snapshots/create) |
| `POST /v1/computer/snapshot/modify` | `edit` | [Change a snapshot](https://heaven.dev/docs/reference/snapshots/edit) |
| `POST /v1/computer/snapshot/modify` | `restore` | [Restore a snapshot](https://heaven.dev/docs/reference/snapshots/restore) |
| `POST /v1/computer/snapshot/delete` |  | [Delete snapshots](https://heaven.dev/docs/reference/snapshots/delete) |

## Run and export

| Endpoint | Action | Request |
| --- | --- | --- |
| `POST /v1/computer/exec` |  | [Run a command](https://heaven.dev/docs/reference/exec/run) |
| `GET /v1/computer/export` |  | [Export a disk](https://heaven.dev/docs/reference/exec/export) |

## Templates

| Endpoint | Action | Request |
| --- | --- | --- |
| `GET /v1/template/` |  | [List templates](https://heaven.dev/docs/reference/templates/view) |

## Pools

| Endpoint | Action | Request |
| --- | --- | --- |
| `GET /v1/pool/` |  | [List or read pools](https://heaven.dev/docs/reference/pools/view) |
| `GET /v1/pool/?view=usage` |  | [Read a pool's usage](https://heaven.dev/docs/reference/pools/usage) |
| `POST /v1/pool/create` |  | [Create a pool](https://heaven.dev/docs/reference/pools/create) |
| `POST /v1/pool/delete` |  | [Delete a pool](https://heaven.dev/docs/reference/pools/delete) |
| `POST /v1/pool/modify` | `start` | [Start a pool](https://heaven.dev/docs/reference/pools/start) |
| `POST /v1/pool/modify` | `stop` | [Stop a pool](https://heaven.dev/docs/reference/pools/stop) |
| `POST /v1/pool/modify` | `pause` | [Pause a pool](https://heaven.dev/docs/reference/pools/pause) |
| `POST /v1/pool/modify` | `resume` | [Resume a pool](https://heaven.dev/docs/reference/pools/resume) |
| `POST /v1/pool/modify` | `stop-last` | [Keep a pool running longest](https://heaven.dev/docs/reference/pools/stop-last) |
| `POST /v1/pool/modify` | `resize` | [Resize a pool](https://heaven.dev/docs/reference/pools/resize) |
| `POST /v1/pool/modify` | `rename` | [Rename a pool](https://heaven.dev/docs/reference/pools/rename) |
| `POST /v1/pool/modify` | `split` | [Split a pool](https://heaven.dev/docs/reference/pools/split) |
| `POST /v1/pool/modify` | `combine` | [Combine pools](https://heaven.dev/docs/reference/pools/combine) |
| `POST /v1/pool/modify` | `transfer` | [Transfer a pool](https://heaven.dev/docs/reference/pools/transfer) |
| `POST /v1/pool/modify` | `defaults set` | [Set pool defaults](https://heaven.dev/docs/reference/pools/defaults-set) |
| `POST /v1/pool/modify` | `defaults clear` | [Clear pool defaults](https://heaven.dev/docs/reference/pools/defaults-clear) |
| `POST /v1/pool/modify` | `share add` | [Share a pool](https://heaven.dev/docs/reference/pools/share-add) |
| `POST /v1/pool/modify` | `share remove` | [Stop sharing a pool](https://heaven.dev/docs/reference/pools/share-remove) |

## Pool snapshots

| Endpoint | Action | Request |
| --- | --- | --- |
| `GET /v1/pool/snapshot/` |  | [List or read pool snapshots](https://heaven.dev/docs/reference/pool-snapshots/view) |
| `POST /v1/pool/snapshot/create` |  | [Snapshot a pool](https://heaven.dev/docs/reference/pool-snapshots/create) |
| `POST /v1/pool/snapshot/modify` | `edit` | [Change a pool snapshot](https://heaven.dev/docs/reference/pool-snapshots/edit) |
| `POST /v1/pool/snapshot/modify` | `restore` | [Restore a pool snapshot](https://heaven.dev/docs/reference/pool-snapshots/restore) |
| `POST /v1/pool/snapshot/delete` |  | [Delete a pool snapshot](https://heaven.dev/docs/reference/pool-snapshots/delete) |
| `POST /v1/pool/snapshot/modify` | `share add` | [Share a pool snapshot](https://heaven.dev/docs/reference/pool-snapshots/share-add) |
| `POST /v1/pool/snapshot/modify` | `share remove` | [Stop sharing a pool snapshot](https://heaven.dev/docs/reference/pool-snapshots/share-remove) |

## Capacity

| Endpoint | Action | Request |
| --- | --- | --- |
| `GET /v1/organization/capacity/` |  | [Read your capacity](https://heaven.dev/docs/reference/capacity/view) |
| `GET /v1/plan/` |  | [List plans](https://heaven.dev/docs/reference/capacity/plan-view) |
| `POST /v1/organization/capacity/create` |  | [Buy capacity](https://heaven.dev/docs/reference/capacity/buy) |
| `POST /v1/organization/capacity/modify` | `resize` | [Change a purchase's plan](https://heaven.dev/docs/reference/capacity/resize) |
| `POST /v1/organization/capacity/modify` | `switch` | [Switch monthly or hourly](https://heaven.dev/docs/reference/capacity/switch) |
| `POST /v1/organization/capacity/modify` | `cancel-change` | [Cancel a scheduled change](https://heaven.dev/docs/reference/capacity/cancel-change) |
| `POST /v1/organization/capacity/delete` |  | [Release capacity](https://heaven.dev/docs/reference/capacity/release) |

## Domains

| Endpoint | Action | Request |
| --- | --- | --- |
| `GET /v1/organization/domain/` |  | [List domains and names](https://heaven.dev/docs/reference/domains/view) |
| `POST /v1/organization/domain/create` |  | [Connect a domain](https://heaven.dev/docs/reference/domains/connect) |
| `POST /v1/organization/domain/modify` | `edit` | [Change who adds names](https://heaven.dev/docs/reference/domains/edit) |
| `POST /v1/organization/domain/modify` | `address` | [Choose the organization's address](https://heaven.dev/docs/reference/domains/address) |
| `POST /v1/organization/domain/delete` |  | [Disconnect a domain](https://heaven.dev/docs/reference/domains/disconnect) |
| `POST /v1/organization/domain/modify` | `add` | [Add a name to a Computer](https://heaven.dev/docs/reference/domains/add) |
| `GET /v1/organization/domain/?view=check` |  | [Check a name's DNS](https://heaven.dev/docs/reference/domains/check) |
| `POST /v1/organization/domain/modify` | `remove` | [Remove a name](https://heaven.dev/docs/reference/domains/remove) |

## Static addresses

| Endpoint | Action | Request |
| --- | --- | --- |
| `GET /v1/organization/ip/` |  | [List static addresses](https://heaven.dev/docs/reference/addresses/view) |
| `POST /v1/organization/ip/create` |  | [Buy static addresses](https://heaven.dev/docs/reference/addresses/buy) |
| `POST /v1/organization/ip/modify` | `attach` | [Attach static addresses](https://heaven.dev/docs/reference/addresses/attach) |
| `POST /v1/organization/ip/modify` | `detach` | [Detach static addresses](https://heaven.dev/docs/reference/addresses/detach) |
| `POST /v1/organization/ip/delete` |  | [Release static addresses](https://heaven.dev/docs/reference/addresses/release) |

## Organizations

| Endpoint | Action | Request |
| --- | --- | --- |
| `GET /v1/organization/` |  | [List or read organizations](https://heaven.dev/docs/reference/organizations/view) |
| `GET /v1/organization/?view=usage` |  | [Read an organization's usage](https://heaven.dev/docs/reference/organizations/usage) |
| `GET /v1/organization/?view=audit` |  | [Read the audit log](https://heaven.dev/docs/reference/organizations/audit-view) |
| `POST /v1/organization/create` |  | [Create an organization](https://heaven.dev/docs/reference/organizations/create) |
| `POST /v1/organization/delete` |  | [Close an organization](https://heaven.dev/docs/reference/organizations/delete) |
| `POST /v1/organization/modify` | `rename` | [Rename an organization](https://heaven.dev/docs/reference/organizations/rename) |
| `POST /v1/organization/modify` | `setting` | [Change an organization's setting](https://heaven.dev/docs/reference/organizations/setting) |
| `GET /v1/organization/?view=member` |  | [List members](https://heaven.dev/docs/reference/organizations/member-view) |
| `POST /v1/organization/modify` | `member add` | [Invite a member](https://heaven.dev/docs/reference/organizations/member-add) |
| `POST /v1/organization/modify` | `member role` | [Change a member's access](https://heaven.dev/docs/reference/organizations/member-role) |
| `POST /v1/organization/modify` | `member remove` | [Remove a member](https://heaven.dev/docs/reference/organizations/member-remove) |
| `POST /v1/organization/modify` | `leave` | [Leave an organization](https://heaven.dev/docs/reference/organizations/leave) |
| `GET /v1/organization/?view=invitation` |  | [List sent invitations](https://heaven.dev/docs/reference/organizations/invitation-view) |
| `POST /v1/organization/modify` | `invitation cancel` | [Cancel an invitation](https://heaven.dev/docs/reference/organizations/invitation-cancel) |
| `POST /v1/organization/modify` | `link add` | [Get a join link](https://heaven.dev/docs/reference/organizations/link-add) |
| `GET /v1/organization/?view=link` |  | [List join links](https://heaven.dev/docs/reference/organizations/link-view) |
| `POST /v1/organization/modify` | `link remove` | [Remove a join link](https://heaven.dev/docs/reference/organizations/link-remove) |

## Teams

| Endpoint | Action | Request |
| --- | --- | --- |
| `GET /v1/organization/team/` |  | [List or read teams](https://heaven.dev/docs/reference/teams/view) |
| `POST /v1/organization/team/create` |  | [Create a team](https://heaven.dev/docs/reference/teams/create) |
| `POST /v1/organization/team/modify` | `rename` | [Rename a team](https://heaven.dev/docs/reference/teams/rename) |
| `POST /v1/organization/team/modify` | `setting` | [Change a team's setting](https://heaven.dev/docs/reference/teams/setting) |
| `POST /v1/organization/team/modify` | `member add` | [Add a team member](https://heaven.dev/docs/reference/teams/member-add) |
| `POST /v1/organization/team/modify` | `member role` | [Change a team member's role](https://heaven.dev/docs/reference/teams/member-role) |
| `POST /v1/organization/team/modify` | `member remove` | [Remove a team member](https://heaven.dev/docs/reference/teams/member-remove) |
| `POST /v1/organization/team/modify` | `leave` | [Leave a team](https://heaven.dev/docs/reference/teams/leave) |
| `POST /v1/organization/team/delete` |  | [Delete a team](https://heaven.dev/docs/reference/teams/delete) |

## Billing

| Endpoint | Action | Request |
| --- | --- | --- |
| `GET /v1/organization/billing/` |  | [Read billing](https://heaven.dev/docs/reference/billing/view) |
| `GET /v1/organization/billing/?view=cost` |  | [Read this month's cost](https://heaven.dev/docs/reference/billing/cost) |
| `GET /v1/organization/billing/?view=history` |  | [List charges](https://heaven.dev/docs/reference/billing/history) |
| `POST /v1/organization/billing/modify` | `top-up` | [Top up the wallet](https://heaven.dev/docs/reference/billing/top-up) |
| `POST /v1/organization/billing/modify` | `charge` | [Charge your saved card](https://heaven.dev/docs/reference/billing/charge) |
| `POST /v1/organization/billing/modify` | `auto-top-up` | [Set automatic top-up](https://heaven.dev/docs/reference/billing/auto-top-up) |
| `POST /v1/organization/billing/modify` | `refund` | [Refund the wallet](https://heaven.dev/docs/reference/billing/refund) |
| `POST /v1/organization/billing/modify` | `redeem` | [Redeem an offer](https://heaven.dev/docs/reference/billing/redeem) |
| `GET /v1/organization/billing/?view=invoices` |  | [List invoices](https://heaven.dev/docs/reference/billing/invoices) |
| `POST /v1/organization/billing/modify` | `pay` | [Pay an invoice](https://heaven.dev/docs/reference/billing/pay) |
| `GET /v1/organization/billing/?view=details` |  | [Read invoice details](https://heaven.dev/docs/reference/billing/details-view) |
| `POST /v1/organization/billing/modify` | `details set` | [Set invoice details](https://heaven.dev/docs/reference/billing/details-set) |
| `POST /v1/organization/billing/modify` | `card setup` | [Start saving a card](https://heaven.dev/docs/reference/billing/card-setup) |
| `POST /v1/organization/billing/modify` | `card save` | [Save a card](https://heaven.dev/docs/reference/billing/card-save) |
| `POST /v1/organization/billing/modify` | `portal` | [Open the billing portal](https://heaven.dev/docs/reference/billing/portal) |
| `POST /v1/organization/billing/modify` | `egress-cap` | [Set the egress cap](https://heaven.dev/docs/reference/billing/egress-cap) |
| `POST /v1/organization/billing/modify` | `spend-alert` | [Set the spend alert](https://heaven.dev/docs/reference/billing/spend-alert) |
| `POST /v1/organization/billing/modify` | `spending-cap` | [Set the spending cap](https://heaven.dev/docs/reference/billing/spending-cap) |
| `POST /v1/organization/billing/modify` | `usage-emails` | [Turn usage notices on or off](https://heaven.dev/docs/reference/billing/usage-emails) |
| `GET /v1/organization/billing/?view=contact` |  | [List billing contacts](https://heaven.dev/docs/reference/billing/contact-view) |
| `POST /v1/organization/billing/modify` | `contact add` | [Add a billing contact](https://heaven.dev/docs/reference/billing/contact-add) |
| `POST /v1/organization/billing/modify` | `contact remove` | [Remove a billing contact](https://heaven.dev/docs/reference/billing/contact-remove) |

## Integrations

| Endpoint | Action | Request |
| --- | --- | --- |
| `GET /v1/organization/integration/` |  | [List integrations](https://heaven.dev/docs/reference/integrations/view) |
| `POST /v1/organization/integration/create` |  | [Create an integration](https://heaven.dev/docs/reference/integrations/create) |
| `POST /v1/organization/integration/modify` | `edit` | [Change an integration](https://heaven.dev/docs/reference/integrations/edit) |
| `POST /v1/organization/integration/modify` | `attach` | [Attach an integration](https://heaven.dev/docs/reference/integrations/attach) |
| `POST /v1/organization/integration/modify` | `detach` | [Detach an integration](https://heaven.dev/docs/reference/integrations/detach) |
| `POST /v1/organization/integration/modify` | `rename` | [Rename an integration](https://heaven.dev/docs/reference/integrations/rename) |
| `POST /v1/organization/integration/modify` | `pause` | [Pause an integration](https://heaven.dev/docs/reference/integrations/pause) |
| `POST /v1/organization/integration/modify` | `resume` | [Resume an integration](https://heaven.dev/docs/reference/integrations/resume) |
| `POST /v1/organization/integration/delete` |  | [Delete an integration](https://heaven.dev/docs/reference/integrations/delete) |
| `GET /v1/organization/integration/?view=repo` |  | [List a GitHub integration's repositories](https://heaven.dev/docs/reference/integrations/repo-view) |

## Account

| Endpoint | Action | Request |
| --- | --- | --- |
| `GET /v1/account/` |  | [Read your account](https://heaven.dev/docs/reference/account/view) |
| `POST /v1/account/modify` | `email` | [Change your email address](https://heaven.dev/docs/reference/account/email) |
| `POST /v1/account/modify` | `name` | [Set your name](https://heaven.dev/docs/reference/account/name) |
| `POST /v1/account/delete` |  | [Delete your account](https://heaven.dev/docs/reference/account/delete) |
| `GET /v1/account/?view=notification` |  | [List notifications](https://heaven.dev/docs/reference/account/notification-view) |
| `POST /v1/account/modify` | `notification read` | [Mark notifications read](https://heaven.dev/docs/reference/account/notification-read) |
| `GET /v1/account/?view=defaults` |  | [Read your default setup script](https://heaven.dev/docs/reference/account/defaults-view) |
| `POST /v1/account/modify` | `defaults set` | [Set your default setup script](https://heaven.dev/docs/reference/account/defaults-set) |
| `POST /v1/account/modify` | `defaults clear` | [Clear your default setup script](https://heaven.dev/docs/reference/account/defaults-clear) |
| `GET /v1/account/?view=sign-in` |  | [Read your sign-ins](https://heaven.dev/docs/reference/account/sign-in-view) |
| `POST /v1/account/modify` | `sign-in lifetime` | [Set your sign-in lifetime](https://heaven.dev/docs/reference/account/sign-in-lifetime) |
| `POST /v1/account/modify` | `sign-in end-all` | [Sign out everywhere](https://heaven.dev/docs/reference/account/sign-in-end-all) |
| `GET /v1/account/?view=mcp-request` |  | [Read an MCP sign-in request](https://heaven.dev/docs/reference/account/mcp-request-view) |
| `GET /v1/account/?view=invitation` |  | [List your invitations](https://heaven.dev/docs/reference/account/invitation-view) |
| `POST /v1/account/modify` | `invitation accept` | [Accept an invitation](https://heaven.dev/docs/reference/account/invitation-accept) |
| `POST /v1/account/modify` | `invitation decline` | [Decline an invitation](https://heaven.dev/docs/reference/account/invitation-decline) |

## SSH keys

| Endpoint | Action | Request |
| --- | --- | --- |
| `GET /v1/account/ssh-key/` |  | [List SSH keys](https://heaven.dev/docs/reference/ssh-keys/view) |
| `POST /v1/account/ssh-key/create` |  | [Add an SSH key](https://heaven.dev/docs/reference/ssh-keys/add) |
| `POST /v1/account/ssh-key/modify` | `rename` | [Rename an SSH key](https://heaven.dev/docs/reference/ssh-keys/rename) |
| `POST /v1/account/ssh-key/delete` |  | [Remove an SSH key](https://heaven.dev/docs/reference/ssh-keys/remove) |

## API keys

| Endpoint | Action | Request |
| --- | --- | --- |
| `GET /v1/account/api-key/` |  | [List API keys](https://heaven.dev/docs/reference/api-keys/view) |
| `POST /v1/account/api-key/create` |  | [Create an API key](https://heaven.dev/docs/reference/api-keys/create) |
| `POST /v1/account/api-key/modify` | `edit` | [Change an API key](https://heaven.dev/docs/reference/api-keys/edit) |
| `POST /v1/account/api-key/modify` | `rotate` | [Rotate an API key](https://heaven.dev/docs/reference/api-keys/rotate) |
| `POST /v1/account/api-key/delete` |  | [Remove an API key](https://heaven.dev/docs/reference/api-keys/remove) |

## Connect codes

| Endpoint | Action | Request |
| --- | --- | --- |
| `POST /v1/account/connect-code/create` |  | [Create a connect code](https://heaven.dev/docs/reference/connect-codes/create) |
| `GET /v1/account/connect-code/` |  | [List agents waiting for approval](https://heaven.dev/docs/reference/connect-codes/view) |
| `POST /v1/account/connect-code/modify` | `approve` | [Approve an agent](https://heaven.dev/docs/reference/connect-codes/approve) |
| `POST /v1/account/connect-code/modify` | `deny` | [Deny an agent](https://heaven.dev/docs/reference/connect-codes/deny) |

## Operations

| Endpoint | Action | Request |
| --- | --- | --- |
| `GET /v1/operation/` |  | [Read an operation](https://heaven.dev/docs/reference/operations/read) |

## Key permissions

| Endpoint | Action | Request |
| --- | --- | --- |
| `GET /v1/command/` |  | [List the commands a key can run](https://heaven.dev/docs/reference/command/view) |

## Feedback

| Endpoint | Action | Request |
| --- | --- | --- |
| `POST /v1/feedback/create` |  | [Send feedback](https://heaven.dev/docs/reference/feedback/send) |
