Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

NVIDIA Run:ai HostPath API

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

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

This API exposes 5 operations across 2 paths, and defines 38 schemas. It is described by OpenAPI 3.0.3, at version latest.

Requests are made against a single base URL, https://app.run.ai.

5 operations 2 paths 38 schemas 1 DELETE2 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
Resource Areas
1

Authentication & Security 1

NVIDIA Run:ai HostPath 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 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

HostPath 5

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

GET
/api/v1/asset/datasource/host-path
List host path assets.
list_host_path_assets 10 params → 200400401403503
POST
/api/v1/asset/datasource/host-path
Create a host path asset.
create_host_path body → 202400401409503
GET
/api/v1/asset/datasource/host-path/{AssetId}
Get a hostPath asset.
get_host_path_by_id 5 params → 200400401403404503
PUT
/api/v1/asset/datasource/host-path/{AssetId}
Update a hostPath asset.
update_host_path_by_id 1 param body → 202400401403404503
DELETE
/api/v1/asset/datasource/host-path/{AssetId}
Delete a hostPath asset.
delete_host_path_by_id 1 param → 202400401403404412503

Schemas 38

The contract defines 38 schemas that model the data the API accepts and returns. The most detailed are AssetReadOnlyFields (11 properties), AssetCreationFields (7 properties), AssetUsageInfo (6 properties), WorkloadSupportedTypes (5 properties). Each schema is shown below with its type and property counts.

HostPathSpec
HttpResponse
object
2 properties 2 required
AssetDescription
string
The description of the asset.
DataSourceOverrides
object
specific fields to override in the data source.
1 property
WorkloadId1
string
A unique ID of the workload.
WorkloadName
string
The name of the workload.
HostPathCreationRequest
object
2 properties 2 required
WorkloadSupportedTypes
object
5 properties
AssetsUsageRefCompute
object
AssetUpdatableFields
object
2 properties 1 required
Scope
string
The scope in which an asset can be used. The highest scope, system, is intended for internal purposes only.
Error
object
3 properties 2 required
AssetId
string
Unique identifier of the asset.
EnvironmentAssetRef
object
Reference information about environment asset.
3 properties 2 required
HostPathMountPropagation
string
Share this volumes mount with other containers. If set to HostToContainer, this volume mount will receive all subsequent mounts that are mounted to this volume…
HostPathUpdateRequest
object
2 properties 2 required
ToolType
string
Super set of Internal and External tool types.
AssetCreationFields
object
7 properties 1 required
UsageTimesInfo
object
Details about times the asset has been used by workloads, etc.
1 property
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.
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.
HostPathListResponse
object
1 property 1 required
AssetKind
string
The kind of the asset.
AssetCreationRequest
AssetDatasourceRef
object
Reference information about a datasource asset.
4 properties 3 required
ComplianceInfoReason
object
An issue preventing the use of a template or asset for creating workloads in a given project.
3 properties 1 required
AssetMeta
HostPath
object
4 properties
AssetRef
object
Reference information about an asset.
2 properties 2 required
AssetUpdateRequest
AssetUsageInfo
object
Details about resources that use the asset.
6 properties
HostPathAsset
object
5 properties 2 required
ClusterIdOptional
string
The id of the cluster.
ComplianceInfo
object
Compliance of an asset with creation of workloads in a given project.
3 properties
WorkloadRefAndStatus
object
Id, name and status of a workspace or training
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

runai-hostpath-api-openapi.yml Raw ↑

Other APIs NVIDIA Run:ai publishes across the network.

NVIDIA Run:ai Access Keys API
NVIDIA Run:ai Access rules API
NVIDIA Run:ai Administrator Command Line Interface API
NVIDIA Run:ai AI Applications API
NVIDIA Run:ai Applications API
NVIDIA Run:ai AuditLogs API
NVIDIA Run:ai Clusters API
NVIDIA Run:ai Compute API
NVIDIA Run:ai ConfigMap API
NVIDIA Run:ai Credentials API
NVIDIA Run:ai Datasources API
NVIDIA Run:ai Datavolumes API