Kubernetes Clusters

Kubernetes Clusters

#340820

Description

This resource is used to return all clusters, as specified in the data forwarder.

No filtering is applied.

This endpoint does not require the analysis ID that is required when using the /systems and /results endpoints.

Resources

  • /kubernetes/clusters
  • /kubernetes/clusters/<clusterName>

Supported Operations

Table: Kubernetes Container Systems Supported Operations

HTTP Method

Input

Output

Description

GET /
kubernetes/clusters

Path Parameter:

N/A

Collection of:

Use this resource to return a list of clusters from which data is being collected.

GET /
kubernetes/clusters/<clusterName>

Path Parameter:

clusterName

Collection of:

Use this resource to retrieve additional details for a specific Kubernetes cluster.

This endpoint returns a structured view, including namespaces, pods, and containers.

Parameters

Path Parameters

Table: Kubernetes Clusters Path Parameters

Parameter Name

Type

Description

clusterName

string

The unique cluster name obtained from the output of /kubernetes/clusters or from the Kubex UI Connections tab.

Response

Table: Kubernetes Container Clusters Response Schema

Element

Type

Filter/Sort

Description

cluster

string

 

The cluster name as specified in the config.yaml files.

firstCollectionTime

date

 

The date and time on which data collection started, in the format: YYYY-MM-DDTHH:mm:ssZ.

lastCollectionTime

date

 

The date and time of the most recent data collection, in the format: YYYY-MM-DDTHH:mm:ssZ.

nodeCount

string

 

The number of nodes discovered in this cluster.

nodeGroupCount

string

 

The number of node groups discovered in this cluster.

containerCount

string

 

The number of containers discovered in this cluster.

kubexAgentVersion

string

 

The data forwarder version.

kubernetesVersion

string

 

The Kubernetes version.

prometheusVersion

string

 

The Prometheus version.

namespace

string

 

The name of the namespace.

podOwnerName

string

 

The pod owner's name.

containers

string

 

The names of the containers in the selected pod.

Examples

Example: Listing All Kubernetes Clusters

The following example shows you how to return all clusters included in data collection.

Request:

Copy 
GET {{scheme}}://{{host}}{{port}}/api/v2/kubernetes/clusters

Response:

Copy

Example: Listing All Clusters

{
    "cluster": "eks_oss_dev",
    "firstCollectionTime": "2025-02-03T09:00:00Z",
    "lastCollectionTime": "2025-03-18T011:00:00Z",
    "nodeCount": 10",
    "nodeGroupCount": 5",
    "ContainerCount": 100",
    "kubexAgentVersion": "v4.1.2",
    "kubernetesVersion": "v1.31.5",
    "prometheusVersion": "2.54.1"
                            
},
                            
{
    "cluster": "gke-arm64",
    "firstCollectionTime": "2025-02-12T19:00:00Z",
    "lastCollectionTime": "2025-03-18T011:00:00Z",
    "nodeCount": 3",
    "nodeGroupCount": 2",
    "ContainerCount": 33",
    "kubexAgentVersion": "v4.1.2",
    "kubernetesVersion": "v1.31.6-gke.100",
    "prometheusVersion": "2.54.1"
},
                            
{                                                    
...
},                            

Example: Listing Specific Cluster Details

The following example shows you how to return details for a specific named cluster.

Request:

Copy 
GET {{scheme}}://{{host}}{{port}}/api/v2/kubernetes/clusters/eks_oss_dev

Response:

Copy

Example: Listing Specific Cluster Details

{
    "cluster": "eks_oss_dev",
    "firstCollectionTime": "2025-02-03T09:00:00Z",
    "lastCollectionTime": "2025-03-18T011:00:00Z",
    "nodeCount": 10",
    "nodeGroupCount": 5",
    "ContainerCount": 100",
    "kubexAgentVersion": "v4.1.2",
    "kubernetesVersion": "v1.32.2-eks-bc803b4",
    "prometheusVersion": "2.54.1",
    "namespaces": [                                                                                    
        {
            "namespace": "production",
            "pods": [
                {
                    "podOwnerName": "webserver-1",
                    "containers": [
                            "apache", "security-agent"
                    ] 
                }
            ]
        },
        {
            "namespace": "kube-system",
            "pods": [
                {
                    "podOwnerName": "aws-node",
                    "containers": [
                             "aws-node",
                             "aws-eks-nodeagent"
                    ] 
                },
                {
                    "podOwnerName": "densify-job",
                    "containers": [
                    "data-forwarder"
                    ]
                }
            ]
        },
            ....
        }
    ]
}