Skip to main content
API Explorer|API Explorer
Platform Operations/Platform Federation
GETPlatformSince 1.0SynchronousAuth Required

GetClusterGroup

Get details of a specific cluster group by its ID.

Execution Availability

Try It Out

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

Path Parameters

Request Inputs

Path Parameters

  • groupIdStringRequired

    ID of the cluster group to retrieve

Responses

200 OK

On success, this API returns the following response structure.

  • idString

    Unique identifier of the cluster group

    Example: cg-001-xyz

  • nameString

    Human-readable name of the cluster group

    Example: production-clusters

  • descriptionString

    Description of the cluster group purpose

    Example: All production environment clusters

  • clusterIdsList

    List of cluster UUIDs that belong to this group

    Example: item1,item2

  • createdAtString

    Created at

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

Endpoint

GET/api/v1/federation/cluster-groups/{groupId}

/api/v1/federation/cluster-groups/{groupId}

Operation ID

GetClusterGroup

Permalink

Request Example

curl -X GET '{host}/api/v1/federation/cluster-groups/{groupId}' -H 'Authorization: Bearer {token}'

Response Example

200
{
  "id": "cg-001-xyz",
  "name": "production-clusters",
  "description": "All production environment clusters",
  "clusterIds": [],
  "createdAt": "example"
}

Change History

This API has no change history records yet.

View all change history