- Category: databases
- Auth: OAUTH2
- Composio-managed OAuth available? No
- Tools: 245
- Triggers: 0
- Slug:
PLANETSCALE - Version: 20261101_00
Tools
Add a member to a team
Add a member to a team
Assign shards to a Neki shard configuration profile
Assign shards to a Neki shard configuration profile
Add shards to a Neki shard configuration profile
Add shards to a Neki shard configuration profile
Cancel a change request for a Neki admin
Cancel a change request for a Neki admin
Cancel a resize request
Cancel a resize request
Cancel a change request
Cancel a change request
Cancel a queued deploy request
Cancel a queued deploy request
Cancel a change request for a Neki branch
Cancel a change request for a Neki branch
Cancel a change request for a Neki router
Cancel a change request for a Neki router
Cancel a change request for a Neki shard configuration profile
Cancel a change request for a Neki shard configuration profile
Cancel a change request for a Neki sidecar
Cancel a change request for a Neki sidecar
Check deploy request storage
Check deploy request storage
Close a deploy request
Close a deploy request
Complete an errored deploy
Complete an errored deploy
Complete a gated deploy request
Complete a gated deploy request
Complete a revert
Complete a revert
Open the SSO configuration portal
Open the SSO configuration portal
Create a backup
Create a backup
PLANETSCALE_CREATE_BACKUPCreate a backup.Input Parameters
1 and 1000 for the retention period of the backup (i.e retention_value 6 and retention_unit hour means 6 hours)Output
Create a backup policy
Create a backup policy
Create a bouncer
Create a bouncer
Create a branch
Create a branch
PLANETSCALE_CREATE_BRANCHCreate a branch in a database, optionally creating the database if it is missing.Input Parameters
restore_production_branch_backup(s) or restore_backup(s) access to do this.restore_production_branch_backup(s) or restore_backup(s) access to do this, in addition to Data Branching™ being enabled for the branch.Output
Create a log signature
Create a log signature
Create a database
Create a database
PLANETSCALE_CREATE_DATABASECreate a database.Input Parameters
Output
Create an IP restriction entry
Create an IP restriction entry
PLANETSCALE_CREATE_DATABASE_POSTGRES_CIDRCreate an IP restriction entry. PostgreSQL databases only.Input Parameters
Output
Create a deploy request
Create a deploy request
PLANETSCALE_CREATE_DEPLOY_REQUESTCreate a deploy request. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.Input Parameters
Output
Create an Insights agent run
Create an Insights agent run
Start SSO domain verification
Start SSO domain verification
Create an organization team
Create an organization team
Create a password
Create a password
Create a billing payment method setup
Create a billing payment method setup
Create a new query patterns report
Create a new query patterns report
Create a read-only replica
Create a read-only replica
Create role credentials
Create role credentials
Create a router for a Neki branch
Create a router for a Neki branch
PLANETSCALE_CREATE_ROUTERCreate a router for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.Input Parameters
new, primary, and replica are reserved. Clients connect through the group by appending it to the username, e.g. user|my-router.Output
Add shards to a Neki branch
Add shards to a Neki branch
Create a shard configuration profile for a Neki branch
Create a shard configuration profile for a Neki branch
PLANETSCALE_CREATE_SHARD_CONFIGURATION_PROFILECreate a shard configuration profile for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.Input Parameters
Output
Add a shard to a Neki shard configuration profile
Add a shard to a Neki shard configuration profile
Create a switchover
Create a switchover
PLANETSCALE_CREATE_SWITCHOVERRequest a switchover for a PostgreSQL branch: a replica is promoted when available, while a single instance restarts and is unreachable during restart. The response method may initially be absent; only one switchover can run at a time, and a failed switchover has an unconfirmed outcome and may not be reversible.Input Parameters
name of the replica returned by the branch’s Postgres infrastructure endpoint to promote. Omit to let the operator select an eligible replica. Only applies to branches with replicas.Output
Create a traffic budget
Create a traffic budget
PLANETSCALE_CREATE_TRAFFIC_BUDGETCreate a traffic budget. PostgreSQL databases only.Input Parameters
Output
Create a traffic rule
Create a traffic rule
Delete a backup
Delete a backup
Delete a backup policy
Delete a backup policy
Delete a bouncer
Delete a bouncer
Delete a branch
Delete a branch
Delete a database
Delete a database
Delete an IP restriction entry
Delete an IP restriction entry
Delete the current billing payment method
Delete the current billing payment method
Delete an SSO domain
Delete an SSO domain
Delete an organization team
Delete an organization team
Delete a password
Delete a password
Delete a query patterns report
Delete a query patterns report
Delete a read-only replica
Delete a read-only replica
Delete role credentials
Delete role credentials
Delete a router from a Neki branch
Delete a router from a Neki branch
Remove a shard from a Neki branch
Remove a shard from a Neki branch
Delete a shard configuration profile for a Neki branch
Delete a shard configuration profile for a Neki branch
Remove a shard from a Neki shard configuration profile
Remove a shard from a Neki shard configuration profile
Remove shards from a Neki shard configuration profile
Remove shards from a Neki shard configuration profile
Delete a traffic budget
Delete a traffic budget
Delete a traffic rule
Delete a traffic rule
Delete a webhook
Delete a webhook
Demote a branch
Demote a branch
Disable organization SSO
Disable organization SSO
Disable directory sync
Disable directory sync
Disable safe migrations for a branch
Disable safe migrations for a branch
Dismiss a schema recommendation
Dismiss a schema recommendation
Enable organization SSO
Enable organization SSO
Open the directory sync portal
Open the directory sync portal
Enable safe migrations for a branch
Enable safe migrations for a branch
Enable force cutover for a deploy request
Enable force cutover for a deploy request
Get the admin for a Neki branch
Get the admin for a Neki branch
Get a change request for a Neki admin
Get a change request for a Neki admin
Get a bouncer
Get a bouncer
Retrieve a branch anomaly
Retrieve a branch anomaly
Get a branch change request
Get a branch change request
Get table storage metrics by keyspace
Get table storage metrics by keyspace
Get time-series metrics
Get time-series metrics
PLANETSCALE_GET_BRANCH_METRICSRetrieve time-series metrics for a database branch. sh curl --get \ --header "Authorization: $PLANETSCALE_SERVICE_TOKEN" \ --data-urlencode "metrics=queries" \ --data-urlencode "period=15m" \ "https://api.planetscale.com/v1/organizations/acme/databases/app-db/branches/main/metrics" Each series contains its metric name, display label, identifying labels, and sampled [Unix timestamp, value] points: json { "type": "MetricSeries", "start_date": "2026-09-09T17:00:00Z", "end_date": "2026-09-09T17:15:00Z", "interval": 60, "series": [ { "type": "TimeSeries", "metric": "queries", "label": "Queries", "labels": { "tablet_type": "primary" }, "points": [[1788973200, 42.0]] } ] } .Input Parameters
metrics[]=name (repeat for multiple), metrics=name, or a comma-separated list (metrics=name,other). Time range is period (for example 15m) or ISO 8601 from/to.Output
Retrieve a branch query
Retrieve a branch query
List queries for an error fingerprint
List queries for an error fingerprint
Get time-series metrics for SQL queries
Get time-series metrics for SQL queries
PLANETSCALE_GET_BRANCH_QUERY_METRICSGet time-series metrics for SQL queries.Input Parameters
metrics[]=name (repeat for multiple), metrics=name, or a comma-separated list (metrics=name,other). Time range is period (for example 15m) or ISO 8601 from/to.Output
Retrieve a query tag
Retrieve a query tag
Get a branch resize request
Get a branch resize request
Get a branch schema
Get a branch schema
Get table storage metrics
Get table storage metrics
Get current user
Get current user
Get an IP restriction entry
Get an IP restriction entry
Get database throttler configurations
Get database throttler configurations
Get the data topology for a Neki branch
Get the data topology for a Neki branch
Get the default postgres role
Get the default postgres role
Get the default shard configuration profile for a Neki branch
Get the default shard configuration profile for a Neki branch
Get a deployment
Get a deployment
Get the deploy queue
Get the deploy queue
Get a deploy request
Get a deploy request
Get deploy request throttler configurations
Get deploy request throttler configurations
Get an Insights agent run
Get an Insights agent run
Get current metric values
Get current metric values
Get current tablet metrics
Get current tablet metrics
Get invoice line items
Get invoice line items
Get a maintenance schedule
Get a maintenance schedule
Get a change request for a Neki branch
Get a change request for a Neki branch
Get the current billing payment method
Get the current billing payment method
Get an organization member
Get an organization member
PLANETSCALE_GET_ORGANIZATION_MEMBERSHIPGet a PlanetScale organization member by user ID or membership ID. Returns membership details, including the user’s information and organization role.Input Parameters
list_organization_members. PlanetScale documents the user ID, but the detail endpoint can return 404 for IDs present in the list; this action falls back to the list result.Output
Get organization SSO status
Get organization SSO status
Get an SSO domain
Get an SSO domain
Get an organization team
Get an organization team
Get a team member
Get a team member
Get a password
Get a password
Get a billing payment method setup
Get a billing payment method setup
Download a finished query patterns report
Download a finished query patterns report
Show the status of a query patterns report
Show the status of a query patterns report
Retrieve query statistics
Retrieve query statistics
Retrieve a summary of query statistics
Retrieve a summary of query statistics
Get a read-only replica
Get a read-only replica
Get a router for a Neki branch
Get a router for a Neki branch
Get a change request for a Neki router
Get a change request for a Neki router
Get a schema recommendation
Get a schema recommendation
Get a shard for a Neki branch
Get a shard for a Neki branch
Get a shard configuration profile for a Neki branch
Get a shard configuration profile for a Neki branch
Get a change request for a Neki shard configuration profile
Get a change request for a Neki shard configuration profile
Get a shard in a Neki shard configuration profile
Get a shard in a Neki shard configuration profile
Get a sidecar for a Neki branch
Get a sidecar for a Neki branch
Get a change request for a Neki sidecar
Get a change request for a Neki sidecar
Get a switchover
Get a switchover
Get time-series tablet metrics
Get time-series tablet metrics
PLANETSCALE_GET_TABLET_METRICSGet time-series tablet metrics.Input Parameters
metrics[]=name (repeat for multiple), metrics=name, or a comma-separated list (metrics=name,other). Time range is period (for example 15m) or ISO 8601 from/to.Output
Get a traffic budget
Get a traffic budget
Lint a branch schema
Lint a branch schema
List change requests for a Neki admin
List change requests for a Neki admin
List parameters for a Neki admin
List parameters for a Neki admin
List admin size SKUs for a Neki branch
List admin size SKUs for a Neki branch
List backup policies
List backup policies
List backups
List backups
Get bouncer resize requests
Get bouncer resize requests
List bouncers
List bouncers
List branch anomalies
List branch anomalies
Get bouncer resize requests
Get bouncer resize requests
Get branch change requests
Get branch change requests
List branch queries
List branch queries
PLANETSCALE_LIST_BRANCH_QUERIESList branch queries.Input Parameters
Output
List branch query errors
List branch query errors
List query statistics grouped by tag
List query statistics grouped by tag
PLANETSCALE_LIST_BRANCH_QUERY_TAG_SUMMARIESList query statistics grouped by tag.Input Parameters
Output
Get branch resize requests
Get branch resize requests
List available cluster sizes
List available cluster sizes
List IP restriction entries
List IP restriction entries
List database regions
List database regions
List deploy operations
List deploy operations
List deploy request reviews
List deploy request reviews
List deploy requests
List deploy requests
PLANETSCALE_LIST_DEPLOY_REQUESTSList deploy requests for a database. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.Input Parameters
Output
List cluster extensions
List cluster extensions
List generated query patterns reports
List generated query patterns reports
List Insights agent runs
List Insights agent runs
List Insights Agent schedules
List Insights Agent schedules
Get invoices
Get invoices
List maintenance schedules
List maintenance schedules
List maintenance windows
List maintenance windows
List change requests for a Neki branch
List change requests for a Neki branch
PLANETSCALE_LIST_NEKI_CHANGE_REQUESTSList change requests for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.Input Parameters
Output
List organization members
List organization members
List organizations
List organizations
List organization SSO domains
List organization SSO domains
List team members
List team members
List teams in an organization
List teams in an organization
List cluster parameters
List cluster parameters
List passwords
List passwords
List available Postgres versions
List available Postgres versions
List read-only regions
List read-only regions
Get read-only replica change requests
Get read-only replica change requests
List read-only replicas
List read-only replicas
List regions for an organization
List regions for an organization
List change requests for a Neki router
List change requests for a Neki router
List parameters for a Neki router
List parameters for a Neki router
List routers for a Neki branch
List routers for a Neki branch
List router size SKUs for a Neki branch
List router size SKUs for a Neki branch
List schema recommendations
List schema recommendations
List change requests for a Neki shard configuration profile
List change requests for a Neki shard configuration profile
List extensions for a Neki shard configuration profile
List extensions for a Neki shard configuration profile
List parameters for a Neki shard configuration profile
List parameters for a Neki shard configuration profile
List shard configuration profiles for a Neki branch
List shard configuration profiles for a Neki branch
List shards for a Neki shard configuration profile
List shards for a Neki shard configuration profile
List shards for a Neki branch
List shards for a Neki branch
List change requests for a Neki sidecar
List change requests for a Neki sidecar
List parameters for a Neki sidecar
List parameters for a Neki sidecar
List sidecars for a Neki branch
List sidecars for a Neki branch
List switchovers
List switchovers
List traffic budgets
List traffic budgets
List traffic budgets affecting a query fingerprint
List traffic budgets affecting a query fingerprint
Get OAuth token info
Get OAuth token info
Promote a branch
Promote a branch
Queue a deploy request
Queue a deploy request
Reassign objects owned by one role to another role
Reassign objects owned by one role to another role
PLANETSCALE_REASSIGN_ROLE_OBJECTSReassign objects owned by one role to another role. PostgreSQL databases only. This changes operational state and may not be safely reversible.Input Parameters
Output
Remove a member from an organization
Remove a member from an organization
PLANETSCALE_REMOVE_ORGANIZATION_MEMBERRemove a member from an organization, optionally deleting associated passwords and service tokens when removing another member. This is destructive: confirm the target before calling.Input Parameters
Output
Remove a member from a team
Remove a member from a team
Renew a password
Renew a password
Renew role expiration
Renew role expiration
Reset default credentials
Reset default credentials
Reset a role's password
Reset a role's password
Review a deploy request
Review a deploy request
PLANETSCALE_REVIEW_DEPLOY_REQUESTReview a deploy request by either approving or commenting on the deploy request. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.Input Parameters
approve_deploy_request or review_deploy_request)Output
Run maintenance for a Postgres branch
Run maintenance for a Postgres branch
Run maintenance for a Neki shard configuration profile
Run maintenance for a Neki shard configuration profile
Run maintenance for selected Neki shard configuration profiles
Run maintenance for selected Neki shard configuration profiles
Set the default shard configuration profile for a Neki branch
Set the default shard configuration profile for a Neki branch
Skip revert period
Skip revert period
Test a webhook
Test a webhook
Update the admin for a Neki branch
Update the admin for a Neki branch
Update auto-apply for deploy request
Update auto-apply for deploy request
Update auto-delete branch for deploy request
Update auto-delete branch for deploy request
Update a backup
Update a backup
Update a backup policy
Update a backup policy
Upsert a bouncer resize request
Upsert a bouncer resize request
PLANETSCALE_UPDATE_BOUNCER_RESIZE_REQUESTUpsert a bouncer resize request. PostgreSQL databases only.Input Parameters
Output
Update a branch
Update a branch
Upsert a change request for cluster size, replicas, storage, or parameters
Upsert a change request for cluster size, replicas, storage, or parameters
PLANETSCALE_UPDATE_BRANCH_CHANGE_REQUESTUpsert a change request for cluster size, replicas, storage, or parameters. PostgreSQL databases only.Input Parameters
Output
Upsert a resize request
Upsert a resize request
Update an IP restriction entry
Update an IP restriction entry
Update database settings
Update database settings
Update database throttler configurations
Update database throttler configurations
PLANETSCALE_UPDATE_DATABASE_THROTTLERUpdate database throttler configurations. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.Input Parameters
Output
Set the data topology for a Neki branch
Set the data topology for a Neki branch
Update deploy request throttler configurations
Update deploy request throttler configurations
PLANETSCALE_UPDATE_DEPLOY_REQUEST_THROTTLERUpdate deploy request throttler configurations. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.Input Parameters
Output
Update an Insights Agent schedule
Update an Insights Agent schedule
Update an organization
Update an organization
Update organization member role
Update organization member role
Update an organization team
Update an organization team
Update a password
Update a password
Update a read-only replica
Update a read-only replica
Update role name
Update role name
Update a router for a Neki branch
Update a router for a Neki branch
Update safe migrations for a branch
Update safe migrations for a branch
Update a shard for a Neki branch
Update a shard for a Neki branch
Update a shard configuration profile for a Neki branch
Update a shard configuration profile for a Neki branch
PLANETSCALE_UPDATE_SHARD_CONFIGURATION_PROFILEUpdate a shard configuration profile for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.Input Parameters
Output
Update a shard in a Neki shard configuration profile
Update a shard in a Neki shard configuration profile
Update a sidecar for a Neki branch
Update a sidecar for a Neki branch
Update a traffic budget
Update a traffic budget
PLANETSCALE_UPDATE_TRAFFIC_BUDGETUpdate a traffic budget. PostgreSQL databases only.