List All Data Center Regions

client.regions.list(?, ?): RegionListResponse { meta, regions, links }

get/v2/regions

To list all of the regions that are available, send a GET request to /v2/regions. The response will be a JSON object with a key called regions. The value of this will be an array of region objects, each of which will contain the standard region attributes.

ParametersExpand Collapse

query: RegionListParams { page, per_page }

page?: number

Which 'page' of paginated results to return.

minimum1

per_page?: number

Number of items returned per page

minimum1

maximum200

ReturnsExpand Collapse

RegionListResponse { meta, regions, links }

meta: MetaProperties { total }

Information about the response itself.

total?: number

Number of objects returned by the request.

regions: Array<Region { available, features, name, 2 more } >

available: boolean

This is a boolean value that represents whether new Droplets can be created in this region.

features: Array<string>

This attribute is set to an array which contains features available in this region

name: string

The display name of the region. This will be a full name that is used in the control panel and other interfaces.

sizes: Array<string>

This attribute is set to an array which contains the identifying slugs for the sizes available in this region. sizes:read is required to view.

slug: string

A human-readable string that is used as a unique identifier for each region.

links?: PageLinks { pages }

pages?: ForwardLinks { last, next } | BackwardLinks { first, prev } | unknown

Accepts one of the following:

ForwardLinks { last, next }

last?: string

URI of the last page of the results.

next?: string

URI of the next page of the results.

BackwardLinks { first, prev }

first?: string

URI of the first page of the results.

prev?: string

URI of the previous page of the results.

unknown

List All Data Center Regions

import Gradient from '@digitalocean/gradient';

const client = new Gradient({
  accessToken: 'My Access Token',
});

const regions = await client.regions.list();

console.log(regions.meta);

{
  "meta": {
    "total": 13
  },
  "regions": [
    {
      "available": true,
      "features": [
        "private_networking",
        "backups",
        "ipv6",
        "metadata",
        "install_agent",
        "storage",
        "image_transfer"
      ],
      "name": "New York 3",
      "sizes": [
        "s-1vcpu-1gb",
        "s-1vcpu-2gb",
        "s-1vcpu-3gb",
        "s-2vcpu-2gb",
        "s-3vcpu-1gb",
        "s-2vcpu-4gb",
        "s-4vcpu-8gb",
        "s-6vcpu-16gb",
        "s-8vcpu-32gb",
        "s-12vcpu-48gb",
        "s-16vcpu-64gb",
        "s-20vcpu-96gb",
        "s-24vcpu-128gb",
        "s-32vcpu-192g"
      ],
      "slug": "nyc3"
    }
  ],
  "links": {
    "pages": {
      "last": "https://api.digitalocean.com/v2/regions?page=13&per_page=1",
      "next": "https://api.digitalocean.com/v2/regions?page=2&per_page=1"
    }
  }
}

Returns Examples

{
  "meta": {
    "total": 13
  },
  "regions": [
    {
      "available": true,
      "features": [
        "private_networking",
        "backups",
        "ipv6",
        "metadata",
        "install_agent",
        "storage",
        "image_transfer"
      ],
      "name": "New York 3",
      "sizes": [
        "s-1vcpu-1gb",
        "s-1vcpu-2gb",
        "s-1vcpu-3gb",
        "s-2vcpu-2gb",
        "s-3vcpu-1gb",
        "s-2vcpu-4gb",
        "s-4vcpu-8gb",
        "s-6vcpu-16gb",
        "s-8vcpu-32gb",
        "s-12vcpu-48gb",
        "s-16vcpu-64gb",
        "s-20vcpu-96gb",
        "s-24vcpu-128gb",
        "s-32vcpu-192g"
      ],
      "slug": "nyc3"
    }
  ],
  "links": {
    "pages": {
      "last": "https://api.digitalocean.com/v2/regions?page=13&per_page=1",
      "next": "https://api.digitalocean.com/v2/regions?page=2&per_page=1"
    }
  }
}