Skip to main content
GET
/
organizations
/
{organization}
/
databases
/
{database}
/
branches
/
{branch}
/
keyspaces
/
{keyspace}
/
vschema
Get the VSchema for the keyspace
curl --request GET \
  --url https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches/{branch}/keyspaces/{keyspace}/vschema \
  --header 'Authorization: Bearer <token>'
{
  "raw": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://planetscale.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

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

Returns the VSchema for the keyspace

​
raw
string
required

The keyspace's VSchema