Update the VSchema for the keyspace

Authorization

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

Service Token Accesses write_production_branch_vschema, write_branch_vschema

PATCH /organizations/{organization}/databases/{database}/branches/{branch}/keyspaces/{keyspace}/vschema

Update the VSchema for the keyspace

cURL

curl --request PATCH \
  --url https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches/{branch}/keyspaces/{keyspace}/vschema \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "vschema": "<string>"
}
'

200

{
  "raw": "<string>"
}

Authorizations

Authorization · string · header · required

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

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

keyspace · string · required

The name of the keyspace

Body

application/json

vschema · string · required

The new VSchema for the keyspace

Response

200

application/json

Returns the VSchema for the keyspace

raw · string · required

The keyspace's VSchema