Skip to main content

List Kubernetes clusters

Reviewed on

You can list all the Kubernetes clusters within your space.

Permissions​

info

This action requires the following IAM (Identity and Access Management) permissions:

  • kubernetes.cluster.get

API​

The request GET /kubernetes/spaces/{spaceId}/clusters lists the Kubernetes clusters of a space.

Parameters​

ParameterTypeRequiredDescription
spaceIdstringYesThe Numspot space ID.

Example response​

{
"items": [
{
"id": "123e4567-e89b-42d3-a456-426614174000",
"name": "my-kubernetes-cluster",
"version": "1.31",
"fullVersion": "1.31.1",
"cidr": "10.0.0.0/16",
"profile": "small",
"dedicatedEtcd": false,
"visibility": "EXTERNAL",
"createdOn": "2026-08-15T12:41:00Z",
"status": {
"state": "RUNNING",
"message": "Cluster is healthy"
}
}
],
"nextToken": "eyJwYWdlIjoxfQ"
}

If more results are available, the response contains a nextToken field that can be used to retrieve the next page.

View the full specification

Was this page helpful?