---
title: "Get Resources"
method: GET
path: "/api/resources"
tags: ["Resource API"]
---

# Get Resources

`GET /api/resources`

## Request

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

Returns the information of resources available in different pools.

## Query parameters

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

## Headers

- `x-osmo-allowed-pools` string, nullable

## Response `200`

Successful Response

- union
  - ResourcesResponse: Object storing execution cluster node resource information.
    - `resources` ResourcesEntry[], required
      - `hostname` string, required
      - `exposed_fields` object, required
      - `taints` object[], required
      - `usage_fields` object, required
      - `conditions` string[], nullable
      - `non_workflow_usage_fields` object, required
      - `allocatable_fields` object, required
      - `platform_allocatable_fields` object, nullable
      - `platform_available_fields` object, nullable
      - `platform_workflow_allocatable_fields` object, nullable
      - `config_fields` object, nullable
      - `backend` string, required
      - `label_fields` object, nullable
      - `pool_platform_labels` object, required
      - `resource_type` 'RESERVED' | 'SHARED' | 'UNUSED', required: Resource type for BackendResource.
  - PoolResourcesResponse: Object storing execution cluster node resource information.
    - `pools` PoolResourcesEntry[], required
      - `pool` string, required
      - `platform` string, required
      - `status` 'ONLINE' | 'OFFLINE' | 'MAINTENANCE', required: Represents the types of statuses a pool can have.
      - `usage_fields` object, required
      - `allocatable_fields` object, required
      - `backend` 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`: 8 breaking, 6 info
  - response property `anyOf[subschema #1: ResourcesResponse]/resources/items/conditions` list-of-types was widened by adding types `null` to media type `application/json` of response `200`
  - response property `anyOf[subschema #1: ResourcesResponse]/resources/items/config_fields` list-of-types was widened by adding types `null` to media type `application/json` of response `200`
  - response property `anyOf[subschema #1: ResourcesResponse]/resources/items/label_fields` list-of-types was widened by adding types `null` to media type `application/json` of response `200`
  - response property `anyOf[subschema #1: ResourcesResponse]/resources/items/platform_allocatable_fields` list-of-types was widened by adding types `null` to media type `application/json` of response `200`
  - …10 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/ResourcesResponse, #/components/schemas/PoolResourcesResponse` to the response body `anyOf` list for the response status `200`
- …earlier changes not shown

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