Skip to main content
ZStack
Platform Operations/Platform Federation

SearchAssets

Search for federated assets by name or label across all clusters in a group.

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

Operation ID

SearchAssets

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

Path Parameters

  • groupId
    StringRequired

    ID of the cluster group to search within

Query Parameters

  • q
    String

    Full-text search query string Full-text search query string

  • assetType
    String

    Filter search results by asset type Filter search results by asset type

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • assets
    List

    List of assets matching the search query

    Example: (nested array)

    • clusterId
      String

      UUID of the cluster this asset belongs to

      Example: cluster-abc-001

    • clusterName
      String

      Human-readable name of the cluster

      Example: prod-cluster-east

    • assetType
      String

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

      Example: pod

    • name
      String

      Name of the asset within its cluster

      Example: nginx-deployment-abc

    • namespace
      String

      Kubernetes namespace or equivalent scope

      Example: default

    • status
      String

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

      Example: Running

    • labels
      LinkedHashMap

      Key-value labels attached to this resource

      Example: (nested object)

    • cpuRequest
      String

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

      Example: 500m

    • memRequest
      String

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

      Example: 256Mi

  • timeoutClusters
    List

    List of cluster IDs that timed out during search

    Example: item1,item2

  • totalCount
    Integer

    Total number of matching assets found

    Example: 42