Skip to main content
GET
/
regions
List public regions
curl --request GET \
  --url https://api.planetscale.com/v1/regions \
  --header 'Authorization: Bearer <token>'
{
  "type": "<string>",
  "current_page": 123,
  "next_page": 123,
  "next_page_url": "<string>",
  "prev_page": 123,
  "prev_page_url": "<string>",
  "data": [
    {
      "id": "<string>",
      "provider": "<string>",
      "enabled": true,
      "public_ip_addresses": [
        "<string>"
      ],
      "display_name": "<string>",
      "location": "<string>",
      "slug": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://planetscale.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

​
page
integer
default:1

If provided, specifies the page offset of returned results

​
per_page
integer
default:25

If provided, specifies the number of returned results

Response

Returns the available public PlanetScale regions

​
type
string
required

The response type. Always "list" for paginated responses.

​
current_page
integer
required

The current page number

​
next_page
integer | null
required

The next page number, or null when this is the last page

​
next_page_url
string | null
required

The next page of results, or null when this is the last page

​
prev_page
integer | null
required

The previous page number, or null when this is the first page

​
prev_page_url
string | null
required

The previous page of results, or null when this is the first page

​
data
object[]
required