API Reference

NKS

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Clusters

Create NKS Cluster

POST/v1/nks/clusters

Get NKS Cluster Details

GET/v1/nks/clusters/{cluster_id}

Update NKS Cluster

PATCH/v1/nks/clusters/{cluster_id}

Delete NKS Cluster

DELETE/v1/nks/clusters/{cluster_id}

List NKS Clusters

GET/v1/nks/clusters

ModelsExpand Collapse

NKSCluster object { id, autoscaling, created_at, 11 more }

NKS Cluster details.

id: string

Unique identifier for the Cluster.

autoscaling: boolean

Whether autoscaling is enabled for the Cluster.

created_at: string

When the Cluster was created.

formatdate-time

kubernetes_version: string

Kubernetes version of the Cluster.

name: string

Name of the Cluster.

pool_ids: array of string

IDs of pools belonging to this Cluster.

private_ip: string

Private IP (VIP) of the Cluster.

project_id: string

Project ID the Cluster belongs to.

public_ip: string

Public IP of the Cluster.

region: RegionName

Region the resource is in.

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 Cluster.

updated_at: string

When the Cluster was last updated.

formatdate-time

vpc_id: string

ID of the VPC the Cluster is in.

NKSClusterList object { items, pagination }

items: array of NKSCluster { id, autoscaling, created_at, 11 more }

id: string

Unique identifier for the Cluster.

autoscaling: boolean

Whether autoscaling is enabled for the Cluster.

created_at: string

When the Cluster was created.

formatdate-time

kubernetes_version: string

Kubernetes version of the Cluster.

name: string

Name of the Cluster.

pool_ids: array of string

IDs of pools belonging to this Cluster.

private_ip: string

Private IP (VIP) of the Cluster.

project_id: string

Project ID the Cluster belongs to.

public_ip: string

Public IP of the Cluster.

region: RegionName

Region the resource is in.

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 Cluster.

updated_at: string

When the Cluster was last updated.

formatdate-time

vpc_id: string

ID of the VPC the Cluster is in.

pagination: Pagination { next_cursor, previous_cursor, total_count }

Pagination response details.

next_cursor: string

previous_cursor: string

total_count: number

minimum0

ClustersAvailability

Check Create NKS Cluster Availability

POST/v1/nks/clusters/availability

Check Update NKS Cluster Availability

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

ClustersPersistent Volume Claims

Get NKS Persistent Volume Claim Details

GET/v1/nks/clusters/{cluster_id}/persistent_volume_claims/{persistent_volume_claim_id}

List NKS Persistent Volume Claims

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

ModelsExpand Collapse

PersistentVolumeClaim object { id, cluster_id, created_at, 5 more }

NKS persistent volume claim details.

id: string

Unique identifier for the persistent volume claim.

cluster_id: string

Cluster this persistent volume claim belongs to.

created_at: string

When the persistent volume claim was first discovered.

formatdate-time

name: string

Name of the persistent volume claim.

size: number

Size of the persistent volume claim 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 persistent volume claim was last updated.

formatdate-time

PersistentVolumeClaimList object { items, pagination }

items: array of PersistentVolumeClaim { id, cluster_id, created_at, 5 more }

id: string

Unique identifier for the persistent volume claim.

cluster_id: string

Cluster this persistent volume claim belongs to.

created_at: string

When the persistent volume claim was first discovered.

formatdate-time

name: string

Name of the persistent volume claim.

size: number

Size of the persistent volume claim 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 persistent volume claim 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

ClustersKubeconfig

Get NKS Cluster Kubeconfig

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

ModelsExpand Collapse

Kubeconfig object { kubeconfig }

Kubeconfig for an NKS Cluster.

kubeconfig: string

Kubeconfig content for the Cluster.

ClustersControllers

Get NKS Controller Details

GET/v1/nks/clusters/{cluster_id}/controllers/{controller_id}

List NKS Controllers

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

ModelsExpand Collapse

NKSController object { id, created_at, instance_type, 4 more }

NKS controller details.

id: string

Unique identifier for the controller.

created_at: string

When the controller was created.

formatdate-time

instance_type: string

Instance type name.

name: string

Name of the controller.

private_ip: string

Private IP address of the controller.

status: ResourceStatus

Status of the resource.

One of the following:

"pending"

"creating"

"updating"

"ready"

"deleting"

"deleted"

"error"

updated_at: string

When the controller was last updated.

formatdate-time

NKSControllerList object { items, pagination }

items: array of NKSController { id, created_at, instance_type, 4 more }

id: string

Unique identifier for the controller.

created_at: string

When the controller was created.

formatdate-time

instance_type: string

Instance type name.

name: string

Name of the controller.

private_ip: string

Private IP address of the controller.

status: ResourceStatus

Status of the resource.

One of the following:

"pending"

"creating"

"updating"

"ready"

"deleting"

"deleted"

"error"

updated_at: string

When the controller 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

ClustersControllersVolumes

Get NKS Controller Volume Details

GET/v1/nks/clusters/{cluster_id}/controllers/{controller_id}/volumes/{volume_id}

List NKS Controller Volumes

GET/v1/nks/clusters/{cluster_id}/controllers/{controller_id}/volumes

ModelsExpand Collapse

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

NKS controller 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

NKSControllerVolumeList object { items, pagination }

items: array of NKSControllerVolume { 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

ClustersLoad Balancers

Get NKS Load Balancer Details

GET/v1/nks/clusters/{cluster_id}/load_balancers/{load_balancer_id}

Update NKS Load Balancer

PATCH/v1/nks/clusters/{cluster_id}/load_balancers/{load_balancer_id}

List NKS Load Balancers

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

ModelsExpand Collapse

NKSLoadBalancer object { id, cluster_id, created_at, 7 more }

NKS load balancer details.

id: string

Unique identifier for the load balancer.

cluster_id: string

Cluster this load balancer belongs to.

created_at: string

When the load balancer was first discovered.

formatdate-time

namespace: string

Kubernetes namespace of the load balancer.

private_ip: string

Private IP address of the load balancer.

public_ip: string

Public IP address assigned to this load balancer.

public_ip_enabled: boolean

Whether a public IP is enabled for this load balancer.

service_name: string

Kubernetes service name of the load balancer.

status: ResourceStatus

Status of the resource.

One of the following:

"pending"

"creating"

"updating"

"ready"

"deleting"

"deleted"

"error"

updated_at: string

When the load balancer was last updated.

formatdate-time

NKSLoadBalancerList object { items, pagination }

items: array of NKSLoadBalancer { id, cluster_id, created_at, 7 more }

id: string

Unique identifier for the load balancer.

cluster_id: string

Cluster this load balancer belongs to.

created_at: string

When the load balancer was first discovered.

formatdate-time

namespace: string

Kubernetes namespace of the load balancer.

private_ip: string

Private IP address of the load balancer.

public_ip: string

Public IP address assigned to this load balancer.

public_ip_enabled: boolean

Whether a public IP is enabled for this load balancer.

service_name: string

Kubernetes service name of the load balancer.

status: ResourceStatus

Status of the resource.

One of the following:

"pending"

"creating"

"updating"

"ready"

"deleting"

"deleted"

"error"

updated_at: string

When the load balancer 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

ClustersPools

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 }

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”.

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 }

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”.

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 }

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.

NKSNodePoolNodeConfigResponse object { boot_volume, instance_type, labels }

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”.

ClustersPoolsAvailability

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

ClustersPoolsNodes

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

ClustersPoolsNodesVolumes

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