# Read a pool's usage

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

Read CPU, memory, storage and traffic history for one pool or all accessible pools. Use `range` to choose the history window.

`GET /v1/pool/?view=usage`

## Parameters

- `pool` (string): Pool name or ID. Omit for all accessible pools.
- `range` (string): History period: 24h (default), 7d or 30d.
- `resolution` (string): History interval: 1m, 5m or 1h. Overrides `points`. With neither, 24h uses 5m; 7d and 30d use 1h.
- `points` (string): Target maximum number of points per series, from 1 to 1000. A series includes at least one point per day. MCP defaults to 24 points. An explicit `resolution` overrides this target.
- `organization` (string): Organization name or ID. A credential, named resource or sole membership can select the organization for you.

## Returns

- `data` (object, always present): Usage history for the selected pools, with their allocations and combined totals.
  - `pools` (object[] | null, always present): Each pool's usage history.
    - `items` (object): A pool's usage history and allocation.
      - `busiest` (object[] | null, always present): Up to five Computers ordered by highest average CPU use.
        - `items` (object): One Computer's average CPU use and peak memory use in a pool's busiest list.
          - `computer_id` (string, always present): Computer ID.
          - `cpu_vcpus_avg` (number | null, always present): Average vCPUs in use over the range.
          - `memory_bytes_peak` (number | null, always present): Peak measured memory use in bytes.
          - `name` (string): Its name when available. May be omitted.
      - `computers` (object[]): Computers ordered by egress, with peak memory use. May be omitted.
        - `items` (object): One Computer's outbound traffic and peak memory use over the selected range.
          - `computer_id` (string, always present): Computer ID.
          - `egress_bytes` (integer, always present): Bytes sent directly to the internet.
          - `front_door_bytes` (integer, always present): Bytes sent through Heaven's front doors to visitors.
          - `memory_bytes_peak` (number | null, always present): Peak measured memory use in bytes, or null if unmeasured.
          - `name` (string): Computer's name when available. May be omitted.
      - `id` (string, always present): Pool ID.
      - `memory_bytes` (integer, always present): Pool's RAM allocation in bytes.
      - `organization` (string): Owning organization's name, when applicable. May be omitted.
      - `pool` (string, always present): Pool name.
      - `series` (object[], always present): Time-ordered intervals using the summary's measure names and units. Unmeasured values are omitted.
        - `items` (object): Measurements for one interval. Unmeasured values are omitted.
      - `storage_allowance_bytes` (integer, always present): Pool's included storage in bytes.
      - `summary` (object, always present): Usage over the selected range.
        - `cpu_vcpus_avg` (number | null, always present): Average vCPUs used by the pool's Computers over measured minutes.
        - `cpu_vcpus_peak` (number | null, always present): Average vCPUs used during the busiest measured minute.
        - `cpu_vcpus_peak_at` (string (date-time)): Busiest CPU minute, included in the summary. May be omitted.
        - `disk_used_bytes_peak` (integer | null, always present): Highest combined file use measured during the interval, in bytes, excluding snapshots.
        - `egress_bytes` (integer): Bytes sent directly to the internet. May be omitted.
        - `front_door_bytes` (integer): Bytes sent to visitors through Heaven's front doors. May be omitted.
        - `io_read_bytes` (integer | null, always present): Bytes read from the Computers' disks.
        - `io_write_bytes` (integer | null, always present): Bytes written to the Computers' disks.
        - `memory_bytes_avg` (number | null, always present): Average combined memory use in bytes over measured minutes.
        - `memory_bytes_peak` (number | null, always present): Peak combined memory use during a measured minute, in bytes.
        - `memory_bytes_peak_at` (string (date-time)): Busiest memory minute, included in the summary. May be omitted.
        - `net_rx_bytes` (integer | null, always present): Bytes received by the pool's Computers.
        - `net_tx_bytes` (integer | null, always present): Bytes sent by the pool's Computers.
        - `start` (string (date-time), always present): Interval's start.
        - `storage_bytes` (integer | null, always present): Latest file use on running Computers, in bytes, excluding stale readings and snapshots.
      - `vcpus` (integer, always present): Pool's vCPU allocation.
  - `range` (string, always present): Selected history range.
  - `resolution_seconds` (integer, always present): Duration of each interval in seconds.
  - `totals` (object, always present): Usage summed across the listed pools at matching times.
    - `cpu` (object, always present): Combined CPU use, in vCPUs.
      - `avg` (number | null, always present): Average over measured points.
      - `now` (number): Latest measured value. May be omitted.
      - `peak` (number | null, always present): Highest combined point.
      - `peak_at` (string (date-time) | null, always present): When that peak occurred.
      - `pools_at_peak` (object[] | null, always present): Pool contributions at the combined peak.
        - `items` (object): A pool's contribution to a combined usage peak.
          - `id` (string, always present): Pool ID.
          - `pool` (string, always present): Pool name.
          - `value` (number, always present): Its contribution, in the enclosing measure's units.
      - `total` (number): Sum over the range, used for egress. May be omitted.
    - `egress` (object, always present): Combined direct internet and front-door egress, in bytes.
      - `avg` (number | null, always present): Average over measured points.
      - `now` (number): Latest measured value. May be omitted.
      - `peak` (number | null, always present): Highest combined point.
      - `peak_at` (string (date-time) | null, always present): When that peak occurred.
      - `pools_at_peak` (object[] | null, always present): Pool contributions at the combined peak.
        - `items` (object): A pool's contribution to a combined usage peak.
          - `id` (string, always present): Pool ID.
          - `pool` (string, always present): Pool name.
          - `value` (number, always present): Its contribution, in the enclosing measure's units.
      - `total` (number): Sum over the range, used for egress. May be omitted.
    - `memory` (object, always present): Combined measured memory use, in bytes.
      - `avg` (number | null, always present): Average over measured points.
      - `now` (number): Latest measured value. May be omitted.
      - `peak` (number | null, always present): Highest combined point.
      - `peak_at` (string (date-time) | null, always present): When that peak occurred.
      - `pools_at_peak` (object[] | null, always present): Pool contributions at the combined peak.
        - `items` (object): A pool's contribution to a combined usage peak.
          - `id` (string, always present): Pool ID.
          - `pool` (string, always present): Pool name.
          - `value` (number, always present): Its contribution, in the enclosing measure's units.
      - `total` (number): Sum over the range, used for egress. May be omitted.
    - `memory_bytes` (integer, always present): Their total RAM allocation in bytes.
    - `storage` (object, always present): Combined measured file use on running Computers, in bytes, excluding snapshots.
      - `avg` (number | null, always present): Average over measured points.
      - `now` (number): Latest measured value. May be omitted.
      - `peak` (number | null, always present): Highest combined point.
      - `peak_at` (string (date-time) | null, always present): When that peak occurred.
      - `pools_at_peak` (object[] | null, always present): Pool contributions at the combined peak.
        - `items` (object): A pool's contribution to a combined usage peak.
          - `id` (string, always present): Pool ID.
          - `pool` (string, always present): Pool name.
          - `value` (number, always present): Its contribution, in the enclosing measure's units.
      - `total` (number): Sum over the range, used for egress. May be omitted.
    - `storage_allowance_bytes` (integer, always present): Their total included storage in bytes.
    - `vcpus` (integer, always present): Listed pools' total vCPU 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. |
