Nirvana Labs API | Compute › VMs › OS Images

Compute

compute

Compute

VMs

compute.vms

Methods

Create VM ->

Operation

post/v1/compute/vms

Create a VM

Get VM Details ->

get/v1/compute/vms/{vm_id}

Get details about a VM

Update VM ->

Operation

patch/v1/compute/vms/{vm_id}

Update a VM

Delete VM ->

Operation

delete/v1/compute/vms/{vm_id}

Delete a VM

List VMs -> Cursor<

get/v1/compute/vms

List all VMs

Restart VM ->

Operation

post/v1/compute/vms/{vm_id}/restart

Restart a VM

Domain types

CPUConfig = { vcpu }

CPU configuration for the VM.

CPUConfigRequest = { vcpu }

CPU configuration for the VM.

MemoryConfig = { size }

Memory configuration for the VM.

MemoryConfigRequest = { size }

Memory configuration for the VM.

OSImage = { created_at, display_name, name }

OS Image details.

SSHKeyRequest = { public_key }

Public SSH key configuration for the VM.

VM = { id, boot_volume_id, cpu_config, 15 more... }

VM details.

VMList = { items, pagination }

Compute VMs

Availability

compute.vms.availability

Methods

Check VM Create Availability ->

post/v1/compute/vms/availability

Check VM Create Availability

Check VM Update Availability ->

patch/v1/compute/vms/{vm_id}/availability

Check VM Update Availability

Compute VMs

OS Images

compute.vms.os_images

Methods

List OS Images -> Cursor<

OSImage

get/v1/compute/vms/os_images

List all OS Images

query Parameters

cursor: string

Optional

Pagination cursor returned by a previous request

limit: number

Optional

(maximum: 100, minimum: 10, default: 10)

Maximum number of items to return

Response fields

items: Array<

OSImage

pagination:

Pagination

Pagination response details.

Request example

curl https://api.nirvanalabs.io/v1/compute/vms/os_images \
    -H "Authorization: Bearer $NIRVANA_LABS_API_KEY"

200Example

{
  "items": [
    {
      "created_at": "2025-01-01T00:00:00Z",
      "display_name": "Ubuntu 24.04 (Noble)",
      "name": "ubuntu-noble-2025-10-01"
    }
  ],
  "pagination": {
    "next_cursor": "RhwniMT4B74siYZcPF8TnCdGI1l9rpPvg",
    "previous_cursor": "ARhwnmi1hA7wEbHbMjdYQlOB_ZusP4fYvw",
    "total_count": 125
  }
}