Get nodes overview and states
Get list of nodes with current state and overview. Use view=detail (default) for full response or view=basic for a lightweight nodeUUID + hostname/BMC identity list, including the optional OOB nodeName when OOB data is selected (see models.BasicNodesResponse). Detail responses include the preferred verification-check fields and the deprecated integrityCheck aliases for backward compatibility. All filter parameters are optional arrays - empty means no filter applied.
Query parameters
View mode: ‘detail’ for full response (default) or ‘basic’ for nodeUUID + hostname + optional OOB nodeName + bmcHostname/bmcIP only (lightweight query, does not support filtering or sorting by healthStatuses, verificationChecks, firmwareChecks, or agentStatuses).
Select the in-band or OOB (BMC/Redfish) data source. Returns only nodes enrolled through that source. nodeName is OOB-specific metadata and is absent from in-band responses. In the OOB view, nodes expose nodeName, bmcHostname/bmcIP, optional gpuType/gpuCount and BMC-based verification, while publicIP/privateIP/kernelVersion/gpuDriverVersion/gpuFirmwareVersions are empty. Empty defaults to the in-band view for view=detail; for view=basic, omitting both dataSource and agentType returns a combined view that merges OOB and in-band identity.
Deprecated: use dataSource. Alias for selecting the in-band or OOB data source; when both parameters are supplied, their values must match.
Page number (0-indexed)
Filter by computezone names (partial match). Empty means all computezones
Filter by nodegroup names (partial match). Empty means all nodegroups
Filter by public IP addresses in the in-band view. Empty means all public IPs; rejected for OOB and combined views.
Filter by private IP addresses in the in-band view. Empty means all private IPs; rejected for OOB and combined views.
Filter by verification-check status. Takes precedence when both verificationChecks and deprecated integrityChecks are supplied.
Deprecated: use verificationChecks.
Filter by agent status for the selected dataSource. Healthy liveness is Online; every other, missing, or unrecognized liveness value is Offline.
Case-insensitive substring search across nodeUUID and source-appropriate node identity fields. Searches nodeUUID or hostname for dataSource=inband; nodeUUID, nodeName, or bmcHostname for dataSource=oob; and nodeUUID plus all three names for the combined basic view (view=basic with both source parameters omitted). Leading and trailing whitespace is ignored; blank means no search.
Filter by the in-band OS hostname (case-insensitive partial match). Applies to the in-band view and to active in-band identities in the combined basic view; rejected for dataSource=oob.
Filter by the configured node name (case-insensitive partial match). Applies to the OOB view (dataSource=oob) and the combined basic view; rejected for the in-band view.
Filter by BMC hostname (case-insensitive partial match). Applies to the OOB view (dataSource=oob) and the combined basic view; rejected for the in-band view.
Field to sort by. Use verificationCheck; integrityCheck remains a deprecated alias. Defaults to hostname (in-band view) or bmcHostname (OOB view). nodeName and bmcHostname apply only to OOB-capable views; the in-band-only GPU firmware/kernel/driver/agentVersion keys apply only to the in-band view. Combined basic view supports only hostname, nodeName, bmcHostname, nodeUUID, nodeGroup, computeZone, gpuType, and gpuCount, matching its filterable fields. A key not valid for the selected dataSource is rejected. gpuFirmwareVersions pins nodes whose GPUs have mismatched vbios versions to the top, then sorts the remaining (uniform) nodes by that common vbios in the requested order.
Sort order (asc, desc)
Response
Basic view response (view=basic)