---
title: "Read Pool"
method: GET
path: "/api/configs/pool/{name}"
tags: ["Config API"]
---

# Read Pool

`GET /api/configs/pool/{name}`

## Request

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

Read Pool configuration

Return type Any to prevent unwanted artifacts between Pool and PoolEditable outputs
Should return Pool or PoolEditable objects

## Path parameters

- `name` string, required

## Query parameters

- `verbose` boolean

## Response `200`

Successful Response

- union
  - PoolOutput: Single Pool Entry
    - `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
    - `common_default_variables` object
    - `common_resource_validations` string[]
    - `parsed_resource_validations` ResourceAssertion[]
      - `operator` 'GT' | 'GE' | 'LT' | 'LE' | 'EQ', required
      - `left_operand` string, required
      - `right_operand` string, required
      - `assert_message` string, required
    - `common_pod_template` string[]
    - `parsed_pod_template` object
    - `parsed_pod_template_for_accounting` object
    - `common_group_templates` string[]
    - `parsed_group_templates` object[]
    - `platforms` object
    - `last_heartbeat` string, date-time, nullable
  - PoolEditable
    - `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
    - `common_default_variables` object
    - `common_resource_validations` string[]
    - `common_pod_template` string[]
    - `common_group_templates` string[]
    - `platforms` object

## 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-05-11** `4a5778cf4e28`: 2 info
  - added the optional property `anyOf[subschema #1: Pool]/parsed_pod_template_for_accounting` to the response with the `200` status
  - added the optional property `anyOf[subschema #1: Pool]/platforms/additionalProperties/parsed_pod_template_for_accounting` to the response with the `200` status
- **2026-04-08** `a8157dc3279d`: 3 breaking, 10 info
  - response property `anyOf[subschema #2: PoolEditable]/default_platform` list-of-types was widened by adding types `null` to media type `application/json` of response `200`
  - the `anyOf[subschema #2: PoolEditable]/download_type` response's property type changed from `string` to no type for status `200`
  - the `anyOf[subschema #2: PoolEditable]/resources` response's property type changed from no type to `object` for status `200`
  - added `#/components/schemas/Pool-Output` to the response body `anyOf` list for the response status `200`
  - …9 more
- **2026-03-31** `639e39b0d1eb`: 1 breaking, 1 info
  - the response's body type changed from `string` to no type for status `200`
  - added `#/components/schemas/Pool, #/components/schemas/PoolEditable` to the response body `anyOf` list for the response status `200`

[Operation history](https://skmtc.dev/nvidia/apis/nvidia-corporation-osmo-api/changes/api/configs/pool/:name/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)