Jump to Content

OpenAPI document PlanetScale docs

API Reference

OpenAPI document PlanetScale docs

Introduction

Getting started with PlanetScale API
Rate limits
Pagination

Authentication

Service tokens
OAuth
OAuth access scopes
Sample OAuth application

PlanetScale API

Backups
Branch changes
Cluster extensions
- List cluster extensionsget
Cluster parameters
- List cluster parametersget
Database branch keyspaces
Database branch passwords
Databases
Keyspace VSchemas
- Get the VSchema for the keyspaceget
- Update the VSchema for the keyspacepatch
OAuth applications
OAuth tokens
- Create or renew an OAuth tokenpost
Organizations
Roles
Query Insights reports
Users
- Get current userget
Workflows
Deploy requests
Webhooks
Invoices
Database branches
Organization members
- List organization membersget
Regions
- List public regionsget

Get a keyspace

get https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches/{branch}/keyspaces/{name}

Language

Credentials

Header

Log in to use your API keys