NVIDIA Run:ai

Storage Class Configuration

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.

List storage class configurations

Retrieves a list of storage class configurations defined in the system.

SecuritybearerAuth
Request
query Parameters
filterBy
Array of strings

Filter results by a parameter. Use the format field-name operator value. Operators are == Equals, != Not equals, <= Less than or equal, >= Greater than or equal, =@ contains, !@ Does not contains, =^ Starts with and =$ Ends with. Dates are in ISO 8601 timestamp format and available for operators ==, !=, <= and >=.

Example: filterBy=name!=some-name
sortBy
string

Sort results by a parameters.

Enum: "name" "tenantId" "scopeType" "scopeId"
sortOrder
string
Default: "asc"

Sort results in descending or ascending order.

Enum: "asc" "desc"
offset
integer <int32>

The offset of the first item returned in the collection.

Example: offset=100
limit
integer <int32> [ 1 .. 500 ]
Default: 50

The maximum number of entries to return.

Responses
200

Executed successfully.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

get/api/v1/storage-class-configuration
Response samples
application/json
{
  • "storageClassConfigurations": [
    ],
  • "next": 1
}

Create storage class configuration

Creates a new storage class configuration in the NVIDIA Run:ai platform. This endpoint enables administrators to define storage class behavior and customize their usage settings.

SecuritybearerAuth
Request
Request Body schema: application/json
required
tenantId
integer or null <int32>

The id of the tenant.

scopeType
required
string
Default: "cluster"

the scope type of the configuration.

Value: "cluster"
scopeId
required
string <uuid> (ScopeClusterId)

The ID of the cluster.

name
required
string (StorageClassName)

The name of the storage class to which the configuration applies.

object or null (StorageClassPermissions)

Defines the access permissions and behavioral rules for this storage class.

object or null (StorageClassCustomization)

Optional UI/policy controls that define defaults and requirements when creating PVCs with this storage class.

Responses
201

Executed successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

post/api/v1/storage-class-configuration
Request samples
application/json
{
  • "tenantId": 1001,
  • "scopeType": "cluster",
  • "scopeId": "65fafe40-a220-4dd7-8724-4598b81c0643",
  • "name": "Standard",
  • "permissions": {
    },
  • "customization": {
    }
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenantId": 1001,
  • "scopeType": "cluster",
  • "scopeId": "65fafe40-a220-4dd7-8724-4598b81c0643",
  • "name": "Standard",
  • "permissions": {
    },
  • "customization": {
    }
}

Get storage class configuration by id

Retrieves a specific storage class configuration by its unique identifier. Use this endpoint to view detailed information about the configuration, including its permissions and customization options.

SecuritybearerAuth
Request
path Parameters
id
required
string

unique identifier of the storage class configuration

query Parameters
tenantId
integer
Responses
200

Storage class configuration

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

get/api/v1/storage-class-configuration/{id}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenantId": 1001,
  • "scopeType": "cluster",
  • "scopeId": "65fafe40-a220-4dd7-8724-4598b81c0643",
  • "name": "Standard",
  • "permissions": {
    },
  • "customization": {
    }
}

Patch storage class configuration by id

Partially updates an existing storage class configuration by its unique identifier. Use this endpoint to modify specific fields, such as permissions, customization values, or attributes, without replacing the entire configuration.

SecuritybearerAuth
Request
path Parameters
id
required
string

unique identifier of the storage class configuration

query Parameters
tenantId
integer
Request Body schema: application/json
required
object or null (StorageClassPermissions)

Defines the access permissions and behavioral rules for this storage class.

object or null

Optional UI/policy controls that define defaults and requirements when creating PVCs with this storage class.

Responses
200

Storage class configuration

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

patch/api/v1/storage-class-configuration/{id}
Request samples
application/json
{
  • "permissions": {
    },
  • "customization": {
    }
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenantId": 1001,
  • "scopeType": "cluster",
  • "scopeId": "65fafe40-a220-4dd7-8724-4598b81c0643",
  • "name": "Standard",
  • "permissions": {
    },
  • "customization": {
    }
}

Update storage class configuration by id

Updates an existing storage class configuration by its unique identifier. Use this endpoint to fully replace an existing configuration, including permissions and customization settings.

SecuritybearerAuth
Request
path Parameters
id
required
string

unique identifier of the storage class configuration

query Parameters
tenantId
integer
Request Body schema: application/json
required
object or null (StorageClassPermissions)

Defines the access permissions and behavioral rules for this storage class.

object or null (StorageClassCustomization)

Optional UI/policy controls that define defaults and requirements when creating PVCs with this storage class.

Responses
200

Storage class configuration

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

put/api/v1/storage-class-configuration/{id}
Request samples
application/json
{
  • "permissions": {
    },
  • "customization": {
    }
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenantId": 1001,
  • "scopeType": "cluster",
  • "scopeId": "65fafe40-a220-4dd7-8724-4598b81c0643",
  • "name": "Standard",
  • "permissions": {
    },
  • "customization": {
    }
}

Delete storage class configuration by id

Deletes a specific storage class configuration by its unique identifier. Use this endpoint to permanently remove configurations that are no longer needed.

SecuritybearerAuth
Request
path Parameters
id
required
string

unique identifier of the storage class configuration

query Parameters
tenantId
integer
Responses
204

Storage class configuration deleted

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

delete/api/v1/storage-class-configuration/{id}
Response samples
application/json
{
  • "code": 401,
  • "message": "Issuer is not familiar."
}
➔ Next to Git