---
title: "List regions"
method: GET
path: "/regions"
tags: ["Regions"]
---

# List regions

`GET /regions`

Retrieves a list of available regions.

## Query parameters

- `filter[available]` StringFilter
  - `eq` string — Equal
  - `ne` string — Not equal
  - `in` string — In (comma-separated list)
  - `nin` string — Not in (comma-separated list)
  - `between` string — Between (comma-separated list)
  - `contains` string — Contains
  - `starts` string — Starts with
  - `ends` string — Ends with
- `filter[private]` StringFilter
  - `eq` string — Equal
  - `ne` string — Not equal
  - `in` string — In (comma-separated list)
  - `nin` string — Not in (comma-separated list)
  - `between` string — Between (comma-separated list)
  - `contains` string — Contains
  - `starts` string — Starts with
  - `ends` string — Ends with
- `filter[zone]` StringFilter
  - `eq` string — Equal
  - `ne` string — Not equal
  - `in` string — In (comma-separated list)
  - `nin` string — Not in (comma-separated list)
  - `between` string — Between (comma-separated list)
  - `contains` string — Contains
  - `starts` string — Starts with
  - `ends` string — Ends with
- `page[size]` integer
- `page[before]` string
- `page[after]` string
- `sort` string

## Response `200`

OK

- object
  - `regions` Region[]
    - `id` string — The ID of the region.
    - `label` string — The human-readable name of the region.
    - `zone` string — Geographical zone of the region
    - `selection_label` string — The label to display when choosing between regions for new projects.
    - `project_label` string — The label to display on existing projects.
    - `timezone` string — Default timezone of the region
    - `available` boolean — Indicator whether or not this region is selectable during the checkout. Not available regions will never show up during checkout.
    - `private` boolean — Indicator whether or not this platform is for private use only.
    - `endpoint` string — Link to the region API endpoint.
    - `provider` object — Information about the region provider.
      - `name` string
      - `logo` string
    - `datacenter` object — Information about the region provider data center.
      - `name` string
      - `label` string
      - `location` string
    - `environmental_impact` object — Information about the region provider's environmental impact.
      - `zone` string
      - `carbon_intensity` string
      - `green` boolean
  - `_links` ListLinks
    - `self` Link — A hypermedia link to the {current, next, previous} set of items.
      - `href` string — URL of the link
    - `previous` Link — A hypermedia link to the {current, next, previous} set of items.
      - `href` string — URL of the link
    - `next` Link — A hypermedia link to the {current, next, previous} set of items.
      - `href` string — URL of the link

## Other responses

- `400` — Bad Request
- `403` — Forbidden
- `404` — Not Found

---

[API](https://skmtc.net/upsun/apis/upsun-com-rest-api.md) · [All operations](https://skmtc.net/upsun/apis/upsun-com-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/upsun/upsun-com-rest-api/revisions/6cc88fde6435/schema)