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

The Datavolumes API from NVIDIA Run:ai — 5 operation(s) for datavolumes.

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

This API exposes 9 operations across 5 paths, and defines 21 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 5 paths 21 schemas 1 DELETE5 GET2 PATCH1 POST

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 Datavolumes 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 5 paths, the API surfaces 9 operations — 1 DELETE, 5 GET, 2 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Datavolumes 9
GET
/api/v1/datavolumes
List datavolumes in permitted scopes
get_datavolumes 8 params → 200400401403500503
POST
/api/v1/datavolumes
Create a datavolume
create_datavolume body → 201400401403500503
GET
/api/v1/datavolumes/{datavolumeId}
Get datavolume
get_datavolume 1 param → 200401403404500503
DELETE
/api/v1/datavolumes/{datavolumeId}
Delete datavolume
delete_datavolume 1 param → 202204401403404500503
PATCH
/api/v1/datavolumes/{datavolumeId}
Patch datavolume
patch_datavolume 1 param body → 200400401403404500503
GET
/api/v1/datavolumes/name-availability
Data volumes name availability.
datavolume_name_availability 2 params → 204401403409503
GET
/api/v1/datavolumes/count
Count data volumes.
count_datavolumes 4 params → 200400401403500503
PATCH
/api/v1/datavolumes/{datavolumeId}/sharedScopes
Patch the datavolume's shared scopes
patch_datavolume_shared_scopes 1 param body → 200400401403404500503
GET
/api/v1/datavolumes/{datavolumeId}/sharedScopes
Get the datavolume's shared scopes
get_datavolume_shared_scopes 1 param → 200401403404500503

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are DatavolumeCreationFields (6 properties), Condition2 (5 properties), DatavolumeStatus (5 properties), BaseFields (5 properties). Each schema is shown below with its type and property counts.

HttpResponse
object
2 properties 2 required
DatavolumeRequestType
string
Which datavolumes to return in the GET datavolumes response. Originated - datavolumes that are originated in the permitted scopes of the caller. UsableInProjec…
DatavolumeNoSharedScopes
SharedScopesPatchRequest
object
2 properties
Error
object
3 properties 2 required
EnrichmentDataFields1
object
3 properties 1 required
DatavolumePatchFields
object
1 property
Conditions1
array
DatavolumesNoSharedScopes
array
Condition2
object
5 properties 2 required
SharedScope
ClusterId
string
The id of the cluster.
SharedScopes
array
DatavolumeCreationFields
object
6 properties 3 required
DatavolumePhase
string
Phase of the Datavolume in the cluster
DatavolumeStatus
object
5 properties 1 required
SharedScopeBase
object
2 properties 2 required
BaseFields
object
5 properties 1 required
ScopeType2
string
DatavolumeInnerFields
Datavolume

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

runai-datavolumes-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 Departments API