Get NKS Cluster Details

client.nks.clusters.get(, ?): NKSCluster { id, autoscaling, created_at, 11 more }

GET/v1/nks/clusters/{cluster_id}

Get details about an NKS cluster

ParametersExpand Collapse

clusterID: string

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

Get NKS Cluster Details

import NirvanaLabs from '@nirvana-labs/nirvana';

const client = new NirvanaLabs({
  apiKey: process.env['NIRVANA_LABS_API_KEY'], // This is the default and can be omitted
});

const nksCluster = await client.nks.clusters.get('cluster_id');

console.log(nksCluster.id);

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "autoscaling": true,
  "created_at": "2025-01-01T00:00:00Z",
  "kubernetes_version": "v1.34.4",
  "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-sva-2",
  "status": "ready",
  "tags": [
    "production",
    "ethereum"
  ],
  "updated_at": "2025-01-01T00:00:00Z",
  "vpc_id": "123e4567-e89b-12d3-a456-426614174000"
}

Returns Examples

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "autoscaling": true,
  "created_at": "2025-01-01T00:00:00Z",
  "kubernetes_version": "v1.34.4",
  "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-sva-2",
  "status": "ready",
  "tags": [
    "production",
    "ethereum"
  ],
  "updated_at": "2025-01-01T00:00:00Z",
  "vpc_id": "123e4567-e89b-12d3-a456-426614174000"
}