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 Nodes API

Nodes are worker machines in Kubernetes and may be either a virtual or a physical machine, depending on the cluster. Each Node is managed by the NVIDIA Run:ai control plane. For more information, see [Nodes](https://run-ai-docs.nvidia.com/saas/platform-management/aiinitiatives/resources/nodes).

NVIDIA Run:ai Nodes 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 Nodes. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

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

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

6 operations 6 paths 16 schemas 6 GET

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 Nodes 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 6

Across 6 paths, the API surfaces 6 operations — 6 GET. Each is listed below with its method, path, parameters, and response codes.

Nodes 6

Nodes are worker machines in Kubernetes and may be either a virtual or a physical machine, depending on the cluster. Each Node is managed by the NVIDIA Run:ai control plane. For m…

GET
/api/v1/clusters/{clusterUuid}/nodesdeprecated
Get a list of nodes.
get_nodes 8 params → 200401403404500503
GET
/api/v1/clusters/{clusterUuid}/nodes/count
Count nodes
count_nodes 3 params → 200400401403500503
GET
/api/v1/nodes
Get a list of nodes.
get_tenant_nodes 6 params → 200401403404500503
GET
/api/v1/nodes/count
Count tenant nodes
count_tenant_nodes 2 params → 200400401403500503
GET
/api/v1/nodes/telemetry
Get node telemetry data.
get_node_telemetry 4 params → 200400401403404500503
GET
/api/v1/nodes/{nodeId}/metrics
Get the node metrics data.
get_node_metrics 5 params → 200207400401403404500503

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are NodeInfo (8 properties), NodeTaint (3 properties), MeasurementResponse (3 properties), TelemetryResponse (3 properties). Each schema is shown below with its type and property counts.

NodeTaint
object
3 properties 2 required
NodeAdditionalFields
object
1 property 1 required
NodeAdditionalReadFields
object
3 properties 2 required
NodeInfo
object
8 properties 3 required
Error
object
3 properties 2 required
MetricsResponse
object
1 property 1 required
GpuInfo
object
2 properties 2 required
TelemetryResponse
object
3 properties 3 required
ClusterId
string
The id of the cluster.
NodeTelemetryType
string
NodeStatusConditionDetails
object
3 properties 2 required
Nodes
object
1 property 1 required
MeasurementResponse
object
3 properties 2 required
NodeFilterSortFields
string
NodeMetricType
string
Specify which metric data to request.
Node

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

runai-nodes-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