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

ListFederatedAssets

List federated assets across all clusters in a group with optional filters.

Execution Availability

Try It Out

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

Path Parameters

Query Parameters

Request Inputs

Path Parameters

  • groupIdStringRequired

    ID of the cluster group to list assets for

Query Parameters

  • namespaceString

    Filter assets by namespace Filter assets by namespace

  • assetTypeString

    Filter assets by type (e.g. pod, vm) Filter assets by type (e.g. pod, vm)

Responses

200 OK

On success, this API returns the following response structure.

  • itemsList

    List of federated assets

    Example: (nested array)

    • clusterIdString

      UUID of the cluster this asset belongs to

      Example: cluster-abc-001

    • clusterNameString

      Human-readable name of the cluster

      Example: prod-cluster-east

    • assetTypeString

      Type of federated asset (e.g. vm, pod, volume)

      Example: pod

    • nameString

      Name of the asset within its cluster

      Example: nginx-deployment-abc

    • namespaceString

      Kubernetes namespace or equivalent scope

      Example: default

    • statusString

      Current status of the asset (Running, Stopped, etc.)

      Example: Running

    • labelsLinkedHashMap

      Key-value labels attached to this resource

      Example: (nested object)

    • cpuRequestString

      CPU resource request (e.g. "500m")

      Example: 500m

    • memRequestString

      Memory resource request (e.g. "256Mi")

      Example: 256Mi

  • totalInteger

    Total number of assets matching the filter

    Example: 100

  • limitInteger

    Maximum number of items per page

    Example: 20

  • offsetInteger

    Number of items skipped

    Example: 20

Endpoint

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

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

Operation ID

ListFederatedAssets

Permalink

Request Example

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

Response Example

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

Change History

This API has no change history records yet.

View all change history