---
title: "List options values for a pod template workspace kind"
method: POST
path: "/workspacekinds/{name}/podtemplate/options/listvalues"
tags: ["workspacekinds"]
---

# List options values for a pod template workspace kind

`POST /workspacekinds/{name}/podtemplate/options/listvalues`

## Request

- Base URL: `http://localhost:4000/api/v1`
- URL: `http://localhost:4000/api/v1/workspacekinds/{name}/podtemplate/options/listvalues`
- Auth: none declared

Returns filtered imageConfig and podConfig options based on the provided context.

## Path parameters

- `name` string, required

## Request body

- ApiPodTemplateOptionsListValuesRequestEnvelope
  - `data` OptionsListValuesRequest, required
    - `context` OptionsListValuesContext, required
      - `imageConfig` OptionsContextImageConfig
        - `id` string, required
      - `namespace` OptionsContextNamespace
        - `name` string, required
      - `podConfig` OptionsContextPodConfig
        - `id` string, required

## Response `200`

Successful operation. Returns filtered options with ruleEffects.

- ApiPodTemplateOptionsEnvelope
  - `data` OptionsPodTemplateOptions, required
    - `imageConfig` OptionsImageConfig, required
      - `default` string, required
      - `values` OptionsImageConfigValue[]
        - `clusterMetrics` OptionsClusterOptionMetrics
          - `workspacesCount` integer, required
        - `description` string, required
        - `displayName` string, required
        - `hidden` boolean, required
        - `id` string, required
        - `labels` OptionsOptionLabel[]
          - `key` string, required
          - `value` string, required
        - `redirect` OptionsOptionRedirect
          - `message` OptionsRedirectMessage
            - `level` 'Info' | 'Warning' | 'Danger', required
            - `text` string, required
          - `to` string, required
        - `restrictions` CommonRestrictions, required
          - `deny` boolean, required
          - `denyMessage` CommonDenyMessage
            - `text` string, required
    - `podConfig` OptionsPodConfig, required
      - `default` string, required
      - `values` OptionsPodConfigValue[]
        - `clusterMetrics` OptionsClusterOptionMetrics
          - `workspacesCount` integer, required
        - `description` string, required
        - `displayName` string, required
        - `hidden` boolean, required
        - `id` string, required
        - `labels` OptionsOptionLabel[]
          - `key` string, required
          - `value` string, required
        - `redirect` OptionsOptionRedirect
          - `message` OptionsRedirectMessage
            - `level` 'Info' | 'Warning' | 'Danger', required
            - `text` string, required
          - `to` string, required
        - `restrictions` CommonRestrictions, required
          - `deny` boolean, required
          - `denyMessage` CommonDenyMessage
            - `text` string, required

## Other responses

- `400`: Bad Request. Invalid workspace kind name or request body.
- `401`: Unauthorized. Authentication is required.
- `403`: Forbidden. User does not have permission to access the workspace kind.
- `404`: Not Found. Workspace kind does not exist.
- `413`: Request Entity Too Large. The request body is too large.
- `415`: Unsupported Media Type. Content-Type header is not correct.
- `422`: Unprocessable Entity. Validation error.
- `500`: Internal server error. An unexpected error occurred on the server.

## Changes

- **2026-06-24** `257ea068094f`: 1 info
  - endpoint added
- **2026-01-30** `e4dc5b696346`: 1 breaking
  - api path removed without deprecation

[Operation history](https://skmtc.dev/opendatahub-io/apis/kubeflow-notebooks-api/changes/workspacekinds/:name/podtemplate/options/listvalues/post.md)

---

[API](https://skmtc.dev/opendatahub-io/apis/kubeflow-notebooks-api.md) - [All operations](https://skmtc.dev/opendatahub-io/apis/kubeflow-notebooks-api/llms.txt) - [OpenAPI document](https://skmtc.dev/opendatahub-io/apis/kubeflow-notebooks-api/revisions/f336b3b779f0?raw)