GET
/
project
/
{project_id}
/
kubernetes-cluster
curl --request GET \
  --url https://api.ubicloud.com/project/{project_id}/kubernetes-cluster \
  --header 'Authorization: Bearer <token>'
{
  "count": 123,
  "items": [
    {
      "cp_node_count": 123,
      "cp_vms": [
        {
          "id": "vmhfy8gff8c67hasb0eez2k1pd",
          "ip4": "127.0.0.1",
          "ip4_enabled": true,
          "ip6": "2606:4700:3108::ac42:2835",
          "location": "eu-central-h1",
          "name": "my-vm-name",
          "size": "<string>",
          "state": "<string>",
          "storage_size_gib": 123,
          "unix_user": "<string>"
        }
      ],
      "display_state": "<string>",
      "id": "kcqxhqbg86sj0ng5e9ck5n191z",
      "location": "eu-central-h1",
      "name": "my-cluster-name",
      "node_size": "<string>",
      "nodepools": [
        {
          "kubernetes_cluster_id": "kcqxhqbg86sj0ng5e9ck5n191z",
          "id": "knqxhqbg86sj0ng5e9ck5n191z",
          "name": "my-nodepool-name",
          "node_count": 123,
          "node_size": "<string>",
          "vms": [
            {
              "id": "vmhfy8gff8c67hasb0eez2k1pd",
              "ip4": "127.0.0.1",
              "ip4_enabled": true,
              "ip6": "2606:4700:3108::ac42:2835",
              "location": "eu-central-h1",
              "name": "my-vm-name",
              "size": "<string>",
              "state": "<string>",
              "storage_size_gib": 123,
              "unix_user": "<string>"
            }
          ]
        }
      ],
      "services_load_balancer_url": "<string>",
      "version": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

project_id
string
required

ID of the project

Example:

"pjkkmx0f2vke4h36nk9cm8v8q0"

Query Parameters

start_after
string

Pagination - Start after

page_size
integer
default:10

Pagination - Page size

order_column
string
default:id

Pagination - Order column

Response

200
application/json

A list of KubernetesClusters

The response is of type object.