Skip to content

List Kubernetes Clusters

GET
/tenant_clusters/
curl --request GET \
  --url 'https://api.e2enetworks.com/myaccount/api/v1/gpu/tenant_clusters/?project_id=<PROJECT_ID>&location=<LOCATION>&apikey=<API_KEY>' \
  --header 'Authorization: Bearer <API_TOKEN>'

Returns the Kubernetes clusters in a project and region, newest first, with their node pools and status. Send page_no and per_page together to get one page; without them every cluster is returned.

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
project_id
required
integer

Project ID

page_no
integer

The page number from which you want your page search results to be displayed.

per_page
integer

Number of results per page

active_iam
integer

Active IAM ID (To access contact person account) Find your Active IAM ID here

location
required
string
Allowed values: Delhi Chennai

Location

Responses

Section titled “Responses”

200

Section titled “200”

The project’s clusters in this region.

Media typeapplication/json
object
code
integer
data
Array<object>
object
id
integer
name
string
description
string
nullable
region
string
status
string
Allowed values: queued cluster_provisioning worker_joining worker_joined ready failed deleting deleted
tenant_k8s_version
string
control_plane_replicas
integer
worker_replicas

The node count across all worker pools.

integer
ready_workers
integer
node_pools
Array<object>
object
id
integer
tenant_cluster_id
integer
name
string
role
string
Allowed values: control_plane worker
status

resizing while the pool moves to a new fixed size, scaling while its autoscaler changes the node count.

string
Allowed values: queued joining ready resizing scaling failed deleting
replicas

The node count the pool is set to.

integer
ready_replicas

The pool’s nodes that are up and ready.

integer
labels
Array<object>
object
key
required

The key without the node.e2enetworks.com/ prefix, which the platform adds. Up to 63 letters, numbers, -, _, or ., starting and ending with a letter or number.

string
<= 63 characters
value
required

Required. The same characters as the key.

string
<= 63 characters
taints
Array<object>
object
key
required

The key without the node.e2enetworks.com/ prefix, which the platform adds. Up to 63 letters, numbers, -, _, or ., starting and ending with a letter or number.

string
<= 63 characters
value

May be empty.

string
<= 63 characters
effect
required

NoExecute evicts running pods that do not tolerate the taint.

string
Allowed values: NoSchedule PreferNoSchedule NoExecute
sku_details

The computing resource and pricing plan a node pool runs on.

object
specs
object
sku_id
integer
name
string
series
string
cpu
integer
memory
integer
plan
object
sku_item_price_id
integer
sku_type

hourly or committed.

string
committed_days
integer
unit_price
number
currency
string
committed_info

Set only for a pool on a committed plan.

object
updation_policy
string
Allowed values: auto_renew convert_to_hourly_billing
next_sku_item_price

The computing resource and pricing plan a node pool runs on.

object
specs
object
sku_id
integer
name
string
series
string
cpu
integer
memory
integer
plan
object
sku_item_price_id
integer
sku_type

hourly or committed.

string
committed_days
integer
unit_price
number
currency
string
end_date
string format: date-time
nullable
autoscaling

The pool’s size bounds. A min_replicas lower than max_replicas means the pool is autoscaled; equal values are a fixed size.

object
min_replicas
integer
max_replicas
integer
created_at
string format: date-time
updated_at
string format: date-time
vpc

The VPC and subnet the cluster’s nodes take their addresses from.

object
vpc_id
integer
name
string
cidr
string
subnet
object
subnet_id
integer
name
string
cidr
string
gateway_ip
string
created_at
string format: date-time
updated_at
string format: date-time
errors
object
message
string
total_page_number

Only when page_no and per_page are sent.

integer
total_count

Only when page_no and per_page are sent.

integer

Example 

{
  "code": 200,
  "data": [
    {
      "id": 103,
      "name": "tir-k8s-prod",
      "description": "Production cluster",
      "region": "Delhi",
      "status": "queued",
      "tenant_k8s_version": "v1.31.4",
      "control_plane_replicas": 3,
      "worker_replicas": 2,
      "ready_workers": 2,
      "node_pools": [
        {
          "id": 22,
          "tenant_cluster_id": 103,
          "name": "app-workers",
          "role": "control_plane",
          "status": "queued",
          "replicas": 2,
          "ready_replicas": 2,
          "labels": [
            {
              "key": "team",
              "value": "ml"
            }
          ],
          "taints": [
            {
              "key": "dedicated",
              "value": "gpu",
              "effect": "NoSchedule"
            }
          ],
          "sku_details": {
            "specs": {
              "sku_id": 101,
              "name": "C3.8GB",
              "series": "CPU",
              "cpu": 4,
              "memory": 8
            },
            "plan": {
              "sku_item_price_id": 1001,
              "sku_type": "hourly",
              "committed_days": 0,
              "unit_price": 4.5,
              "currency": "INR"
            }
          },
          "committed_info": {
            "updation_policy": "auto_renew",
            "next_sku_item_price": {
              "specs": {
                "sku_id": 101,
                "name": "C3.8GB",
                "series": "CPU",
                "cpu": 4,
                "memory": 8
              },
              "plan": {
                "sku_item_price_id": 1001,
                "sku_type": "hourly",
                "committed_days": 0,
                "unit_price": 4.5,
                "currency": "INR"
              }
            },
            "end_date": "2026-11-20T10:15:00Z"
          },
          "autoscaling": {
            "min_replicas": 2,
            "max_replicas": 2
          },
          "created_at": "2026-10-20T10:15:00Z",
          "updated_at": "2026-10-20T10:42:00Z"
        }
      ],
      "vpc": {
        "vpc_id": 55,
        "name": "prod-vpc",
        "cidr": "10.10.0.0/16",
        "subnet": {
          "subnet_id": 77,
          "name": "prod-subnet",
          "cidr": "10.10.0.0/24",
          "gateway_ip": "10.10.0.1"
        }
      },
      "created_at": "2026-10-20T10:15:00Z",
      "updated_at": "2026-10-20T10:42:00Z"
    }
  ],
  "errors": {},
  "message": "Success",
  "total_page_number": 1,
  "total_count": 1
}

© E2E Networks Limited · CIN L72900DL2009PLC341980