Skip to content

Share a Computer

Share a Computer with specific people, a team or the whole organization. The default role grants website access. Choose root to grant SSH access or admin to also grant management access. Sharing again keeps the broader role.

Parameters

#
computerstring
Computer name or ID.
computersstring[]
Computer names or IDs, supplied instead of computer.
usersstring[]
A person to share the Computer with, by email address or user ID.
teamstring
The team in the Computer's organization to give access to.
whole_organizationboolean
Select everyone in the organization that owns the Computer.
rolestring
Access to grant. web opens the website and is the default. root adds SSH. admin adds management access. Transfer, sharing and support access stay with owners.
commandsstring[]
Additional management command allowed on this Computer. Give an exact command name such as restart.
messagestring
Message for the invitation email to the people being given access. Use up to 500 bytes.

Returns

#
dataobject | object[]Always present
Sharing results for each recipient and Computer.
Show 3 attributesHide attributes
alternative-1object
A saved share and any access retained through other routes.
Show 7 attributesHide attributes
commandsstring[] | nullAlways present
Management commands this share grants in addition to its role.
hintstring
How to reduce access retained through those other routes. May be omitted.
keptobject[]
Access the recipient still has through other routes. May be omitted.
Show 1 attributeHide attributes
itemsobject
Access retained through a route other than the share just changed.
Show 4 attributesHide attributes
commandsstring[]
Additional management commands this route grants. May be omitted.
namestring
Role, team or pool identifying that route. May be omitted.
rolestringAlways present
Access role this route grants.
viastringAlways present
Route granting access, such as ownership, an organization role, team or pool share.
noticestring
Sharing email's state, when a notice applies. May be omitted.
rolestringAlways present
Resulting access role, or none after removal.
sharedstringAlways present
Person, team or organization whose share was changed.
updatedbooleanAlways present
Whether this request changed the share.
alternative-2object[]
A saved share and any access retained through other routes.
Show 1 attributeHide attributes
itemsobject
A saved share and any access retained through other routes.
Show 7 attributesHide attributes
commandsstring[] | nullAlways present
Management commands this share grants in addition to its role.
hintstring
How to reduce access retained through those other routes. May be omitted.
keptobject[]
Access the recipient still has through other routes. May be omitted.
Show 1 attributeHide attributes
itemsobject
Access retained through a route other than the share just changed.
Show 4 attributesHide attributes
commandsstring[]
Additional management commands this route grants. May be omitted.
namestring
Role, team or pool identifying that route. May be omitted.
rolestringAlways present
Access role this route grants.
viastringAlways present
Route granting access, such as ownership, an organization role, team or pool share.
noticestring
Sharing email's state, when a notice applies. May be omitted.
rolestringAlways present
Resulting access role, or none after removal.
sharedstringAlways present
Person, team or organization whose share was changed.
updatedbooleanAlways present
Whether this request changed the share.
alternative-3object
Results for a multi-Computer request. Each target can succeed or fail independently.
Show 2 attributesHide attributes
request_idstringAlways present
Request ID for this multi-Computer change.
resultsobject[] | nullAlways present
Each target's accepted operation, direct result or error, in request order.
Show 1 attributeHide attributes
itemsobject
One Computer's operation, direct result or error.
Show 4 attributesHide attributes
computerobjectAlways present
Target's ID and name.
Show 2 attributesHide attributes
idstringAlways present
Computer ID.
namestringAlways present
Computer's name when this result was prepared.
dataJSON value
Direct command result, with the same meaning as a single-Computer result. May be omitted.
errorobject
Reason this target could not be changed. May be omitted.
Show 7 attributesHide attributes
actionobject
A suggested command addressing the problem. May be omitted.
Show 2 attributesHide attributes
commandstringAlways present
Command's catalog name.
linestringAlways present
Complete suggested command line.
kindstringAlways present
Error category. unknown means the effect is uncertain; reconcile before retrying.
messagestringAlways present
What happened and any action needed from you.
operation_idstring
Operation to read before repeating uncertain work. May be omitted.
request_idstring
Request ID identifying the change during reconciliation. May be omitted.
retry_afterinteger
Seconds before retrying a rate-limited request or a refused wait. May be omitted.
urlstring
Payment page for a payment-required response. May be omitted.
operationobject
Accepted operation for this target, if the command returns one. May be omitted.
Show 9 attributesHide attributes
bystring
Requester's email address, or user ID if no email is recorded. Omitted for your own requests. May be omitted.
completed_atstring (date-time)
When the operation reached its final state. Absent while unfinished. May be omitted.
computer_idstringAlways present
Computer's stable ID.
created_atstring (date-time)
When Heaven accepted the change. May be omitted.
error_codestring
Recorded failure code. May be omitted.
idstringAlways present
Operation ID for operation view.
kindstringAlways present
Change being tracked.
messagestring
An explanation of the recorded failure and any next action. May be omitted.
statestringAlways present
accepted means saved and unfinished. complete means the change finished. failed means it could not finish. superseded means a newer change replaced it before completion. Values: "accepted", "complete", "failed", "superseded".

Errors

#
CodeStatusWhat happened
invalid400An input is missing or invalid.
unauthenticated401The credential is missing, invalid, expired or revoked.
denied403The caller lacks permission for this action.
not_found404The resource is absent or inaccessible to this caller.
conflict409The request conflicts with the current resource state or an earlier request.
over_capacity409The request exceeds a resource or credential allowance.
access_list_full409The change would exceed the access-list allowance.
payment_required402Payment or credit is required.
rate_limited429The caller's request rate exceeds its limit.
busy429Too much work is in progress to accept this request.
unknown503The outcome is unconfirmed; a change may have happened.
unavailable503The service or requested feature is unavailable.

Notes

#
  • CLI: heaven login with HEAVEN_API_KEY unset. MCP: Heaven sign-in. cURL: HEAVEN_SIGN_IN_KEY from approved device sign-in (POST /v1/auth/create).
  • A key limited to a command list cannot run this command.
  • Use computers instead of computer for several targets, each with its own result.
  • People: Grant access to people by email address. Required: users. Optional: computer, computers, role, commands, message.
  • Team: Grant access to a team in the Computer's organization. Required: team. Optional: computer, computers, role, commands, message.
  • Organization: Grant access to every member of the Computer's organization. Required: whole_organization. Optional: computer, computers, role, commands, message.