Skip to main content
API Explorer|API Explorer
Monitoring & Collection/Zaku
GETZakuSince 1.0SynchronousAuth Required

SearchNodes

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

Execution Availability

Try It Out

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

Query Parameters

Request Inputs

Query Parameters

  • clusterUuidString

    Filter by cluster UUID Filter by cluster UUID

  • platformIdString

    Filter by platform ID Filter by platform ID

  • ipContainsString

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

  • rolesList

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

  • statusesList

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

Responses

200 OK

On success, this API returns the following response structure.

  • itemsList

    Collection of result items

    Example: (nested array)

    • uuidString

      Unique identifier of the node

      Example: node-xyz789

    • platformIdString

      Platform ID this node belongs to

      Example: plat-001

    • clusterUuidString

      UUID of the cluster this node belongs to

      Example: cluster-abc123

    • nameString

      Hostname of the Kubernetes node

      Example: k8s-node-01

    • nodeIpString

      Primary IP address of the node

      Example: 10.0.1.25

    • roleString

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

      Example: worker

    • statusString

      Current node status (Ready, NotReady, etc.)

      Example: Ready

    • cpuCapacityInteger

      Total CPU capacity in millicores

      Example: 32000

    • memoryCapacityString

      Total memory capacity in bytes

      Example: 137438953472

    • labelsRawString

      Raw JSON string of Kubernetes node labels

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

    • createDateString

      Timestamp when the node was registered

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

    • lastSyncAtString

      Timestamp of the last sync for this node

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

  • totalInteger

    Total number of matching nodes

    Example: 45

  • limitInteger

    Page size used in this response

    Example: 20

  • offsetInteger

    Offset used in this response

    Example: 20

Endpoint

GET/api/v1/zaku/nodes

/api/v1/zaku/nodes

Operation ID

SearchNodes

Permalink

Request Example

curl -X GET '{host}/api/v1/zaku/nodes' -H 'Authorization: Bearer {token}'

Response Example

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

Change History

This API has no change history records yet.

View all change history