Skip to main content
GET
/
kubernetes
/
clusters
/
{clusterName}
/
containers?details=true
List container recommendations with additional details
curl --request GET \
  --url 'https://{host}/api/v2/kubernetes/clusters/{clusterName}/containers?details=true' \
  --header 'Authorization: Bearer <token>'
[
  {
    "cluster": "<string>",
    "namespace": "<string>",
    "podOwnerName": "<string>",
    "podOwnerKind": "<string>",
    "container": "<string>",
    "entityId": "<string>",
    "containerId": "<string>",
    "avgContainerCount": 123,
    "currentCpuRequestmCores": 123,
    "currentCpuLimitmCores": 123,
    "currentMemRequestBytes": 123,
    "currentMemLimitBytes": 123,
    "recommendedCpuRequestmCores": 123,
    "recommendedCpuLimitmCores": 123,
    "recommendedMemRequestBytes": 123,
    "recommendedMemLimitBytes": 123,
    "estimatedSavingsPerContainer": 123,
    "analyzedOn": "2023-11-07T05:31:56Z",
    "hpaMetricName": "<string>",
    "hpaMetricThreshold": "<string>",
    "currentEphemeralStorageRequestBytes": 123,
    "currentEphemeralStorageLimitBytes": 123,
    "recommendedEphemeralStorageRequestBytes": 123,
    "recommendedEphemeralStorageLimitBytes": 123,
    "gpu": {
      "currentGpuModel": "<string>",
      "currentGpuSharingStrategy": "<string>",
      "currentGpuRequest": 123,
      "gpuComputeOptimal": 123,
      "gpuMemoryOptimalBytes": 123,
      "gpuOverallOptimal": 123,
      "recommendedGpuModel": "<string>",
      "recommendedGpuSharingStrategy": "<string>",
      "recommendedGpuRequest": 123
    },
    "predictedUptime": 123,
    "configLastChangedOn": "2023-11-07T05:31:56Z",
    "nodeGroup": [
      "<string>"
    ],
    "oomKills_last7days": 123,
    "dateFirstAudited": "2023-11-07T05:31:56Z",
    "dateLastAudited": "2023-11-07T05:31:56Z"
  }
]

Overview

This endpoint returns container recommendation details for a specific cluster with additional fields when details=true is included. For the base response format without additional details, see getKubernetesClusterContainers.

Additional Fields with details=true

When you include details=true in the query parameters, the following additional fields are included in each container recommendation:
FieldTypeDescription
predictedUptimenumber (float)Predicted uptime percentage for the container
configLastChangedOnstring (date-time)Timestamp of the most recent change to requests/limits
nodeGrouparray of stringsNames of associated node groups
oomKills_last7daysintegerNumber of OOM (Out Of Memory) events in the last 7 days
dateFirstAuditedstring (date-time)When this container was first audited (from workload history)
dateLastAuditedstring (date-time)When this container was last audited (from workload history)

Example Request

curl -X GET "https://api.example.com/api/v2/kubernetes/clusters/my-cluster/containers?details=true" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Example Response

[
  {
    "cluster": "my-cluster",
    "namespace": "production",
    "podOwnerName": "web-app",
    "podOwnerKind": "Deployment",
    "container": "nginx",
    "entityId": "abc123",
    "containerId": "def456",
    "avgContainerCount": 3,
    "currentCpuRequestmCores": 500,
    "currentCpuLimitmCores": 1000,
    "currentMemRequestBytes": 536870912,
    "currentMemLimitBytes": 1073741824,
    "recommendedCpuRequestmCores": 300,
    "recommendedCpuLimitmCores": 600,
    "recommendedMemRequestBytes": 268435456,
    "recommendedMemLimitBytes": 536870912,
    "estimatedSavingsPerContainer": 45.50,
    "analyzedOn": "2026-06-08T10:30:00Z",
    "hpaMetricName": "cpu",
    "hpaMetricThreshold": "75%",
    "currentEphemeralStorageRequestBytes": 1073741824,
    "currentEphemeralStorageLimitBytes": 2147483648,
    "recommendedEphemeralStorageRequestBytes": 536870912,
    "recommendedEphemeralStorageLimitBytes": 1073741824,
    
    // Additional fields when details=true
    "predictedUptime": 99.8,
    "configLastChangedOn": "2026-05-15T14:20:00Z",
    "nodeGroup": ["node-group-1", "node-group-2"],
    "oomKills_last7days": 2,
    "dateFirstAudited": "2026-01-10T08:00:00Z",
    "dateLastAudited": "2026-06-08T10:30:00Z"
  }
]

Use Cases

The detailed fields are particularly useful for:
  • Stability Monitoring: oomKills_last7days helps identify containers experiencing memory pressure
  • Change Tracking: configLastChangedOn shows when resource configurations were last modified
  • Historical Analysis: dateFirstAudited and dateLastAudited provide audit timeline context
  • Infrastructure Planning: nodeGroup information helps with placement and scaling decisions
  • Reliability Metrics: predictedUptime aids in understanding container availability patterns
Fields without values may be omitted from the response. All timestamps are in UTC format (YYYY-MM-DDTHH:mm:ssZ).

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.

Query Parameters

details
enum<boolean>
required

Must be set to true to get additional fields

Available options:
true

Response

Array of container recommendations with additional details

cluster
string

Cluster name as specified in the config.yaml files.

namespace
string

Namespace associated with the container.

podOwnerName
string

Name of the controller or pod owning the container.

podOwnerKind
string

Controller type (e.g., DaemonSet, Deployment, ReplicaSet, ReplicationController, StatefulSet).

container
string

Container manifest name.

entityId
string

Unique identifier for the selected cluster assigned by Kubex.

containerId
string

Unique identifier for the listed container.

avgContainerCount
integer

Average number of containers from the "In Service Instances" metric.

currentCpuRequestmCores
integer

Current CPU request (mCores).

currentCpuLimitmCores
integer

Current CPU limit (mCores).

currentMemRequestBytes
integer

Current memory request (bytes).

currentMemLimitBytes
integer

Current memory limit (bytes).

Recommended CPU request (mCores).

Recommended CPU limit (mCores).

Recommended memory request (bytes).

Recommended memory limit (bytes).

estimatedSavingsPerContainer
number<float>

Estimated savings per container when applying the recommendations.

analyzedOn
string<date-time>

Most recent analysis refresh (UTC, YYYY-MM-DDTHH:mm:ssZ).

hpaMetricName
string

HPA metric name (e.g., cpu, memory).

hpaMetricThreshold
string

HPA metric threshold (e.g., 75%).

currentEphemeralStorageRequestBytes
number

Current ephemeral storage request (bytes).

currentEphemeralStorageLimitBytes
number

Current ephemeral storage limit (bytes).

Recommended ephemeral storage request (bytes).

Recommended ephemeral storage limit (bytes).

gpu
object

GPU-related recommendations and metrics (present for GPU workloads).

predictedUptime
number<float>

Predicted uptime percentage for the container.

configLastChangedOn
string<date-time>

Timestamp of the most recent change to requests/limits.

nodeGroup
string[]

Names of associated node groups.

oomKills_last7days
integer

Number of OOM events in the last 7 days.

dateFirstAudited
string<date-time>

When this container was first audited (from workload history).

dateLastAudited
string<date-time>

When this container was last audited (from workload history).