Get Cluster
curl --request GET \
--url http://{host}:{port}/{basePath}/clusters/{name} \
--header 'Authorization: <api-key>'import requests
url = "http://{host}:{port}/{basePath}/clusters/{name}"
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/{name}', 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/{name}",
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/{name}"
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/{name}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("http://{host}:{port}/{basePath}/clusters/{name}")
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": "ClusterRegistration",
"metadata": {
"name": "production-us-east-1",
"namespace": "chatcli-system",
"createdAt": "2026-01-15T10:00:00Z"
},
"spec": {
"displayName": "Production US East 1",
"kubeconfigSecret": "cluster-prod-us-east-1-kubeconfig",
"tier": "production",
"region": "us-east-1"
},
"status": {
"phase": "Connected",
"lastHealthCheck": "2026-03-19T15:00:00Z",
"kubernetesVersion": "v1.31.2",
"nodeCount": 12,
"namespaceCount": 25,
"activeIssues": 2,
"activeRemediations": 1,
"resourceUsage": {
"cpuCapacity": "48",
"cpuUsed": "31.2",
"memoryCapacity": "192Gi",
"memoryUsed": "124Gi"
}
}
}
Clusters
Get Cluster
Returns details of a specific federated cluster including health status, node count, resource usage, and active incidents
GET
/
clusters
/
{name}
Get Cluster
curl --request GET \
--url http://{host}:{port}/{basePath}/clusters/{name} \
--header 'Authorization: <api-key>'import requests
url = "http://{host}:{port}/{basePath}/clusters/{name}"
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/{name}', 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/{name}",
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/{name}"
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/{name}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("http://{host}:{port}/{basePath}/clusters/{name}")
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": "ClusterRegistration",
"metadata": {
"name": "production-us-east-1",
"namespace": "chatcli-system",
"createdAt": "2026-01-15T10:00:00Z"
},
"spec": {
"displayName": "Production US East 1",
"kubeconfigSecret": "cluster-prod-us-east-1-kubeconfig",
"tier": "production",
"region": "us-east-1"
},
"status": {
"phase": "Connected",
"lastHealthCheck": "2026-03-19T15:00:00Z",
"kubernetesVersion": "v1.31.2",
"nodeCount": 12,
"namespaceCount": 25,
"activeIssues": 2,
"activeRemediations": 1,
"resourceUsage": {
"cpuCapacity": "48",
"cpuUsed": "31.2",
"memoryCapacity": "192Gi",
"memoryUsed": "124Gi"
}
}
}
string
required
Unique cluster registration name
string
default:"default"
Kubernetes namespace where the ClusterRegistration CR resides
{
"apiVersion": "v1",
"kind": "ClusterRegistration",
"metadata": {
"name": "production-us-east-1",
"namespace": "chatcli-system",
"createdAt": "2026-01-15T10:00:00Z"
},
"spec": {
"displayName": "Production US East 1",
"kubeconfigSecret": "cluster-prod-us-east-1-kubeconfig",
"tier": "production",
"region": "us-east-1"
},
"status": {
"phase": "Connected",
"lastHealthCheck": "2026-03-19T15:00:00Z",
"kubernetesVersion": "v1.31.2",
"nodeCount": 12,
"namespaceCount": 25,
"activeIssues": 2,
"activeRemediations": 1,
"resourceUsage": {
"cpuCapacity": "48",
"cpuUsed": "31.2",
"memoryCapacity": "192Gi",
"memoryUsed": "124Gi"
}
}
}
{
"apiVersion": "v1",
"kind": "Error",
"error": {
"code": 404,
"message": "Cluster not found",
"details": "No cluster registration named 'production-us-east-1' found"
}
}
Authorizations
Bearer token issued by the operator. Format: Authorization: Bearer <token>.
Path Parameters
Unique registration name of the cluster.
Example:
"production-us-east-1"
Query Parameters
Kubernetes namespace where the ClusterRegistration CR resides.
⌘I