Skip to content

Stop a pool

Stop a pool's Computers and free its CPU and RAM for other pools on the same server. Running processes end and disks are kept. Paid capacity keeps billing.

Parameters

#
poolstringRequired
Pool name or ID.
organizationstring
Organization name or ID. A credential, named resource or sole membership can select the organization for you.

Returns

#
dataobjectAlways present
The pool's saved power setting. Its Computers apply the change asynchronously.
Show 3 attributesHide attributes
alreadyboolean
Whether the pool already had this setting. May be omitted.
poolstringAlways present
Pool whose power was set.
powerstringAlways present
Requested power: running, paused or stopped.

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.