Skip to main content
ZStack
Monitoring & Collection/Zaku

SearchNodes

Search nodes across clusters with filters for IP, role, status, and labels

GET/api/v1/zaku/nodes

Operation ID

SearchNodes

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

Query Parameters

  • clusterUuid
    String

    Filter by cluster UUID Filter by cluster UUID

  • platformId
    String

    Filter by platform ID Filter by platform ID

  • ipContains
    String

    Substring to match against node IP address Substring to match against node IP address

  • roles
    List

    Filter by node roles (master, worker) Filter by node roles (master, worker)

  • statuses
    List

    Filter by node statuses (Ready, NotReady) Filter by node statuses (Ready, NotReady)

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • items
    List

    Collection of result items

    Example: (nested array)

    • uuid
      String

      Unique identifier of the node

      Example: node-xyz789

    • platformId
      String

      Platform ID this node belongs to

      Example: plat-001

    • clusterUuid
      String

      UUID of the cluster this node belongs to

      Example: cluster-abc123

    • name
      String

      Hostname of the Kubernetes node

      Example: k8s-node-01

    • nodeIp
      String

      Primary IP address of the node

      Example: 10.0.1.25

    • role
      String

      Role of the node within the cluster (master or worker)

      Example: worker

    • status
      String

      Current node status (Ready, NotReady, etc.)

      Example: Ready

    • cpuCapacity
      Integer

      Total CPU capacity in millicores

      Example: 32000

    • memoryCapacity
      String

      Total memory capacity in bytes

      Example: 137438953472

    • labelsRaw
      String

      Raw JSON string of Kubernetes node labels

      Example: {"kubernetes.io/role":"worker"}

    • createDate
      String

      Timestamp when the node was registered

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

    • lastSyncAt
      String

      Timestamp of the last sync for this node

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

  • total
    Integer

    Total number of matching nodes

    Example: 45

  • limit
    Integer

    Page size used in this response

    Example: 20

  • offset
    Integer

    Offset used in this response

    Example: 20