---
title: "List read-only regions"
method: GET
path: "/organizations/{organization}/databases/{database}/read-only-regions"
tags: ["Databases"]
---

# List read-only regions

`GET /organizations/{organization}/databases/{database}/read-only-regions`

List read-only regions for the database's default branch
### Authorization
A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:

**Service Token Accesses**
 `read_database`, `delete_database`, `write_database`, `read_branch`, `delete_branch`, `create_branch`, `delete_production_branch`, `connect_branch`, `connect_production_branch`, `connect_production_read_only_branch`, `delete_branch_password`, `delete_production_branch_password`, `delete_production_read_only_branch_password`, `read_deploy_request`, `create_deploy_request`, `approve_deploy_request`, `read_comment`, `create_comment`, `restore_backup`, `restore_production_branch_backup`, `read_backups`, `write_backups`, `delete_backups`, `delete_production_branch_backups`, `write_branch_vschema`, `write_production_branch_vschema`

**OAuth Scopes**

 | Resource | Scopes |
| :------- | :---------- |
| Organization | `read_branches` |
| Database | `read_branches` |

## Path parameters

- `organization` string, required
- `database` string, required

## Query parameters

- `page` integer
- `per_page` integer

## Response `200`

List of the database's read-only regions

- object
  - `type` string, required — The response type. Always "list" for paginated responses.
  - `current_page` integer, required — The current page number
  - `next_page` integer, nullable, required — The next page number, or null when this is the last page
  - `next_page_url` string, nullable, required — The next page of results, or null when this is the last page
  - `prev_page` integer, nullable, required — The previous page number, or null when this is the first page
  - `prev_page_url` string, nullable, required — The previous page of results, or null when this is the first page
  - `data` object[], required
    - `id` string, required — The ID of the read-only region
    - `display_name` string, required — The name of the read-only region
    - `created_at` string, required — When the read-only region was created
    - `updated_at` string, required — When the read-only region was last updated
    - `ready_at` string, nullable, required — When the read-only region was ready to serve queries
    - `ready` boolean, required — Whether or not the read-only region is ready to serve queries
    - `actor` object, required
      - `id` string, required — The ID of the actor
      - `display_name` string, required — The name of the actor
      - `avatar_url` string, required — The URL of the actor's avatar
    - `region` object, required
      - `id` string, required — The ID of the region
      - `provider` string, required — Provider for the region (ex. AWS)
      - `enabled` boolean, required — Whether or not the region is currently active
      - `public_ip_addresses` string[], required — Public IP addresses for the region
      - `display_name` string, required — Name of the region
      - `location` string, required — Location of the region
      - `slug` string, required — The slug of the region
      - `current_default` boolean, required — True if the region is the default for new branch creation
      - `mysql_supported` boolean, required — Whether the region supports MySQL/Vitess databases
      - `postgresql_supported` boolean, required — Whether the region supports PostgreSQL databases

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `500` — Internal Server Error

---

[API](https://skmtc.net/planetscale/apis/planetscale-api.md) · [All operations](https://skmtc.net/planetscale/apis/planetscale-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/planetscale/planetscale-api/versions/fa19f3305241/schema)