Skip to content
Docs

Clusters

Create NKS Cluster
client.NKS.Clusters.New(ctx, body) (*Operation, error)
POST/v1/nks/clusters
Get NKS Cluster Details
client.NKS.Clusters.Get(ctx, clusterID) (*NKSCluster, error)
GET/v1/nks/clusters/{cluster_id}
Update NKS Cluster
client.NKS.Clusters.Update(ctx, clusterID, body) (*Operation, error)
PATCH/v1/nks/clusters/{cluster_id}
Delete NKS Cluster
client.NKS.Clusters.Delete(ctx, clusterID) (*Operation, error)
DELETE/v1/nks/clusters/{cluster_id}
List NKS Clusters
client.NKS.Clusters.List(ctx, query) (*Cursor[NKSCluster], error)
GET/v1/nks/clusters
ModelsExpand Collapse
type NKSCluster struct{…}

NKS Cluster details.

ID string

Unique identifier for the Cluster.

Autoscaling bool

Whether autoscaling is enabled for the Cluster.

CreatedAt Time

When the Cluster was created.

formatdate-time
KubernetesVersion string

Kubernetes version of the Cluster.

Name string

Name of the Cluster.

PoolIDs []string

IDs of pools belonging to this Cluster.

PrivateIP string

Private IP (VIP) of the Cluster.

ProjectID string

Project ID the Cluster belongs to.

PublicIP string

Public IP of the Cluster.

Region RegionName

Region the resource is in.

Status of the resource.

One of the following:
const ResourceStatusPending ResourceStatus = "pending"
const ResourceStatusCreating ResourceStatus = "creating"
const ResourceStatusUpdating ResourceStatus = "updating"
const ResourceStatusReady ResourceStatus = "ready"
const ResourceStatusDeleting ResourceStatus = "deleting"
const ResourceStatusDeleted ResourceStatus = "deleted"
const ResourceStatusError ResourceStatus = "error"
Tags []string

Tags attached to the Cluster.

UpdatedAt Time

When the Cluster was last updated.

formatdate-time
VPCID string

ID of the VPC the Cluster is in.

type NKSClusterList struct{…}
Items []NKSCluster
ID string

Unique identifier for the Cluster.

Autoscaling bool

Whether autoscaling is enabled for the Cluster.

CreatedAt Time

When the Cluster was created.

formatdate-time
KubernetesVersion string

Kubernetes version of the Cluster.

Name string

Name of the Cluster.

PoolIDs []string

IDs of pools belonging to this Cluster.

PrivateIP string

Private IP (VIP) of the Cluster.

ProjectID string

Project ID the Cluster belongs to.

PublicIP string

Public IP of the Cluster.

Region RegionName

Region the resource is in.

Status of the resource.

One of the following:
const ResourceStatusPending ResourceStatus = "pending"
const ResourceStatusCreating ResourceStatus = "creating"
const ResourceStatusUpdating ResourceStatus = "updating"
const ResourceStatusReady ResourceStatus = "ready"
const ResourceStatusDeleting ResourceStatus = "deleting"
const ResourceStatusDeleted ResourceStatus = "deleted"
const ResourceStatusError ResourceStatus = "error"
Tags []string

Tags attached to the Cluster.

UpdatedAt Time

When the Cluster was last updated.

formatdate-time
VPCID string

ID of the VPC the Cluster is in.

ClustersAvailability

Check Create NKS Cluster Availability
client.NKS.Clusters.Availability.New(ctx, body) error
POST/v1/nks/clusters/availability
Check Update NKS Cluster Availability
client.NKS.Clusters.Availability.Update(ctx, clusterID, body) error
PATCH/v1/nks/clusters/{cluster_id}/availability

ClustersPersistent Volume Claims

Get NKS Persistent Volume Claim Details
client.NKS.Clusters.PersistentVolumeClaims.Get(ctx, clusterID, persistentVolumeClaimID) (*PersistentVolumeClaim, error)
GET/v1/nks/clusters/{cluster_id}/persistent_volume_claims/{persistent_volume_claim_id}
List NKS Persistent Volume Claims
client.NKS.Clusters.PersistentVolumeClaims.List(ctx, clusterID, query) (*Cursor[PersistentVolumeClaim], error)
GET/v1/nks/clusters/{cluster_id}/persistent_volume_claims
ModelsExpand Collapse
type PersistentVolumeClaim struct{…}

