Skip to navigation
REST APIOrganizationsNode Pools

Get nodepools minimal

View as Markdown

Retrieve essential node pool data required for common operations (e.g., workload submission)

Authentication

AuthorizationBearer
Bearer authentication

Query parameters

filterBylist of stringsOptional

Filter results by a parameter. Use the format field-name operator value. Operators are == Equals, != Not equals, <= Less than or equal, >= Greater than or equal. Dates are in ISO 8601 timestamp format and available for operators ==, !=, <= and >=.

sortByenumOptional
Sort results by a parameter.
Allowed values:
sortOrderenumOptionalDefaults to asc
Sort results in descending or ascending order.
Allowed values:
offsetintegerOptional
The offset of the first item returned in the collection.
limitintegerOptional1-500Defaults to 50
The maximum number of entries to return.

Response

ok
nodepoolslist of objectsOptional

Errors

400
Bad Request Error
503
Service Unavailable Error