For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
GitHub
DocumentationREST API Reference
DocumentationREST API Reference
    • Getting Started
  • API Reference
    • Service Account
    • Infrastructure Provider
    • Tenant
    • Tenant Account
    • Site
    • Allocation
    • IP Block
    • VPC
    • VPC Peering
    • VPC Prefix
    • Subnet
    • Expected Machine
    • Expected Power Shelf
    • Expected Rack
    • Expected Switch
    • SKU
    • Infini Band Partition
    • Nv Link Logical Partition
    • Instance Type
    • Instance
      • GETRetrieve all Instances
      • POSTCreate an Instance
      • POSTBatch Create Instances
      • GETRetrieve Instance
      • DELDelete Instance
      • PATCHUpdate Instance
      • GETRetrieve Instance status history
      • GETRetrieve all Interfaces
      • GETRetrieve all Instance InfiniBand Interfaces
      • GETRetrieve all Instance NVLink Interfaces
    • Operating System
    • Machine
    • Rack
    • Task
    • Tray
    • Network Security Group
    • Dpu Extension Service
    • SSH Key Group
    • SSH Key
    • User
    • Metadata
    • Audit
    • Tenant Identity
GitHub
NVIDIANVIDIA
Developer-friendly docs for your API
Privacy Policy | Your Privacy Choices | Terms of Service | Accessibility | Corporate Policies | Product Security | Contact

Copyright © 2026, NVIDIA Corporation.

LogoLogo
API Reference

Instance

||View as Markdown|

Instance is a Machine provisioned with an Operating System by a Tenant and attached to one or more VPC Prefixes or Subnets.

Deprecation history:

  • sshUrl was deprecated in favor of serialConsoleUrl and was removed on April 25th, 2023 0:00 UTC. Please use serialConsoleUrl instead.
  • instanceSubnets was deprecated in favor of interfaces and was removed on May 10th, 2023 0:00 UTC. Please use interfaces instead.
  • sshkeygroups was deprecated in favor of sshKeyGroups and was removed on September 4th, 2025 0:00 UTC. Please use sshKeyGroups instead.
Previous

Delete a Machine/Instance Type association

Next

Retrieve all Instances