For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Documentation Reference

Skip to navigation

REST API Notifications

Email

||View as Markdown|

This page is for Self-Hosted, version v3.0 (default). For other versions, use one of these documentation indexes: - v3.0 (default): https://docs.nvidia.com/run-ai/self-hosted/v3.0/llms.txt - v2.26: https://docs.nvidia.com/run-ai/self-hosted/v2.26/llms.txt - v2.25: https://docs.nvidia.com/run-ai/self-hosted/v2.25/llms.txt - v2.24: https://docs.nvidia.com/run-ai/self-hosted/v2.24/llms.txt

Configure Email notifications for your organization.

Documentation Reference

- Home
REST API
CLI

Home
About the REST API
Making REST API Requests
Pagination
HTTP Status Codes
How to Authenticate to the API
NVIDIA Run:ai API Policy
Clusters
Get a list of clusters.
Create a cluster.
Get clusters minimal data
Get cluster minimal data by id
Get cluster by id.
Update a cluster by id.
Delete a cluster by id.
Get the cluster metrics data.
Retrieve the installation instructions of a cluster by ID.
Departments
Get departments
Create department
Get department
Update department
Delete department
Update department resources
Patch department resources
Get department metrics data.
Get departments telemetry
Count departments
Get departments node pool resources
Count departments node pool resources
Patch multiple departments node pool resources in batch.
List reports
Create a new report request.
Count reports
Reports availability
Delete multiple reports in batch.
Get report
Delete report
Download report
Node Pools
Get the node pool metrics data.
Get nodepools
Create nodepool
Count nodepools
Get nodepools minimal
Get nodepool
Update nodepool
Delete nodepool
Patch nodepool fields
Get nodepool minimal data by ID
Update a Node Pool.
Delete a Node Pool by id.
Update labels of a Node Pool.
Get the cluster's Node Pools.
Create a Node Pool.
Nodes
Count nodes
Get a list of nodes.
Get a node by ID.
Count tenant nodes
Get node telemetry data.
Get the node metrics data.
Projects
Get projects
Create project
Get project
Update project
Delete project
Update project resources
Patch project resources
Get project metrics data.
Get projects telemetry
Count projects
Get projects node pool resources
Count projects node pool resources
Patch multiple projects node pool resources in batch.
Logo
Get tenant logo. (base64)
Upload logo for tenant. (base64)
Download Unix installer script
Get Unix installer script commands
Download Mac installer script
Get Mac installer script commands
Download Linux installer script
Get Linux installer script commands
Get Windows MSI installer script commands
Download RunAI Researcher command line binary
Get CLI document by name
Download Unix installer script
Get Unix installer script commands
Download Mac installer script
Get Mac installer script commands
Download Linux installer script
Get Linux installer script commands
Get Windows MSI installer script commands
Download RunAI Researcher command line binary
Get CLI document by name
Network Topologies
Get network topologies.
Create network topologies
Count the amount of network topologies in a tenant.
Get network topology by id.
Delete network topology by ID.
Access Keys
Get a list of access keys.
Create an access key.
Get access key by id.
Delete an access key by id.
Regenerate an access key secret.
Get a list of all access keys.
Delete an access key by id for administrations.
Access Rules
List the access rules.
Create an access rule.
Get an access rule.
Delete an access rule.
Count access rules.
Delete Multiple Access Rules
Create Multiple Access Rules
Create an access rule for authenticated users/service accounts
Permissions
Get permission sets.
Get permission set by id.
Get a summary of user permissions.
Calculate permitted scopes.
Service Accounts
Get a list of service accounts.
Create a service account.
Get service account by id.
Delete a service account by id.
Update service account details by id.
Regenerate a service account secret.
Roles
Get a list of roles.
Create a role.
Get a role by id.
Update a role by id.
Delete a role by id.
Enable a role by id.
Disable a role by id.
Tokens
Create an access token v1
Create an access token v2
Get users.
Create a local user.
Get minimal user display information.
Count users
Logout a user.
Reset a user's password.
Get a user by id.
Delete a user by id.
Update a user by id.
change user password
Get external idps list
Configure external idp
Get external idp by alias
Update external idp by alias
Delete external idp by alias
Get idp mappers
Update idp mappers
Me
List the access rules assigned to the requesting user.
Count the access rules assigned to the requesting user.
Settings
Get cluster settings
Get cluster setting by key
Update cluster setting by key
Get node pool settings
Get node pool setting by key
Update node pool setting by key
Get org unit settings
Get org unit setting by key
Update org unit setting by key
Get authorization settings
Get authorization setting by key
Update authorization setting by key
Get security settings
Get security setting by key
Update security setting by key
Get all workloads settings.
Get a workloads setting by key.
Update a workloads setting by key.
Get workloads settings
Get workloads setting by key
Update workloads setting by key
Get datavolumes settings
Get datavolumes setting by key
Update datavolumes setting by key
Get notifications settings
Get notifications setting by key
Update notifications setting by key
Get branding settings
Get branding setting by key
Update branding setting by key
Org Unit
Get ranks
Audit Logs
Get audit logs
Download audit logs
List datavolumes in permitted scopes
Create a datavolume
Get datavolume
Delete datavolume
Patch datavolume
Data volumes name availability.
Count data volumes.
Get the datavolume's shared scopes
Patch the datavolume's shared scopes
Events
Get the workload events.
Get the workload history.
Get revision events by id.
Get the revision history.
Pods
List pods.
Get pod metrics data.
Get workload pods by id.
Get pods count.
Get revision pods by id.
List workloads.
Get a workload.
Count workloads.
Get the workloads telemetry.
Get workload metrics data.
Get workload endpoints.
Get workload structure elements by workload id.
Get a single workload structure element by element id.
Get element metrics data.
Count workload structure elements.
Workloads V2
Create a workload.
Get a specific workload.
Update workload spec.
Delete a workload.
Nvidia Nim
Create a NVIDIA NIM service. [Experimental]
Get a NVIDIA NIM service. [Experimental]
Update NVIDIA NIM service spec. [Experimental]
Workspaces
Create a workspace.
Get workspace data.
Delete a workspace.
Suspend a workspace.
Resume a workspace.
Trainings
Create a training.
Get training data.
Delete a training.
Suspend a training.
Resume a training.
Inferences
Create an inference.
Get inference data.
Delete an inference.
Update inference spec.
Get inference metrics data.
Get inference pod's metrics data.
Revisions
Get inference workload revisions by id.
Get inference workload revisions count.
Get revision data.
Distributed
Create a distributed training.
Get distributed training's data. [Experimental]
Delete a distributed training by id.
Suspend a distributed training.
Resume a distributed training.
Workload batch operations.
Workload Properties
List workload categories.
Get workload category by id.
List workload types.
Create a workload type. [Experimental]
List workload type by id.
Update a workload type by id.
Delete a workload type by id. [Experimental]
Get workload priorities.
Workload Templates
List templates. [Experimental]
Template name availability
Get a template, any type. [Experimental]
Count templates. [Experimental]
List all workspace templates. [Experimental]
Create a new workspace template. [Experimental]
Retrieve a specific workspace template by ID. [Experimental]
Update a workspace template by ID. [Experimental]
Delete a workspace template by ID. [Experimental]
Patch a workspace template by ID. [Experimental]
List all training templates. [Experimental]
Create a new training template. [Experimental]
Retrieve a specific training template by ID. [Experimental]
Update a training template by ID. [Experimental]
Delete a training template by ID. [Experimental]
Patch a training template by ID. [Experimental]
List all distributed training templates. [Experimental]
Create a new distributed training template. [Experimental]
Get a specific distributed training template by ID. [Experimental]
Update a distributed training template by ID. [Experimental]
Delete a distributed training template by ID. [Experimental]
Patch a distributed training template by ID. [Experimental]
List all inference templates.
Create a new inference template.
Get a specific inference template by ID.
Delete an inference template by ID.
Distributed Inferences
Create a distributed inference.
Get a distributed inference data.
Delete a distributed inference.
Update distributed inference spec.
Compute
List compute assets.
Create compute asset.
Retrieve a compute asset.
Update a compute asset.
Delete a compute asset.
Credentials
List credentials.
List access keys.
Create an access key.
Get an access key.
Update an access key.
Delete an access key.
List password credentials.
Create a userid / password credential.
Get a userid / password credential.
Update a password credential.
Delete a password asset.
List docker registry credentials.
Create a docker registry credential.
Get a docker registry credential.
Update a docker registry credential.
Delete a docker registry credential.
List generic-secrets.
Create a generic-secret.
Get a generic-secret.
Update a generic-secret.
Delete a generic-secret.
List ngc-api-keys.
Create a ngc-api-key.
Get a ngc-api-key.
Update a ngc-api-key.
Delete a ngc-api-key.
Datasources
List datasource assets.
Environment
List environment assets.
Create an environment asset.
Get an environment asset.
Update an environment asset.
Delete an environment asset.
Get all storageClasses from a cluster.
get a Storage Class/Classes for a given cluster
get a Storage Class/Classes for a given cluster
List storage class configurations
Create storage class configuration
Get storage class configuration by id
Update storage class configuration by id
Delete storage class configuration by id
Patch storage class configuration by id
Git
List Git assets.
Create a Git asset.
Get a Git asset.
Update a Git asset.
Delete a Git asset.
Host Path
List host path assets.
Create a host path asset.
Get a hostPath asset.
Update a hostPath asset.
Delete a hostPath asset.
Nfs
List NFS assets.
Create an NFS asset.
Get an NFS asset.
Update an NFS asset.
Delete an NFS asset.
Pvc
List PVC assets.
Create a PVC asset.
Get a PVC asset.
Update a PVC asset.
Delete a PVC asset.
Get the PVC history.
Registry
Get registries.
Create a registry asset.
Get a registry.
Update a registry asset.
Delete a registry asset.
Get the repositories in the registry.
Get the repositories tags in the registry.
S3
List S3 assets.
Create an S3 asset.
Get an S3 asset.
Update an S3 asset.
Delete an S3 asset.
Config MAP
List ConfigMap datasource assets.
Create a ConfigMap datasource asset.
Get a ConfigMap asset.
Update a ConfigMap asset.
Delete a ConfigMap asset.
Secret
List Secret datasource assets.
Create a Secret datasource asset.
Get a Secret asset.
Update a Secret asset.
Delete a Secret asset.
Template
List templates.
Create a template.
Get a template.
Update a template.
Delete a template.
Policy
List policies
Get a training policy.
Overwrite a training policy.
Delete a training policy.
Update a training policy.
Get a workspace policy.
Overwrite a workspace policy.
Delete a workspace policy.
Update a workspace policy.
Get a distributed policy.
Overwrite a distributed policy.
Delete a distributed policy.
Update a distributed policy.
Get an inference policy.
Overwrite an inference policy.
Delete an inference policy.
Update an inference policy.
Get a distributed inference policy.
Overwrite a distributed inference policy.
Delete a distributed inference policy.
Update a distributed inference policy.
Get NVIDIA NIM service policy.
Overwrite NVIDIA NIM service policy.
Delete NVIDIA NIM service policy.
Update NVIDIA NIM service policy.
Get minimal mapping info. [experimental]
Get mapping field info. [experimental]
List policies. [experimental]
Create a policy. [experimental]
Get the effective policy by type and scope. The effective policy is a combination of the policy provided for the given scope (if exist) and the effective policies of its parent scopes.
Get a policy. [experimental]
Replace a policy. [experimental]
Delete a policy. [experimental]
Patch a policy. [experimental]
Delete rules from a policy. [experimental]
Notification State
Get notification state
Update notification state
Notification Types
Get notification types
Notification Channels
Get supported Notification Channels
Create notification channel
Get notification channel
Update notification channel
Delete notification channel
Patch notification channel
Validate configuration of Notification Channel
Slack
Get slack notification channel
Patch slack notification channel
Get slack notification state
Update slack notification state
Create Slack app
Delete Slack app
Connect Slack workspace
Disconnect Slack workspace
Validate configuration of Slack Channel
Create Slack app
Email
Get email notification channel
Create email notification channel
Update email notification channel
Delete email notification channel
Patch email notification channel
Get email notification state
Update email notification state
Validate configuration of Email Channel
Subscriptions
Get user subscriptions
Create user subscription
Update user subscription
Delete user subscription
List AI applications. [Experimental]
Create AI application.
Upload a Helm chart archive.
Count AI applications. [Experimental]
Get AI application. [Experimental]
Delete AI application.
Interacting with Workloads Using the Cluster API
Configuring Slack Notifications
Using Node Affinity via API
NIM Observability Metrics via API
API Python Client (runapy)
Install and Configure the Client
Install and Configure CLI
Add NVIDIA Run:ai Authorization to Kubeconfig
Auto Update CLI Mechanism
CLI Commands Examples
Command Reference
runai application
runai application delete
runai application describe
runai application list
runai application submit
runai auth
runai auth get-token
runai cluster
runai cluster list
runai cluster set
runai compute
runai compute describe
runai compute list
runai config
runai config describe
runai config generate
runai config set
runai credential
runai credential list
runai datasource
runai datasource describe
runai datasource list
runai datavolume
runai datavolume list
runai department
runai department list
runai diagnostics
runai diagnostics collect-logs
runai environment
runai environment describe
runai environment list
runai inference
runai inference bash
runai inference delete
runai inference describe
runai inference distributed
runai inference distributed bash
runai inference distributed delete
runai inference distributed describe
runai inference distributed exec
runai inference distributed list
runai inference distributed logs
runai inference distributed port-forward
runai inference distributed scale
runai inference distributed submit
runai inference exec
runai inference list
runai inference logs
runai inference nim
runai inference nim bash
runai inference nim delete
runai inference nim describe
runai inference nim exec
runai inference nim list
runai inference nim logs
runai inference nim port-forward
runai inference nim scale
runai inference nim submit
runai inference nim update
runai inference port-forward
runai inference standard
runai inference standard bash
runai inference standard delete
runai inference standard describe
runai inference standard exec
runai inference standard list
runai inference standard logs
runai inference standard port-forward
runai inference standard submit
runai inference standard update
runai inference submit
runai inference update
runai kubeconfig
runai kubeconfig set
runai login
runai login access-key
runai login sso
runai login user
runai logout
runai mpi
runai mpi attach
runai mpi bash
runai mpi delete
runai mpi describe
runai mpi exec
runai mpi list
runai mpi logs
runai mpi port-forward
runai mpi resume
runai mpi submit
runai mpi suspend
runai my-credential
runai my-credential create
runai my-credential delete
runai my-credential list
runai node
runai node list
runai nodepool
runai nodepool list
runai project
runai project create
runai project list
runai project set
runai pvc
runai pvc list
runai pytorch
runai pytorch attach
runai pytorch bash
runai pytorch delete
runai pytorch describe
runai pytorch exec
runai pytorch list
runai pytorch logs
runai pytorch port-forward
runai pytorch resume
runai pytorch submit
runai pytorch suspend
runai report
runai report metrics
runai report metrics clear
runai report metrics config
runai report metrics output
runai template
runai template describe
runai template list
runai training
runai training attach
runai training bash
runai training delete
runai training describe
runai training exec
runai training list
runai training logs
runai training mpi
runai training mpi attach
runai training mpi bash
runai training mpi delete
runai training mpi describe
runai training mpi exec
runai training mpi list
runai training mpi logs
runai training mpi port-forward
runai training mpi resume
runai training mpi submit
runai training mpi suspend
runai training port-forward
runai training pytorch
runai training pytorch attach
runai training pytorch bash
runai training pytorch delete
runai training pytorch describe
runai training pytorch exec
runai training pytorch list
runai training pytorch logs
runai training pytorch port-forward
runai training pytorch resume
runai training pytorch submit
runai training pytorch suspend
runai training resume
runai training standard
runai training standard attach
runai training standard bash
runai training standard delete
runai training standard describe
runai training standard exec
runai training standard list
runai training standard logs
runai training standard port-forward
runai training standard resume
runai training standard submit
runai training standard suspend
runai training submit
runai training suspend
runai upgrade
runai version
runai whoami
runai workload
runai workload delete
runai workload describe
runai workload exec
runai workload list
runai workload logs
runai workload submit
runai workload-type
runai workload-type describe
runai workload-type list
runai workspace
runai workspace attach
runai workspace bash
runai workspace delete
runai workspace describe
runai workspace exec
runai workspace list
runai workspace logs
runai workspace port-forward
runai workspace resume
runai workspace submit
runai workspace suspend

Self-Hosted
Multi-Tenant

v3.0
v2.26
v2.25
v2.24

Developer-friendly docs for your API