Parameters
#poolstringRequired
Pool name or ID.
defaultstring[]
Pool default to clear. Choose setup-script, cpu, disk or domain. Omit to clear all pool defaults.
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
#| Code | Status | What happened |
|---|---|---|
| invalid | 400 | An input is missing or invalid. |
| unauthenticated | 401 | The credential is missing, invalid, expired or revoked. |
| denied | 403 | The caller lacks permission for this action. |
| not_found | 404 | The resource is absent or inaccessible to this caller. |
| conflict | 409 | The request conflicts with the current resource state or an earlier request. |
| over_capacity | 409 | The request exceeds a resource or credential allowance. |
| access_list_full | 409 | The change would exceed the access-list allowance. |
| payment_required | 402 | Payment or credit is required. |
| rate_limited | 429 | The caller's request rate exceeds its limit. |
| busy | 429 | Too much work is in progress to accept this request. |
| unknown | 503 | The outcome is unconfirmed; a change may have happened. |
| unavailable | 503 | The service or requested feature is unavailable. |
Notes
#- CLI:
heaven loginwithHEAVEN_API_KEYunset. MCP: Heaven sign-in. cURL:HEAVEN_SIGN_IN_KEYfrom approved device sign-in (POST /v1/auth/create). - A key limited to a command list cannot run this command.