Skip to content

All endpoints

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 for authentication or the OpenAPI document for machine-readable definitions.

Computers

#
EndpointActionRequest
GET /v1/computer/List or read Computers
GET /v1/computer/?view=usageRead a Computer's usage
GET /v1/computer/?view=logsRead the boot console
POST /v1/computer/createCreate a Computer
POST /v1/computer/deleteDelete Computers
POST /v1/computer/modifystartStart a Computer
POST /v1/computer/modifystopStop a Computer
POST /v1/computer/modifyrestartRestart a Computer
POST /v1/computer/modifypausePause a Computer
POST /v1/computer/modifyresumeResume a Computer
POST /v1/computer/modifyresetReinstall a Computer
POST /v1/computer/modifyrenameRename a Computer
POST /v1/computer/modifymoveMove a Computer
POST /v1/computer/modifyresizeResize a Computer
POST /v1/computer/modifytagTag a Computer
GET /v1/computer/?view=tagList tags
POST /v1/computer/modifycommentComment on a Computer
GET /v1/computer/?view=terminalOpen the browser terminal
GET /v1/computer/?view=desktopOpen the desktop
GET /v1/computer/?view=accessRead who has access
POST /v1/computer/modifyshare addShare a Computer
POST /v1/computer/modifyshare removeStop sharing a Computer
POST /v1/computer/modifyshare link addCreate a share link
POST /v1/computer/modifyshare link removeRemove a share link
POST /v1/computer/modifytransferTransfer a Computer
POST /v1/computer/modifygrant-support-rootGive support root access
POST /v1/computer/modifywebsiteSet who reaches the website
GET /v1/computer/?view=portList public ports
POST /v1/computer/modifyport addPublish a port
POST /v1/computer/modifyport removeClose a port
GET /v1/computer/?view=mailRead mail settings
POST /v1/computer/modifymailChange mail settings
GET /v1/computer/?view=mail+statusRead a message's delivery

Snapshots

#
EndpointActionRequest
GET /v1/computer/snapshot/List or read snapshots
POST /v1/computer/snapshot/createSnapshot a Computer
POST /v1/computer/snapshot/modifyeditChange a snapshot
POST /v1/computer/snapshot/modifyrestoreRestore a snapshot
POST /v1/computer/snapshot/deleteDelete snapshots

Run and export

#
EndpointActionRequest
POST /v1/computer/execRun a command
GET /v1/computer/exportExport a disk

Templates

#
EndpointActionRequest
GET /v1/template/List templates

Pools

#
EndpointActionRequest
GET /v1/pool/List or read pools
GET /v1/pool/?view=usageRead a pool's usage
POST /v1/pool/createCreate a pool
POST /v1/pool/deleteDelete a pool
POST /v1/pool/modifystartStart a pool
POST /v1/pool/modifystopStop a pool
POST /v1/pool/modifypausePause a pool
POST /v1/pool/modifyresumeResume a pool
POST /v1/pool/modifystop-lastKeep a pool running longest
POST /v1/pool/modifyresizeResize a pool
POST /v1/pool/modifyrenameRename a pool
POST /v1/pool/modifysplitSplit a pool
POST /v1/pool/modifycombineCombine pools
POST /v1/pool/modifytransferTransfer a pool
POST /v1/pool/modifydefaults setSet pool defaults
POST /v1/pool/modifydefaults clearClear pool defaults
POST /v1/pool/modifyshare addShare a pool
POST /v1/pool/modifyshare removeStop sharing a pool

Pool snapshots

#
EndpointActionRequest
GET /v1/pool/snapshot/List or read pool snapshots
POST /v1/pool/snapshot/createSnapshot a pool
POST /v1/pool/snapshot/modifyeditChange a pool snapshot
POST /v1/pool/snapshot/modifyrestoreRestore a pool snapshot
POST /v1/pool/snapshot/deleteDelete a pool snapshot
POST /v1/pool/snapshot/modifyshare addShare a pool snapshot
POST /v1/pool/snapshot/modifyshare removeStop sharing a pool snapshot

Capacity

#
EndpointActionRequest
GET /v1/organization/capacity/Read your capacity
GET /v1/plan/List plans
POST /v1/organization/capacity/createBuy capacity
POST /v1/organization/capacity/modifyresizeChange a purchase's plan
POST /v1/organization/capacity/modifyswitchSwitch monthly or hourly
POST /v1/organization/capacity/modifycancel-changeCancel a scheduled change
POST /v1/organization/capacity/deleteRelease capacity

Domains

#
EndpointActionRequest
GET /v1/organization/domain/List domains and names
POST /v1/organization/domain/createConnect a domain
POST /v1/organization/domain/modifyeditChange who adds names
POST /v1/organization/domain/modifyaddressChoose the organization's address
POST /v1/organization/domain/deleteDisconnect a domain
POST /v1/organization/domain/modifyaddAdd a name to a Computer
GET /v1/organization/domain/?view=checkCheck a name's DNS
POST /v1/organization/domain/modifyremoveRemove a name

Static addresses

#
EndpointActionRequest
GET /v1/organization/ip/List static addresses
POST /v1/organization/ip/createBuy static addresses
POST /v1/organization/ip/modifyattachAttach static addresses
POST /v1/organization/ip/modifydetachDetach static addresses
POST /v1/organization/ip/deleteRelease static addresses

Organizations

