Get a branch schema

Authorization

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

Service Token Accesses read_branch, delete_branch, create_branch, connect_production_branch, connect_branch

OAuth Scopes

Resource	Scopes
Organization	read_branches
Database	read_branches
Branch	read_branch

GET /organizations/{organization}/databases/{database}/branches/{branch}/schema

Get a branch schema

cURL

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

200

{
  "data": [
    {
      "name": "<string>",
      "html": "<string>",
      "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

Query Parameters

keyspace · string

Return the schema for a single Vitess keyspace

namespace · string

Return the schema for a PostgreSQL catalog namespace in <database>.<schema> format (e.g. public.schema1)

Response

200

application/json

Gets the schema for the branch

data · object[] · required

Show child attributes