## List

`client.regions.list(RegionListParamsquery?, RequestOptionsoptions?): 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.

### Parameters

- `query: RegionListParams`

  - `page?: number`

    Which 'page' of paginated results to return.

  - `per_page?: number`

    Number of items returned per page

### Returns

- `RegionListResponse`

  - `meta: MetaProperties`

    Information about the response itself.

    - `total?: number`

      Number of objects returned by the request.

  - `regions: Array<Region>`

    - `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?: ForwardLinks | BackwardLinks | unknown`

      - `ForwardLinks`

        - `last?: string`

          URI of the last page of the results.

        - `next?: string`

          URI of the next page of the results.

      - `BackwardLinks`

        - `first?: string`

          URI of the first page of the results.

        - `prev?: string`

          URI of the previous page of the results.

      - `unknown`

### Example

```typescript
import Gradient from '@digitalocean/gradient';

const client = new Gradient();

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

console.log(regions.meta);
```