NKS persistent volume claim details.

ID string

Unique identifier for the persistent volume claim.

ClusterID string

Cluster this persistent volume claim belongs to.

CreatedAt Time

When the persistent volume claim was first discovered.

formatdate-time
Name string

Name of the persistent volume claim.

Size int64

Size of the persistent volume claim in GB.

Status of the resource.

One of the following:
const ResourceStatusPending ResourceStatus = "pending"
const ResourceStatusCreating ResourceStatus = "creating"
const ResourceStatusUpdating ResourceStatus = "updating"
const ResourceStatusReady ResourceStatus = "ready"
const ResourceStatusDeleting ResourceStatus = "deleting"
const ResourceStatusDeleted ResourceStatus = "deleted"
const ResourceStatusError ResourceStatus = "error"

Type of the Volume.

One of the following:
const VolumeTypeNvme VolumeType = "nvme"
const VolumeTypeABS VolumeType = "abs"
UpdatedAt Time

When the persistent volume claim was last updated.

formatdate-time
type PersistentVolumeClaimList struct{…}
ID string

Unique identifier for the persistent volume claim.

ClusterID string

Cluster this persistent volume claim belongs to.

CreatedAt Time

When the persistent volume claim was first discovered.

formatdate-time
Name string

Name of the persistent volume claim.

Size int64

Size of the persistent volume claim in GB.

Status of the resource.

One of the following:
const ResourceStatusPending ResourceStatus = "pending"
const ResourceStatusCreating ResourceStatus = "creating"
const ResourceStatusUpdating ResourceStatus = "updating"
const ResourceStatusReady ResourceStatus = "ready"
const ResourceStatusDeleting ResourceStatus = "deleting"
const ResourceStatusDeleted ResourceStatus = "deleted"
const ResourceStatusError ResourceStatus = "error"

Type of the Volume.

One of the following:
const VolumeTypeNvme VolumeType = "nvme"
const VolumeTypeABS VolumeType = "abs"
UpdatedAt Time

When the persistent volume claim was last updated.

formatdate-time

ClustersKubeconfig

Get NKS Cluster Kubeconfig
client.NKS.Clusters.Kubeconfig.Get(ctx, clusterID) (*Kubeconfig, error)
GET/v1/nks/clusters/{cluster_id}/kubeconfig
ModelsExpand Collapse
type Kubeconfig struct{…}

Kubeconfig for an NKS Cluster.

Kubeconfig string

Kubeconfig content for the Cluster.

ClustersControllers

Get NKS Controller Details
client.NKS.Clusters.Controllers.Get(ctx, clusterID, controllerID) (*NKSController, error)
GET/v1/nks/clusters/{cluster_id}/controllers/{controller_id}
List NKS Controllers
client.NKS.Clusters.Controllers.List(ctx, clusterID, query) (*Cursor[NKSController], error)
GET/v1/nks/clusters/{cluster_id}/controllers
ModelsExpand Collapse
type NKSController struct{…}

NKS controller details.

ID string

Unique identifier for the controller.

CreatedAt Time

When the controller was created.

formatdate-time
InstanceType string

Instance type name.

Name string

Name of the controller.

PrivateIP string

Private IP address of the controller.

Status of the resource.

One of the following:
const ResourceStatusPending ResourceStatus = "pending"
const ResourceStatusCreating ResourceStatus = "creating"
const ResourceStatusUpdating ResourceStatus = "updating"
const ResourceStatusReady ResourceStatus = "ready"
const ResourceStatusDeleting ResourceStatus = "deleting"
const ResourceStatusDeleted ResourceStatus = "deleted"
const ResourceStatusError ResourceStatus = "error"
UpdatedAt Time

When the controller was last updated.

formatdate-time
type NKSControllerList struct{…}
ID string

Unique identifier for the controller.

CreatedAt Time

