Get details for a Kubernetes cluster
curl --request GET \
--url https://{host}/api/v2/kubernetes/clusters/{clusterName} \
--header 'Authorization: Bearer <token>'import requests
url = "https://{host}/api/v2/kubernetes/clusters/{clusterName}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{host}/api/v2/kubernetes/clusters/{clusterName}', 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://{host}/api/v2/kubernetes/clusters/{clusterName}",
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://{host}/api/v2/kubernetes/clusters/{clusterName}"
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://{host}/api/v2/kubernetes/clusters/{clusterName}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/api/v2/kubernetes/clusters/{clusterName}")
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{
"cluster": "<string>",
"firstCollectionTime": "2023-11-07T05:31:56Z",
"lastCollectionTime": "2023-11-07T05:31:56Z",
"nodeCount": "<string>",
"nodeGroupCount": "<string>",
"containerCount": "<string>",
"kubexAgentVersion": "<string>",
"kubernetesVersion": "<string>",
"prometheusVersion": "<string>",
"namespaces": [
{
"namespace": "<string>",
"pods": [
{
"podOwnerName": "<string>",
"containers": [
"<string>"
]
}
]
}
]
}{
"status": 123,
"message": "<string>"
}{
"status": 123,
"message": "<string>"
}{
"status": 123,
"message": "<string>"
}Kubernetes
Get details for a Kubernetes cluster
Returns namespaces, pods, and containers for the specified cluster.
GET
/
kubernetes
/
clusters
/
{clusterName}
Get details for a Kubernetes cluster
curl --request GET \
--url https://{host}/api/v2/kubernetes/clusters/{clusterName} \
--header 'Authorization: Bearer <token>'import requests
url = "https://{host}/api/v2/kubernetes/clusters/{clusterName}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{host}/api/v2/kubernetes/clusters/{clusterName}', 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://{host}/api/v2/kubernetes/clusters/{clusterName}",
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://{host}/api/v2/kubernetes/clusters/{clusterName}"
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://{host}/api/v2/kubernetes/clusters/{clusterName}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/api/v2/kubernetes/clusters/{clusterName}")
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{
"cluster": "<string>",
"firstCollectionTime": "2023-11-07T05:31:56Z",
"lastCollectionTime": "2023-11-07T05:31:56Z",
"nodeCount": "<string>",
"nodeGroupCount": "<string>",
"containerCount": "<string>",
"kubexAgentVersion": "<string>",
"kubernetesVersion": "<string>",
"prometheusVersion": "<string>",
"namespaces": [
{
"namespace": "<string>",
"pods": [
{
"podOwnerName": "<string>",
"containers": [
"<string>"
]
}
]
}
]
}{
"status": 123,
"message": "<string>"
}{
"status": 123,
"message": "<string>"
}{
"status": 123,
"message": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Unique cluster name from /kubernetes/clusters or the Kubex UI Connections tab.
Response
Cluster details
Cluster name as specified in config.yaml.
When data collection started (UTC).
Most recent data collection time (UTC).
Number of nodes discovered in the cluster.
Number of node groups discovered in the cluster.
Number of containers discovered in the cluster.
Data forwarder (Kubex agent) version.
Kubernetes version.
Prometheus version.
Namespaces discovered in the cluster.
Show child attributes
Show child attributes

