---
title: "List node pools"
method: GET
path: "/api/v1/orgs/{orgId}/clusters/{id}/nodepools"
tags: ["clusters"]
---

# List node pools

`GET /api/v1/orgs/{orgId}/clusters/{id}/nodepools`

## Path parameters

- `orgId` integer, required
- `id` integer, required

## Response `200`

Node pool list

- NodePoolSummary[]
  - union
    - object — A summary of information about the node pool.
      - `name` string, required — Node pool name.
      - `size` integer, required — Node pool size.
      - `labels` object — Node pool labels.
      - `autoscaling` NodePoolAutoScaling — Node pool auto scaling settings.
        - `enabled` boolean — Enable node pool autoscaling.
        - `minSize` integer, required — Minimum node pool size.
        - `maxSize` integer, required — Maximum node pool size.
      - `volumeEncryption` EKSNodePoolVolumeEncryption, nullable — Encryption details of the node volumes in an EKS node pool.
        - `enabled` boolean, required — Indicator of encrypted node pool node volumes.
        - `encryptionKeyARN` string — KMS key ARN to use for node volume encryption.
      - `volumeSize` integer — Size of the EBS volume in GiBs of the nodes in the pool.
      - `volumeType` string — Type of the EBS volume of the nodes in the pool (default gp3).
      - `instanceType` string, required — Machine instance type.
      - `image` string — Instance AMI.
      - `spotPrice` string — The upper limit price for the requested spot instance. If this field is left empty or 0 passed in on-demand instances used instead of spot instances.
      - `subnetId` string
      - `securityGroups` string[] — List of additional custom security groups for all nodes in the pool.
      - `useInstanceStore` boolean — Setup available instance stores (NVMe disks) to use for Kubelet root if available. As a result emptyDir volumes will be provisioned on local instance storage disks. You can check out available instance storages here https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes.
      - `status` string — Current status of the node pool.
      - `statusMessage` string — Details and reasoning about the status value.
    - object — A summary of information about the node pool.
      - `name` string, required — Node pool name.
      - `size` integer, required — Node pool size.
      - `labels` object — Node pool labels.
      - `autoscaling` NodePoolAutoScaling — Node pool auto scaling settings.
        - `enabled` boolean — Enable node pool autoscaling.
        - `minSize` integer, required — Minimum node pool size.
        - `maxSize` integer, required — Maximum node pool size.
      - `volumeEncryption` EKSNodePoolVolumeEncryption, nullable — Encryption details of the node volumes in an EKS node pool.
        - `enabled` boolean, required — Indicator of encrypted node pool node volumes.
        - `encryptionKeyARN` string — KMS key ARN to use for node volume encryption.
      - `volumeSize` integer — Size of the EBS volume in GiBs of the nodes in the pool.
      - `volumeType` string — Type of the EBS volume of the nodes in the pool (default gp3).
      - `instanceType` string, required — Machine instance type.
      - `image` string — Instance AMI.
      - `spotPrice` string — The upper limit price for the requested spot instance. If this field is left empty or 0 passed in on-demand instances used instead of spot instances.
      - `subnetId` string
      - `securityGroups` string[] — List of additional custom security groups for all nodes in the pool.
      - `useInstanceStore` boolean — Setup available instance stores (NVMe disks) to use for Kubelet root if available. As a result emptyDir volumes will be provisioned on local instance storage disks. You can check out available instance storages here https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes.
      - `status` string — Current status of the node pool.
      - `statusMessage` string — Details and reasoning about the status value.

## Other responses

- `default` — Internal server error

---

[API](https://skmtc.net/banzaicloud/apis/pipeline-api.md) · [All operations](https://skmtc.net/banzaicloud/apis/pipeline-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/banzaicloud/pipeline-api/versions/a2e35c430378/schema)