When the controller was created.

formatdate-time
InstanceType string

Instance type name.

Name string

Name of the controller.

PrivateIP string

Private IP address of the controller.

Status of the resource.

One of the following:
const ResourceStatusPending ResourceStatus = "pending"
const ResourceStatusCreating ResourceStatus = "creating"
const ResourceStatusUpdating ResourceStatus = "updating"
const ResourceStatusReady ResourceStatus = "ready"
const ResourceStatusDeleting ResourceStatus = "deleting"
const ResourceStatusDeleted ResourceStatus = "deleted"
const ResourceStatusError ResourceStatus = "error"
UpdatedAt Time

When the controller was last updated.

formatdate-time

ClustersControllersVolumes

Get NKS Controller Volume Details
client.NKS.Clusters.Controllers.Volumes.Get(ctx, clusterID, controllerID, volumeID) (*NKSControllerVolume, error)
GET/v1/nks/clusters/{cluster_id}/controllers/{controller_id}/volumes/{volume_id}
List NKS Controller Volumes
client.NKS.Clusters.Controllers.Volumes.List(ctx, clusterID, controllerID, query) (*Cursor[NKSControllerVolume], error)
GET/v1/nks/clusters/{cluster_id}/controllers/{controller_id}/volumes
ModelsExpand Collapse
type NKSControllerVolume struct{…}

NKS controller volume details.

ID string

Unique identifier for the volume.

CreatedAt Time

When the volume was created.

formatdate-time

Volume kind.

One of the following:
const VolumeKindBoot VolumeKind = "boot"
const VolumeKindData VolumeKind = "data"
Name string

Name of the volume.

Size int64

Size of the volume in GB.

Status of the resource.

One of the following:
const ResourceStatusPending ResourceStatus = "pending"
const ResourceStatusCreating ResourceStatus = "creating"
const ResourceStatusUpdating ResourceStatus = "updating"
const ResourceStatusReady ResourceStatus = "ready"
const ResourceStatusDeleting ResourceStatus = "deleting"
const ResourceStatusDeleted ResourceStatus = "deleted"
const ResourceStatusError ResourceStatus = "error"

Type of the Volume.

One of the following:
const VolumeTypeNvme VolumeType = "nvme"
const VolumeTypeABS VolumeType = "abs"
UpdatedAt Time

When the volume was last updated.

formatdate-time
type NKSControllerVolumeList struct{…}
ID string

Unique identifier for the volume.

CreatedAt Time

When the volume was created.

formatdate-time

Volume kind.

One of the following:
const VolumeKindBoot VolumeKind = "boot"
const VolumeKindData VolumeKind = "data"
Name string

Name of the volume.

Size int64

Size of the volume in GB.

Status of the resource.

One of the following:
const ResourceStatusPending ResourceStatus = "pending"
const ResourceStatusCreating ResourceStatus = "creating"
const ResourceStatusUpdating ResourceStatus = "updating"
const ResourceStatusReady ResourceStatus = "ready"
const ResourceStatusDeleting ResourceStatus = "deleting"
const ResourceStatusDeleted ResourceStatus = "deleted"
const ResourceStatusError ResourceStatus = "error"

Type of the Volume.

One of the following:
const VolumeTypeNvme VolumeType = "nvme"
const VolumeTypeABS VolumeType = "abs"
UpdatedAt Time

When the volume was last updated.

formatdate-time

ClustersLoad Balancers

Get NKS Load Balancer Details
client.NKS.Clusters.LoadBalancers.Get(ctx, clusterID, loadBalancerID) (*NKSLoadBalancer, error)
GET/v1/nks/clusters/{cluster_id}/load_balancers/{load_balancer_id}
Update NKS Load Balancer
client.NKS.Clusters.LoadBalancers.Update(ctx, clusterID, loadBalancerID, body) (*Operation, error)
PATCH/v1/nks/clusters/{cluster_id}/load_balancers/{load_balancer_id}
List NKS Load Balancers
client.NKS.Clusters.LoadBalancers.List(ctx, clusterID, query) (*Cursor[NKSLoadBalancer], error)
GET/v1/nks/clusters/{cluster_id}/load_balancers
ModelsExpand Collapse
type NKSLoadBalancer struct{…}

