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

ListClusters

List all Kubernetes clusters registered under a platform

Execution Availability

Try It Out

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

Query Parameters

Request Inputs

Query Parameters

  • platformIdString

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

  • limitInteger

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

    Example: 0

  • offsetInteger

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

    Example: 0

Responses

200 OK

On success, this API returns the following response structure.

  • itemsList

    Collection of result items

    Example: (nested array)

    • 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

    • gpuPoolCountInteger

      Number of GPU pools in this cluster

      Example: 3

  • totalInteger

    Total number of matching clusters

    Example: 5

  • limitInteger

    Page size used in this response

    Example: 20

  • offsetInteger

    Offset used in this response

    Example: 20

Endpoint

GET/api/v1/zaku/clusters

/api/v1/zaku/clusters

Operation ID

ListClusters

Permalink

Request Example

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

Response Example

200
{
  "items": [
    {}
  ],
  "total": 5,
  "limit": 20,
  "offset": 20
}

Change History

This API has no change history records yet.

View all change history