Skip to content

PlanetScale ​

Manage MySQL-compatible databases, branches, and deploy requests with PlanetScale.

DetailValue
CategoryDatabase
Base URLhttps://api.planetscale.com/v1
AuthenticationBearer Token
Endpoints8
Connector keyplanetscale

Using PlanetScale in a workflow ​

  1. Go to Connections and click New Connection.
  2. Pick PlanetScale from the marketplace.
  3. Enter your credentials (see Authentication above for what's expected).
  4. In a workflow, drop an API Call node and select this connection.
  5. Pick the operation you need from the Operation dropdown — see the table below.

Available Endpoints ​

EndpointSummary
GET /organizations/{organization}/databasesList databases
POST /organizations/{organization}/databasesCreate a database
GET /organizations/{organization}/databases/{database}Get database details
GET /organizations/{organization}/databases/{database}/branchesList branches
POST /organizations/{organization}/databases/{database}/branchesCreate a branch
GET /organizations/{organization}/databases/{database}/deploy-requestsList deploy requests
POST /organizations/{organization}/databases/{database}/deploy-requestsCreate deploy request
GET /organizations/{organization}/databases/{database}/branches/{branch}/schemaGet branch schema

Each endpoint has its own page with parameter details, an example API Call node configuration, and the response shape.