NKS load balancer details.

ID string

Unique identifier for the load balancer.

ClusterID string

Cluster this load balancer belongs to.

CreatedAt Time

When the load balancer was first discovered.

formatdate-time
Namespace string

Kubernetes namespace of the load balancer.

PrivateIP string

Private IP address of the load balancer.

PublicIP string

Public IP address assigned to this load balancer.

PublicIPEnabled bool

Whether a public IP is enabled for this load balancer.

ServiceName string

Kubernetes service name of the load balancer.

Status of the resource.

One of the following:
const ResourceStatusPending ResourceStatus = "pending"
const ResourceStatusCreating ResourceStatus = "creating"
const ResourceStatusUpdating ResourceStatus = "updating"
const ResourceStatusReady ResourceStatus = "ready"
const ResourceStatusDeleting ResourceStatus = "deleting"
const ResourceStatusDeleted ResourceStatus = "deleted"
const ResourceStatusError ResourceStatus = "error"
UpdatedAt Time

When the load balancer was last updated.

formatdate-time
type NKSLoadBalancerList struct{…}
ID string

Unique identifier for the load balancer.

ClusterID string

Cluster this load balancer belongs to.

CreatedAt Time

When the load balancer was first discovered.

formatdate-time
Namespace string

Kubernetes namespace of the load balancer.

PrivateIP string

Private IP address of the load balancer.

PublicIP string

Public IP address assigned to this load balancer.

PublicIPEnabled bool

Whether a public IP is enabled for this load balancer.

ServiceName string

Kubernetes service name of the load balancer.

Status of the resource.

One of the following:
const ResourceStatusPending ResourceStatus = "pending"
const ResourceStatusCreating ResourceStatus = "creating"
const ResourceStatusUpdating ResourceStatus = "updating"
const ResourceStatusReady ResourceStatus = "ready"
const ResourceStatusDeleting ResourceStatus = "deleting"
const ResourceStatusDeleted ResourceStatus = "deleted"
const ResourceStatusError ResourceStatus = "error"
UpdatedAt Time

When the load balancer was last updated.

formatdate-time

ClustersPools

Create NKS Node Pool
client.NKS.Clusters.Pools.New(ctx, clusterID, body) (*Operation, error)
POST/v1/nks/clusters/{cluster_id}/pools
Get NKS Node Pool Details
client.NKS.Clusters.Pools.Get(ctx, clusterID, poolID) (*NKSNodePool, error)
GET/v1/nks/clusters/{cluster_id}/pools/{pool_id}
Update NKS Node Pool
client.NKS.Clusters.Pools.Update(ctx, clusterID, poolID, body) (*Operation, error)
PATCH/v1/nks/clusters/{cluster_id}/pools/{pool_id}
Delete NKS Node Pool
client.NKS.Clusters.Pools.Delete(ctx, clusterID, poolID) (*Operation, error)
DELETE/v1/nks/clusters/{cluster_id}/pools/{pool_id}
List NKS Node Pools
client.NKS.Clusters.Pools.List(ctx, clusterID, query) (*Cursor[NKSNodePool], error)
GET/v1/nks/clusters/{cluster_id}/pools
ModelsExpand Collapse
type NKSNodePool struct{…}

NKS node pool details.

ID string

Unique identifier for the node pool.

ClusterID string

ID of the Cluster this node pool belongs to.

CreatedAt Time

When the node pool was created.

formatdate-time
Name string

Name of the node pool.

Node configuration.

Boot volume configuration.

Size int64

Size of the boot volume in GB.

maximum512
minimum64

Type of the Volume.

One of the following:
const VolumeTypeNvme VolumeType = "nvme"
const VolumeTypeABS VolumeType = "abs"
InstanceType string

Instance type name.

Labels []string

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

NodeCount int64

Number of nodes.

Status of the resource.

