For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
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
viewenumOptionalDefaults to detail
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).
Allowed values:
agentTypeenumOptionalDefaults to inband
Select the in-band or OOB (BMC/Redfish) view: returns only nodes enrolled by that agent type. nodeName is source-specific metadata configured on the OOB collector and is absent from in-band responses. In the OOB view, nodes expose nodeName, bmcHostname/bmcIP and BMC-based verification, while publicIP/privateIP/kernelVersion/gpuDriverVersion/gpuType/gpuCount/gpuFirmwareVersions are empty. Empty defaults to the in-band view for view=detail; for view=basic, an empty agentType returns a combined view that merges the OOB nodeName and BMC identity alongside the in-band hostname.
Allowed values:
pageintegerOptionalDefaults to 0
Page number (0-indexed)
pageSizeintegerOptionalDefaults to 10
Page size
nodeUUIDslist of stringsOptional
Filter by specific node UUIDs. Empty means all nodes
healthStatuseslist of enumsOptional
Filter by health status values
Allowed values:
computeZoneIdslist of stringsOptional
Filter by computezone IDs. Empty means all computezones
computeZoneNameslist of stringsOptional
Filter by computezone names (partial match). Empty means all computezones
nodeGroupIdslist of stringsOptional
Filter by nodegroup IDs. Empty means all nodegroups
nodeGroupNameslist of stringsOptional
Filter by nodegroup names (partial match). Empty means all nodegroups
gpuTypeslist of stringsOptional
Filter by GPU type values in the in-band view. Empty means all GPU types; rejected for OOB and combined views.
gpuCountslist of integersOptional
Filter by GPU count values in the in-band view. Empty means all GPU counts; rejected for OOB and combined views.
publicIPslist of stringsOptional
Filter by public IP addresses in the in-band view. Empty means all public IPs; rejected for OOB and combined views.
privateIPslist of stringsOptional
Filter by private IP addresses in the in-band view. Empty means all private IPs; rejected for OOB and combined views.
verificationCheckslist of enumsOptional
Filter by verification-check status. Takes precedence when both verificationChecks and deprecated integrityChecks are supplied.
integrityCheckslist of enumsOptionalDeprecated
Deprecated: use verificationChecks.
firmwareCheckslist of enumsOptional
Filter by firmware check status
Allowed values:
agentStatuseslist of enumsOptional
Filter by agent status values
Allowed values:
searchstringOptional
Case-insensitive substring search across nodeUUID and source-appropriate node identity fields. Searches nodeUUID or hostname for agentType=inband; nodeUUID, nodeName, or bmcHostname for agentType=oob; and nodeUUID plus all three names for the combined basic view (view=basic with agentType omitted). Leading and trailing whitespace is ignored; blank means no search.
hostnamestringOptional
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 agentType=oob.
nodeNamestringOptional
Filter by the configured node name (case-insensitive partial match). Applies to the OOB view (agentType=oob) and the combined basic view; rejected for the in-band view.
bmcHostnamestringOptional
Filter by BMC hostname (case-insensitive partial match). Applies to the OOB view (agentType=oob) and the combined basic view; rejected for the in-band view.
sortByenumOptionalDefaults to hostname
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/kernel/driver/agentVersion keys apply only to the in-band view. A key not valid for the selected agentType 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.
orderenumOptionalDefaults to asc
Sort order (asc, desc)
Allowed values:
Response
Basic view response (view=basic)
models.InbandNodesResponseobject
OR
models.OobNodesResponseobject
OR
models.BasicNodesResponseobject
Errors
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
499
Client Closed Request Error
500
Internal Server Error
503
Service Unavailable Error
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.
Select the in-band or OOB (BMC/Redfish) view: returns only nodes enrolled by that agent type. nodeName is source-specific metadata configured on the OOB collector and is absent from in-band responses. In the OOB view, nodes expose nodeName, bmcHostname/bmcIP and BMC-based verification, while publicIP/privateIP/kernelVersion/gpuDriverVersion/gpuType/gpuCount/gpuFirmwareVersions are empty. Empty defaults to the in-band view for view=detail; for view=basic, an empty agentType returns a combined view that merges the OOB nodeName and BMC identity alongside the in-band hostname.
Case-insensitive substring search across nodeUUID and source-appropriate node identity fields. Searches nodeUUID or hostname for agentType=inband; nodeUUID, nodeName, or bmcHostname for agentType=oob; and nodeUUID plus all three names for the combined basic view (view=basic with agentType omitted). Leading and trailing whitespace is ignored; blank means no search.
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/kernel/driver/agentVersion keys apply only to the in-band view. A key not valid for the selected agentType 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.
