---
title: "Get keyspaces"
method: GET
path: "/organizations/{organization}/databases/{database}/branches/{branch}/keyspaces"
tags: ["Database branch keyspaces"]
---

# Get keyspaces

`GET /organizations/{organization}/databases/{database}/branches/{branch}/keyspaces`

### Authorization
A service token   must have at least one of the following access   in order to use this API endpoint:

**Service Token Accesses**
 `read_branch`

## Path parameters

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

## Query parameters

- `page` integer
- `per_page` integer

## Response `200`

Returns keyspaces

- object
  - `type` string, required — The response type. Always "list" for paginated responses.
  - `current_page` integer, required — The current page number
  - `per_page` integer, required — The maximum number of results per page
  - `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 keyspace
    - `name` string, required — Name of the keyspace
    - `shards` integer, required — The number of keyspace shards
    - `sharded` boolean, required — If the keyspace is sharded
    - `replicas` integer, required — Total number of replicas in the keyspace
    - `extra_replicas` integer, required — Number of extra replicas in the keyspace
    - `created_at` string, required — When the keyspace was created
    - `updated_at` string, required — When the keyspace was last updated
    - `cluster_name` string, required — The SKU representing the keyspace cluster size
    - `cluster_display_name` string, required — The SKU representing the keyspace cluster size for display
    - `resizing` boolean, required — Is the keyspace currently resizing
    - `resize_in_progress` boolean, required — True if the keyspace has an unfinished resize request
    - `resize_pending` boolean, required — Is the keyspace awaiting a resize
    - `config_change_in_progress` boolean, required — Is the keyspace undergoing a config change
    - `ready` boolean, required — Is the keyspace provisioned and serving traffic
    - `metal` boolean, required — Is the keyspace running on metal instances
    - `default` boolean, required — Is this the default keyspace for the branch
    - `imported` boolean, required — Is this keyspace used in an import
    - `vector_pool_allocation` number, nullable, required — Percentage of buffer pool memory allocated to vector indexes
    - `node_ttl_strategy` 'node_ttl_follow_maintenance' | 'node_ttl_always' | 'node_ttl_off', required — Controls when node TTL drains are allowed
    - `replication_durability_constraints` object, required
      - `strategy` 'available' | 'lag' | 'always', nullable — The replication durability strategy
    - `vreplication_flags` object, required
      - `optimize_inserts` boolean, required — Enable optimized inserts
      - `allow_no_blob_binlog_row_image` boolean, required — Allow no blob binlog row image
      - `vplayer_batching` boolean, required — Enable VPlayer batching
    - `mysqld_options` object, required — MySQL daemon configuration options
    - `vttablet_options` object, required — VTTablet configuration options

## Other responses

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

## Changes

- **2026-08-12** `fd4480152110` — 1 info
  - added the required property `data/items/resize_in_progress` to the response with the `200` status
- **2026-08-11** `4b2e4f05bda2` — 1 info
  - added the required property `per_page` to the response with the `200` status
- **2026-06-01** `72506953f367` — 7 breaking, 2 info
  - the response property `data/items/replication_durability_constraints/strategy` became nullable for the status `200`
  - the response property `data/items/vector_pool_allocation` became nullable for the status `200`
  - the response property `next_page` became nullable for the status `200`
  - the response property `next_page_url` became nullable for the status `200`
  - …5 more
- **2026-02-24** `3c33e46f8ff2` — 1 breaking, 2 info
  - removed the required property `data/items/mysqld_options/binlog_row_value_options` from the response with the `200` status
  - added the required property `data/items/node_ttl_strategy` to the response with the `200` status
  - added the required property `data/items/vttablet_options` to the response with the `200` status
- **2026-02-10** `ed1825db11c6` — 1 info
  - added the required property `data/items/mysqld_options` to the response with the `200` status

[Full history](https://skmtc.dev/planetscale/apis/planetscale-api/changes/organizations/:organization/databases/:database/branches/:branch/keyspaces/get.md)

---

[API](https://skmtc.dev/planetscale/apis/planetscale-api.md) · [All operations](https://skmtc.dev/planetscale/apis/planetscale-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/planetscale/planetscale-api/revisions/6d28c038c4fd/schema)