Get VM Details

client.compute.vms.get(, ?): VM { id, boot_volume_id, cpu_config, 16 more }

GET/v1/compute/vms/{vm_id}

Get details about a VM

ParametersExpand Collapse

vmID: string

ReturnsExpand Collapse

VM { id, boot_volume_id, cpu_config, 16 more }

VM details.

id: string

Unique identifier for the VM.

boot_volume_id: string

ID of the boot volume attached to the VM.

cpu_config: CPUConfig { vcpu }

CPU configuration for the VM.

vcpu: number

Number of virtual CPUs.

maximum192

minimum1

created_at: string

When the VM was created.

formatdate-time

data_volume_ids: Array<string>

IDs of the data volumes attached to the VM.

memory_config: MemoryConfig { size }

Memory configuration for the VM.

size: number

Size of the memory in GB.

maximum768

minimum1

name: string

Name of the VM.

private_ip: string | null

Private IP of the VM.

project_id: string

Project ID the VM belongs to.

public_ip: string | null

Public IP of the VM.

public_ip_enabled: boolean

Whether the public IP is enabled for the VM.

region: RegionName { }

Region the resource is in.

status: ResourceStatus

Status of the resource.

One of the following:

"pending"

"creating"

"updating"

"ready"

"deleting"

"deleted"

"error"

subnet_id: string

ID of the subnet the VM is in.

tags: Array<string>

Tags to attach to the VM.

updated_at: string

When the VM was updated.

formatdate-time

vpc_id: string

ID of the VPC the VM is in.

vpc_name: string

Name of the VPC the VM is in.

instance_type?: string | null

Instance type name.

Get VM Details

import NirvanaLabs from '@nirvana-labs/nirvana';

const client = new NirvanaLabs({
  apiKey: process.env['NIRVANA_LABS_API_KEY'], // This is the default and can be omitted
});

const vm = await client.compute.vms.get('vm_id');

console.log(vm.id);

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "boot_volume_id": "123e4567-e89b-12d3-a456-426614174000",
  "cpu_config": {
    "vcpu": 2
  },
  "created_at": "2025-01-01T00:00:00Z",
  "data_volume_ids": [
    "123e4567-e89b-12d3-a456-426614174001",
    "123e4567-e89b-12d3-a456-426614174002"
  ],
  "memory_config": {
    "size": 2
  },
  "name": "my-vm",
  "private_ip": "10.0.0.1",
  "project_id": "123e4567-e89b-12d3-a456-426614174000",
  "public_ip": "123.123.123.123",
  "public_ip_enabled": true,
  "region": "us-sva-2",
  "status": "ready",
  "subnet_id": "123e4567-e89b-12d3-a456-426614174000",
  "tags": [
    "production",
    "ethereum"
  ],
  "updated_at": "2025-01-01T00:00:00Z",
  "vpc_id": "123e4567-e89b-12d3-a456-426614174000",
  "vpc_name": "my-vpc",
  "instance_type": "n1-standard-8"
}

Returns Examples

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "boot_volume_id": "123e4567-e89b-12d3-a456-426614174000",
  "cpu_config": {
    "vcpu": 2
  },
  "created_at": "2025-01-01T00:00:00Z",
  "data_volume_ids": [
    "123e4567-e89b-12d3-a456-426614174001",
    "123e4567-e89b-12d3-a456-426614174002"
  ],
  "memory_config": {
    "size": 2
  },
  "name": "my-vm",
  "private_ip": "10.0.0.1",
  "project_id": "123e4567-e89b-12d3-a456-426614174000",
  "public_ip": "123.123.123.123",
  "public_ip_enabled": true,
  "region": "us-sva-2",
  "status": "ready",
  "subnet_id": "123e4567-e89b-12d3-a456-426614174000",
  "tags": [
    "production",
    "ethereum"
  ],
  "updated_at": "2025-01-01T00:00:00Z",
  "vpc_id": "123e4567-e89b-12d3-a456-426614174000",
  "vpc_name": "my-vpc",
  "instance_type": "n1-standard-8"
}