Skip to content

Share a pool

Grant access to create Computers in a pool. Computers made by external recipients belong to the pool's account. For existing organization members, a share scopes access to the pool and can allow specific pool power commands. New recipients receive an email invitation.

Parameters

#
poolstringRequired
Pool name or ID.
usersstring[]
Email address or user ID of the person to give pool access to.
with_organizationstring
Organization name to share the pool with.
teamstring
Recipient team: TEAM within your organization, ORGANIZATION@TEAM for another organization.
rolestring
Access for external recipients to Computers they create. Choose web for website access, root for SSH and website access, or admin to also manage the Computer. Defaults to root.
commandsstring[]
Additional command granted to a recipient. For external recipients, it applies to Computers they create. For members, the pool commands available to grant are pool start, pool stop, pool pause and pool resume.
organizationstring
Organization name or ID. A credential, named resource or sole membership can select the organization for you.

Returns

#
dataobjectAlways present
A saved pool share.
Show 5 attributesHide attributes
commandsstring[] | nullAlways present
Additional commands granted by the resulting share.
notestring
Ownership and access consequences for Computers created through this share. May be omitted.
notifiedintegerAlways present
Number of people notified by email.
rolestringAlways present
Resulting role, or none after removal.
updatedbooleanAlways present
Whether this request changed the share.

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.
  • People: Share the pool with the named people. Required: users. Optional: role, commands, organization.
  • Organization: Share the pool with members of another organization. Required: with_organization. Optional: role, commands, organization.
  • Team: Share the pool with a team. Required: team. Optional: role, commands, organization.