---
title: "Get account usage"
description: "Returns the account's effective limits and defaults next to what it uses now: the computer quota with the computers using it, per-computer resource allocation, sampled memory and storage usage, sites…"
canonical: "https://www.cool.computer/docs/api-reference/computers/get-account-usage"
---
# Get account usage

> Returns the account's effective limits and defaults next to what it uses now: the computer quota with the computers using it, per-computer resource allocation, sampled memory and storage usage, sites…

```http
GET https://api.cool.computer/api/usage
```

Returns the account's effective limits and defaults next to what it uses now: the computer quota with the computers using it, per-computer resource allocation, sampled memory and storage usage, sites created in the last 24 hours against the daily limit, transfer limits, and network policy limits. Call this before creating a computer or stating account-specific limits.

## Authorization

- A Cool Computers API key, user access token, or claimed agent access token in the Authorization header. Follow https://www.cool.computer/auth.md for agent registration and https://www.cool.computer/authentication.md for direct user credentials.

## Responses

- `200`: Effective account limits and usage.
  - `application/json` (object)
    - `default_visibility` (string, required)
    - `resources` (object, required)
      - `allocation` (object, required)
        - `available` (boolean, required)
        - `vcpu` (integer)
        - `guest_memory_ceiling_mib` (integer)
        - `rootfs_bytes` (integer, int64)
        - `pid_limit` (integer, int64)
        - `open_files_limit` (integer, int64)
      - `usage` (object, required)
        - `available` (boolean, required)
        - `sampled_at` (string, date-time)
        - `unavailable_reason` (string)
        - `memory` (object, required)
          - `available` (boolean, required)
          - `unavailable_reason` (string)
          - `sampled_at` (string, date-time)
          - `sample_age_ms` (integer, int64)
          - `account_limit_mib` (integer, required): Memory all of the account's computers may hold together, idle ones included. The host holds them to it: a computer that needs more than the room left has a process stopped by its own kernel, and a new computer is refused with account_memory_full.
          - `account_used_mib` (integer, required): Memory the account's computers hold now, counted as account_limit_mib counts it: without page cache the host can drop at once.
          - `active_vms` (integer, required)
          - `sampled_vms` (integer, required)
        - `storage` (object, required)
          - `available` (boolean, required)
          - `unavailable_reason` (string)
          - `account_used_bytes` (integer, int64, required)
          - `account_limit_bytes` (integer, int64, required)
          - `account_available_bytes` (integer, int64, required)
        - `computers` (array of object, required)
          - `id` (string, required)
          - `name` (string, required)
          - `status` (string, required)
          - `sample_available` (boolean, required)
          - `allocated_vcpu` (integer)
          - `cgroup_sample_available` (boolean, required)
          - `cgroup_current_mib` (integer)
          - `cgroup_current_bytes` (integer, int64)
          - `firecracker_rss_available` (boolean, required)
          - `firecracker_rss_bytes` (integer, int64)
          - `firecracker_cpu_available` (boolean, required)
          - `firecracker_cpu_seconds` (number)
          - `cpu_counter_epoch` (string)
          - `balloon` (object)
            - `target_mib` (integer, required)
            - `actual_mib` (integer, required)
            - `swap_in` (integer, int64)
            - `swap_out` (integer, int64)
            - `major_faults` (integer, int64)
            - `minor_faults` (integer, int64)
            - `free_memory` (integer, int64)
            - `total_memory` (integer, int64)
            - `available_memory` (integer, int64)
            - `disk_caches` (integer, int64)
            - `hugetlb_allocations` (integer, int64)
            - `hugetlb_failures` (integer, int64)
          - `network_sample_available` (boolean, required)
          - `network_counter_epoch` (string)
          - `guest_ingress_bytes_total` (integer, int64)
          - `guest_egress_bytes_total` (integer, int64)
          - `disk_sample_available` (boolean, required)
          - `disk_referenced_bytes` (integer, int64)
          - `disk_available_bytes` (integer, int64)
    - `computer_quota` (object, required): Computers with a VM that count against the account's computer limit, with the computers using each slot.
      - `limit` (integer, required)
      - `used` (integer, required)
      - `rule` (string, required)
      - `computers` (array of object, required)
        - `id` (string, required)
        - `name` (string, required)
        - `status` (string, required)
    - `site_creations` (object, required): Sites the account created or claimed in the last 24 hours, including ones since deleted, against the most it may in that window; a site that gains a VM stops counting.
      - `limit` (integer, required)
      - `used` (integer, required)
      - `window_hours` (integer, required)
    - `transfers` (object, required): Byte and entry limits for file transfers and streamed exec stdin.
      - `single_file_bytes` (integer, int64, required)
      - `archive_payload_bytes` (integer, int64, required)
      - `archive_entries` (integer, required)
      - `upload_request_bytes` (integer, int64, required)
      - `exec_stream_stdin_bytes` (integer, required)
    - `network` (object, required): Outbound network policy limits and the protocols each exposure mode accepts.
      - `allowed_host_limit` (integer, required)
      - `protocols` (array of string, required)
      - `connect_ports` (array of integer, required)
      - `direct_public_protocols_by_mode` (object, required)
        - `open` (array of string, required)
        - `allowlist` (array of string, required)
        - `none` (array of string, required)
- `401`: Unauthorized.
- `429`: Too Many Requests. If the problem code is api_request_rate_exceeded, wait for Retry-After seconds; other problem codes describe a separate limit.
- `500`: Internal Server Error.
- `default`: A machine-readable API error with a stable code and recovery instruction.

An error is an `application/problem+json` document with a stable `code`; [API errors](/docs/api-reference/errors) says how to handle one.

## Example

```sh
curl "https://api.cool.computer/api/usage" \
  -H "authorization: Bearer $TOKEN"
```
