## List Regions

**get** `/v1/regions`

List all regions

### Query Parameters

- `cursor: optional string`

  Pagination cursor returned by a previous request

- `limit: optional number`

  Maximum number of items to return

### Returns

- `RegionList object { items, pagination }`

  - `items: array of Region`

    - `availability: RegionAvailability`

      Availability status of the region.

      - `"live"`

      - `"preview"`

      - `"maintenance"`

      - `"sunset"`

    - `compute: object { vms }`

      Compute products available in this region.

      - `vms: boolean`

        VMs indicates if Virtual Machines are available.

    - `name: string`

      Name of the region.

    - `networking: object { 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: object { 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: object { 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.

  - `pagination: Pagination`

    Pagination response details.

    - `next_cursor: string`

    - `previous_cursor: string`

    - `total_count: number`

### Example

```http
curl https://api.nirvanalabs.io/v1/regions \
    -H "Authorization: Bearer $NIRVANA_LABS_API_KEY"
```

#### Response

```json
{
  "items": [
    {
      "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
      }
    }
  ],
  "pagination": {
    "next_cursor": "RhwniMT4B74siYZcPF8TnCdGI1l9rpPvg",
    "previous_cursor": "ARhwnmi1hA7wEbHbMjdYQlOB_ZusP4fYvw",
    "total_count": 125
  }
}
```