---
title: "Get Pool Quotas"
method: GET
path: "/api/pool_quota"
tags: ["Pool API"]
---

# Get Pool Quotas

`GET /api/pool_quota`

## Request

- The document declares no server URL.
- Auth: none declared

## Query parameters

- `all_pools` boolean
- `pools` string[], nullable

## Response `200`

Successful Response

- PoolResponse: Object storing pool information.
  - `node_sets` PoolNodeSetResourceUsage[], required
    - `pools` PoolResourceUsage[], required
      - `name` string
      - `description` string
      - `status` 'ONLINE' | 'OFFLINE' | 'MAINTENANCE': Represents the types of statuses a pool can have.
      - `download_type` 'download': Type of Config to fetch or set
      - `enable_maintenance` boolean
      - `backend` string, required
      - `default_platform` string, nullable
      - `default_exec_timeout` string
      - `default_queue_timeout` string
      - `max_exec_timeout` string
      - `max_queue_timeout` string
      - `default_exit_actions` object
      - `resources` PoolResources: Resources allocated to the pool, for schedulers that support this feature
        - `gpu` PoolResourceCountable: Resources like GPU or CPU that have a discrete number. For guarantee and maximum, a value of -1 indicates that there is no limit.
          - `guarantee` integer
          - `maximum` integer
          - `weight` integer
      - `topology_keys` TopologyKey[]
        - `key` string, required
        - `label` string, required
      - `platforms` object
      - `resource_usage` ResourceUsage, required: Object storing resource usage information.
        - `quota_used` string, required
        - `quota_free` string, required
        - `quota_limit` string, required
        - `total_usage` string, required
        - `total_capacity` string, required
        - `total_free` string, required
  - `resource_sum` ResourceUsage, required: Object storing resource usage information.
    - `quota_used` string, required
    - `quota_free` string, required
    - `quota_limit` string, required
    - `total_usage` string, required
    - `total_capacity` string, required
    - `total_free` string, required

## Other responses

- `422`: Validation Error

## Changes

- **2026-08-03** `b9d312a13f5d`: 2 info
  - added the optional property `detail/items/ctx` to the response with the `422` status
  - added the optional property `detail/items/input` to the response with the `422` status
- **2026-04-08** `a8157dc3279d`: 3 breaking, 10 info
  - response property `node_sets/items/pools/items/default_platform` list-of-types was widened by adding types `null` to media type `application/json` of response `200`
  - the `node_sets/items/pools/items/download_type` response's property type changed from `string` to no type for status `200`
  - the `node_sets/items/pools/items/resources` response's property type changed from no type to `object` for status `200`
  - `query` request parameter `pools` list-of-types was widened by adding types `null`
  - …9 more
- **2026-03-31** `639e39b0d1eb`: 1 breaking, 2 info
  - the response's body type changed from `string` to `object` for status `200`
  - added the required property `node_sets` to the response with the `200` status
  - added the required property `resource_sum` to the response with the `200` status

[Operation history](https://skmtc.dev/nvidia/apis/nvidia-corporation-osmo-api/changes/api/pool_quota/get.md)

---

[API](https://skmtc.dev/nvidia/apis/nvidia-corporation-osmo-api.md) - [All operations](https://skmtc.dev/nvidia/apis/nvidia-corporation-osmo-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nvidia/apis/nvidia-corporation-osmo-api/revisions/845585a71dbb?raw)