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

Clusters

Create NKS Cluster
client.nks.clusters.create(ClusterCreateParams { autoscaling, kubernetes_version, name, 4 more } body, RequestOptionsoptions?): Operation { id, created_at, details, 6 more }
POST/v1/nks/clusters
Get NKS Cluster Details
client.nks.clusters.get(stringclusterID, RequestOptionsoptions?): NKSCluster { id, autoscaling, created_at, 11 more }
GET/v1/nks/clusters/{cluster_id}
Update NKS Cluster
client.nks.clusters.update(stringclusterID, ClusterUpdateParams { autoscaling, name, tags } body, RequestOptionsoptions?): Operation { id, created_at, details, 6 more }
PATCH/v1/nks/clusters/{cluster_id}
Delete NKS Cluster
client.nks.clusters.delete(stringclusterID, RequestOptionsoptions?): Operation { id, created_at, details, 6 more }
DELETE/v1/nks/clusters/{cluster_id}
List NKS Clusters
client.nks.clusters.list(ClusterListParams { project_id, cursor, limit } query, RequestOptionsoptions?): Cursor<NKSCluster { id, autoscaling, created_at, 11 more } >
GET/v1/nks/clusters
ModelsExpand Collapse
NKSCluster { 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<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<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 { items, pagination }
items: Array<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<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<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.

ClustersAvailability

Check Create NKS Cluster Availability
client.nks.clusters.availability.create(AvailabilityCreateParams { autoscaling, kubernetes_version, name, 4 more } body, RequestOptionsoptions?): void
POST/v1/nks/clusters/availability
Check Update NKS Cluster Availability
client.nks.clusters.availability.update(stringclusterID, AvailabilityUpdateParams { autoscaling, name, tags } body, RequestOptionsoptions?): void
PATCH/v1/nks/clusters/{cluster_id}/availability

ClustersPersistent Volume Claims

Get NKS Persistent Volume Claim Details
client.nks.clusters.persistentVolumeClaims.get(stringpersistentVolumeClaimID, PersistentVolumeClaimGetParams { cluster_id } params, RequestOptionsoptions?): PersistentVolumeClaim { id, cluster_id, created_at, 5 more }
GET/v1/nks/clusters/{cluster_id}/persistent_volume_claims/{persistent_volume_claim_id}
List NKS Persistent Volume Claims
client.nks.clusters.persistentVolumeClaims.list(stringclusterID, PersistentVolumeClaimListParams { cursor, limit } query?, RequestOptionsoptions?): Cursor<PersistentVolumeClaim { id, cluster_id, created_at, 5 more } >
GET/v1/nks/clusters/{cluster_id}/persistent_volume_claims
ModelsExpand Collapse
PersistentVolumeClaim { 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 { items, pagination }
items: Array<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

ClustersKubeconfig

Get NKS Cluster Kubeconfig
client.nks.clusters.kubeconfig.get(stringclusterID, RequestOptionsoptions?): Kubeconfig { kubeconfig }
GET/v1/nks/clusters/{cluster_id}/kubeconfig
ModelsExpand Collapse
Kubeconfig { kubeconfig }

Kubeconfig for an NKS Cluster.

kubeconfig: string

Kubeconfig content for the Cluster.

ClustersControllers

Get NKS Controller Details
client.nks.clusters.controllers.get(stringcontrollerID, ControllerGetParams { cluster_id } params, RequestOptionsoptions?): NKSController { id, created_at, instance_type, 4 more }
GET/v1/nks/clusters/{cluster_id}/controllers/{controller_id}
List NKS Controllers
client.nks.clusters.controllers.list(stringclusterID, ControllerListParams { cursor, limit } query?, RequestOptionsoptions?): Cursor<NKSController { id, created_at, instance_type, 4 more } >
GET/v1/nks/clusters/{cluster_id}/controllers
ModelsExpand Collapse
NKSController { 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 | null

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 { items, pagination }
items: Array<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 | null

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

ClustersControllersVolumes

Get NKS Controller Volume Details
client.nks.clusters.controllers.volumes.get(stringvolumeID, VolumeGetParams { cluster_id, controller_id } params, RequestOptionsoptions?): NKSControllerVolume { id, created_at, kind, 5 more }
GET/v1/nks/clusters/{cluster_id}/controllers/{controller_id}/volumes/{volume_id}
List NKS Controller Volumes
client.nks.clusters.controllers.volumes.list(stringcontrollerID, VolumeListParams { cluster_id, cursor, limit } params, RequestOptionsoptions?): Cursor<NKSControllerVolume { id, created_at, kind, 5 more } >
GET/v1/nks/clusters/{cluster_id}/controllers/{controller_id}/volumes
ModelsExpand Collapse
NKSControllerVolume { 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 { items, pagination }
items: Array<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

ClustersLoad Balancers

Get NKS Load Balancer Details
client.nks.clusters.loadBalancers.get(stringloadBalancerID, LoadBalancerGetParams { cluster_id } params, RequestOptionsoptions?): NKSLoadBalancer { id, cluster_id, created_at, 7 more }
GET/v1/nks/clusters/{cluster_id}/load_balancers/{load_balancer_id}
Update NKS Load Balancer
client.nks.clusters.loadBalancers.update(stringloadBalancerID, LoadBalancerUpdateParams { cluster_id, public_ip_enabled } params, RequestOptionsoptions?): Operation { id, created_at, details, 6 more }
PATCH/v1/nks/clusters/{cluster_id}/load_balancers/{load_balancer_id}
List NKS Load Balancers
client.nks.clusters.loadBalancers.list(stringclusterID, LoadBalancerListParams { cursor, limit } query?, RequestOptionsoptions?): Cursor<NKSLoadBalancer { id, cluster_id, created_at, 7 more } >
GET/v1/nks/clusters/{cluster_id}/load_balancers
ModelsExpand Collapse
NKSLoadBalancer { 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 | null

Private IP address of the load balancer.

public_ip: string | null

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 { items, pagination }
items: Array<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 | null

Private IP address of the load balancer.

public_ip: string | null

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

ClustersPools

Create NKS Node Pool
client.nks.clusters.pools.create(stringclusterID, PoolCreateParams { name, node_config, node_count, tags } body, RequestOptionsoptions?): Operation { id, created_at, details, 6 more }
POST/v1/nks/clusters/{cluster_id}/pools
Get NKS Node Pool Details
client.nks.clusters.pools.get(stringpoolID, PoolGetParams { cluster_id } params, RequestOptionsoptions?): NKSNodePool { id, cluster_id, created_at, 6 more }
GET/v1/nks/clusters/{cluster_id}/pools/{pool_id}
Update NKS Node Pool
client.nks.clusters.pools.update(stringpoolID, PoolUpdateParams { cluster_id, name, node_config, 2 more } params, RequestOptionsoptions?): Operation { id, created_at, details, 6 more }
PATCH/v1/nks/clusters/{cluster_id}/pools/{pool_id}
Delete NKS Node Pool
client.nks.clusters.pools.delete(stringpoolID, PoolDeleteParams { cluster_id } params, RequestOptionsoptions?): Operation { id, created_at, details, 6 more }
DELETE/v1/nks/clusters/{cluster_id}/pools/{pool_id}
List NKS Node Pools
client.nks.clusters.pools.list(stringclusterID, PoolListParams { cursor, limit } query?, RequestOptionsoptions?): Cursor<NKSNodePool { id, cluster_id, created_at, 6 more } >
GET/v1/nks/clusters/{cluster_id}/pools
ModelsExpand Collapse
NKSNodePool { 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<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<string>

Tags attached to the node pool.

updated_at: string

When the node pool was last updated.

formatdate-time
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"
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"
NKSNodePoolList { items, pagination }
items: Array<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<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<string>

Tags attached to the node pool.

updated_at: string

When the node pool was last updated.

formatdate-time
NKSNodePoolNodeConfig { 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?: Array<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 { 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<string>

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

ClustersPoolsAvailability

Check Create NKS Node Pool Availability
client.nks.clusters.pools.availability.create(stringclusterID, AvailabilityCreateParams { name, node_config, node_count, tags } body, RequestOptionsoptions?): void
POST/v1/nks/clusters/{cluster_id}/pools/availability
Check Update NKS Node Pool Availability
client.nks.clusters.pools.availability.update(stringpoolID, AvailabilityUpdateParams { cluster_id, name, node_config, 2 more } params, RequestOptionsoptions?): void
PATCH/v1/nks/clusters/{cluster_id}/pools/{pool_id}/availability

ClustersPoolsNodes

Get NKS Node Details
client.nks.clusters.pools.nodes.get(stringnodeID, NodeGetParams { cluster_id, pool_id } params, RequestOptionsoptions?): NKSNode { id, created_at, name, 3 more }
GET/v1/nks/clusters/{cluster_id}/pools/{pool_id}/nodes/{node_id}
Delete NKS Node
client.nks.clusters.pools.nodes.delete(stringnodeID, NodeDeleteParams { cluster_id, pool_id } params, RequestOptionsoptions?): Operation { id, created_at, details, 6 more }
DELETE/v1/nks/clusters/{cluster_id}/pools/{pool_id}/nodes/{node_id}
List NKS Nodes
client.nks.clusters.pools.nodes.list(stringpoolID, NodeListParams { cluster_id, cursor, limit } params, RequestOptionsoptions?): Cursor<NKSNode { id, created_at, name, 3 more } >
GET/v1/nks/clusters/{cluster_id}/pools/{pool_id}/nodes
ModelsExpand Collapse
NKSNode { 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 | null

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 { items, pagination }
items: Array<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 | null

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

ClustersPoolsNodesVolumes

Get NKS Node Volume Details
client.nks.clusters.pools.nodes.volumes.get(stringvolumeID, VolumeGetParams { cluster_id, pool_id, node_id } params, RequestOptionsoptions?): NKSNodeVolume { id, created_at, kind, 5 more }
GET/v1/nks/clusters/{cluster_id}/pools/{pool_id}/nodes/{node_id}/volumes/{volume_id}
List NKS Node Volumes
client.nks.clusters.pools.nodes.volumes.list(stringnodeID, VolumeListParams { cluster_id, pool_id, cursor, limit } params, RequestOptionsoptions?): Cursor<NKSNodeVolume { id, created_at, kind, 5 more } >
GET/v1/nks/clusters/{cluster_id}/pools/{pool_id}/nodes/{node_id}/volumes
ModelsExpand Collapse
NKSNodeVolume { 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 { items, pagination }
items: Array<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