API Reference

NKS

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Clusters

Create NKS Cluster

$ nirvana nks:clusters create

POST/v1/nks/clusters

Get NKS Cluster Details

$ nirvana nks:clusters get

GET/v1/nks/clusters/{cluster_id}

Update NKS Cluster

$ nirvana nks:clusters update

PATCH/v1/nks/clusters/{cluster_id}

Delete NKS Cluster

$ nirvana nks:clusters delete

DELETE/v1/nks/clusters/{cluster_id}

List NKS Clusters

$ nirvana nks:clusters list

GET/v1/nks/clusters

ModelsExpand Collapse

nks_cluster: 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.

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: "us-sva-2"

Region the resource is in.

"us-sva-2"

status: "pending" or "creating" or "updating" or 4 more

Status of the resource.

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

vpc_id: string

ID of the VPC the Cluster is in.

nks_cluster_list: 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.

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: "us-sva-2"

Region the resource is in.

"us-sva-2"

status: "pending" or "creating" or "updating" or 4 more

Status of the resource.

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

vpc_id: string

ID of the VPC the Cluster is in.

pagination: object { next_cursor, previous_cursor, total_count }

Pagination response details.

next_cursor: string

previous_cursor: string

total_count: number

ClustersAvailability

Check Create NKS Cluster Availability

$ nirvana nks:clusters:availability create

POST/v1/nks/clusters/availability

Check Update NKS Cluster Availability

$ nirvana nks:clusters:availability update

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

ClustersPersistent Volume Claims

Get NKS Persistent Volume Claim Details

$ nirvana nks:clusters:persistent-volume-claims get

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

List NKS Persistent Volume Claims

$ nirvana nks:clusters:persistent-volume-claims list

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

ModelsExpand Collapse

persistent_volume_claim: 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.

name: string

Name of the persistent volume claim.

size: number

Size of the persistent volume claim in GB.

status: "pending" or "creating" or "updating" or 4 more

Status of the resource.

"pending"

"creating"

"updating"

"ready"

"deleting"

"deleted"

"error"

type: "nvme" or "abs"

Type of the Volume.

"nvme"

"abs"

updated_at: string

When the persistent volume claim was last updated.

persistent_volume_claim_list: 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.

name: string

Name of the persistent volume claim.

size: number

Size of the persistent volume claim in GB.

status: "pending" or "creating" or "updating" or 4 more

Status of the resource.

"pending"

"creating"

"updating"

"ready"

"deleting"

"deleted"

"error"

type: "nvme" or "abs"

Type of the Volume.

"nvme"

"abs"

updated_at: string

When the persistent volume claim was last updated.

pagination: object { next_cursor, previous_cursor, total_count }

Pagination response details.

next_cursor: string

previous_cursor: string

total_count: number

ClustersKubeconfig

Get NKS Cluster Kubeconfig

$ nirvana nks:clusters:kubeconfig get

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

$ nirvana nks:clusters:controllers get

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

List NKS Controllers

$ nirvana nks:clusters:controllers list

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

ModelsExpand Collapse

nks_controller: 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.

instance_type: string

Instance type name.

name: string

Name of the controller.

private_ip: string

Private IP address of the controller.

status: "pending" or "creating" or "updating" or 4 more

Status of the resource.

"pending"

"creating"

"updating"

"ready"

"deleting"

"deleted"

"error"

updated_at: string

When the controller was last updated.

nks_controller_list: 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.

instance_type: string

Instance type name.

name: string

Name of the controller.

private_ip: string

Private IP address of the controller.

status: "pending" or "creating" or "updating" or 4 more

Status of the resource.

"pending"

"creating"

"updating"

"ready"

"deleting"

"deleted"

"error"

updated_at: string

When the controller was last updated.

pagination: object { next_cursor, previous_cursor, total_count }

Pagination response details.

next_cursor: string

previous_cursor: string

total_count: number

ClustersControllersVolumes

Get NKS Controller Volume Details

$ nirvana nks:clusters:controllers:volumes get

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

List NKS Controller Volumes

$ nirvana nks:clusters:controllers:volumes list

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

ModelsExpand Collapse

nks_controller_volume: 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.

kind: "boot" or "data"

Volume kind.

"boot"

"data"

name: string

Name of the volume.

size: number

Size of the volume in GB.

status: "pending" or "creating" or "updating" or 4 more

Status of the resource.

"pending"

"creating"

"updating"

"ready"

"deleting"

"deleted"

"error"

type: "nvme" or "abs"

Type of the Volume.

"nvme"

"abs"

updated_at: string

When the volume was last updated.

nks_controller_volume_list: 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.

kind: "boot" or "data"

Volume kind.

"boot"

"data"

name: string

Name of the volume.

size: number

Size of the volume in GB.

status: "pending" or "creating" or "updating" or 4 more

Status of the resource.

"pending"

"creating"

"updating"

"ready"

"deleting"

"deleted"

"error"

type: "nvme" or "abs"

Type of the Volume.

"nvme"

"abs"

updated_at: string

When the volume was last updated.

pagination: object { next_cursor, previous_cursor, total_count }

Pagination response details.

next_cursor: string

previous_cursor: string

total_count: number

ClustersLoad Balancers

Get NKS Load Balancer Details

$ nirvana nks:clusters:load-balancers get

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

Update NKS Load Balancer

$ nirvana nks:clusters:load-balancers update

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

List NKS Load Balancers

$ nirvana nks:clusters:load-balancers list

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

