Reference > PyDo > Library Reference > regions > list()

Was this page helpful?

Give Feedback

pydo.regions.list()

Generated on 25 November 2024 from pydo version v0.6.0

Description

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.

Parameters

Name	Type	Required	Description	Default Value
`per_page`	integer	False	Number of items returned per page	20
`page`	integer	False	Which ‘page’ of paginated results to return.	1

Request Sample

import os
from pydo import Client

client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN"))

resp = client.regions.list()

Responses

See the API spec for this endpoint to view additional detail on responses, headers, parameters, and more.

200
401
429
500
default

A JSON object with a key set to regions. The value is an array of region objects, each of which contain the standard region attributes.

Click to expand an example response.

{
  "regions": [
    {
      "name": "New York 3",
      "slug": "nyc3",
      "features": [
        "private_networking",
        "backups",
        "ipv6",
        "metadata",
        "install_agent",
        "storage",
        "image_transfer"
      ],
      "available": true,
      "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"
      ]
    }
  ],
  "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"
    }
  },
  "meta": {
    "total": 13
  }
}

Unauthorized

Click to expand an example response.

{
  "id": "unauthorized",
  "message": "Unable to authenticate you."
}

API Rate limit exceeded

Click to expand an example response.

{
  "id": "too_many_requests",
  "message": "API Rate limit exceeded."
}

Server error.

Click to expand an example response.

{
  "id": "server_error",
  "message": "Unexpected server-side error"
}

Unexpected error

Click to expand an example response.

{
  "id": "example_error",
  "message": "some error message"
}