---
title: "List Regions"
method: GET
path: "/v1/regions"
---

# List Regions

`GET /v1/regions`

## Request

- Base URL: `https://api.dreamscalelabs.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.dreamscalelabs.com/v1/regions`
- Auth: none declared

The regions users can choose (DSL-354): ids, labels, flags, fallback and probe URLs,
and the one ``auto`` recommends for the caller (DSL-359).

Public: it names places, nothing about an account. Clients keep no list of their own.
``include_hidden`` also lists regions that aren't live (``live: false``) so clients can
label stored values (and aliases) from any region in the record; only live ones are
offered. ``country`` (ISO 3166-1 alpha-2) and ``subdivision`` (ISO 3166-2, for the US and
Canada; it needs ``country``) say where the robot is; without them the client address's
GeoIP location is used.

## Query parameters

- `include_hidden` boolean
- `country` string, nullable
- `subdivision` string, nullable

## Response `200`

Successful Response

- object

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/dreamscalelabs/apis/dreamscale-control-plane.md) - [All operations](https://skmtc.dev/dreamscalelabs/apis/dreamscale-control-plane/llms.txt) - [OpenAPI document](https://skmtc.dev/dreamscalelabs/apis/dreamscale-control-plane/revisions/ced796c07cb0?raw)