List Clusters
curl --request GET \
--url http://{host}:{port}/{basePath}/clusters \
--header 'Authorization: <api-key>'import requests
url = "http://{host}:{port}/{basePath}/clusters"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('http://{host}:{port}/{basePath}/clusters', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "62437",
CURLOPT_URL => "http://{host}:{port}/{basePath}/clusters",
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: <api-key>"
],
]);
$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 := "http://{host}:{port}/{basePath}/clusters"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://{host}:{port}/{basePath}/clusters")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("http://{host}:{port}/{basePath}/clusters")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"apiVersion": "v1",
"kind": "ClusterList",
"metadata": {
"totalCount": 4
},
"items": [
{
"name": "prod-sa-east-1",
"region": "sa-east-1",
"provider": "aws",
"version": "1.29.2",
"status": "healthy",
"nodes": {
"total": 12,
"ready": 12
},
"incidents": {
"active": 2,
"total24h": 5
},
"resources": {
"cpuUsagePercent": 62,
"memoryUsagePercent": 71,
"podCount": 245,
"podCapacity": 360
},
"lastHeartbeat": "2026-03-19T15:29:00Z",
"connectedAt": "2026-01-05T10:00:00Z"
},
{
"name": "prod-us-east-1",
"region": "us-east-1",
"provider": "aws",
"version": "1.29.2",
"status": "healthy",
"nodes": {
"total": 8,
"ready": 8
},
"incidents": {
"active": 0,
"total24h": 1
},
"resources": {
"cpuUsagePercent": 45,
"memoryUsagePercent": 55,
"podCount": 180,
"podCapacity": 240
},
"lastHeartbeat": "2026-03-19T15:29:00Z",
"connectedAt": "2026-01-05T10:00:00Z"
},
{
"name": "staging-sa-east-1",
"region": "sa-east-1",
"provider": "aws",
"version": "1.30.0",
"status": "degraded",
"nodes": {
"total": 4,
"ready": 3
},
"incidents": {
"active": 1,
"total24h": 3
},
"resources": {
"cpuUsagePercent": 78,
"memoryUsagePercent": 82,
"podCount": 95,
"podCapacity": 120
},
"lastHeartbeat": "2026-03-19T15:28:30Z",
"connectedAt": "2026-02-01T14:00:00Z"
}
]
}
Clusters
List Clusters
Returns the list of Kubernetes clusters managed by the platform (federated environment)
GET
/
clusters
List Clusters
curl --request GET \
--url http://{host}:{port}/{basePath}/clusters \
--header 'Authorization: <api-key>'import requests
url = "http://{host}:{port}/{basePath}/clusters"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('http://{host}:{port}/{basePath}/clusters', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "62437",
CURLOPT_URL => "http://{host}:{port}/{basePath}/clusters",
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: <api-key>"
],
]);
$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 := "http://{host}:{port}/{basePath}/clusters"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://{host}:{port}/{basePath}/clusters")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("http://{host}:{port}/{basePath}/clusters")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"apiVersion": "v1",
"kind": "ClusterList",
"metadata": {
"totalCount": 4
},
"items": [
{
"name": "prod-sa-east-1",
"region": "sa-east-1",
"provider": "aws",
"version": "1.29.2",
"status": "healthy",
"nodes": {
"total": 12,
"ready": 12
},
"incidents": {
"active": 2,
"total24h": 5
},
"resources": {
"cpuUsagePercent": 62,
"memoryUsagePercent": 71,
"podCount": 245,
"podCapacity": 360
},
"lastHeartbeat": "2026-03-19T15:29:00Z",
"connectedAt": "2026-01-05T10:00:00Z"
},
{
"name": "prod-us-east-1",
"region": "us-east-1",
"provider": "aws",
"version": "1.29.2",
"status": "healthy",
"nodes": {
"total": 8,
"ready": 8
},
"incidents": {
"active": 0,
"total24h": 1
},
"resources": {
"cpuUsagePercent": 45,
"memoryUsagePercent": 55,
"podCount": 180,
"podCapacity": 240
},
"lastHeartbeat": "2026-03-19T15:29:00Z",
"connectedAt": "2026-01-05T10:00:00Z"
},
{
"name": "staging-sa-east-1",
"region": "sa-east-1",
"provider": "aws",
"version": "1.30.0",
"status": "degraded",
"nodes": {
"total": 4,
"ready": 3
},
"incidents": {
"active": 1,
"total24h": 3
},
"resources": {
"cpuUsagePercent": 78,
"memoryUsagePercent": 82,
"podCount": 95,
"podCapacity": 120
},
"lastHeartbeat": "2026-03-19T15:28:30Z",
"connectedAt": "2026-02-01T14:00:00Z"
}
]
}
string
Filter by status:
healthy, degraded, unreachablestring
Filter by region (e.g.,
us-east-1, sa-east-1){
"apiVersion": "v1",
"kind": "ClusterList",
"metadata": {
"totalCount": 4
},
"items": [
{
"name": "prod-sa-east-1",
"region": "sa-east-1",
"provider": "aws",
"version": "1.29.2",
"status": "healthy",
"nodes": {
"total": 12,
"ready": 12
},
"incidents": {
"active": 2,
"total24h": 5
},
"resources": {
"cpuUsagePercent": 62,
"memoryUsagePercent": 71,
"podCount": 245,
"podCapacity": 360
},
"lastHeartbeat": "2026-03-19T15:29:00Z",
"connectedAt": "2026-01-05T10:00:00Z"
},
{
"name": "prod-us-east-1",
"region": "us-east-1",
"provider": "aws",
"version": "1.29.2",
"status": "healthy",
"nodes": {
"total": 8,
"ready": 8
},
"incidents": {
"active": 0,
"total24h": 1
},
"resources": {
"cpuUsagePercent": 45,
"memoryUsagePercent": 55,
"podCount": 180,
"podCapacity": 240
},
"lastHeartbeat": "2026-03-19T15:29:00Z",
"connectedAt": "2026-01-05T10:00:00Z"
},
{
"name": "staging-sa-east-1",
"region": "sa-east-1",
"provider": "aws",
"version": "1.30.0",
"status": "degraded",
"nodes": {
"total": 4,
"ready": 3
},
"incidents": {
"active": 1,
"total24h": 3
},
"resources": {
"cpuUsagePercent": 78,
"memoryUsagePercent": 82,
"podCount": 95,
"podCapacity": 120
},
"lastHeartbeat": "2026-03-19T15:28:30Z",
"connectedAt": "2026-02-01T14:00:00Z"
}
]
}
Authorizations
Bearer token issued by the operator. Format: Authorization: Bearer <token>.
Query Parameters
Filter by cluster status.
Available options:
healthy, degraded, unreachable Filter by region (e.g. us-east-1).
⌘I