Get Region

client.regions.get(, ?): Region { availability, compute, name, 3 more }

GET/v1/regions/{name}

Get a region by name

ParametersExpand Collapse

name: string

ReturnsExpand Collapse

Region { availability, compute, name, 3 more }

Region response with product availability.

availability: RegionAvailability

Availability status of the region.

One of the following:

"live"

"preview"

"maintenance"

"sunset"

compute: Compute { vms }

Compute products available in this region.

vms: boolean

VMs indicates if Virtual Machines are available.

name: string

Name of the region.

networking: Networking { connect, vpcs }

Networking products available in this region.

connect: boolean

Connect indicates if Nirvana Connect is available.

vpcs: boolean

VPCs indicates if Virtual Private Clouds are available.

nks: NKS { autoscaling, clusters }

NKS products available in this region.

autoscaling: boolean

Autoscaling indicates if NKS node pool autoscaling is available.

clusters: boolean

Clusters indicates if NKS managed Kubernetes clusters are available.

storage: Storage { abs, local_nvme }

Storage products available in this region.

abs: boolean

ABS indicates if Accelerated Block Storage is available.

local_nvme: boolean

LocalNVMe indicates if locally-attached NVMe storage is available.

Get Region

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 region = await client.regions.get('us-sva-2');

console.log(region.availability);

{
  "availability": "live",
  "compute": {
    "vms": true
  },
  "name": "us-sva-2",
  "networking": {
    "connect": true,
    "vpcs": true
  },
  "nks": {
    "autoscaling": false,
    "clusters": false
  },
  "storage": {
    "abs": false,
    "local_nvme": true
  }
}

Returns Examples

{
  "availability": "live",
  "compute": {
    "vms": true
  },
  "name": "us-sva-2",
  "networking": {
    "connect": true,
    "vpcs": true
  },
  "nks": {
    "autoscaling": false,
    "clusters": false
  },
  "storage": {
    "abs": false,
    "local_nvme": true
  }
}