List

API Reference

Regions

List All Data Center Regions

regions.list(RegionListParams**kwargs) -> RegionListResponse

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

page: Optional[int]

Which 'page' of paginated results to return.

minimum1

per_page: Optional[int]

Number of items returned per page

minimum1

maximum200

ReturnsExpand Collapse

class RegionListResponse: …

meta: MetaProperties

Information about the response itself.

regions: List[Region]

available: bool

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

features: List[str]

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

name: str

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

sizes: List[str]

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: str

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

links: Optional[PageLinks]

HTTPPython

from gradient import Gradient

client = Gradient()
regions = client.regions.list()
print(regions.meta)

200 example

{
  "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

200 example

{
  "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"
    }
  }
}