# Clear pool defaults

URL: https://heaven.dev/docs/reference/pools/defaults-clear
Updated: 2026-11-21

Clear named defaults for Computers created in a pool. Omit the names to clear all pool defaults.

`POST /v1/pool/modify`

## Parameters

- `pool` (string, required): Pool name or ID.
- `default` (string[]): Pool default to clear. Choose setup-script, cpu, disk or domain. Omit to clear all pool defaults.
- `organization` (string): Organization name or ID. A credential, named resource or sole membership can select the organization for you.

## Returns

- `data` (object, always present): Defaults for new Computers in this pool.
  - `disk_bytes` (integer, always present): Default per-Computer disk size in bytes. Zero uses the pool's allocation.
  - `domain` (string): Domain used to name new Computers as `NAME.DOMAIN`, when set. May be omitted.
  - `pool` (string, always present): Pool whose defaults were changed.
  - `set` (boolean, always present): Whether a pool setup script is now set.
  - `vcpus` (integer, always present): Default per-Computer CPU setting. Zero uses the pool's allocation.

## Errors

Each code is explained in full at https://heaven.dev/docs/reference/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 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.

## Examples

```sh tab="heaven CLI"
heaven pool defaults clear POOL [DEFAULT...]
  [--organization ORGANIZATION]
```

```sh tab="SSH"
ssh cli@heaven.dev pool defaults clear POOL [DEFAULT...]
  [--organization ORGANIZATION]
```

```sh tab="cURL"
curl https://heaven.dev/v1/pool/modify \
  -H "Authorization: Bearer $HEAVEN_SIGN_IN_KEY" \
  --json '{"action": "defaults clear", "pool": "web"}'
```

```json tab="MCP"
{ "tool": "pool_defaults_clear",
  "arguments": { "pool": "web" } }
```

Response:

```json title="Response excerpt"
{
  "version": 1,
  "data": {
    "disk_bytes": 0,
    "pool": "web",
    "set": false,
    "vcpus": 0
  }
}
```
