---
title: "List NodePools"
method: GET
path: "/ske/v2alpha1/thr1-free/workspaces/{workspaceUUID}/sotoonnodepools"
tags: ["Sotoon Kubernetes Engine"]
---

# List NodePools

`GET /ske/v2alpha1/thr1-free/workspaces/{workspaceUUID}/sotoonnodepools`

## Request

- Base URL: `https://api.sotoon.ir` (the document declares no server; this is the origin it was published from)
- URL: `https://api.sotoon.ir/ske/v2alpha1/thr1-free/workspaces/{workspaceUUID}/sotoonnodepools`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/sotoon/apis/sotoon-api/docs/ske/v2alpha1/thr1-free/workspaces/:workspaceUUID/sotoonnodepools/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves a list of all Kubernetes NodePools in the specified workspace.
NodePools are scalable groups of worker nodes with intelligent deletion policies.

## Path parameters

- `workspaceUUID` string, required

## Response `200`

Successfully retrieved the list of NodePools. The response includes
configuration and status information for each nodepool.

- ContainerSotoonNodepoolList
  - `apiVersion` string, required: Version identifier of the API schema
  - `items` ContainerSotoonNodepool[], required: Collection of SotoonNodepool resources
    - `apiVersion` 'ske.sotoon.ir/v1alpha1', required: Version identifier of the API schema
    - `kind` 'SotoonNodepool', required: The string value 'SotoonNodepool' that identifies the schema
    - `metadata` ContainerObjectMeta, required: Standard resource metadata fields
      - `annotations` object, required: Annotations store additional metadata about the resource
      - `creationTimestamp` string, date-time, required
      - `deletionTimestamp` string, date-time, required
      - `labels` object, required: Labels are key-value pairs attached to resources for organization and categorization
      - `name` string, required: User-provided name that uniquely identifies the resource within its workspace
      - `resourceVersion` string: Internal version for optimistic concurrency control
      - `uid` string, required: System-generated unique identifier for the resource
      - `workspace` string, required: Unique identifier of the workspace where the resource belongs
    - `spec` ContainerSotoonNodepoolSpec, required: Desired configuration for the nodepool
      - `allowedUnsafeSysctls` string[]: List of allowed unsafe sysctls
      - `clusterName` string, required: Name of the cluster this nodepool belongs to
      - `cri` ContainerNodeCRIConfig, nullable: Container runtime configuration
        - `runtime` 'containerd' | 'docker', required: Container runtime to use
      - `labels` object: Labels to apply to worker nodes
      - `replicas` integer, required: Number of worker nodes desired in the nodepool
      - `template` ContainerSotoonMachineTemplate, required: Template configuration for worker nodes
        - `iamEnabled` boolean, required: Enable IAM integration for nodes
        - `instanceType` string, required: Instance type for worker nodes in Engine
      - `version` ContainerSKEVersion, required: Control-plane version configuration
        - `kubernetesVersion` string, required: Kubernetes version
        - `patchVersion` string, required: SKE patch version
    - `status` ContainerSotoonNodepoolStatus, required: Current observed state of the nodepool
      - `availableReplicas` integer, required: Number of replicas available for scheduling
      - `conditions` V1Condition[]: Current conditions of the nodepool
        - `lastTransitionTime` string, date-time, required
        - `message` string, required
        - `observedGeneration` integer
        - `reason` string, required
        - `status` string, required
        - `type` string, required
      - `phase` 'ScalingUp' | 'ScalingDown' | 'Running' | 'Failed' | 'Provisioning' | 'Unknown', required: Current phase of scaling operation
      - `ready` boolean, required: Indicates if the nodepool is ready
      - `readyReplicas` integer, required: Number of replicas that are ready to serve traffic
      - `replicas` integer, required: Current total number of replicas
      - `unavailableReplicas` integer, required: Number of replicas currently unavailable
      - `updatedReplicas` integer, required: Number of replicas updated to the latest spec
  - `kind` 'SotoonNodepoolList', required: The string value 'SotoonNodepoolList'
  - `metadata` V1ListMeta, required: Standard resource metadata fields
    - `continue` string
    - `remainingItemCount` integer, nullable
    - `resourceVersion` string
    - `selfLink` string

## Other responses

- `400`: Bad request - invalid configuration
- `401`: Unauthorized - invalid or expired authentication token
- `403`: Forbidden - insufficient permissions for workspace operations
- `404`: Not found - workspace or resource does not exist
- `422`: Unprocessable entity - resource constraints or quota exceeded

---

[API](https://skmtc.dev/sotoon/apis/sotoon-api.md) - [All operations](https://skmtc.dev/sotoon/apis/sotoon-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sotoon/apis/sotoon-api/revisions/7b3e36d9e9a6?raw)