Database branches
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
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
Query parameters
keyspacestring
Return the schema for a single Vitess keyspace
namespacestring
Return the schema for a PostgreSQL catalog namespace in <database>.<schema> format (e.g. public.schema1)
Response
Gets the schema for the branch