NVIDIA Run:ai PVC API

Use a PVC as a data source location for data sets that are relevant to the workload being submitted.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

This API exposes 6 operations across 3 paths, and defines 63 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 operations 3 paths 63 schemas 1 DELETE3 GET1 POST1 PUT

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

License

NVIDIA Run:ai

Resource Areas

Authentication & Security 1

NVIDIA Run:ai PVC 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 3 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

PVC 6

Use a PVC as a data source location for data sets that are relevant to the workload being submitted.

GET

/api/v1/asset/datasource/pvc

List PVC assets.

list_pvc_assets 11 params → 200401403503

POST

/api/v1/asset/datasource/pvc

Create a PVC asset.

create_pvc_asset body → 202400401403409503

GET

/api/v1/asset/datasource/pvc/{AssetId}

Get a PVC asset.

get_pvc_asset_by_id 6 params → 200401403404503

PUT

/api/v1/asset/datasource/pvc/{AssetId}

Update a PVC asset.

update_pvc_asset_by_id 1 param body → 202401403404default

DELETE

/api/v1/asset/datasource/pvc/{AssetId}

Delete a PVC asset.

delete_pvc_asset_by_id 1 param → 202401403404503

GET

/api/v1/asset/datasource/pvc/{AssetId}/history

Get the PVC history.

get_pvc_history 3 params → 200401403404503

Schemas 63

The contract defines 63 schemas that model the data the API accepts and returns. The most detailed are AssetReadOnlyFields (11 properties), Event1 (8 properties), AssetCreationFields (7 properties), PVCAsset (7 properties). Each schema is shown below with its type and property counts.

PvcFieldsNonUpdatable

object

6 properties

DataSourceOverrides

object

specific fields to override in the data source.

1 property

PVCListResponse

object

1 property 1 required

AssetsUsageRefCompute

object

Error

object

3 properties 2 required

EnvironmentAssetRef

object

Reference information about environment asset.

3 properties 2 required

PVCAssetSpec

PVCCreationRequest

object

2 properties 2 required

PVCHistoryResponse

object

2 properties 1 required

PvcClaimSize

string

Requested size for the PVC. Mandatory when existingPvc is false. Recommended sizes: TB/GB/MB/TIB/GIB/MIB

UsageTimesInfo

object

Details about times the asset has been used by workloads, etc.

1 property

PvcAddedAttrValues

array

an optional array of key-values pairs that are written as annotations on the created PVC. the allowed attributes are determined according to the storage class…

AssetsUsageRef

object

Reference information about usage of assets by other assets, for example datasources that uses credentials.

5 properties

AssetName

string

The name of the asset.

ClusterId

string

The id of the cluster.

AssetCreationRequest

Pvc

ComplianceInfoReason

object

An issue preventing the use of a template or asset for creating workloads in a given project.

3 properties 1 required

AssetMeta

AssetClusterStatusIssues

array

AssetClusterStatusIssue

object

3 properties 3 required

AssetDescription

string

The description of the asset.

AssetClusterStatusInfo

object

4 properties

WorkloadName

string

The name of the workload.

ClaimInfo

object

Claim information for the newly created PVC. The information should not be provided when attempting to use existing PVC.

5 properties

AssetId

string

Unique identifier of the asset.

HistoryRecord

object

2 properties 2 required

HistoryRecordType

string

PolicyRuleEnum

string

Indicates which validation rule (e.g., min, max, step, options, required, canEdit, canAdd) conflicted with policy restrictions, causing the asset or template t…

AssetReadOnlyFields

object

11 properties 6 required

UpdateCount

integer

the value of an update counter of a data in the system.

AssetKind

string

The kind of the asset.

AssetSyncStatusEnum

string

AssetDatasourceRef

object

Reference information about a datasource asset.

4 properties 3 required

AssetClusterStatusIssueEnum

string

AssetUsageInfo

object

Details about resources that use the asset.

6 properties

ComplianceInfo

object

Compliance of an asset with creation of workloads in a given project.

3 properties

PvcAddedAttrValue

object

2 properties 1 required

HistoryRecordMeta

object

2 properties 2 required

WorkloadRefAndStatus

object

Id, name and status of a workspace or training

3 properties 2 required

Scope

string

The scope in which an asset can be used. The highest scope, system, is intended for internal purposes only.

AssetRef

object

Reference information about an asset.

2 properties 2 required

PvcVolumeMode

string

Default volume mode for the PVC. Choose between Filesystem (default) or Block.

AssetUpdateRequest

PVCAsset

object

7 properties 2 required

PVCUpdateRequest

object

2 properties 2 required

HttpResponse

object

2 properties 2 required

ClusterInfo1

object

Cluster related information of the asset.

1 property

InvolvedObject

object

4 properties 4 required

WorkloadId1

string

A unique ID of the workload.

WorkloadSupportedTypes

object

5 properties

AssetUpdatableFields

object

2 properties 1 required

HistoryRecords

array

ClusterResourceInfo

object

1 property

ToolType

string

Super set of Internal and External tool types.

AssetCreationFields

object

7 properties 1 required

ScopeType

string

ScopeId

string

The id of the cluster, department or project, depending on the scope type.

Event1

object

8 properties 4 required

ClusterIdOptional

string

The id of the cluster.

AssetPhaseUpdate

object

2 properties 2 required

PvcFieldsUpdatable

object

1 property

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

Other APIs NVIDIA Run:ai publishes across the network.

NVIDIA Run:ai Access Keys API

AE Profile APIs.io

NVIDIA Run:ai Access rules API

AE Profile APIs.io

NVIDIA Run:ai Administrator Command Line Interface API

AE Profile APIs.io

NVIDIA Run:ai AI Applications API

AE Profile APIs.io

NVIDIA Run:ai Applications API

AE Profile APIs.io

NVIDIA Run:ai AuditLogs API

AE Profile APIs.io

NVIDIA Run:ai Clusters API

AE Profile APIs.io

NVIDIA Run:ai Compute API

AE Profile APIs.io

NVIDIA Run:ai ConfigMap API

AE Profile APIs.io

NVIDIA Run:ai Credentials API

AE Profile APIs.io

NVIDIA Run:ai Datasources API

AE Profile APIs.io

NVIDIA Run:ai Datavolumes API

AE Profile APIs.io

#PVC

← Back to N APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

NVIDIA Run:ai PVC API

Metadata

Authentication & Security 1

Paths & Operations 6

Schemas 63

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

NVIDIA Run:ai PVC API

Metadata

Authentication & Security 1

Paths & Operations 6

Schemas 63

Specification

Source

More from NVIDIA Run:ai 12

API Details

Provider

Explore more