Get Instance Type

client.instanceTypes.get(, , ?): InstanceType { chipset, created_at, family, 7 more }

GET/v1/instance_types/{region}/{name}

Get an instance type by region and name

ParametersExpand Collapse

name: string

params: InstanceTypeGetParams { region }

region: "us-sva-2"

Region name

ReturnsExpand Collapse

InstanceType { chipset, created_at, family, 7 more }

Instance type.

chipset: string

created_at: string

When the Instance Type was created.

formatdate-time

family: string

memory_gb: number

name: string

network_bandwidth_gbps: number

Network bandwidth in Gbps.

region: RegionName { }

Region the resource is in.

series: string

updated_at: string

When the Instance Type was updated.

formatdate-time

vcpu: number

Get Instance Type

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 instanceType = await client.instanceTypes.get('n1-standard-8', { region: 'us-sva-2' });

console.log(instanceType.network_bandwidth_gbps);

{
  "chipset": "amd-epyc-9354p",
  "created_at": "2025-01-01T00:00:00Z",
  "family": "standard",
  "memory_gb": 32,
  "name": "n1-standard-8",
  "network_bandwidth_gbps": 1,
  "region": "us-sva-2",
  "series": "n1",
  "updated_at": "2025-01-01T00:00:00Z",
  "vcpu": 8
}

Returns Examples

{
  "chipset": "amd-epyc-9354p",
  "created_at": "2025-01-01T00:00:00Z",
  "family": "standard",
  "memory_gb": 32,
  "name": "n1-standard-8",
  "network_bandwidth_gbps": 1,
  "region": "us-sva-2",
  "series": "n1",
  "updated_at": "2025-01-01T00:00:00Z",
  "vcpu": 8
}