How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
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 Node Pools. 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.2.0, 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.2.0
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.

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

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
Where this information came from

This is an independent, third-party profile of NVIDIA Run:ai NodePools API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.