Get 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 read_branch, delete_branch, create_branch, connect_production_branch, connect_branch

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

Get the VSchema for the keyspace

cURL

curl --request GET \
  --url https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches/{branch}/keyspaces/{keyspace}/vschema \
  --header 'Authorization: Bearer <token>'

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

Response

200

application/json

Returns the VSchema for the keyspace

raw · string · required

The keyspace's VSchema