Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

NVIDIA Run:ai NodePools API

Node pools assist in managing heterogeneous resources effectively. A node pool is a set of nodes grouped into a bucket of resources using a predefined (for example, GPU-Type) or administrator-defined label (for example, key & value). For more information, see [Node Pools](https://run-ai-docs.nvidia.com/saas/platform-management/aiinitiatives/resources/node-pools/#introduction).

NVIDIA Run:ai NodePools API is one of 62 APIs that NVIDIA Run:ai publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include NodePools. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 13 operations across 7 paths, and defines 27 schemas. It is described by OpenAPI 3.0.3, at version latest.

Requests are made against a single base URL, https://app.run.ai.

13 operations 7 paths 27 schemas 2 DELETE5 GET1 PATCH2 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
latest
Base URL
https://app.run.ai
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

NVIDIA Run:ai NodePools API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer authentication

Paths & Operations 13

Across 7 paths, the API surfaces 13 operations — 2 DELETE, 5 GET, 1 PATCH, 2 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

NodePools 13

Node pools assist in managing heterogeneous resources effectively. A node pool is a set of nodes grouped into a bucket of resources using a predefined (for example, GPU-Type) or a…

GET
/api/v1/clusters/{clusterUuid}/nodepools/{nodepoolName}/metrics
Get the node pool metrics data.
get_nodepool_metrics 6 params → 200207400401403404500503
POST
/api/v1/node-pools
Create nodepool
create_nodepool body → 201400401403503
GET
/api/v1/node-pools
Get nodepools
get_nodepools 5 params → 200400401403503
GET
/api/v1/node-pools/count
Count nodepools
count_nodepools 1 param → 200400401403503
DELETE
/api/v1/node-pools/{nodepoolId}
Delete nodepool
delete_nodepool 1 param → 202204400401403404500503
PUT
/api/v1/node-pools/{nodepoolId}
Update nodepool
update_nodepool 1 param body → 200400401403404500503
PATCH
/api/v1/node-pools/{nodepoolId}
Patch nodepool fields
patch_nodepool 1 param body → 200400401403404500503
GET
/api/v1/node-pools/{nodepoolId}
Get nodepool
get_nodepool 1 param → 200400401403404500503
GET
/v1/k8s/clusters/{clusterId}/node-poolsdeprecated
Get the cluster's Node Pools.
getNodePools 1 param → 200403404default
POST
/v1/k8s/clusters/{clusterId}/node-poolsdeprecated
Create a Node Pool.
createNodePool 1 param body → 201400409default
PUT
/v1/k8s/clusters/{clusterId}/node-pools/{id}/labelsdeprecated
Update labels of a Node Pool.
updateNodePoolLabels 2 params body → 202400403404503
DELETE
/v1/k8s/clusters/{clusterId}/node-pools/{id}deprecated
Delete a Node Pool by id.§
deleteNodePool 2 params → 202400403404503
PUT
/v1/k8s/clusters/{clusterId}/node-pools/{id}deprecated
Update a Node Pool.
updateNodePool 2 params body → 202400403404503

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are NodepoolCreateResponseFields (12 properties), NodepoolCreateFields (11 properties), NodepoolCalculatedFields (10 properties), NodepoolUpdateFields (9 properties). Each schema is shown below with its type and property counts.

NodepoolSortFilterFields
string
HttpResponse
object
2 properties 2 required
SchedulingConfiguration
object
2 properties
NetworkTopologyNameOptional
string
Name of the network topology
MetricsType
string
specifies what data to request
NodePool1
PlacementStrategy
string
Error
object
3 properties 2 required
Error1
object
2 properties 2 required
UpdateNodePoolRequest
object
4 properties
MetricsResponse
object
1 property 1 required
NodepoolCalculatedFields
object
10 properties 8 required
NodepoolUpdateFields
object
9 properties
NodepoolConditionDetails
object
5 properties 2 required
NetworkTopologyIdOptional
string
The unique identifier for the network topology
PlacementStrategy1
object
2 properties
NodepoolGPUNetworkAccelerationDetection
string
GPUNetworkAccelerationDetection is a strategy to use for GPU Network Acceleration detection
NodePoolLabelsRequest
object
2 properties
NodepoolSyncUpdateFields
object
8 properties
NodepoolCreateResponseFields
object
12 properties 4 required
NodePoolCreateRequest
object
5 properties
NodepoolCreateFields
object
11 properties 4 required
NodepoolPhase
string
Phase of Node Pool
NodepoolSyncFields
object
4 properties 1 required
MeasurementResponse
object
3 properties 2 required
Nodepool
GPUResourceOptimization
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

runai-nodepools-api-openapi.yml Raw ↑

Other APIs NVIDIA Run:ai publishes across the network.

NVIDIA Run:ai Access Keys API
NVIDIA Run:ai Access rules API
NVIDIA Run:ai Administrator Command Line Interface API
NVIDIA Run:ai AI Applications API
NVIDIA Run:ai Applications API
NVIDIA Run:ai AuditLogs API
NVIDIA Run:ai Clusters API
NVIDIA Run:ai Compute API
NVIDIA Run:ai ConfigMap API
NVIDIA Run:ai Credentials API
NVIDIA Run:ai Datasources API
NVIDIA Run:ai Datavolumes API