Credentials are used to unlock protected resources such as applications, containers, and other assets. For more information, see [Credentials](https://run-ai-docs.nvidia.com/saas/workloads-in-nvidia-run-ai/assets/credentials).
NVIDIA Run:ai Credentials 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 Credentials. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.
This API exposes
26 operations
across 11 paths,
and defines 76 schemas.
It is described by OpenAPI 3.0.3, at version latest.
Requests are made against a single base URL, https://app.run.ai.
26 operations11 paths76 schemas5 DELETE11 GET5 POST5 PUT
Metadata
The identity and technical contract details declared by the specification.
NVIDIA Run:ai Credentials 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 26
Across 11 paths, the API surfaces 26 operations — 5 DELETE, 11 GET, 5 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.
Credentials 26
Credentials are used to unlock protected resources such as applications, containers, and other assets. For more information, see [Credentials](https://run-ai-docs.nvidia.com/saas/…
The contract defines 76 schemas that model the data the API accepts and returns. The most detailed are AssetReadOnlyFields (11 properties), AssetCreationFields (7 properties), NgcApiKey (6 properties), DockerRegistry (6 properties). Each schema is shown below with its type and property counts.
CredentialsListResponseEntry
object
5 properties2 required
DataSourceOverrides
object
specific fields to override in the data source.
1 property
AssetsUsageRefCompute
object
GenericSecret
object
6 properties2 required
AccessKey
object
6 properties2 required
Error
object
3 properties2 required
EnvironmentAssetRef
object
Reference information about environment asset.
3 properties2 required
NgcApiKey
object
6 properties2 required
Password
object
6 properties2 required
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.
GenericSecretUpdateRequest
object
1 property
AccessKeySpec
AssetCreationRequest
ComplianceInfoReason
object
An issue preventing the use of a template or asset for creating workloads in a given project.
3 properties1 required
AssetMeta
GenericSecretCreationSpec
object
2 properties
AssetClusterStatusIssues
array
PasswordSpec
AssetClusterStatusIssue
object
3 properties3 required
GenericSecretListResponse
object
1 property1 required
PasswordListResponse
object
1 property1 required
KeyValuePair
object
Details of key-value pair to be stored in the credential.
2 properties
DockerRegistryCreationRequest
object
2 properties2 required
AssetDescription
string
The description of the asset.
AssetClusterStatusInfo
object
4 properties
WorkloadName
string
The name of the workload.
AssetId
string
Unique identifier of the asset.
EncryptionKeyId
object
1 property1 required
NgcApiKeyCreationSpec
object
1 property
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…
DockerRegistryListResponse
object
1 property1 required
AssetReadOnlyFields
object
11 properties6 required
UpdateCount
integer
the value of an update counter of a data in the system.
CredentialsListResponseAssetSpec
object
5 properties
AssetKind
string
The kind of the asset.
AssetSyncStatusEnum
string
AssetDatasourceRef
object
Reference information about a datasource asset.
4 properties3 required
PasswordCreationSpec
object
3 properties
DockerRegistryCreationSpec
object
4 properties
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
GenericSecretKeyValuePairs
array
Set of key-value pairs to store in the new credential.
WorkloadRefAndStatus
object
Id, name and status of a workspace or training
3 properties2 required
PasswordUpdateRequest
object
1 property
GenericSecretCreationRequest
object
2 properties2 required
DockerRegistryUpdateRequest
object
1 property
Scope
string
The scope in which an asset can be used. The highest scope, system, is intended for internal purposes only.
CredentialUpdatableFields
object
1 property
CredentialUpdateRequest
CredentialsListResponse
object
1 property1 required
AssetRef
object
Reference information about an asset.
2 properties2 required
AccessKeyListResponse
object
1 property1 required
DockerRegistry
object
6 properties2 required
NgcApiKeyUpdateRequest
object
1 property
HttpResponse
object
2 properties2 required
ClusterInfo1
object
Cluster related information of the asset.
1 property
WorkloadId1
string
A unique ID of the workload.
WorkloadSupportedTypes
object
5 properties
PasswordCreationRequest
object
2 properties2 required
AssetUpdatableFields
object
2 properties1 required
DockerRegistrySpec
AccessKeyUpdateRequest
object
1 property
ClusterResourceInfo
object
1 property
ToolType
string
Super set of Internal and External tool types.
AccessKeyCreationRequest
object
2 properties2 required
AssetCreationFields
object
7 properties1 required
ScopeType
string
GenericSecretSpec
NgcApiKeyCreationRequest
object
2 properties2 required
ScopeId
string
The id of the cluster, department or project, depending on the scope type.
NgcApiKeyListResponse
object
1 property1 required
NgcApiKeySpec
AccessKeyCreationSpec
object
3 properties
ClusterIdOptional
string
The id of the cluster.
Specification
The full machine-readable OpenAPI contract behind this narrative.
