PlanetScale

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

Detail	Value
Category	Database
Base URL	https://api.planetscale.com/v1
Authentication	Bearer Token
Endpoints	8
Connector key	planetscale

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. The full list is below.

Available endpoints

Endpoint	Summary
GET /organizations/{organization}/databases	List databases
POST /organizations/{organization}/databases	Create a database
GET /organizations/{organization}/databases/{database}	Get database details
GET /organizations/{organization}/databases/{database}/branches	List branches
POST /organizations/{organization}/databases/{database}/branches	Create a branch
GET /organizations/{organization}/databases/{database}/deploy-requests	List deploy requests
POST /organizations/{organization}/databases/{database}/deploy-requests	Create deploy request
GET /organizations/{organization}/databases/{database}/branches/{branch}/schema	Get branch schema

Each endpoint is documented in full below. Use the outline on the right to jump to one.

GET /organizations/{organization}/databases

List databases

Detail	Value
Operation ID	database.listDatabases
Method	GET
Path	/organizations/{organization}/databases

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your PlanetScale connection from the Connection dropdown.
3. In the Operation dropdown, select database.listDatabases.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream PlanetScale API reference.

POST /organizations/{organization}/databases

Create a database

Detail	Value
Operation ID	database.createDatabase
Method	POST
Path	/organizations/{organization}/databases

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your PlanetScale connection from the Connection dropdown.
3. In the Operation dropdown, select database.createDatabase.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream PlanetScale API reference.

GET /organizations/{organization}/databases/{database}

Get database details

Detail	Value
Operation ID	database.getDatabase
Method	GET
Path	/organizations/{organization}/databases/{database}

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your PlanetScale connection from the Connection dropdown.
3. In the Operation dropdown, select database.getDatabase.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream PlanetScale API reference.

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

List branches

Detail	Value
Operation ID	database.listBranches
Method	GET
Path	/organizations/{organization}/databases/{database}/branches

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your PlanetScale connection from the Connection dropdown.
3. In the Operation dropdown, select database.listBranches.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream PlanetScale API reference.

POST /organizations/{organization}/databases/{database}/branches

Create a branch

Detail	Value
Operation ID	database.createBranch
Method	POST
Path	/organizations/{organization}/databases/{database}/branches

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your PlanetScale connection from the Connection dropdown.
3. In the Operation dropdown, select database.createBranch.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream PlanetScale API reference.

GET /organizations/{organization}/databases/{database}/deploy-requests

List deploy requests

Detail	Value
Operation ID	database.listDeployRequests
Method	GET
Path	/organizations/{organization}/databases/{database}/deploy-requests

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your PlanetScale connection from the Connection dropdown.
3. In the Operation dropdown, select database.listDeployRequests.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream PlanetScale API reference.

POST /organizations/{organization}/databases/{database}/deploy-requests

Create deploy request

Detail	Value
Operation ID	database.createDeployRequest
Method	POST
Path	/organizations/{organization}/databases/{database}/deploy-requests

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your PlanetScale connection from the Connection dropdown.
3. In the Operation dropdown, select database.createDeployRequest.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream PlanetScale API reference.

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

Get branch schema

Detail	Value
Operation ID	database.getBranchSchema
Method	GET
Path	/organizations/{organization}/databases/{database}/branches/{branch}/schema

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your PlanetScale connection from the Connection dropdown.
3. In the Operation dropdown, select database.getBranchSchema.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream PlanetScale API reference.