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 Storage Classes API

The Storage Classes API retrieves a list of available, pre-defined storage classes in the system.

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

This API exposes 3 operations across 3 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.

3 operations 3 paths 27 schemas 3 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 Storage Classes 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 3

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

Storage Classes 3

The Storage Classes API retrieves a list of available, pre-defined storage classes in the system.

GET
/v1/k8s/clusters/{uuid}/storage-classesdeprecated
Get all storageClasses from a cluster.
V1GetStorageClasses 2 params → 200401404default
GET
/api/v1/storage-classes
get a Storage Class/Classes for a given cluster
getStorageClasses 3 params → 200401403500503
GET
/api/v2/storage-classes
get a Storage Class/Classes for a given cluster
getStorageClassesV2 3 params → 200401403500503

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are PvcAddedAttribute (12 properties), ClaimSizeCustomization (5 properties), StorageClassPermissions (5 properties), StorageClassV2 (5 properties). Each schema is shown below with its type and property counts.

AttributesCustomization
array
Defines additional annotation attributes to be applied to PVCs created under this storage class. Each attribute describes an annotation key and its expected va…
Error
object
3 properties 2 required
AllowedForEphemeralVolumes
boolean
Allows workloads to create ephemeral volumes using this storage class. When disabled, users cannot (a) create PVC assets with autoDelete=true and ephemeral=tru…
StorageClassCustomization
object
Optional UI/policy controls that define defaults and requirements when creating PVCs with this storage class.
4 properties
AccessModeCustomization
object
Controls whether PVC access modes are required and what defaults to apply.
3 properties
StorageClasses1
object
1 property 1 required
AllowDataSharing
boolean
Allows creation of PVCs using a shared volume.
ClaimSizeCustomization
object
Defines the default, supported units, and range constraints for PVC claim sizes. These settings control the requested storage capacity when creating a PVC usin…
5 properties
PvcClaimSize
string
Requested size for the PVC. Mandatory when existingPvc is false. Recommended sizes: TB/GB/MB/TIB/GIB/MIB
PvcAddedAttributeFormat
string
Defines the data type the attribute can accept. Enum: "text" "number" "boolean"
StorageClassSpec
object
3 properties 1 required
AllowedForAssets
boolean
Determines whether PVC assets can be created using this storage class.
PvcAddedAttribute
object
Attribute that is added to any PVC of a given storage class.
12 properties 1 required
PvcClaimMinSize
string
Minimum claim size allowed for PVCs created with this storage class. Mandatory when existingPvc = false. Recommended values: TB, GB, MB, TIB, GIB, MIB.
PvcClaimMaxSize
string
Maximum claim size allowed for PVCs created with this storage class. Mandatory when existingPvc = false. Recommended values: TB, GB, MB, TIB, GIB, MIB.
AllowedForWorkloads
boolean
Allows workloads to include PVCs that use this storage class. When disabled, users cannot (a) include non-existing PVC assets created with this class in asset-…
PvcSupportedAccessModes
object
Defines the access modes supported by the given storage class. These values indicate which access configurations can be used when creating PVCs with this class.
3 properties
PvcVolumeMode
string
Default volume mode for the PVC. Choose between Filesystem (default) or Block.
AllowedForPersistentVolumes
boolean
Allows workloads to create persistent volumes using this storage class. When disabled, users cannot (a) create PVC assets with autoDelete=true and ephemeral=tr…
StorageClass1
object
3 properties 1 required
StorageClassV2
object
5 properties 3 required
PvcClaimStepSize
string
Defines the incremental step between allowed numeric values (for example, 1, 0.1).
StorageClassPermissions
object
Defines the access permissions and behavioral rules for this storage class.
5 properties
V1Error
object
3 properties 2 required
StorageClassesV2
object
1 property 1 required
VolumeModeCustomization
object
Defines whether the volumeMode field is required when creating PVCs and specifies default and supported modes for the storage class.
3 properties
PvcAccessModes
object
Default access mode(s) applied to newly created PVCs unless explicitly overridden.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

runai-storage-classes-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