Skip to main content
ZStack
Platform Operations/Platform Federation

ListClusterGroups

List all cluster groups available in the federation.

GET/api/v1/federation/cluster-groups

Operation ID

ListClusterGroups

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

This API requires no request parameters.

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • items
    List

    List of cluster group records

    Example: (nested array)

    • id
      String

      Unique identifier of the cluster group

      Example: cg-001-xyz

    • name
      String

      Human-readable name of the cluster group

      Example: production-clusters

    • description
      String

      Description of the cluster group purpose

      Example: All production environment clusters

    • clusterIds
      List

      List of cluster UUIDs that belong to this group

      Example: item1,item2

    • createdAt
      String

      Created at

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

  • total
    Integer

    Total number of cluster groups

    Example: 5

  • limit
    Integer

    Maximum number of items per page

    Example: 20

  • offset
    Integer

    Number of items skipped

    Example: 20