> ## Documentation Index > Fetch the complete documentation index at: https://docs.ornn.com/llms.txt > Use this file to discover all available pages before exploring further. # List a reservation's VMs > Returns the reservation's VMs, oldest first, with their status, latest operation, grouped launch progress, and SSH details. Deleted VMs are omitted. ip and port appear while a VM is provisioning or running; tenant_username and ready_at appear only when it is running. Connect when status is running, using the returned ip, port, and tenant_username. Poll every five seconds with a deadline while any VM is provisioning or deleting. A failed VM carries failure with a code and message. You can read this list after the reservation ends. Connect with `ssh -p @` once a VM's `status` is `running`. ## OpenAPI ````yaml openapi.yaml GET /v1/orchestrator/reservations/{reservation_id}/virtual-machines openapi: 3.1.0 info: title: Ornn compute API version: 1.0.0 description: >- Customer HTTP API for Ornn GPU capacity. It covers reserved capacity and nodes, VM and Bare Metal access, Kubernetes and Slurm clusters, SSH keys, storage volumes and GitHub repositories, private networks, monitoring, buying and selling capacity (Reserve, Market, Spot, and Relist), and billing. API keys are scoped to one organization and act with their creator's access there; account, team, and API-key management stay in the console. Most operations require an approved organization. See https://docs.ornn.com/api-keys to create a key and https://docs.ornn.com/guides/kubernetes-api for an end-to-end Kubernetes integration. Examples use fictional IDs and credentials. The info.version field identifies the contract revision, not a shared API path version. contact: email: support@ornn.com servers: - url: https://api.ornn.com description: Production security: - OrnnApiKey: [] tags: - name: Authentication - name: Reservations - name: GPU nodes - name: Clusters - name: Workers - name: Virtual machines description: >- Choose a VM disk, launch VM access on a reservation, and read each VM's status, launch progress, and SSH connection details. - name: Bare Metal description: >- Launch Bare Metal access on a reservation, read a host's readiness and SSH connection details, and reboot or hard reset it. - name: SSH keys description: >- Register public keys for your organization, choose which keys a VM or Bare Metal reservation uses, and queue key delivery to machines. Slurm clusters take organization key IDs at launch. Kubernetes API access does not use SSH keys. - name: Reserve description: >- Browse reserved-capacity listings and their terms, and post, cancel, or accept offers. Reserve listings are visible to approved organizations. - name: Market description: >- Browse relisted capacity and buy windows at the asking price, paid up front. Open to every member of your organization. - name: Spot description: >- Hourly order books for VMs with 1, 2, 4, or 8 GPUs on one node: read books, trades, and quotes, place and cancel bids, and follow fills. - name: Relist description: >- Sell whole nodes from a reservation you hold at your asking price, and manage those listings. - name: Storage description: >- Managed volumes, their files, and GitHub repository pulls. Volumes belong to the API key's creator in the key's organization. - name: Networks description: >- Organization private networks and the WireGuard configs you use to reach private machines and clusters. - name: Monitoring description: >- Machine telemetry and console logs for capacity your organization holds. Reads are limited to your reservation window. - name: Billing description: >- Invoices, billing summary, usage cost, Ornn credits, and account statements. Saving a card and paying invoices stay in the console. externalDocs: description: REST integration walkthrough url: >- https://docs.ornn.com/guides/kubernetes-access#provision-and-manage-through-rest paths: /v1/orchestrator/reservations/{reservation_id}/virtual-machines: get: tags: - Virtual machines summary: List a reservation's VMs description: >- Returns the reservation's VMs, oldest first, with their status, latest operation, grouped launch progress, and SSH details. Deleted VMs are omitted. ip and port appear while a VM is provisioning or running; tenant_username and ready_at appear only when it is running. Connect when status is running, using the returned ip, port, and tenant_username. Poll every five seconds with a deadline while any VM is provisioning or deleting. A failed VM carries failure with a code and message. You can read this list after the reservation ends. operationId: accessListReservationVirtualMachines parameters: - name: reservation_id in: path required: true description: An owned reservation ID (reservationId in reservation responses). schema: type: string format: uuid example: 11111111-1111-4111-8111-111111111111 responses: '200': description: The reservation's VMs. The example shows one running VM. content: application/json: schema: $ref: '#/components/schemas/AccessVirtualMachineList' example: virtual_machines: - id: 66666666-6666-4666-8666-666666666666 node_id: 33333333-3333-4333-8333-333333333333 reservation_id: 11111111-1111-4111-8111-111111111111 status: running operation: provision operation_id: 99999999-9999-4999-8999-999999999999 operation_status: succeeded operation_started_at: '2026-10-15T00:02:15Z' operation_completed_at: '2026-10-15T00:09:48Z' stages: - key: prepare_host label: Preparing host status: completed started_at: '2026-10-15T00:02:15Z' completed_at: '2026-10-15T00:02:40Z' - key: start_vm label: Starting virtual machine status: completed started_at: '2026-10-15T00:04:05Z' completed_at: '2026-10-15T00:05:30Z' - key: configure_access label: Configuring access status: completed started_at: '2026-10-15T00:09:20Z' completed_at: '2026-10-15T00:09:48Z' failure: null ready_at: '2026-10-15T00:09:48Z' hostname: ornn-vm-11111111-0 ip: 203.0.113.10 tenant_username: tenant port: 2222 gpu_count: 8 disk_id: 77777777-7777-4777-8777-777777777777 created_at: '2026-10-15T00:02:11Z' destroy_at: null '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': description: The reservation is absent or not owned by your organization. content: application/json: schema: $ref: '#/components/schemas/Error' example: detail: code: reservation_not_found message: Ornn could not find that reservation. default: $ref: '#/components/responses/Error' components: schemas: AccessVirtualMachineList: type: object required: - virtual_machines properties: virtual_machines: type: array items: $ref: '#/components/schemas/AccessVirtualMachine' Error: type: object properties: code: type: string detail: oneOf: - type: string - type: object required: - code - message properties: code: type: string message: type: string AccessVirtualMachine: type: object required: - id - node_id - reservation_id - status - stages - gpu_count - created_at properties: id: type: string format: uuid description: >- VM id. Reboot a VM and reimage take this ID with its node_id. The host reboot and hard reset route takes a node ID, not this ID. node_id: type: string format: uuid description: The host node running the VM. reservation_id: type: string format: uuid status: type: string description: >- provisioning, running, failed, or deleting. Treat any other value as not ready. operation: type: - string - 'null' description: >- The latest operation, provision, destroy, or reboot. A VM stays running during a reboot. operation_id: type: - string - 'null' format: uuid operation_status: type: - string - 'null' description: queued, running, succeeded, or failed. operation_started_at: type: - string - 'null' format: date-time operation_completed_at: type: - string - 'null' format: date-time stages: type: array description: Customer launch progress for the latest provision, in order. items: $ref: '#/components/schemas/AccessVirtualMachineStage' failure: description: >- Present when the VM or its latest operation failed. code is virtual_machine_provision_failed, virtual_machine_cleanup_failed, or virtual_machine_reboot_failed. oneOf: - type: 'null' - type: object required: - code - message properties: code: type: string message: type: string ready_at: type: - string - 'null' format: date-time description: When the VM first became ready. Set only while running. hostname: type: string description: The VM's hostname. Not an SSH address. ip: type: - string - 'null' description: SSH address. Present while provisioning or running. tenant_username: type: - string - 'null' description: Linux login, tenant. Present only while running. port: type: - integer - 'null' description: SSH port. Present while provisioning or running. Do not assume 22. gpu_count: type: integer disk_id: type: - string - 'null' format: uuid created_at: type: string format: date-time destroy_at: type: - string - 'null' format: date-time AccessVirtualMachineStage: type: object required: - key - label - status properties: key: type: string description: >- One of prepare_host, prepare_gpu, prepare_disk, start_vm, verify_readiness, configure_storage, or configure_access. Stages that have not started are omitted. label: type: string description: Display label, such as Starting virtual machine. status: type: string enum: - pending - running - completed - failed started_at: type: - string - 'null' format: date-time completed_at: type: - string - 'null' format: date-time responses: Unauthorized: description: >- The credential is missing, invalid, revoked, or no longer belongs to a current organization member. Check the HTTP status before parsing the body. content: application/json: schema: $ref: '#/components/schemas/Error' Forbidden: description: >- The credential lacks access to this operation, or the organization requires approval. An API key does not bypass these checks. content: application/json: schema: $ref: '#/components/schemas/Error' Error: description: >- Unsuccessful request. Check HTTP status first. Errors may have detail.code/detail.message, a string detail and optional top-level code, or an empty/non-JSON body. 401: invalid credential; 403: access or approval required; 404: not visible or credentials not ready; 409: lifecycle conflict; 429: back off; 5xx: service failure. Inspect current state before retrying mutations. content: application/json: schema: $ref: '#/components/schemas/Error' securitySchemes: OrnnApiKey: type: http scheme: bearer bearerFormat: ornn_sk_... description: >- Create an organization API key in Account Settings > Developer. Do not send this key to the Kubernetes API server. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.