ModelsExpand Collapse

nks_load_balancer: 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.

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: "pending" or "creating" or "updating" or 4 more

Status of the resource.

"pending"

"creating"

"updating"

"ready"

"deleting"

"deleted"

"error"

updated_at: string

When the load balancer was last updated.

nks_load_balancer_list: 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.

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: "pending" or "creating" or "updating" or 4 more

Status of the resource.

"pending"

"creating"

"updating"

"ready"

"deleting"

"deleted"

"error"

updated_at: string

When the load balancer was last updated.

pagination: object { next_cursor, previous_cursor, total_count }

Pagination response details.

next_cursor: string

previous_cursor: string

total_count: number

ClustersPools

Create NKS Node Pool

$ nirvana nks:clusters:pools create

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

Get NKS Node Pool Details

$ nirvana nks:clusters:pools get

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

Update NKS Node Pool

$ nirvana nks:clusters:pools update

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

Delete NKS Node Pool

$ nirvana nks:clusters:pools delete

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

List NKS Node Pools

$ nirvana nks:clusters:pools list

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

ModelsExpand Collapse

nks_node_pool: 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.

name: string

Name of the node pool.

node_config: object { boot_volume, instance_type, labels }

Node configuration.

boot_volume: object { size, type }

Boot volume configuration.

size: number

Size of the boot volume in GB.

type: "nvme" or "abs"

Type of the Volume.

"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: "pending" or "creating" or "updating" or 4 more

Status of the resource.

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

nks_node_pool_boot_volume: object { size, type }

Boot volume configuration.

size: number

Size of the boot volume in GB.

type: "nvme" or "abs"

Type of the Volume.

"nvme"

"abs"

nks_node_pool_boot_volume_response: object { size, type }

Boot volume configuration.

size: number

Size of the boot volume in GB.

type: "nvme" or "abs"

Type of the Volume.

"nvme"

"abs"

nks_node_pool_list: 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.

name: string

Name of the node pool.

node_config: object { boot_volume, instance_type, labels }

Node configuration.

boot_volume: object { size, type }

Boot volume configuration.

size: number

Size of the boot volume in GB.

type: "nvme" or "abs"

Type of the Volume.

"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: "pending" or "creating" or "updating" or 4 more

Status of the resource.

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

pagination: object { next_cursor, previous_cursor, total_count }

Pagination response details.

next_cursor: string

previous_cursor: string

total_count: number

nks_node_pool_node_config: object { boot_volume, instance_type, labels }

Node configuration.

boot_volume: object { size, type }

Boot volume configuration.

size: number

Size of the boot volume in GB.

type: "nvme" or "abs"

Type of the Volume.

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

nks_node_pool_node_config_response: object { boot_volume, instance_type, labels }

Node configuration.

boot_volume: object { size, type }

Boot volume configuration.

size: number

Size of the boot volume in GB.

type: "nvme" or "abs"

Type of the Volume.

"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

$ nirvana nks:clusters:pools:availability create

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

Check Update NKS Node Pool Availability

$ nirvana nks:clusters:pools:availability update

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

ClustersPoolsNodes

Get NKS Node Details

$ nirvana nks:clusters:pools:nodes get

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

Delete NKS Node

$ nirvana nks:clusters:pools:nodes delete

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

List NKS Nodes

$ nirvana nks:clusters:pools:nodes list

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

ModelsExpand Collapse

nks_node: 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.

name: string

Name of the node.

private_ip: string

Private IP address of the node.

status: "pending" or "creating" or "updating" or 4 more

Status of the resource.

"pending"

"creating"

"updating"

"ready"

"deleting"

"deleted"

"error"

updated_at: string

When the node was last updated.

nks_node_list: 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.

name: string

Name of the node.

private_ip: string

Private IP address of the node.

status: "pending" or "creating" or "updating" or 4 more

Status of the resource.

"pending"

"creating"

"updating"

"ready"

"deleting"

"deleted"

"error"

updated_at: string

When the node was last updated.

pagination: object { next_cursor, previous_cursor, total_count }

Pagination response details.

next_cursor: string

previous_cursor: string

total_count: number

ClustersPoolsNodesVolumes

Get NKS Node Volume Details

$ nirvana nks:clusters:pools:nodes:volumes get

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

List NKS Node Volumes

$ nirvana nks:clusters:pools:nodes:volumes list

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

ModelsExpand Collapse

nks_node_volume: 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.

kind: "boot" or "data"

Volume kind.

"boot"

"data"

name: string

Name of the volume.

size: number

Size of the volume in GB.

status: "pending" or "creating" or "updating" or 4 more

Status of the resource.

"pending"

"creating"

"updating"

"ready"

"deleting"

"deleted"

"error"

type: "nvme" or "abs"

Type of the Volume.

"nvme"

"abs"

updated_at: string

When the volume was last updated.

nks_node_volume_list: 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.

kind: "boot" or "data"

Volume kind.

"boot"

"data"

name: string

Name of the volume.

size: number

Size of the volume in GB.

status: "pending" or "creating" or "updating" or 4 more

Status of the resource.

"pending"

"creating"

"updating"

"ready"

"deleting"

"deleted"

"error"

type: "nvme" or "abs"

Type of the Volume.

"nvme"

"abs"

updated_at: string

When the volume was last updated.

pagination: object { next_cursor, previous_cursor, total_count }

Pagination response details.

next_cursor: string

previous_cursor: string

total_count: number