NVIDIA Run:ai Policy API
Policies allow administrators to impose restrictions and set default values for researcher workloads. Restrictions and default values can be placed on CPUs, GPUs, and other resources or entities. For more information, see [Policies](https://run-ai-docs.nvidia.com/saas/platform-management/policies/#introduction).
NVIDIA Run:ai Policy 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 Policy. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.
This API exposes 25 operations across 7 paths, and defines 378 schemas. It is described by OpenAPI 3.2.0, at version latest.
Requests are made against a single base URL, https://app.run.ai.
25 operations
7 paths
378 schemas
6 DELETE7 GET6 PATCH6 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
NVIDIA Run:ai Policy 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 25
Across 7 paths, the API surfaces 25 operations — 6 DELETE, 7 GET, 6 PATCH, 6 PUT. Each is listed below with its method, path, parameters, and response codes.
Policy 25
Policies allow administrators to impose restrictions and set default values for researcher workloads. Restrictions and default values can be placed on CPUs, GPUs, and other resour…
GET
/api/v2/policy
List policies
PATCH
/api/v2/policy/trainings
Update a training policy.
PUT
/api/v2/policy/trainings
Overwrite a training policy.
GET
/api/v2/policy/trainings
Get a training policy.
DELETE
/api/v2/policy/trainings
Delete a training policy.
PATCH
/api/v2/policy/workspaces
Update a workspace policy.
PUT
/api/v2/policy/workspaces
Overwrite a workspace policy.
GET
/api/v2/policy/workspaces
Get a workspace policy.
DELETE
/api/v2/policy/workspaces
Delete a workspace policy.
PATCH
/api/v2/policy/distributed
Update a distributed policy.
PUT
/api/v2/policy/distributed
Overwrite a distributed policy.
GET
/api/v2/policy/distributed
Get a distributed policy.
DELETE
/api/v2/policy/distributed
Delete a distributed policy.
PATCH
/api/v2/policy/inferences
Update an inference policy.
PUT
/api/v2/policy/inferences
Overwrite an inference policy.
GET
/api/v2/policy/inferences
Get an inference policy.
DELETE
/api/v2/policy/inferences
Delete an inference policy.
PATCH
/api/v2/policy/distributed-inferences
Update a distributed inference policy.
PUT
/api/v2/policy/distributed-inferences
Overwrite a distributed inference policy.
GET
/api/v2/policy/distributed-inferences
Get a distributed inference policy.
DELETE
/api/v2/policy/distributed-inferences
Delete a distributed inference policy.
PATCH
/api/v2/policy/nim-services
Update NVIDIA NIM service policy.
PUT
/api/v2/policy/nim-services
Overwrite NVIDIA NIM service policy.
GET
/api/v2/policy/nim-services
Get NVIDIA NIM service policy.
DELETE
/api/v2/policy/nim-services
Delete NVIDIA NIM service policy.
Schemas 378
The contract defines 378 schemas that model the data the API accepts and returns. The most detailed are ReplicaDefaultsV2 (32 properties), ReplicaRulesV2 (32 properties), DistributedInferenceLeaderWorkerDefaultsV2 (18 properties), DistributedInferenceLeaderWorkerRulesV2 (18 properties). Each schema is shown below with its type and property counts.
NumWorkers
integernull
the number of workers that will be allocated for running the workload.
NimServicePvcFields
objectnull
4 properties
ConfigMapInstance
objectnull
PvcsRules
objectnull
2 properties
AnnotationsDefaults
objectnull
1 property
HostPathsRules
objectnull
2 properties
CpuMemoryRequest
stringnull
The amount of CPU memory to allocate for this workload (1G, 20M, .etc). The workload will receive at least this amount of memory. Note that the workload will n…
DistributedInferenceLeaderDefaults
object
1 property
ClusterIdOptional
stringnull
The id of the cluster.
TenantId
integer
The id of the tenant.
WorkspacePolicyDefaultsV2
HostPathMountPropagationRules
objectnull
Label
objectnull
Label details to be populated into the container.
3 properties
Parallelism
integernull
Used with Hyperparameter Optimization. Specifies the maximum number of pods the workload should run at any given time (applicable to standard training only).
S3Instance
objectnull
NodeSelectorTerm
objectnull
A null or empty node selector term matches no objects. The requirements of them are ANDed.
1 property
ImagePullSecrets
arraynull
A list of references to Kubernetes secrets in the same namespace used for pulling container images.
InitialReplicasField
object
1 property
UidGidSourceOptions
objectnull
1 property
EnvironmentVariablePodFieldReference
objectnull
Details of the field-reference and key use to populate the environment variable
1 property
PvcAccessModesRules
objectnull
Rules for access mode(s) for a newly created PVC.
3 properties
PvcFieldsNonUpdatable
objectnull
6 properties
Preemptibility
stringnull
Specifies whether the workload can be preempted by higher-priority workloads. Valid values are preemptible and non-preemptible. If explicitly set, this value t…
ProjectIdOptional
integernull
The id of the project.
ConcurrencyHardLimitField
object
1 property
CleanPodPolicyRules
objectnull
InferencePolicyRulesV2
DistributedInferenceLeaderRules
object
1 property
DistributedInferenceRulesV2
PvcRules
objectnull
4 properties
TrainingPolicyOverwriteRequestV2
object
2 properties
SecretsRules
objectnull
2 properties
PodAffinityRules
objectnull
2 properties
PvcAccessModes
objectnull
Default access mode(s) applied to newly created PVCs unless explicitly overridden.
3 properties
AllowPrivilegeEscalation
booleannull
Allow the container running the workload and all launched processes to gain additional privileges after the workload starts. For more information consult the U…
Completions
integernull
Used with Hyperparameter Optimization. Specifies the number of successful pods the job should reach to be completed. The Job will be marked as successful once…
WorkspacePolicyRulesV2
CreateHomeDir
booleannull
When set to true, creates a home directory for the container.
SourceOfRule
objectnull
This field is used by the system along with effective rules, in order to specify the org unit from which this effective rule has been derived. It should be lef…
5 properties
1 required
Tolerations
arraynull
Set of tolerations to apply to the workload.
PolicySyncStatusOfCluster
object
3 properties
2 required
InferencePolicyOverwriteRequestV2
object
2 properties
DistributedInferenceReplicasFieldRules
object
1 property
StringRulesCommon
object
3 properties
IntegerRules
objectnull
7 properties
DistributedImposedAssets
objectnull
2 properties
EmptyDirsDefaults
objectnull
2 properties
ScaleDownDelayField
object
1 property
TolerationsDefaults
objectnull
2 properties
InstancesRules
objectnull
1 property
WorkspacePolicyDefaultsAndRulesV2
objectnull
4 properties
ServingPortAccessAuthorizationTypeEnum
stringnull
Specifies who can send inference requests to the serving endpoint: Possible values: - public: No authorization is required. (Default) - authenticatedUsers: Any…
ServingPortAccess
object
4 properties
Args
stringnull
Arguments to the command that the container running the workload executes.
PolicyCreationFields
object
5 properties
2 required
PolicyListResponse
object
1 property
DistributedFrameworkRules
objectnull
Command
stringnull
A command to the server as the entry point of the container running the workload.
GitsRules
objectnull
2 properties
SecretInstance2
objectnull
ExposedUrlRules
objectnull
Rules for the attributed of exposedUrls
7 properties
UidGidSource
stringnull
Indicate the way to determine the user and group ids of the container. The options are a. fromTheImage - user and group ids are determined by the docker image…
CleanPodPolicyOptions
objectnull
1 property
TrainingPolicyRulesV2
ExtendedResourcesRules
objectnull
2 properties
HostNetwork
booleannull
Whether to enable host networking. Default to false.
GitRules
objectnull
4 properties
NimServiceMultiNodeRules
objectnull
1 property
HostPathItems
arraynull
Set of host paths to use in the workload.
MpiLauncherCreationPolicyRules
objectnull
Secret5
ConfigMapsDefaults
objectnull
2 properties
NimServicePolicy
objectnull
4 properties
DistributedInferenceServingPortAccessAuthorizationTypeEnum
stringnull
Specifies who can send inference requests to the serving endpoint: Possible values: - public: No authorization is required. (Default) - authenticatedUsers: Any…
DistributedInferenceServingPortRules-2
objectnull
Defines the configuration for the inference serving endpoint. This determines how applications or services can send inference requests to the workload.
MpiLauncherCreationPolicy
stringnull
Define whether the MPI Launcher is created in parallel with the workers, or if its creation is postponed until all workers are in Ready state. This prevents fa…
S3sDefaults
objectnull
2 properties
AutoScaling
objectnull
Annotations
arraynull
Set of annotations to populate into the container running the workload.
ClusterId
string
The id of the cluster.
DistributedFrameworkOptions
objectnull
1 property
StringRules
objectnull
NimServiceWorkers
integernull
Specifies the number of worker nodes to use when running the NIM service in multi-node.
ServingPortProtocolOptions
objectnull
1 property
ServingPortPort
integernull
The port that the container running the inference service exposes (mandatory).
ProbeHandlerRules
objectnull
1 property
RunAsNonRoot
booleannull
Force the container to run as a non-root user.
ServingPortGrpcPort
integernull
The GRPC port that the container running the inference service exposes.
NfssDefaults
objectnull
2 properties
ExtendedResourceRules
objectnull
Rules for the attributes of extendedResources
1 property
NimServiceMultiNode
objectnull
Defines whether the NIM service runs as a multi-node deployment. If workers is set to 1 or more, the service runs in multi-node.
1 property
Toleration
objectnull
Toleration details.
7 properties
DistributedInferencePolicyDefaultsAndRulesV2
objectnull
4 properties
EmptyDirInstance
objectnull
SecretRules
objectnull
3 properties
WorkspacePolicyV2
objectnull
4 properties
WorkspacePolicyChangeRequestV2
object
3 properties
Probes
objectnull
Probes are used to determine if the container is healthy and ready to accept traffic.
1 property
PreemptibilityRules
objectnull
GitPassword
objectnull
3 properties
HostPathInstance
objectnull
ServingPortExposedUrl
stringnull
The custom URL to use for the serving port. If empty (default), an autogenerated URL will be used.
CpuCoreLimit
numbernull
Limitations on the number of CPUs consumed by the workload (0.5, 1, .etc). The system guarantees that this workload will not be able to consume more than this…
Tty
booleannull
Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
ImagePullSecretsRules
objectnull
2 properties
ImagePullSecret
objectnull
A reference to a secret in the same namespace used to pull container images.
3 properties
NimServicePolicyDefaultsAndRules
objectnull
3 properties
SupplementalGroups
stringnull
Comma separated list of groups that the user running the container belongs to, in addition to the group indicated by runAsGid. Use only when the source uid/gid…
UidGidSourceRules
objectnull
DistributedInferenceWorkersFieldRules
object
1 property
SeccompProfileTypeRules
objectnull
SecretFieldsUpdatable
objectnull
2 properties
ServingPortServiceTypeOptions
objectnull
1 property
Ports
arraynull
Set of container ports that the workload exposes.
HostIpc
booleannull
Whether to enable host IPC. Defaults to false.
GitsDefaults
objectnull
2 properties
DistributedInferenceRestartPolicyRules
objectnull
DistributedInferenceStartupPolicyFieldRules
objectnull
1 property
PvcsDefaults
objectnull
2 properties
QuantityRules
objectnull
6 properties
EmptyDirsRules
objectnull
2 properties
Annotation
objectnull
Annotation details to be populated into the container.
3 properties
ExposedUrls
arraynull
Set of container ports that the workload exposes via URLs.
HostPath
objectnull
4 properties
PvcClaimSize
stringnull
Requested size for the PVC. Mandatory when existingPvc is false. Recommended sizes: TB/GB/MB/TIB/GIB/MIB
Labels
arraynull
Set of labels to populate into the container running the workload.
TrainingPolicyDefaultsV2
TerminateAfterPreemption
booleannull
Indicates if the job should be terminated by the system after it has been preempted.
GitItems
arraynull
Set of git repositories to use in the workload.
RunAsUid
integernull
The user id to run the entrypoint of the container which executes the workspace. Default to the value specified in the environment asset runAsUid field (option…
MpiLauncherCreationPolicyOptions
objectnull
1 property
MaxReplicas
integernull
the upper limit for the number of worker pods that can be set by the autoscaler. Cannot be smaller than MinReplicas. (applicable only for PyTorch)
PolicyId
string
The unique id of the policy.
StringOption
object
One of the values that the field can be assigned to, when options police is applied on the field.
2 properties
1 required
NimServiceServingPortRules
objectnull
A port for accessing the inference service
7 properties
GpuRequestRules
objectnull
InferencesMaxReplicasField
object
1 property
InitializationTimeoutField
object
1 property
DistributedInferenceImposedAssets
objectnull
2 properties
Image
stringnull
Docker image name. For more information, see [Images](https://kubernetes.io/docs/concepts/containers/images). The image name is mandatory for creating a worklo…
PolicyReadOnlyFields
object
7 properties
5 required
DistributedInferencePolicyChangeRequestV2
object
3 properties
DistributedPolicyV2
objectnull
4 properties
DistributedInferenceLeaderWorkerRulesV2
object
18 properties
AutoScalingField
object
1 property
ImposedAssets
arraynull
a list of datasource assets to import into the policy. these datasources will be included in any workload that will be created in the scope of the policy.
DistributedPolicyChangeRequestV2
object
3 properties
TrainingPolicyChangeRequestV2
object
3 properties
PvcItems
arraynull
Set of pvc persistent volume claims to use in the workload.
S3AccessKey
objectnull
3 properties
EnvironmentVariableSecret
objectnull
Details of the secret and key use to populate the environment variable
2 properties
PolicyListEntry
objectnull
3 properties
TrainingPolicyV2
objectnull
4 properties
PortsDefaults
objectnull
2 properties
ServingPortRules
objectnull
6 properties
RestartPolicyRule
objectnull
Category
stringnull
Specify the workload category assigned to the workload. Categories are used to classify and monitor different types of workloads within the NVIDIA Run:ai platf…
GpuMemoryRequest
stringnull
Required if and only if gpuRequestType is memory. States the GPU memory to allocate for the created workload, per GPU device. Note that the workload will not b…
DistributedPolicyDefaultsAndRulesV2
objectnull
4 properties
Capability
string
ExtendedResources
arraynull
Extended resources and their quantity.
HostPathMountPropagation
stringnull
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…
TolerationOperatorRules
objectnull
MatchExpressionOperator
string
Represents a key's relationship to a set of values (mandatory).
ProbeHandler
objectnull
The action taken to determine the health of the container. (mandatory)
1 property
SecretFieldsNonUpdatable
objectnull
1 property
ServingPortProtocolRules
objectnull
ExposedUrlsRules
objectnull
2 properties
ClaimInfo
objectnull
Claim information for the newly created PVC. The information should not be provided when attempting to use existing PVC.
5 properties
S3Items
arraynull
Set of s3 buckets to use in the workload.
MetricThresholdField
object
1 property
DistributedInferenceWorkerRules
object
1 property
DefaultFromRule
objectnull
2 properties
Pvc
DistributedPolicyRulesV2
objectnull
2 properties
PvcInstance
objectnull
BackoffLimit
integernull
Specifies the number of retries before marking a workload as failed (not applicable to Inference workloads). The default value is 6.
TolerationsRules
objectnull
2 properties
TerminationGracePeriod
integernull
Duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the po…
PortsRules
objectnull
2 properties
ImagePullPolicyOptions
objectnull
1 property
DistributedInferenceWorkersField
object
1 property
ImagePullPolicy
stringnull
Image pull policy. Defaults to Always if :latest tag is specified, otherwise it is IfNotPresent.
SecretsDefaults
objectnull
2 properties
NodeAffinityRequired
objectnull
If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements…
1 property
ServingPortMetricsPort
integernull
The port where metrics are exposed, required only if it's different than the main port.
ProbesRules
objectnull
1 property
DistributedInferenceServingPortAuthorizationTypeRules
objectnull
Timestamp
string
The time at which an event occurred. e.g. the time an effective policy has been updated
ImagePullPolicyRules
objectnull
PolicySyncStatus
object
1 property
NimServiceRules
InferenceFieldsRules
objectnull
2 properties
DistributedInferencePolicyV2
objectnull
4 properties
Capabilities
arraynull
Add POSIX capabilities to running containers. Defaults to the default set of capabilities granted by the container runtime.
TolerationRules
objectnull
Toleration details.
6 properties
RelatedUrlsDefaults
objectnull
2 properties
AutoScalingMetricNim
stringnull
The metric to use for autoscaling (mandatory).
AutoScalingMinReplicas
integernull
The minimum number of replicas for autoscaling. Defaults to 1.
ServingPortAuthorizationTypeOptions
objectnull
1 property
DataVolumeItems
arraynull
Set of data volumes to use in the workload.
NimServiceNgcAuthSecret
stringnull
The name of a Kubernetes secret containing the NGC access credentials. The secret must contain a key named NGCAPIKEY with the API key as the value.
PodAffinityType
stringnull
The affinity type, required or preferred. (mandatory)
DistributedInferenceWorkerDefaults
object
1 property
NumberRules
objectnull
7 properties
ProbeRules
objectnull
6 properties
ServingPortAuthorizationTypeRules
objectnull
RestartPolicyOptions
objectnull
1 property
PvcFieldsUpdatable
objectnull
1 property
Error
object
3 properties
2 required
DistributedInferencePolicyOverwriteRequestV2
object
2 properties
S3Rules
objectnull
3 properties
InferencePolicyDefaultsAndRulesV2
objectnull
4 properties
GitAuthenticationMethod
string
Specifies the authentication method to use when accessing the Git repository. This is required for private repositories - password - Authenticate using a usern…
DistributedInferenceRestartPolicyOptions
objectnull
1 property
DefaultMode
stringnull
File permission mode in octal string format. This value must be a 4-digit octal number, representing the default file mode when mounting a Secret or ConfigMap…
PriorityClass
stringnull
Specifies the priority class for the workload, which determines its scheduling behavior. Valid values are: very-low, low, medium-low, medium, medium-high, high…
InferencePolicyV2
objectnull
4 properties
GitSecretRef
objectnull
4 properties
ImagePullSecretsRulesAttributes
objectnull
Rules for the attributes of imagePullSecrets
2 properties
RelatedUrls
arraynull
Set of URLs that are related to the workload.
PolicyType
string
The type of policy which determines the kind of workloads it is affecting
ServingPortExposedProtocolOptions
objectnull
1 property
GitCommon
objectnull
4 properties
PvcVolumeMode
stringnull
Default volume mode for the PVC. Choose between Filesystem (default) or Block.
TolerationOperatorOptions
objectnull
1 property
DistributedFramework
stringnull
The distributed training framework used in the workload.
HostPathMountPropagationOptions
object
1 property
ServingPortServiceType
stringnull
The type of Kubernetes service to create for the inference deployment. Options include 'ClusterIP' (default), 'NodePort', 'LoadBalancer', and 'ExternalName'.
ServingPortExposedProtocol
stringnull
The protocol to use for the exposed URL. If grpcPort is set, this defaults to grpc. Otherwise, it defaults to http.
ReplicaRulesV2
objectnull
32 properties
RelatedUrlRules
objectnull
Rules for the attributes of relatedUrls
3 properties
FieldsToReset
array
set of fields in jsonpath format that is requested to clear their policy (default and rules)
PodAffinityTypeRules
objectnull
NimServicePolicyOverwriteRequest
object
2 properties
SeccompProfileType
stringnull
Indicates which kind of seccomp profile will be applied to the container. The options are a. RuntimeDefault - the container runtime default profile should be u…
ScopeType
string
EnvironmentVariable
objectnull
Details of an environment variable which is populated into the container.
8 properties
NimCacheRules
objectnull
2 properties
AutoScalingCommonFields
objectnull
EnvironmentVariables
arraynull
Set of environment variables to populate into the container running the workload.
ServingPort
objectnull
A port for accessing the inference service
Probe
objectnull
6 properties
PortServiceTypeRules
objectnull
Port
objectnull
A port for accessing the workload.
7 properties
DataVolumeInstance
objectnull
ExtendedResourcesDefaults
objectnull
2 properties
AutoDeletionTimeAfterPreemption
integernull
Specifies the duration after which a finished workload (completed or failed) will be automatically deleted. The default is 30 days. Log retention is managed se…
DistributedInferenceServingPortAuthorizationTypeOptions
objectnull
1 property
ExtendedResource
objectnull
Quantity of an extended resource.
3 properties
ArrayRules
objectnull
4 properties
PolicyValidationStatus
objectnull
1 property
Nfs
objectnull
4 properties
PortServiceType
stringnull
The service type of the port (mandatory).
ServingPortExposedProtocolRules
objectnull
ServingPortContainerAndProtocol
object
2 properties
DistributedInferenceServingPortAccess
object
5 properties
ClaimInfoRules
objectnull
3 properties
SeccompProfileTypeOptions
objectnull
1 property
AutoScalingMetricOptions
objectnull
1 property
S3Common
objectnull
3 properties
EmptyDir
objectnull
3 properties
AutoScalingMetricFields
objectnull
MatchExpression
objectnull
A selector that contains values, a key, and an operator that relates the key and values.
3 properties
2 required
EmptyDirItems
arraynull
A list of emptyDir volumes to mount in the workload.
ServingConfigurationRules
objectnull
2 properties
Stdin
booleannull
Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in…
GpuRequestType
stringnull
Sets the unit type for GPU resources requests. Stated in terms of portion or memory. Sets the unit type for other GPU request fields. If gpuDevicesRequest 1, o…
PvcAddedAttrValue
object
2 properties
1 required
PolicyMeta
InferencePolicyChangeRequestV2
object
3 properties
DistributedInferenceServingPortRules
objectnull
7 properties
WorkspacePolicyOverwriteRequestV2
object
2 properties
ConfigMapItems
arraynull
Set of config map volumes to use in the workload
RelatedUrl
objectnull
A URL that is related to the workload. For example, a URL to an external server providing statistics or logging about the workload.
4 properties
NfssRules
objectnull
2 properties
ExposedUrl
objectnull
A URL for accessing the workload.
9 properties
EnvironmentVariableUserCredential
objectnull
Defines a reference to a user-created credential and a specific key within that credential whose value will populate the environment variable. User credentials…
2 properties
CpuCoreRequest
numbernull
CPU units to allocate for the created workload (0.5, 1, .etc). The workload will receive at least this amount of CPU. Note that the workload will not be schedu…
PolicyName
string
A chosen name for the policy.
WorkingDir
stringnull
Container's working directory. If not specified, the container runtime default will be used. This may be configured in the container image.
CpuMemoryLimit
stringnull
Limitations on the CPU memory to allocate for this workload (1G, 20M, .etc). The system guarantees that this workload will not be able to consume more than thi…
TolerationEffectOptions
objectnull
1 property
StringRulesOptions
object
1 property
InferencesMinReplicasField
object
1 property
DataVolumesRules
objectnull
2 properties
DistributedInferenceDefaultsV2
DataVolumeRules
objectnull
2 properties
AutoScalingScaleWindowSeconds
integernull
The time window for autoscaling decisions, in seconds. Defaults to 300 seconds.
DistributedPolicyOverwriteRequestV2
object
2 properties
GitInstance
objectnull
NimServicePolicyChangeRequest
object
3 properties
RestartPolicy
stringnull
Specify the restart policy of the workload pods. Default is empty, which is determine by the framework default
GpuPortionRequest
numbernull
Required if and only if gpuRequestType is portion. States the portion of the GPU to allocate for the created workload, per GPU device, between 0 and 1. The def…
DistributedInferenceLeaderWorkerDefaultsV2
object
18 properties
ScaleToZeroRetentionField
object
1 property
DistributedInferenceRestartPolicy
stringnull
Determines the behavior when a pod fails. - RecreateGroupOnPodRestart: Restarts all pods in the group if any pod fails. - None: No automatic restart behavior i…
ExposedUrlsDefaults
objectnull
2 properties
MinReplicas
integernull
the lower limit for the number of worker pods to which the training job can scale down. (applicable only for PyTorch)
LargeShmRequest
booleannull
A large /dev/shm device to mount into a container running the created workload. An shm is a shared file system mounted on RAM.
ConfigMapsRules
objectnull
2 properties
EnvironmentVariableConfigMap
objectnull
Details of the configMap and key use to populate the environment variable
2 properties
IntegerRulesOptional
objectnull
6 properties
NimServiceServingPort
objectnull
A port for accessing the inference service
7 properties
NodeType2
stringnull
Nodes (machines), or a group of nodes on which the workload will run. To use this feature, your Administrator will need to label nodes. For more information, s…
ArbitraryRules
objectnull
3 properties
ItemRules
objectnull
3 properties
GpuDevicesRequest
integernull
Requested number of GPU devices. Currently if more than one device is requested, it is not possible to provide values for gpuMemory or gpuPortion.
EmptyDirRules
objectnull
3 properties
S3sRules
objectnull
2 properties
NimCache
objectnull
The specification of a NIM cache volume.
2 properties
InferencePolicyDefaultsV2
DistributedInferenceStartupPolicyField
objectnull
1 property
NimServiceDefaults
PreemptibilityOptions
objectnull
1 property
DepartmentIdOptional
stringnull
The id of the department.
TolerationEffect
stringnull
The taint effect to match. (mandatory)
DistributedInferenceStartupPolicyOptions
objectnull
1 property
ImagePullSecretsDefaults
objectnull
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…
ServingConfigurationField
object
1 property
NimServiceReplicas
integernull
The number of replicas to deploy.
AutoScalingMaxReplicas
integernull
The maximum number of replicas for autoscaling. Defaults to minReplicas. Must be no less than minReplicas.
MetricThresholdPercentageField
object
1 property
PortServiceTypeOptions
objectnull
1 property
TrainingPolicyDefaultsAndRulesV2
objectnull
4 properties
StorageInstanceName
objectnull
1 property
AuthorizationType
stringnull
Specifies who can access the connection URL: - authenticatedUsers: Any authenticated user or service account can access the URL; the authorizedUsers and author…
ConfigMapRules
objectnull
4 properties
EnvironmentVariablesDefaults
objectnull
1 property
InferenceFields
objectnull
ServingPortProtocol
stringnull
The protocol used by the port, defaults to http
DistributedInferenceStartupPolicy
stringnull
Determines when the worker pods should start during workload initialization. - LeaderCreated: Workers start after the leader pod is created. - LeaderReady: Wor…
NfsItems
arraynull
Set of nfs volumes to use in the workload.
DataVolumesDefaults
objectnull
2 properties
PodAffinity
objectnull
Pod affinity scheduling rules (e.g. co-locate this workload in the same node, zone, etc. as some other workloads).
2 properties
ServingPortExposeExternally
booleannull
Indicates whether the inference serving endpoint should be accessible outside the cluster. If set to true, the endpoint will be exposed externally. To enable e…
DistributedInferenceReplicasField
object
1 property
DistributedInferenceServingPort
objectnull
Defines the configuration for the inference serving endpoint. This determines how applications or services can send inference requests to the workload.
DistributedInferenceServingPortProtocol
stringnull
The protocol used to access the port.
SshAuthMountPath
stringnull
Specifies the directory where SSH keys are mounted. (applicable only for MPI)
DistributedInferenceServingPortContainerAndProtocol
object
2 properties
ProbeHandlerScheme
stringnull
Scheme to use for connecting to the host, defaults to HTTP.
NodePools
arraynull
A prioritized list of node pools for the scheduler to run the workload on. The scheduler will always try to use the first node pool before moving to the next o…
RunAsGid
integernull
The group id to run the entrypoint of the container which executes the workspace. Default to the value specified in the environment asset runAsGid field (optio…
SecretItems1
arraynull
Set of secret volumes to use in the workload
BooleanRules
objectnull
3 properties
SlotsPerWorker
integernull
Specifies the number of slots per worker used in hostfile. Defaults to 1. (applicable only for MPI)
TolerationOperator
stringnull
A key's relationship to the value. Equal uses key and value. Exists is equivalent to wildcard for value, so that a workload can tolerate all taints of a partic…
AutoScalingMetricField
object
1 property
CleanPodPolicy
stringnull
The policy describes how to deal with pods when the job is finished.
DataVolume
objectnull
2 properties
ReplicaDefaultsV2
objectnull
32 properties
AutoScalingRules
objectnull
11 properties
HostPathsDefaults
objectnull
2 properties
DistributedPolicyDefaultsV2
objectnull
2 properties
HostPathRules
objectnull
4 properties
TolerationEffectRules
objectnull
AutoScalingMetric
stringnull
The metric to use for autoscaling. Mandatory if minReplicas < maxReplicas, except for the special case where minReplicas is set to 0 and maxReplicas is set to…
AutoScalingMetricRules
objectnull
ExcludeField
objectnull
1 property
ReadOnlyRootFileSystem
booleannull
If true, mounts the container's root filesystem as read-only.
DistributedInferenceCommonDefaultsV2
objectnull
NfsInstance
objectnull
DistributedInferenceCommonRulesV2
objectnull
AutoScalingMetricThreshold
integernull
The threshold to use with the specified metric for autoscaling (mandatory).
LabelsDefaults
objectnull
1 property
RelatedUrlsRules
objectnull
2 properties
NfsRules
objectnull
4 properties
GpuPortionLimit
numbernull
Limitations on the portion consumed by the workload, per GPU device. The system guarantees The gpuPotionLimit must be no less than the gpuPortionRequest.
GpuRequestOptions
objectnull
1 property
ServingConfiguration
objectnull
The inference workload serving configuration.
2 properties
PodAffinityTypeOptions
object
1 property
ServingPortServiceTypeRules
objectnull
ConfigMap
objectnull
4 properties
GpuMemoryLimit
stringnull
Limitation on the memory consumed by the workload, per GPU device. The system guarantees The gpuMemoryLimit must be no less than gpuMemoryRequest.
PortRules
objectnull
Rules for port attributes
6 properties
ActivationReplicasField
object
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from NVIDIA Run:ai 12
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
#Policy
Where this information came from
This is an independent, third-party profile of NVIDIA Run:ai Policy API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.