Overview

You can use the PlanetScale API to manage your PlanetScale databases programmatically.

The PlanetScale API does not include direct access to the data in the database. Some endpoints will consist of database schema information or connection information.

Authentication

Before making your first API call, set up the proper authentication for the PlanetScale API using the Authorization header. There are two API authentication types: Service tokens and OAuth.

Service tokens

Most endpoints only need a service token for authentication, but some organization-specific endpoints also need OAuth. Each endpoint will state what types of authentication are allowed. See the Service tokens documentation for creating a service token and making your first API call with the PlanetScale API.

OAuth applications

All OAuth applications have a comprehensive list of scopes that the application can request from the PlanetScale user. See the OAuth documentation for more info.