One of the following:
const ResourceStatusPending ResourceStatus = "pending"
const ResourceStatusCreating ResourceStatus = "creating"
const ResourceStatusUpdating ResourceStatus = "updating"
const ResourceStatusReady ResourceStatus = "ready"
const ResourceStatusDeleting ResourceStatus = "deleting"
const ResourceStatusDeleted ResourceStatus = "deleted"
const ResourceStatusError ResourceStatus = "error"
Tags []string

Tags attached to the node pool.

UpdatedAt Time

When the node pool was last updated.

formatdate-time
type NKSNodePoolBootVolume struct{…}

Boot volume configuration.

Size int64

Size of the boot volume in GB.

maximum512
minimum64

Type of the Volume.

One of the following:
const VolumeTypeNvme VolumeType = "nvme"
const VolumeTypeABS VolumeType = "abs"
type NKSNodePoolBootVolumeResponse struct{…}

Boot volume configuration.

Size int64

Size of the boot volume in GB.

maximum512
minimum64

Type of the Volume.

One of the following:
const VolumeTypeNvme VolumeType = "nvme"
const VolumeTypeABS VolumeType = "abs"
type NKSNodePoolList struct{…}
Items []NKSNodePool
ID string

Unique identifier for the node pool.

ClusterID string

ID of the Cluster this node pool belongs to.

CreatedAt Time

When the node pool was created.

formatdate-time
Name string

Name of the node pool.

Node configuration.

Boot volume configuration.

Size int64

Size of the boot volume in GB.

maximum512
minimum64

Type of the Volume.

One of the following:
const VolumeTypeNvme VolumeType = "nvme"
const VolumeTypeABS VolumeType = "abs"
InstanceType string

Instance type name.

Labels []string

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

NodeCount int64

Number of nodes.

Status of the resource.

One of the following:
const ResourceStatusPending ResourceStatus = "pending"
const ResourceStatusCreating ResourceStatus = "creating"
const ResourceStatusUpdating ResourceStatus = "updating"
const ResourceStatusReady ResourceStatus = "ready"
const ResourceStatusDeleting ResourceStatus = "deleting"
const ResourceStatusDeleted ResourceStatus = "deleted"
const ResourceStatusError ResourceStatus = "error"
Tags []string

Tags attached to the node pool.

UpdatedAt Time

When the node pool was last updated.

formatdate-time
type NKSNodePoolNodeConfig struct{…}

Node configuration.

Boot volume configuration.

Size int64

Size of the boot volume in GB.

maximum512
minimum64

Type of the Volume.

One of the following:
const VolumeTypeNvme VolumeType = "nvme"
const VolumeTypeABS VolumeType = "abs"
InstanceType string

Instance type name used for worker nodes.

Labels []stringOptional

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.

type NKSNodePoolNodeConfigResponse struct{…}

Node configuration.

Boot volume configuration.

Size int64

Size of the boot volume in GB.

maximum512
minimum64

Type of the Volume.

One of the following:
const VolumeTypeNvme VolumeType = "nvme"
const VolumeTypeABS VolumeType = "abs"
InstanceType string

Instance type name.

Labels []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.New(ctx, clusterID, body) error
POST/v1/nks/clusters/{cluster_id}/pools/availability
Check Update NKS Node Pool Availability
client.NKS.Clusters.Pools.Availability.Update(ctx, clusterID, poolID, body) error
PATCH/v1/nks/clusters/{cluster_id}/pools/{pool_id}/availability

ClustersPoolsNodes

Get NKS Node Details
client.NKS.Clusters.Pools.Nodes.Get(ctx, clusterID, poolID, nodeID) (*NKSNode, error)
GET/v1/nks/clusters/{cluster_id}/pools/{pool_id}/nodes/{node_id}
Delete NKS Node
client.NKS.Clusters.Pools.Nodes.Delete(ctx, clusterID, poolID, nodeID) (*Operation, error)
DELETE/v1/nks/clusters/{cluster_id}/pools/{pool_id}/nodes/{node_id}
List NKS Nodes
client.NKS.Clusters.Pools.Nodes.List(ctx, clusterID, poolID, query) (*Cursor[NKSNode], error)
GET/v1/nks/clusters/{cluster_id}/pools/{pool_id}/nodes
ModelsExpand Collapse
type NKSNode struct{…}

