Storage Class Configuration

List storage class configurations

get

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

Authorizations

AuthorizationstringRequired

Bearer authentication

Query parameters

filterBystring[]Optional

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: ["name!=some-name"]

sortBystring · enumOptional

Sort results by a parameters.

Possible values:

sortOrderstring · enumOptional

Sort results in descending or ascending order.

Default: ascPossible values:

offsetinteger · int32Optional

The offset of the first item returned in the collection.

Example: 100

limitinteger · int32 · min: 1 · max: 500Optional

The maximum number of entries to return.

Default: 50

Responses

200

Executed successfully.

application/json

nextintegerOptionalExample: 1

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

503

unexpected error

application/json

get/api/v1/storage-class-configuration

GET /api/v1/storage-class-configuration HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "storageClassConfigurations": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "tenantId": 1001,
      "scopeType": "cluster",
      "scopeId": "123e4567-e89b-12d3-a456-426614174000",
      "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"
          }
        ]
      }
    }
  ],
  "next": 1
}

Create storage class configuration

post

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.

Authorizations

AuthorizationstringRequired

Bearer authentication

Body

tenantIdinteger · int32Optional

The id of the tenant.

Example: 1001

scopeTypestring · enumRequired

the scope type of the configuration.

Default: clusterExample: clusterPossible values:

scopeIdstring · uuidRequired

The ID of the cluster.

namestringRequired

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

Example: Standard

Responses

201

Executed successfully.

application/json

idstring · uuidRequired

The unique identifier of the storage class configuration.

tenantIdinteger · int32Required

The id of the tenant.

Example: 1001

scopeTypestring · enumRequired

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

Default: clusterExample: clusterPossible values:

scopeIdstring · uuidRequired

The ID of the cluster.

namestringRequired

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

Example: Standard

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

503

unexpected error

application/json

post/api/v1/storage-class-configuration

POST /api/v1/storage-class-configuration HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 980

{
  "tenantId": 1,
  "scopeType": "cluster",
  "scopeId": "123e4567-e89b-12d3-a456-426614174000",
  "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"
      }
    ]
  }
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "tenantId": 1001,
  "scopeType": "cluster",
  "scopeId": "123e4567-e89b-12d3-a456-426614174000",
  "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"
      }
    ]
  }
}

Get storage class configuration by id

get

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.

Authorizations

AuthorizationstringRequired

Bearer authentication

Path parameters

idstringRequired

unique identifier of the storage class configuration

Query parameters

tenantIdintegerOptional

Responses

200

Storage class configuration

application/json

idstring · uuidRequired

The unique identifier of the storage class configuration.

tenantIdinteger · int32Required

The id of the tenant.

Example: 1001

scopeTypestring · enumRequired

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

Default: clusterExample: clusterPossible values:

scopeIdstring · uuidRequired

The ID of the cluster.

namestringRequired

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

Example: Standard

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

503

unexpected error

application/json

get/api/v1/storage-class-configuration/{id}

GET /api/v1/storage-class-configuration/{id} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "tenantId": 1001,
  "scopeType": "cluster",
  "scopeId": "123e4567-e89b-12d3-a456-426614174000",
  "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"
      }
    ]
  }
}

Update storage class configuration by id

put

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

Authorizations

AuthorizationstringRequired

Bearer authentication

Path parameters

idstringRequired

unique identifier of the storage class configuration

Query parameters

tenantIdintegerOptional

Body

Responses

200

Storage class configuration

application/json

idstring · uuidRequired

The unique identifier of the storage class configuration.

tenantIdinteger · int32Required

The id of the tenant.

Example: 1001

scopeTypestring · enumRequired

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

Default: clusterExample: clusterPossible values:

scopeIdstring · uuidRequired

The ID of the cluster.

namestringRequired

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

Example: Standard

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

503

unexpected error

application/json

put/api/v1/storage-class-configuration/{id}

PUT /api/v1/storage-class-configuration/{id} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 878

{
  "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"
      }
    ]
  }
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "tenantId": 1001,
  "scopeType": "cluster",
  "scopeId": "123e4567-e89b-12d3-a456-426614174000",
  "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"
      }
    ]
  }
}

Delete storage class configuration by id

delete

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

Authorizations

AuthorizationstringRequired

Bearer authentication

Path parameters

idstringRequired

unique identifier of the storage class configuration

Query parameters

tenantIdintegerOptional

Responses

204

Storage class configuration deleted

No content

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

503

unexpected error

application/json

delete/api/v1/storage-class-configuration/{id}

DELETE /api/v1/storage-class-configuration/{id} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Patch storage class configuration by id

patch

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.

Authorizations

AuthorizationstringRequired

Bearer authentication

Path parameters

idstringRequired

unique identifier of the storage class configuration

Query parameters

tenantIdintegerOptional

Body

Responses

200

Storage class configuration

application/json

idstring · uuidRequired

The unique identifier of the storage class configuration.

tenantIdinteger · int32Required

The id of the tenant.

Example: 1001

scopeTypestring · enumRequired

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

Default: clusterExample: clusterPossible values:

scopeIdstring · uuidRequired

The ID of the cluster.

namestringRequired

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

Example: Standard

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

503

unexpected error

application/json

patch/api/v1/storage-class-configuration/{id}

PATCH /api/v1/storage-class-configuration/{id} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 919

{
  "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"
      }
    ],
    "attributesToRemove": [
      "dnsname",
      "dnsip"
    ]
  }
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "tenantId": 1001,
  "scopeType": "cluster",
  "scopeId": "123e4567-e89b-12d3-a456-426614174000",
  "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"
      }
    ]
  }
}