Nirvana Labs API | Compute › VMs

API Reference

Compute

compute

Compute

VMs

compute.vms

Methods

Create VM ->

Operation

post/v1/compute/vms

Create a VM

Delete VM ->

Operation

delete/v1/compute/vms/{vm_id}

Delete a VM

path Parameters

vm_id: string

Response fields

Operation

Request example

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

200Example

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2021-01-01T00:00:00Z",
  "kind": "vm",
  "resource_id": "123e4567-e89b-12d3-a456-426614174123",
  "status": "pending",
  "type": "create",
  "updated_at": "2021-01-01T00:00:00Z"
}

Get VM Details ->

get/v1/compute/vms/{vm_id}

Get details about a VM

List VMs ->

VMList

get/v1/compute/vms

List all VMs

Update VM ->

Operation

patch/v1/compute/vms/{vm_id}

Update a VM

Domain types

CPUConfig = { vcpu }

CPU configuration for the VM.

MemoryConfig = { size }

Memory configuration for the VM.

OSImage = { created_at, display_name, name }

OS Image details.

SSHKey = { public_key }

Public SSH key configuration for the VM.

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

VM details.

VMList = { items }

Compute VMs

Availability

compute.vms.availability

Methods

Check VM Create Availability -> string

post/v1/compute/vms/availability

Check VM Create Availability

Check VM Update Availability -> string

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

Check VM Update Availability

Compute VMs

OS Images

compute.vms.os_images

Methods

List OS Images -> Array<

OSImage

get/v1/compute/vms/os_images

List all OS Images

Compute VMs

Volumes

compute.vms.volumes

Methods

List VM S Volumes ->

VolumeList

get/v1/compute/vms/{vm_id}/volumes

List VM's Volumes

Compute

Volumes

compute.volumes

Methods

Create Volume ->

Operation

post/v1/compute/volumes

Create a Volume. Only data volumes can be created.

Delete Volume ->

Operation

delete/v1/compute/volumes/{volume_id}

Delete a Volume. Boot or data volumes can be deleted.

Get Volume ->

Volume

get/v1/compute/volumes/{volume_id}

Get a Volume.

List Volumes ->

VolumeList

get/v1/compute/volumes

List all volumes

Update Volume ->

Operation

patch/v1/compute/volumes/{volume_id}

Update a Volume. Boot or data volumes can be updated.

Domain types

StorageType = "nvme"

Storage type the volume is using.

Volume = { id, created_at, kind, 7 more... }

Volume details.

VolumeKind = "boot" | "data"

Volume kind.

VolumeList = { items }

Compute Volumes

Availability

compute.volumes.availability

Methods

Check Volume Create Availability -> string

post/v1/compute/volumes/availability

Check Volume Create Availability

Check Volume Update Availability -> string

patch/v1/compute/volumes/{volume_id}/availability

Check Volume Update Availability