Skip to main content
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>'
{
  "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>"
          ]
        }
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
clusterName
string
required

Unique cluster name from /kubernetes/clusters or the Kubex UI Connections tab.

Response

Cluster details

​
cluster
string

Cluster name as specified in config.yaml.

​
firstCollectionTime
string<date-time>

When data collection started (UTC).

​
lastCollectionTime
string<date-time>

Most recent data collection time (UTC).

​
nodeCount
string

Number of nodes discovered in the cluster.

​
nodeGroupCount
string

Number of node groups discovered in the cluster.

​
containerCount
string

Number of containers discovered in the cluster.

​
kubexAgentVersion
string

Data forwarder (Kubex agent) version.

​
kubernetesVersion
string

Kubernetes version.

​
prometheusVersion
string

Prometheus version.

​
namespaces
object[]

Namespaces discovered in the cluster.