Sign in

v17

latestOpenAPI 3.0.1raw.githubusercontent.com2026-07-08165682.0 MB
Database branch keyspaces

Create a keyspace

Authorization

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

Service Token Accesses create_branch

post/organizations/{organization}/databases/{database}/branches/{branch}/keyspaces

Path parameters

organizationstring required

The name of the organization the branch belongs to

databasestring required

The name of the database the branch belongs to

branchstring required

The name of the branch

Request body

namestring required

The name of the keyspace

cluster_sizestring required

The database cluster size name (e.g., 'PS_10', 'PS_80'). Use the 'List available cluster sizes' endpoint to get available options for your organization. /v1/organizations/:organization/cluster-size-skus

extra_replicasinteger

The number of additional replicas beyond the included default

shardsinteger

The number of shards. Default: 1

Response

Returns a created keyspace

idstring required

The ID of the keyspace

namestring required

Name of the keyspace

shardsinteger required

The number of keyspace shards

shardedboolean required

If the keyspace is sharded

replicasinteger required

Total number of replicas in the keyspace

extra_replicasinteger required

Number of extra replicas in the keyspace

created_atstring required

When the keyspace was created

updated_atstring required

When the keyspace was last updated

cluster_namestring required

The SKU representing the keyspace cluster size

cluster_display_namestring required

The SKU representing the keyspace cluster size for display

resizingboolean required

Is the keyspace currently resizing

resize_pendingboolean required

Is the keyspace awaiting a resize

config_change_in_progressboolean required

Is the keyspace undergoing a config change

readyboolean required

Is the keyspace provisioned and serving traffic

metalboolean required

Is the keyspace running on metal instances

defaultboolean required

Is this the default keyspace for the branch

importedboolean required

Is this keyspace used in an import

vector_pool_allocationnumber 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

mysqld_optionsobject required

MySQL daemon configuration options

vttablet_optionsobject required

VTTablet configuration options