Create storage class configuration | NVIDIA Run:ai Documentation

curl -X POST http://localhost:8080/api/v1/storage-class-configuration \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "scopeType": "cluster",
  "scopeId": "string",
  "name": "Standard"
}'

{
  "id": "string",
  "tenantId": 1001,
  "scopeType": "cluster",
  "scopeId": "string",
  "name": "Standard",
  "permissions": {
    "allowedForAssets": true,
    "allowedForWorkloads": true,
    "allowedForEphemeralVolumes": true,
    "allowedForPersistentVolumes": true,
    "allowDataSharing": true
  },
  "customization": {
    "accessMode": {
      "required": true,
      "default": {
        "readWriteOnce": true,
        "readOnlyMany": false,
        "readWriteMany": false
      },
      "supportedValues": {
        "readWriteOnce": true,
        "readOnlyMany": true,
        "readWriteMany": true
      }
    },
    "volumeMode": {
      "required": true,
      "default": "Filesystem",
      "supportedValues": {
        "filesystem": true,
        "block": true
      }
    },
    "claimSize": {
      "default": "1G",
      "supportedUnits": [
        "MB"
      ],
      "min": "1G",
      "max": "1G",
      "step": "1G"
    },
    "attributes": [
      {
        "key": "dnsname",
        "format": "text",
        "display": "DNS Name",
        "description": "The host name of the DNS",
        "placeholder": "enter hostname or IP address",
        "required": "true",
        "defaultValue": "my.dns.com",
        "validationRegexp": "^[a-zA-Z0-9.-_]+$",
        "minValue": 100,
        "maxValue": 200,
        "step": 5,
        "validationError": "Invalid URL"
      }
    ]
  }
}

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.

Authentication

AuthorizationBearer

Bearer authentication

Request

This endpoint expects an object.

scopeTypeenumRequiredDefaults to cluster

the scope type of the configuration.

Allowed values:

scopeIdstringRequiredformat: "uuid"

The ID of the cluster.

namestringRequired

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

tenantIdinteger or nullOptional

The id of the tenant.

permissionsobjectOptional

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

customizationobjectOptional

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

Response

Executed successfully.

idstringformat: "uuid"

The unique identifier of the storage class configuration.

tenantIdinteger

The id of the tenant.

scopeTypeenumDefaults to cluster

Currently supported value: ‘cluster’, which is also the default.

Allowed values:

scopeIdstringformat: "uuid"

The ID of the cluster.

namestring

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

permissionsobjectOptional

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

customizationobjectOptional

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

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

503

Service Unavailable Error