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

Use these endpoints to create, manage and delete NVIDIA Run:ai Kubernetes clusters.

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

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

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

9 operations 6 paths 29 schemas 1 DELETE6 GET1 POST1 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 Clusters 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 9

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

Clusters 9

Use these endpoints to create, manage and delete NVIDIA Run:ai Kubernetes clusters.

GET
/api/v1/clusters
Get a list of clusters.
get_clusters 2 params → 200401403404500503
POST
/api/v1/clusters
Create a cluster.
create_cluster body → 201401403404500503
GET
/api/v1/clusters/{clusterUuid}
Get cluster by id.
get_cluster_by_uuid 2 params → 200401403404500503
DELETE
/api/v1/clusters/{clusterUuid}
Delete a cluster by id.
delete_cluster 2 params → 202204401403500503
PUT
/api/v1/clusters/{clusterUuid}
Update a cluster by id.
updateCluster 1 param body → 204400401403500503
GET
/api/v1/clusters/{clusterUuid}/metrics
Get the cluster metrics data.
get_cluster_metrics 7 params → 200207400401403404422500
GET
/api/v1/clusters/{clusterUuid}/cluster-install-info
Retrieve the installation instructions of a cluster by ID.
get_cluster_install_info_by_uuid 3 params → 200401403404500503
GET
/v1/k8s/clusters/{cluster_uuid}/installfile
Get cluster installation file by id.
getInstallFile 4 params → 200401404
GET
/v1/k8s/clusters/{clusterUuid}/metricsdeprecated
Get cluster metrics.
getClusterMetrics 5 params → 200401403404500503

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are DisplayedCluster (11 properties), ClusterReportedStatus (5 properties), ResourcesData (4 properties), GroupedMeasurementResponse (4 properties). Each schema is shown below with its type and property counts.

HttpResponse
object
2 properties 2 required
MetricsType
string
specifies what data to request
ClusterState
string
The cluster's state.
DisplayedCluster
object
11 properties 4 required
Error
object
3 properties 2 required
TimeRange
object
Overtime metrics data. Returned only if both start and end query parameters are set.
1 property 1 required
Error1
object
2 properties 2 required
ProjectName1
string
ClusterName
string
ClusterDisplayedStatus
object
The cluster's displayed status.
TenantId
integer
The id of the tenant.
ClusterId
string
The id of the cluster.
ClusterDependenciesStatus
object
2 properties 2 required
ResourceData
object
quota equals to the given resources and allocated equal to the real count of used resources
3 properties 2 required
ClusterCreationRequest
object
3 properties 1 required
GroupedMetricsResponse
object
1 property 1 required
nodepoolName
string
ResourcesDataOvertime
GroupedMeasurementResponse
object
4 properties 2 required
cluster
object
3 properties 2 required
NodepoolName
string
ClusterUpdateRequest
object
1 property 1 required
DepartmentName
string
ResourcesData
object
4 properties 4 required
GroupedMeasurementGroup
object
2 properties 2 required
ClusterDependencyStatus
object
3 properties 1 required
ClusterReportedConfig
object
Holds cluster configuration values.
3 properties
ClusterInstallationInfoResponse
object
4 properties 4 required
ClusterReportedStatus
object
the cluster status reported by the cluster
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

runai-clusters-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 Compute API
NVIDIA Run:ai ConfigMap API
NVIDIA Run:ai Credentials API
NVIDIA Run:ai Datasources API
NVIDIA Run:ai Datavolumes API
NVIDIA Run:ai Departments API