Skip to main content
GET
/
project
/
{project_id}
/
kubernetes-cluster
List all kubernetes clusters
curl --request GET \
  --url https://api.ubicloud.com/project/{project_id}/kubernetes-cluster \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.ubicloud.com/project/{project_id}/kubernetes-cluster"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.ubicloud.com/project/{project_id}/kubernetes-cluster', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ubicloud.com/project/{project_id}/kubernetes-cluster",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.ubicloud.com/project/{project_id}/kubernetes-cluster"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.ubicloud.com/project/{project_id}/kubernetes-cluster")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.ubicloud.com/project/{project_id}/kubernetes-cluster")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "count": 123,
  "items": [
    {
      "cp_node_count": 123,
      "id": "kcqxhqbg86sj0ng5e9ck5n191z",
      "location": "eu-central-h1",
      "name": "my-cluster-name",
      "node_size": "<string>",
      "version": "<string>",
      "cp_vms": [
        {
          "boot_image": "<string>",
          "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>",
      "nodepools": [
        {
          "kubernetes_cluster_id": "kcqxhqbg86sj0ng5e9ck5n191z",
          "id": "knqxhqbg86sj0ng5e9ck5n191z",
          "name": "my-nodepool-name",
          "node_count": 123,
          "node_size": "<string>",
          "vms": [
            {
              "boot_image": "<string>",
              "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>"
    }
  ]
}
{
"error": {
"code": 401,
"message": "There was an error logging in",
"type": "InvalidCredentials",
"details": {}
}
}

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

Pattern: ^pj[0-9a-hj-km-np-tv-z]{24}$
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

A list of KubernetesClusters

count
integer
required
items
object[]
required