Skip to main content
ZStack
Monitoring & Collection/Zaku

ListClusters

List all Kubernetes clusters registered under a platform

GET/api/v1/zaku/clusters

Operation ID

ListClusters

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

Query Parameters

  • platformId
    String

    Filter by platform ID; empty returns all platforms Filter by platform ID; empty returns all platforms

  • limit
    Integer

    Maximum number of results to return Maximum number of results to return

    Example: 0

  • offset
    Integer

    Number of results to skip for pagination Number of results to skip for pagination

    Example: 0

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • items
    List

    Collection of result items

    Example: (nested array)

    • 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

    • gpuPoolCount
      Integer

      Number of GPU pools in this cluster

      Example: 3

  • total
    Integer

    Total number of matching clusters

    Example: 5

  • limit
    Integer

    Page size used in this response

    Example: 20

  • offset
    Integer

    Offset used in this response

    Example: 20