| `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

- API key permission: `pool usage`.

## Examples

```sh tab="heaven CLI"
heaven pool usage [POOL]
  [--range 24h|7d|30d]
  [--resolution 1m|5m|1h]
  [--points N]
  [--organization ORGANIZATION]
```

```sh tab="SSH"
ssh cli@heaven.dev pool usage [POOL]
  [--range 24h|7d|30d]
  [--resolution 1m|5m|1h]
  [--points N]
  [--organization ORGANIZATION]
```

```sh tab="cURL"
curl "https://heaven.dev/v1/pool/?view=usage" \
  -H "Authorization: Bearer $HEAVEN_API_KEY"
```

```json tab="MCP"
{ "tool": "pool_usage",
  "arguments": {  } }
```

Response:

```json title="Response excerpt"
{
  "version": 1,
  "data": {
    "pools": [
      {
        "busiest": [],
        "id": "pool-ea9c049e62e0c27f",
        "memory_bytes": 8589934592,
        "organization": "acme",
        "pool": "web",
        "series": [
          {},
          {},
          {}
        ],
        "storage_allowance_bytes": 100000000000,
        "summary": {
          "cpu_vcpus_avg": null,
          "cpu_vcpus_peak": null,
          "disk_used_bytes_peak": null,
          "io_read_bytes": null,
          "io_write_bytes": null,
          "memory_bytes_avg": null,
          "memory_bytes_peak": null,
          "net_rx_bytes": null,
          "net_tx_bytes": null,
          "start": "2026-11-16T11:00:00Z",
          "storage_bytes": null
        },
        "vcpus": 2
      }
    ],
    "range": "24h",
    "resolution_seconds": 300,
    "totals": {
      "cpu": {
        "avg": null,
        "peak": null,
        "peak_at": null,
        "pools_at_peak": []
      },
      "egress": {
        "avg": null,
        "peak": null,
        "peak_at": null,
        "pools_at_peak": []
      },
      "memory": {
        "avg": null,
        "peak": null,
        "peak_at": null,
        "pools_at_peak": []
      },
      "memory_bytes": 8589934592,
      "storage": {
        "avg": null,
        "peak": null,
        "peak_at": null,
        "pools_at_peak": []
      },
      "storage_allowance_bytes": 100000000000,
      "vcpus": 2
    }
  }
}
```
