Skip to content

Set pool defaults

Set the pool's defaults for new Computers. The pool setup script runs before each new Computer's own setup script.

Parameters

#
poolstringRequired
Pool name or ID.
setup_scriptstring
Script content for new Computers in this pool. Runs before each Computer's own setup script. Treated as a secret and never included in errors.
cpustring
Default whole vCPU count for new Computers created without a CPU size.
diskstring
Default disk size for new Computers created without a disk size, such as 20GB. GB is decimal and GiB is binary.
domainstring
Connected organization domain for NAME.DOMAIN addresses on new Computers in this pool. An empty string clears the default.
organizationstring
Organization name or ID. A credential, named resource or sole membership can select the organization for you.

Returns

#
dataobjectAlways present
Defaults for new Computers in this pool.
Show 5 attributesHide attributes
disk_bytesintegerAlways present
Default per-Computer disk size in bytes. Zero uses the pool's allocation.
domainstring
Domain used to name new Computers as NAME.DOMAIN, when set. May be omitted.
poolstringAlways present
Pool whose defaults were changed.
setbooleanAlways present
Whether a pool setup script is now set.
vcpusintegerAlways present
Default per-Computer CPU setting. Zero uses the pool's allocation.

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.