Sign in

v52

latestOpenAPI 3.0.3GNU Affero General Public License v3.0 (AGPL-3.0)raw.githubusercontent.com2026-08-0113040156.8 KB
Kubernetes Cluster

List kubernetes clusters in a location

get/project/{project_id}/location/{location}/kubernetes-cluster

Path parameters

locationstring required
Example:eu-central-h1

The Ubicloud location/region

project_idstring required
Example:pjkkmx0f2vke4h36nk9cm8v8q0

ID of the project

Query parameters

start_afterstring

Pagination - Start after

page_sizeinteger

Pagination - Page size

order_columnstring

Pagination - Order column

Response

A list of KubernetesClusters

countinteger required

Example response

{
  "items": [
    {
      "cp_vms": [
        {
          "id": "vmhfy8gff8c67hasb0eez2k1pd",
          "location": "eu-central-h1",
          "name": "my-vm-name"
        }
      ],
      "id": "kcqxhqbg86sj0ng5e9ck5n191z",
      "location": "eu-central-h1",
      "name": "my-cluster-name",
      "nodepools": [
        {
          "kubernetes_cluster_id": "kcqxhqbg86sj0ng5e9ck5n191z",
          "id": "knqxhqbg86sj0ng5e9ck5n191z",
          "name": "my-nodepool-name",
          "vms": [
            {
              "id": "vmhfy8gff8c67hasb0eez2k1pd",
              "location": "eu-central-h1",
              "name": "my-vm-name"
            }
          ]
        }
      ]
    }
  ]
}