curl --request GET \
--url {scheme}://{host}:{port}/{basePath}/clusters/{name} \
--header 'X-API-Key: <api-key>'import requests
url = "{scheme}://{host}:{port}/{basePath}/clusters/{name}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('{scheme}://{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 => "{scheme}://{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 => [
"X-API-Key: <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 := "{scheme}://{host}:{port}/{basePath}/clusters/{name}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<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("{scheme}://{host}:{port}/{basePath}/clusters/{name}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("{scheme}://{host}:{port}/{basePath}/clusters/{name}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"apiVersion": "v1",
"kind": "ClusterRegistration",
"spec": {
"name": "prod-us-east-1",
"namespace": "chatcli-system",
"displayName": "Production US East 1",
"region": "us-east-1",
"environment": "prod",
"tier": "critical",
"connected": true,
"version": "v1.31.2",
"nodeCount": 12,
"namespaceCount": 25,
"activeIssues": 2,
"activeRemediations": 1,
"lastHealthCheck": "2026-03-19T15:29:00Z",
"creationTimestamp": "2026-01-05T10:00:00Z"
},
"status": {
"name": "prod-us-east-1",
"namespace": "chatcli-system",
"displayName": "Production US East 1",
"region": "us-east-1",
"environment": "prod",
"tier": "critical",
"connected": true,
"version": "v1.31.2",
"nodeCount": 12,
"namespaceCount": 25,
"activeIssues": 2,
"activeRemediations": 1,
"lastHealthCheck": "2026-03-19T15:29:00Z",
"creationTimestamp": "2026-01-05T10:00:00Z"
},
"resourceMeta": {
"name": "prod-us-east-1",
"namespace": "chatcli-system",
"uid": "a41f0c2e-7d3b-4e9a-b5c6-0f8e2d1a9b37",
"creationTimestamp": "2026-01-05T10:00:00Z"
}
}
{
"apiVersion": "v1",
"kind": "Error",
"error": "Not Found",
"code": 404,
"message": "cluster not found: clusterregistrations \"prod-us-east-1\" not found in any namespace"
}
Obter Cluster
Retorna um ClusterRegistration com status de saúde, número de nós e incidentes ativos
curl --request GET \
--url {scheme}://{host}:{port}/{basePath}/clusters/{name} \
--header 'X-API-Key: <api-key>'import requests
url = "{scheme}://{host}:{port}/{basePath}/clusters/{name}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('{scheme}://{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 => "{scheme}://{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 => [
"X-API-Key: <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 := "{scheme}://{host}:{port}/{basePath}/clusters/{name}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<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("{scheme}://{host}:{port}/{basePath}/clusters/{name}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("{scheme}://{host}:{port}/{basePath}/clusters/{name}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"apiVersion": "v1",
"kind": "ClusterRegistration",
"spec": {
"name": "prod-us-east-1",
"namespace": "chatcli-system",
"displayName": "Production US East 1",
"region": "us-east-1",
"environment": "prod",
"tier": "critical",
"connected": true,
"version": "v1.31.2",
"nodeCount": 12,
"namespaceCount": 25,
"activeIssues": 2,
"activeRemediations": 1,
"lastHealthCheck": "2026-03-19T15:29:00Z",
"creationTimestamp": "2026-01-05T10:00:00Z"
},
"status": {
"name": "prod-us-east-1",
"namespace": "chatcli-system",
"displayName": "Production US East 1",
"region": "us-east-1",
"environment": "prod",
"tier": "critical",
"connected": true,
"version": "v1.31.2",
"nodeCount": 12,
"namespaceCount": 25,
"activeIssues": 2,
"activeRemediations": 1,
"lastHealthCheck": "2026-03-19T15:29:00Z",
"creationTimestamp": "2026-01-05T10:00:00Z"
},
"resourceMeta": {
"name": "prod-us-east-1",
"namespace": "chatcli-system",
"uid": "a41f0c2e-7d3b-4e9a-b5c6-0f8e2d1a9b37",
"creationTimestamp": "2026-01-05T10:00:00Z"
}
}
{
"apiVersion": "v1",
"kind": "Error",
"error": "Not Found",
"code": 404,
"message": "cluster not found: clusterregistrations \"prod-us-east-1\" not found in any namespace"
}
viewer. spec e status trazem o mesmo objeto achatado (veja os campos em Listar Clusters). A referência ao Secret de kubeconfig, o intervalo de health check, as capabilities e as conditions não são retornados; use kubectl get clusterregistration <nome> -o yaml para isso.
{
"apiVersion": "v1",
"kind": "ClusterRegistration",
"spec": {
"name": "prod-us-east-1",
"namespace": "chatcli-system",
"displayName": "Production US East 1",
"region": "us-east-1",
"environment": "prod",
"tier": "critical",
"connected": true,
"version": "v1.31.2",
"nodeCount": 12,
"namespaceCount": 25,
"activeIssues": 2,
"activeRemediations": 1,
"lastHealthCheck": "2026-03-19T15:29:00Z",
"creationTimestamp": "2026-01-05T10:00:00Z"
},
"status": {
"name": "prod-us-east-1",
"namespace": "chatcli-system",
"displayName": "Production US East 1",
"region": "us-east-1",
"environment": "prod",
"tier": "critical",
"connected": true,
"version": "v1.31.2",
"nodeCount": 12,
"namespaceCount": 25,
"activeIssues": 2,
"activeRemediations": 1,
"lastHealthCheck": "2026-03-19T15:29:00Z",
"creationTimestamp": "2026-01-05T10:00:00Z"
},
"resourceMeta": {
"name": "prod-us-east-1",
"namespace": "chatcli-system",
"uid": "a41f0c2e-7d3b-4e9a-b5c6-0f8e2d1a9b37",
"creationTimestamp": "2026-01-05T10:00:00Z"
}
}
{
"apiVersion": "v1",
"kind": "Error",
"error": "Not Found",
"code": 404,
"message": "cluster not found: clusterregistrations \"prod-us-east-1\" not found in any namespace"
}
Autorizações
API key sent in the X-API-Key header. Keys are read from the Secret chatcli-operator-secrets, key api-keys (fallback: ConfigMap chatcli-operator-config, key api-keys) in the operator namespace, as a YAML list of {key, role, name, description} (name is the identity recorded on approval decisions); the operator chart creates it only with apiKeys.create: true. Roles: viewer < operator < admin — any other role string is denied everywhere. Changes are picked up within about 30 seconds; deleting both the Secret and the ConfigMap revokes every key. With no keys configured every /api/ call returns 401, unless CHATCLI_OPERATOR_DEV_MODE=true, which grants admin without a key (development only).
Parâmetros de caminho
ClusterRegistration name.
"prod-us-east-1"
Parâmetros de consulta
Namespace of the object. When omitted, all namespaces are searched and the first object with this name is used.