Nirvana Labs API | NKS › Clusters › Get NKS Cluster Details

post/v1/nks/clusters

Create an NKS Cluster

Get NKS Cluster Details ->

get/v1/nks/clusters/{cluster_id}

Get details about an NKS cluster

path Parameters

cluster_id: string

Response fields

Request example

curl https://api.nirvanalabs.io/v1/nks/clusters/$CLUSTER_ID \
    -H "Authorization: Bearer $NIRVANA_LABS_API_KEY"

200Example

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2025-01-01T00:00:00Z",
  "name": "my-cluster",
  "pool_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "private_ip": "10.0.0.254",
  "project_id": "123e4567-e89b-12d3-a456-426614174000",
  "public_ip": "198.51.100.1",
  "region": "us-wdc-1",
  "status": "ready",
  "tags": [
    "production",
    "ethereum"
  ],
  "updated_at": "2025-01-01T00:00:00Z",
  "vpc_id": "123e4567-e89b-12d3-a456-426614174000"
}

Update NKS Cluster ->

patch/v1/nks/clusters/{cluster_id}

Update an NKS cluster

Delete NKS Cluster ->

delete/v1/nks/clusters/{cluster_id}

Delete an NKS cluster

List NKS Clusters -> Cursor<

get/v1/nks/clusters

List all NKS clusters

Domain types

Kubeconfig = { kubeconfig }

Kubeconfig for an NKS Cluster.

NKSCluster = { id, created_at, name, 9 more... }

NKS Cluster details.

NKSClusterList = { items, pagination }

Availability

nks.clusters.availability

Methods

Check Create NKS Cluster Availability ->

post/v1/nks/clusters/availability

Check if an NKS cluster can be created

Check Update NKS Cluster Availability ->

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

Check if an NKS cluster can be updated

Controllers

nks.clusters.controllers

Methods

Get NKS Controller Details ->

NKSController

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

Get details about an NKS controller

List NKS Controllers -> Cursor<

NKSController

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

List all controllers in an NKS cluster

Domain types

NKSController = { id, cpu_config, created_at, 5 more... }

NKS controller details.

NKSControllerCPUConfigResponse = { vcpu }

CPU configuration.

NKSControllerList = { items, pagination }

NKSControllerMemoryConfigResponse = { size }

Memory configuration.

NKS Clusters Controllers

Volumes

nks.clusters.controllers.volumes

Methods

Get NKS Controller Volume Details ->

NKSControllerVolume

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

Get details about a volume attached to an NKS controller

List NKS Controller Volumes -> Cursor<

NKSControllerVolume

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

List all volumes attached to an NKS controller

Domain types

NKSControllerVolume = { id, created_at, kind, 5 more... }

NKS controller volume details.

NKSControllerVolumeList = { items, pagination }

Kubeconfig

nks.clusters.kubeconfig

Methods

Get NKS Cluster Kubeconfig ->

Kubeconfig

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

Get the kubeconfig for an NKS cluster

Load Balancers

nks.clusters.load_balancers

Methods

Get NKS Load Balancer Details ->

NKSLoadBalancer

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

Get details about an NKS load balancer

List NKS Load Balancers -> Cursor<

NKSLoadBalancer

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

List all load balancers in an NKS cluster

Domain types

NKSLoadBalancer = { id, cluster_id, created_at, 7 more... }

NKS load balancer details.

NKSLoadBalancerList = { items, pagination }

Persistent Volume Claims

nks.clusters.persistent_volume_claims

Methods

Get NKS Persistent Volume Claim Details ->

PersistentVolumeClaim

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

Get details about an NKS persistent volume claim

List NKS Persistent Volume Claims -> Cursor<

PersistentVolumeClaim

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

List all persistent volume claims in an NKS cluster

Domain types

PersistentVolumeClaim = { id, cluster_id, created_at, 5 more... }

NKS persistent volume claim details.

PersistentVolumeClaimList = { items, pagination }

Pools

nks.clusters.pools

Methods

Create NKS Node Pool ->

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

Create a node pool in an NKS cluster

Get NKS Node Pool Details ->

NKSNodePool

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

Get details about an NKS node pool

Update NKS Node Pool ->

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

Update an NKS node pool

Delete NKS Node Pool ->

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

Delete an NKS node pool

List NKS Node Pools -> Cursor<

NKSNodePool

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

List all node pools in an NKS cluster

Domain types

NKSNodePool = { id, cluster_id, created_at, 6 more... }

NKS node pool details.

NKSNodePoolBootVolume = { size, type }

Boot volume configuration.

NKSNodePoolBootVolumeResponse = { size, type }

Boot volume configuration.

NKSNodePoolCPUConfig = { vcpu }

CPU configuration.

NKSNodePoolCPUConfigResponse = { vcpu }

CPU configuration.

NKSNodePoolList = { items, pagination }

NKSNodePoolMemoryConfig = { size }

Memory configuration.

NKSNodePoolMemoryConfigResponse = { size }

Memory configuration.

NKSNodePoolNodeConfig = { boot_volume, cpu_config, memory_config }

Node configuration.

NKSNodePoolNodeConfigResponse = { boot_volume, cpu_config, memory_config }

Node configuration.

NKS Clusters Pools

Availability

nks.clusters.pools.availability

Methods

Check Create NKS Node Pool Availability ->

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

Check if a node pool can be created in an NKS cluster

Check Update NKS Node Pool Availability ->

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

Check if an NKS node pool can be updated

NKS Clusters Pools

Nodes

nks.clusters.pools.nodes

Methods

Get NKS Node Details ->

NKSNode

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

Get details about an NKS node

Delete NKS Node ->