Skip to navigation

Get available query options for nodes

View as Markdown

Returns available filters and sorting options for querying nodes. Sorting fields include verificationCheck and the deprecated integrityCheck alias for backward compatibility. Filter options may be simple strings (e.g., health statuses) or hierarchical objects (e.g., compute zones with nested nodegroups).

Filter options examples:

  • Simple strings: {"name": "healthStatuses", "options": ["Healthy", "Degraded", "Unhealthy"]}
  • Hierarchical objects: {"name": "computeZones", "options": [{"id": "cz-1", "value": "Zone 1", "options": [{"id": "ng-1", "value": "Node Group 1"}]}]}

The available options depend on the selected dataSource. The gpuTypes filter applies to both in-band and OOB views. The OOB view omits the kernel/driver/firmware/agentVersion sort fields, which apply only to in-band-enrolled nodes. In detail view, the agentStatuses filter is source-scoped and offers exactly Online and Offline. Basic view omits health-dependent filters and sorts.

Query parameters

viewenumOptionalDefaults to detail

Select detail or basic options. Basic omits health-dependent filters and sorts; without a source parameter, basic uses combined node GPU info.

Allowed values:
dataSourceenumOptional

Select in-band or OOB data. Omitted defaults to in-band for detail and combined sources for basic.

Allowed values:
agentTypeenumOptionalDeprecated

Deprecated: use dataSource. Alias for selecting the in-band or OOB data source; when both parameters are supplied, their values must match.

Allowed values:

Response

Available query options including filters and sorting configuration
filtersobjectOptional
sortingobjectOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
499
Client Closed Request Error
500
Internal Server Error