List node groups for a Kubernetes cluster

GET/v1/kubernetes_clusters/{kubernetes_cluster_id}/node_groups

To list all node groups within a cluster, perform a GET request to /v1/kubernetes_clusters/{kubernetes_cluster_id}/node_groups. The path parameter selects a certain cluster.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

FieldDetails
kubernetes_cluster_id
string

A unique identifier of a Kubernetes cluster. To list all cluster IDs, use the relevant request.

Query Parameters

FieldDetails
sorting?
string

Value in: "id", "name", "created_at", "updated_at"

Default: "id"

This parameter sorts items. By default, it's id. Also, it's possible to sort by name, updated_at, and created_at.

direction?
string

Value in: "ASC", "DESC"

Default: "ASC"

This parameter defines if items are sorted in an ascending ASC or descending DESC order. By default, ASC is set up.

per_page?
integer

Default: 20

Range: 1–100

The number of results [ 1 .. 100 ] displayed on a page. By default, 20 results are shown.

page?
integer

Default: 1

Min: 1

The number of a page (>= 1) that will be returned. By default, it's 1.

Response Body

application/json

curl -X GET "https://example.com/v1/kubernetes_clusters/N1aMj3bW/node_groups"
[  {    "id": "Mvbmw0eY",    "name": "node-group-99",    "description": null,    "node_count": 0,    "created_at": "2025-12-31T00:00:00.000Z",    "updated_at": "2025-12-31T00:00:00.000Z"  },  {    "id": "openZle7",    "name": "node-group-100",    "description": null,    "node_count": 0,    "created_at": "2025-12-31T00:00:00.000Z",    "updated_at": "2025-12-31T00:00:00.000Z"  }]