The storage class configuration API enables administrators to define, manage, and customize how storage classes are used across the NVIDIA Run:ai platform. Through this API, you can configure access modes, volume modes, and claim size restrictions for persistent volume claims (PVCs). These settings help standardize storage behavior, enforce organization-wide policies, and ensure consistent resource allocation across workloads.
NVIDIA Run:ai Storage Class Configuration 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 Class Configuration. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.
This API exposes
6 operations
across 2 paths,
and defines 30 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 operations2 paths30 schemas1 DELETE2 GET1 PATCH1 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
NVIDIA Run:ai Storage Class Configuration 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 2 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Storage Class Configuration 6
The storage class configuration API enables administrators to define, manage, and customize how storage classes are used across the NVIDIA Run:ai platform. Through this API, you c…
The contract defines 30 schemas that model the data the API accepts and returns. The most detailed are PvcAddedAttribute (12 properties), StorageClassConfiguration (7 properties), StorageClassConfigurationCreationRequest (6 properties), StorageClassPermissions (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 properties2 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…
StorageClassConfigurationListResponse
object
2 properties1 required
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
StorageClassName
string
The name of the storage class to which the configuration applies.
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
TenantId
integer
The id of the tenant.
PvcAddedAttributeFormat
string
Defines the data type the attribute can accept. Enum: "text" "number" "boolean"
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 properties1 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.
ScopeClusterId
string
The ID of the cluster.
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…
StorageClassConfigurationUpdateRequest
object
2 properties
StorageClassConfigurationCreationRequest
object
6 properties3 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
VolumeModeCustomization
object
Defines whether the volumeMode field is required when creating PVCs and specifies default and supported modes for the storage class.
3 properties
PvcAttributesToRemove
object
optional list of attributes that you wish to remove
1 property
StorageClassConfiguration
object
7 properties5 required
StorageClassConfigurationPatchRequest
object
2 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.
