Skip to main content
ZStack
Monitoring & Collection/Zaku

GetResourceHierarchy

Get the full namespace and workload hierarchy of a cluster

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

Operation ID

GetResourceHierarchy

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

Path Parameters

  • clusterUuid
    StringRequired

    UUID of the cluster to retrieve hierarchy for

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • cluster
    Object

    Cluster for this resource

    • uuid
      String

      Unique identifier of the cluster

      Example: cluster-abc123

    • platformId
      String

      Platform ID this cluster belongs to

      Example: plat-001

    • zakuId
      String

      Internal Zaku numeric identifier

      Example: 42

    • name
      String

      Human-readable cluster name

      Example: prod-k8s-cluster-01

    • status
      String

      Current operational status of the cluster

      Example: Running

    • description
      String

      Optional description of the cluster

      Example: Production Kubernetes cluster for AI workloads

    • nodeCount
      Integer

      Total number of nodes in this cluster

      Example: 12

    • createDate
      String

      Timestamp when the cluster was registered

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

    • lastSyncAt
      String

      Timestamp of the last successful sync

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

    • syncStatus
      String

      Status of the last synchronization attempt

      Example: Success

    • lastSyncError
      String

      Error message from the last failed sync, if any

      Example: connection refused

    • syncDurationMs
      String

      Duration of the last sync operation in milliseconds

      Example: 350

  • namespaces
    List

    Namespaces for this resource

    Example: (nested array)

    • uuid
      String

      Unique identifier of the namespace

      Example: ns-001

    • name
      String

      Name of the Kubernetes namespace

      Example: production

    • status
      String

      Current status of the namespace

      Example: Active

    • workloads
      List

      Workloads for this resource

      Example: (nested array)

      • uuid
        String

        Unique identifier of the workload

        Example: wl-001

      • name
        String

        Name of the workload

        Example: nginx-deployment

      • namespace
        String

        Kubernetes namespace of the workload

        Example: default

      • kind
        String

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

        Example: Deployment

      • status
        String

        Current status of the workload

        Example: Running

      • podSpec
        String

        Serialized pod template spec

        Example: {}

    • podCount
      Integer

      Total number of pods in this namespace

      Example: 18

  • nodeCount
    Integer

    Total number of nodes in the cluster

    Example: 12

  • podCount
    Integer

    Total number of pods across all namespaces

    Example: 120