Skip to main content
GET
List node pools

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

tag
string[]

A set of tags to match against resources in the form "name=value", thus when encoded you get "?tag=foo%3Dcat&tag=bar%3Ddog".

organizationID
string[]

Allows resources to be filtered by organization.

projectID
string[]

Allows resources to be filtered by project.

clusterID
string[]

Allows node pools to be filtered by cluster.

regionID
string[]

Allows resources to be filtered by region. For platform releases, matches releases available in any supplied region.

name
string

Filters resources by exact, case-sensitive display name. Every matching resource is returned because display names are not unique. A valid Kubernetes label value, typically used for resource names that can be indexed in the database.

Pattern: ^[0-9A-Za-z](?:[0-9A-Za-z-_.]{0,61}[0-9A-Za-z])?$
provisioningStatus
enum<string>[]

Filters resources by UNI provisioning status. Repeat the parameter to match any supplied value.

The provisioning state of a resource.

Available options:
pending,
provisioning,
provisioned,
deprovisioning,
error
healthStatus
enum<string>[]

Filters resources by UNI health status. Repeat the parameter to match any supplied value.

The health state of a resource.

Available options:
unknown,
healthy,
degraded,
error
deleting
boolean

Filters by deletion state. True returns terminating resources, false returns non-terminating resources, and omission returns both.

Response

A list of node pools.

metadata
object
required

Project-scoped resource read metadata with Kubernetes generation freshness.

spec
object
required

Desired node pool state.

status
object
required

Product-specific resolved placement and observed node pool state.