PATCH
/
organizations
/
{organization}
/
databases
/
{database}
/
branches
/
{branch}
/
keyspaces
/
{name}
Configure keyspace settings
curl --request PATCH \
  --url https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches/{branch}/keyspaces/{name} \
  --header 'Authorization: <api-key>'
{
  "id": "<string>",
  "name": "<string>",
  "shards": 123,
  "sharded": true,
  "replicas": 123,
  "extra_replicas": 123,
  "created_at": "<string>",
  "updated_at": "<string>",
  "cluster_name": "<string>",
  "cluster_display_name": "<string>",
  "resizing": true,
  "resize_pending": true,
  "ready": true,
  "metal": true,
  "default": true,
  "imported": true,
  "vector_pool_allocation": 123,
  "replication_durability_constraints": {
    "strategy": "available"
  },
  "vreplication_flags": {
    "optimize_inserts": true,
    "allow_no_blob_binlog_row_image": true,
    "vplayer_batching": true
  }
}

Authorizations

Authorization
string
header
required

Path Parameters

organization
string
required

The name of the organization the branch belongs to

database
string
required

The name of the database the branch belongs to

branch
string
required

The name of the branch

name
string
required

The name of the keyspace

Response

Returns the keyspace

id
string
required

The ID of the keyspace

name
string
required

Name of the keyspace

shards
number
required

The number of keyspace shards

sharded
boolean
required

If the keyspace is sharded

replicas
number
required

Total number of replicas in the keyspace

extra_replicas
number
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_pending
boolean
required

Is the keyspace awaiting a resize

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
required

Percentage of buffer pool memory allocated to vector indexes

replication_durability_constraints
object
required
vreplication_flags
object
required