#
EndpointActionRequest
GET /v1/organization/List or read organizations
GET /v1/organization/?view=usageRead an organization's usage
GET /v1/organization/?view=auditRead the audit log
POST /v1/organization/createCreate an organization
POST /v1/organization/deleteClose an organization
POST /v1/organization/modifyrenameRename an organization
POST /v1/organization/modifysettingChange an organization's setting
GET /v1/organization/?view=memberList members
POST /v1/organization/modifymember addInvite a member
POST /v1/organization/modifymember roleChange a member's access
POST /v1/organization/modifymember removeRemove a member
POST /v1/organization/modifyleaveLeave an organization
GET /v1/organization/?view=invitationList sent invitations
POST /v1/organization/modifyinvitation cancelCancel an invitation
POST /v1/organization/modifylink addGet a join link
GET /v1/organization/?view=linkList join links
POST /v1/organization/modifylink removeRemove a join link

Teams

#
EndpointActionRequest
GET /v1/organization/team/List or read teams
POST /v1/organization/team/createCreate a team
POST /v1/organization/team/modifyrenameRename a team
POST /v1/organization/team/modifysettingChange a team's setting
POST /v1/organization/team/modifymember addAdd a team member
POST /v1/organization/team/modifymember roleChange a team member's role
POST /v1/organization/team/modifymember removeRemove a team member
POST /v1/organization/team/modifyleaveLeave a team
POST /v1/organization/team/deleteDelete a team

Billing

#
EndpointActionRequest
GET /v1/organization/billing/Read billing
GET /v1/organization/billing/?view=costRead this month's cost
GET /v1/organization/billing/?view=historyList charges
POST /v1/organization/billing/modifytop-upTop up the wallet
POST /v1/organization/billing/modifychargeCharge your saved card
POST /v1/organization/billing/modifyauto-top-upSet automatic top-up
POST /v1/organization/billing/modifyrefundRefund the wallet
POST /v1/organization/billing/modifyredeemRedeem an offer
GET /v1/organization/billing/?view=invoicesList invoices
POST /v1/organization/billing/modifypayPay an invoice
GET /v1/organization/billing/?view=detailsRead invoice details
POST /v1/organization/billing/modifydetails setSet invoice details
POST /v1/organization/billing/modifycard setupStart saving a card
POST /v1/organization/billing/modifycard saveSave a card
POST /v1/organization/billing/modifyportalOpen the billing portal
POST /v1/organization/billing/modifyegress-capSet the egress cap
POST /v1/organization/billing/modifyspend-alertSet the spend alert
POST /v1/organization/billing/modifyspending-capSet the spending cap
POST /v1/organization/billing/modifyusage-emailsTurn usage notices on or off
GET /v1/organization/billing/?view=contactList billing contacts
POST /v1/organization/billing/modifycontact addAdd a billing contact
POST /v1/organization/billing/modifycontact removeRemove a billing contact

Integrations

#
EndpointActionRequest
GET /v1/organization/integration/List integrations
POST /v1/organization/integration/createCreate an integration
POST /v1/organization/integration/modifyeditChange an integration
POST /v1/organization/integration/modifyattachAttach an integration
POST /v1/organization/integration/modifydetachDetach an integration
POST /v1/organization/integration/modifyrenameRename an integration
POST /v1/organization/integration/modifypausePause an integration
POST /v1/organization/integration/modifyresumeResume an integration
POST /v1/organization/integration/deleteDelete an integration
GET /v1/organization/integration/?view=repoList a GitHub integration's repositories

Account

#
EndpointActionRequest
GET /v1/account/Read your account
POST /v1/account/modifyemailChange your email address
POST /v1/account/modifynameSet your name
POST /v1/account/deleteDelete your account
GET /v1/account/?view=notificationList notifications
POST /v1/account/modifynotification readMark notifications read
GET /v1/account/?view=defaultsRead your default setup script
POST /v1/account/modifydefaults setSet your default setup script
POST /v1/account/modifydefaults clearClear your default setup script
GET /v1/account/?view=sign-inRead your sign-ins
POST /v1/account/modifysign-in lifetimeSet your sign-in lifetime
POST /v1/account/modifysign-in end-allSign out everywhere
GET /v1/account/?view=mcp-requestRead an MCP sign-in request
GET /v1/account/?view=invitationList your invitations
POST /v1/account/modifyinvitation acceptAccept an invitation
POST /v1/account/modifyinvitation declineDecline an invitation

SSH keys

#
EndpointActionRequest
GET /v1/account/ssh-key/List SSH keys
POST /v1/account/ssh-key/createAdd an SSH key
POST /v1/account/ssh-key/modifyrenameRename an SSH key
POST /v1/account/ssh-key/deleteRemove an SSH key

API keys

#
EndpointActionRequest
GET /v1/account/api-key/List API keys
POST /v1/account/api-key/createCreate an API key
POST /v1/account/api-key/modifyeditChange an API key
POST /v1/account/api-key/modifyrotateRotate an API key
POST /v1/account/api-key/deleteRemove an API key

Connect codes

#
EndpointActionRequest
POST /v1/account/connect-code/createCreate a connect code
GET /v1/account/connect-code/List agents waiting for approval
POST /v1/account/connect-code/modifyapproveApprove an agent
POST /v1/account/connect-code/modifydenyDeny an agent

Operations

#
EndpointActionRequest
GET /v1/operation/Read an operation

Key permissions

#
EndpointActionRequest
GET /v1/command/List the commands a key can run

Feedback

#
EndpointActionRequest
POST /v1/feedback/createSend feedback