NKS node details.

ID string

Unique identifier for the node.

CreatedAt Time

When the node was created.

formatdate-time
Name string

Name of the node.

PrivateIP string

Private IP address of the node.

Status of the resource.

One of the following:
const ResourceStatusPending ResourceStatus = "pending"
const ResourceStatusCreating ResourceStatus = "creating"
const ResourceStatusUpdating ResourceStatus = "updating"
const ResourceStatusReady ResourceStatus = "ready"
const ResourceStatusDeleting ResourceStatus = "deleting"
const ResourceStatusDeleted ResourceStatus = "deleted"
const ResourceStatusError ResourceStatus = "error"
UpdatedAt Time

When the node was last updated.

formatdate-time
type NKSNodeList struct{…}
Items []NKSNode
ID string

Unique identifier for the node.

CreatedAt Time

When the node was created.

formatdate-time
Name string

Name of the node.

PrivateIP string

Private IP address of the node.

Status of the resource.

One of the following:
const ResourceStatusPending ResourceStatus = "pending"
const ResourceStatusCreating ResourceStatus = "creating"
const ResourceStatusUpdating ResourceStatus = "updating"
const ResourceStatusReady ResourceStatus = "ready"
const ResourceStatusDeleting ResourceStatus = "deleting"
const ResourceStatusDeleted ResourceStatus = "deleted"
const ResourceStatusError ResourceStatus = "error"
UpdatedAt Time

When the node was last updated.

formatdate-time

ClustersPoolsNodesVolumes

Get NKS Node Volume Details
client.NKS.Clusters.Pools.Nodes.Volumes.Get(ctx, clusterID, poolID, nodeID, volumeID) (*NKSNodeVolume, error)
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(ctx, clusterID, poolID, nodeID, query) (*Cursor[NKSNodeVolume], error)
GET/v1/nks/clusters/{cluster_id}/pools/{pool_id}/nodes/{node_id}/volumes
ModelsExpand Collapse
type NKSNodeVolume struct{…}

NKS node volume details.

ID string

Unique identifier for the volume.

CreatedAt Time

When the volume was created.

formatdate-time

Volume kind.

One of the following:
const VolumeKindBoot VolumeKind = "boot"
const VolumeKindData VolumeKind = "data"
Name string

Name of the volume.

Size int64

Size of the volume in GB.

Status of the resource.

One of the following:
const ResourceStatusPending ResourceStatus = "pending"
const ResourceStatusCreating ResourceStatus = "creating"
const ResourceStatusUpdating ResourceStatus = "updating"
const ResourceStatusReady ResourceStatus = "ready"
const ResourceStatusDeleting ResourceStatus = "deleting"
const ResourceStatusDeleted ResourceStatus = "deleted"
const ResourceStatusError ResourceStatus = "error"

Type of the Volume.

One of the following:
const VolumeTypeNvme VolumeType = "nvme"
const VolumeTypeABS VolumeType = "abs"
UpdatedAt Time

When the volume was last updated.

formatdate-time
type NKSNodeVolumeList struct{…}
ID string

Unique identifier for the volume.

CreatedAt Time

When the volume was created.

formatdate-time

Volume kind.

One of the following:
const VolumeKindBoot VolumeKind = "boot"
const VolumeKindData VolumeKind = "data"
Name string

Name of the volume.

Size int64

Size of the volume in GB.

Status of the resource.

One of the following:
const ResourceStatusPending ResourceStatus = "pending"
const ResourceStatusCreating ResourceStatus = "creating"
const ResourceStatusUpdating ResourceStatus = "updating"
const ResourceStatusReady ResourceStatus = "ready"
const ResourceStatusDeleting ResourceStatus = "deleting"
const ResourceStatusDeleted ResourceStatus = "deleted"
const ResourceStatusError ResourceStatus = "error"

Type of the Volume.

One of the following:
const VolumeTypeNvme VolumeType = "nvme"
const VolumeTypeABS VolumeType = "abs"
UpdatedAt Time

When the volume was last updated.

formatdate-time