Skip to content
Nirvana Labs Nirvana Labs API
Docs
API Reference
NKS
Clusters
Pools

Update NKS Node Pool

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

Update an NKS node pool

Path ParametersExpand Collapse
cluster_id: string
pool_id: string
Body ParametersJSONExpand Collapse
name: optional string

Name of the node pool.

node_config: optional object { labels }

Partial node configuration update.

labels: optional array of string

Kubernetes labels to apply to each node in the pool. Each entry is “key=value”. When provided, the list fully replaces the current labels on the pool and on live nodes.

node_count: optional number

Number of nodes.

maximum100
minimum0
tags: optional array of string

Tags to attach to the node pool.

ReturnsExpand Collapse
Operation object { id, created_at, details, 6 more }

Operation details.

id: string

Unique identifier for the Operation.

created_at: string

When the Operation was created.

formatdate-time
details: OperationDetails { changes }

Structured details about what an operation is changing.

changes: OperationChanges { from, to }

Map of changed field names to their from/to diffs. Keys depend on the parent operation’s kind+type.

from: string or number or boolean or array of string

Previous value.

One of the following:
string
number
boolean
array of string
to: string or number or boolean or array of string

New value.

One of the following:
string
number
boolean
array of string
kind: OperationKind

Kind of Operation.

One of the following:
"vm"
"volume"
"vpc"
"firewall_rule"
"nks_cluster"
"nks_node_pool"
project_id: string

Project ID the Operation belongs to.

resource_id: string

ID of the resource that the Operation is acting on.

status: OperationStatus

Status of the Operation.

One of the following:
"pending"
"running"
"done"
"failed"
"unknown"
type: OperationType

Type of Operation.

One of the following:
"create"
"update"
"delete"
"restart"
updated_at: string

When the Operation was updated.

formatdate-time

Update NKS Node Pool

curl https://api.nirvanalabs.io/v1/nks/clusters/$CLUSTER_ID/pools/$POOL_ID \
    -X PATCH \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $NIRVANA_LABS_API_KEY" \
    -d '{
          "name": "my-node-pool",
          "node_count": 5,
          "tags": [
            "production",
            "ethereum"
          ]
        }'
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2025-01-01T00:00:00Z",
  "details": {
    "changes": {
      "foo": {
        "from": "string",
        "to": "string"
      }
    }
  },
  "kind": "vm",
  "project_id": "123e4567-e89b-12d3-a456-426614174000",
  "resource_id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "pending",
  "type": "create",
  "updated_at": "2025-01-01T00:00:00Z"
}
Returns Examples
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2025-01-01T00:00:00Z",
  "details": {
    "changes": {
      "foo": {
        "from": "string",
        "to": "string"
      }
    }
  },
  "kind": "vm",
  "project_id": "123e4567-e89b-12d3-a456-426614174000",
  "resource_id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "pending",
  "type": "create",
  "updated_at": "2025-01-01T00:00:00Z"
}