Get NKS Node Pool Details

GET/v1/nks/clusters/{cluster_id}/pools/{pool_id}

Get details about an NKS node pool

Path ParametersExpand Collapse

cluster_id: string

pool_id: string

ReturnsExpand Collapse

NKSNodePool object { id, cluster_id, created_at, 6 more }

NKS node pool details.

id: string

Unique identifier for the node pool.

cluster_id: string

ID of the Cluster this node pool belongs to.

created_at: string

When the node pool was created.

formatdate-time

name: string

Name of the node pool.

node_config: NKSNodePoolNodeConfigResponse { boot_volume, instance_type, labels, taints }

Node configuration.

boot_volume: NKSNodePoolBootVolumeResponse { size, type }

Boot volume configuration.

size: number

Size of the boot volume in GB.

maximum512

minimum64

type: VolumeType

Type of the Volume.

One of the following:

"nvme"

"abs"

instance_type: string

Instance type name.

labels: array of string

Kubernetes labels applied to each node in the pool. Each entry is “key=value”.

taints: array of string

Kubernetes taints applied to each node in the pool. Each entry is “key=value:Effect”.

node_count: number

Number of nodes.

status: ResourceStatus

Status of the resource.

One of the following:

"pending"

"creating"

"updating"

"ready"

"deleting"

"deleted"

"error"

tags: array of string

Tags attached to the node pool.

updated_at: string

When the node pool was last updated.

formatdate-time

Get NKS Node Pool Details

curl https://api.nirvanalabs.io/v1/nks/clusters/$CLUSTER_ID/pools/$POOL_ID \
    -H "Authorization: Bearer $NIRVANA_LABS_API_KEY"

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "cluster_id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2025-01-01T00:00:00Z",
  "name": "my-node-pool",
  "node_config": {
    "boot_volume": {
      "size": 100,
      "type": "abs"
    },
    "instance_type": "n1-standard-8",
    "labels": [
      "env=prod",
      "team=platform"
    ],
    "taints": [
      "dedicated=gpu:NoSchedule"
    ]
  },
  "node_count": 3,
  "status": "ready",
  "tags": [
    "production",
    "ethereum"
  ],
  "updated_at": "2025-01-01T00:00:00Z"
}

Returns Examples

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "cluster_id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2025-01-01T00:00:00Z",
  "name": "my-node-pool",
  "node_config": {
    "boot_volume": {
      "size": 100,
      "type": "abs"
    },
    "instance_type": "n1-standard-8",
    "labels": [
      "env=prod",
      "team=platform"
    ],
    "taints": [
      "dedicated=gpu:NoSchedule"
    ]
  },
  "node_count": 3,
  "status": "ready",
  "tags": [
    "production",
    "ethereum"
  ],
  "updated_at": "2025-01-01T00:00:00Z"
}