API Reference

NKS

Clusters

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Pools

Create NKS Node Pool

POST/v1/nks/clusters/{cluster_id}/pools

Get NKS Node Pool Details

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

Update NKS Node Pool

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

Delete NKS Node Pool

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

List NKS Node Pools

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

ModelsExpand 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

NKSNodePoolBootVolume object { 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"

NKSNodePoolBootVolumeResponse object { 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"

NKSNodePoolList object { items, pagination }

items: array of NKSNodePool { id, cluster_id, created_at, 6 more }

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

pagination: Pagination { next_cursor, previous_cursor, total_count }

Pagination response details.

next_cursor: string

previous_cursor: string

total_count: number

minimum0

NKSNodePoolNodeConfig object { boot_volume, instance_type, labels, taints }

Node configuration.

boot_volume: NKSNodePoolBootVolume { 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 used for worker nodes.

labels: optional array of string

Kubernetes labels to apply to each node in the pool. Each entry is “key=value”. Keys under kubernetes.io, k8s.io, and nirvanalabs.io prefixes are reserved.

taints: optional array of string

Kubernetes taints to apply to each node in the pool at creation time. Each entry is “key=value:Effect” where Effect is NoSchedule, PreferNoSchedule, or NoExecute. Taints are immutable after pool creation.

NKSNodePoolNodeConfigResponse object { 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”.

PoolsAvailability

Check Create NKS Node Pool Availability

POST/v1/nks/clusters/{cluster_id}/pools/availability

Check Update NKS Node Pool Availability

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

PoolsCost

Estimate NKS Node Pool Create Cost

POST/v1/nks/clusters/{cluster_id}/pools/cost

Estimate NKS Node Pool Update Cost

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

PoolsNodes

Get NKS Node Details

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

Delete NKS Node

DELETE/v1/nks/clusters/{cluster_id}/pools/{pool_id}/nodes/{node_id}

List NKS Nodes

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

ModelsExpand Collapse

NKSNode object { id, created_at, name, 3 more }

NKS node details.

id: string

Unique identifier for the node.

created_at: string

When the node was created.

formatdate-time

name: string

Name of the node.

private_ip: string

Private IP address of the node.

status: ResourceStatus

Status of the resource.

One of the following:

"pending"

"creating"

"updating"

"ready"

"deleting"

"deleted"

"error"

updated_at: string

When the node was last updated.

formatdate-time

NKSNodeList object { items, pagination }

items: array of NKSNode { id, created_at, name, 3 more }

id: string

Unique identifier for the node.

created_at: string

When the node was created.

formatdate-time

name: string

Name of the node.

private_ip: string

Private IP address of the node.

status: ResourceStatus

Status of the resource.

One of the following:

"pending"

"creating"

"updating"

"ready"

"deleting"

"deleted"

"error"

updated_at: string

When the node was last updated.

formatdate-time

pagination: Pagination { next_cursor, previous_cursor, total_count }

Pagination response details.

next_cursor: string

previous_cursor: string

total_count: number

minimum0

PoolsNodesVolumes

Get NKS Node Volume Details

GET/v1/nks/clusters/{cluster_id}/pools/{pool_id}/nodes/{node_id}/volumes/{volume_id}

List NKS Node Volumes

GET/v1/nks/clusters/{cluster_id}/pools/{pool_id}/nodes/{node_id}/volumes

ModelsExpand Collapse

NKSNodeVolume object { id, created_at, kind, 5 more }

NKS node volume details.

id: string

Unique identifier for the volume.

created_at: string

When the volume was created.

formatdate-time

kind: VolumeKind

Volume kind.

One of the following:

"boot"

"data"

name: string

Name of the volume.

size: number

Size of the volume in GB.

status: ResourceStatus

Status of the resource.

One of the following:

"pending"

"creating"

"updating"

"ready"

"deleting"

"deleted"

"error"

type: VolumeType

Type of the Volume.

One of the following:

"nvme"

"abs"

updated_at: string

When the volume was last updated.

formatdate-time

NKSNodeVolumeList object { items, pagination }

items: array of NKSNodeVolume { id, created_at, kind, 5 more }

id: string

Unique identifier for the volume.

created_at: string

When the volume was created.

formatdate-time

kind: VolumeKind

Volume kind.

One of the following:

"boot"

"data"

name: string

Name of the volume.

size: number

Size of the volume in GB.

status: ResourceStatus

Status of the resource.

One of the following:

"pending"

"creating"

"updating"

"ready"

"deleting"

"deleted"

"error"

type: VolumeType

Type of the Volume.

One of the following:

"nvme"

"abs"

updated_at: string

When the volume was last updated.

formatdate-time

pagination: Pagination { next_cursor, previous_cursor, total_count }

Pagination response details.

next_cursor: string

previous_cursor: string

total_count: number

minimum0