Skip to main content
API Explorer|API Explorer
Monitoring & Collection/Zaku
GETZakuSince 1.0SynchronousAuth Required

GetResourceHierarchy

Get the full namespace and workload hierarchy of a cluster

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Request Inputs

Path Parameters

  • clusterUuidStringRequired

    UUID of the cluster to retrieve hierarchy for

Responses

200 OK

On success, this API returns the following response structure.

  • clusterObject

    Cluster for this resource

    • uuidString

      Unique identifier of the cluster

      Example: cluster-abc123

    • platformIdString

      Platform ID this cluster belongs to

      Example: plat-001

    • zakuIdString

      Internal Zaku numeric identifier

      Example: 42

    • nameString

      Human-readable cluster name

      Example: prod-k8s-cluster-01

    • statusString

      Current operational status of the cluster

      Example: Running

    • descriptionString

      Optional description of the cluster

      Example: Production Kubernetes cluster for AI workloads

    • nodeCountInteger

      Total number of nodes in this cluster

      Example: 12

    • createDateString

      Timestamp when the cluster was registered

      Example: 2026-01-15T08:00:00Z

    • lastSyncAtString

      Timestamp of the last successful sync

      Example: 2026-01-15T08:00:00Z

    • syncStatusString

      Status of the last synchronization attempt

      Example: Success

    • lastSyncErrorString

      Error message from the last failed sync, if any

      Example: connection refused

    • syncDurationMsString

      Duration of the last sync operation in milliseconds

      Example: 350

  • namespacesList

    Namespaces for this resource

    Example: (nested array)

    • uuidString

      Unique identifier of the namespace

      Example: ns-001

    • nameString

      Name of the Kubernetes namespace

      Example: production

    • statusString

      Current status of the namespace

      Example: Active

    • workloadsList

      Workloads for this resource

      Example: (nested array)

      • uuidString

        Unique identifier of the workload

        Example: wl-001

      • nameString

        Name of the workload

        Example: nginx-deployment

      • namespaceString

        Kubernetes namespace of the workload

        Example: default

      • kindString

        Kind of the workload resource (Deployment, StatefulSet, DaemonSet)

        Example: Deployment

      • statusString

        Current status of the workload

        Example: Running

      • podSpecString

        Serialized pod template spec

        Example: {}

    • podCountInteger

      Total number of pods in this namespace

      Example: 18

  • nodeCountInteger

    Total number of nodes in the cluster

    Example: 12

  • podCountInteger

    Total number of pods across all namespaces

    Example: 120

Endpoint

GET/api/v1/zaku/clusters/{clusterUuid}/hierarchy

/api/v1/zaku/clusters/{clusterUuid}/hierarchy

Operation ID

GetResourceHierarchy

Permalink

Request Example

curl -X GET '{host}/api/v1/zaku/clusters/{clusterUuid}/hierarchy' -H 'Authorization: Bearer {token}'

Response Example

200
{
  "cluster": {},
  "namespaces": [
    {}
  ],
  "nodeCount": 12,
  "podCount": 120
}

Change History

This API has no change history records yet.

View all change history