Add a member to a team
Add a member to a team.
ActionTry it
Integrate PlanetScale
with your AI CRM
Manage PlanetScale organizations, databases, branches, deploy requests, backups, workflows, insights, and infrastructure through delegated OAuth access.
Explore Triggers and Actions
Add a shard to a Neki shard configuration profile
Add a shard to a Neki shard configuration profile. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.
ActionTry it
Add shards to a Neki branch
Add shards to a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.
ActionTry it
Add shards to a Neki shard configuration profile
Add shards to a Neki shard configuration profile. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.
ActionTry it
Assign shards to a Neki shard configuration profile
Assign shards to a Neki shard configuration profile. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.
ActionTry it
Cancel a change request
Cancel a branch resize change request. Vitess/MySQL databases only. This is destructive: confirm the target before calling.
ActionTry it
Cancel a change request for a Neki admin
Cancel a change request for a Neki admin. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404. This is destructive: confirm the target before calling.
ActionTry it
Cancel a change request for a Neki branch
Cancel a change request for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404. This is destructive: confirm the target before calling.
ActionTry it
Cancel a change request for a Neki router
Cancel a change request for a Neki router. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404. This is destructive: confirm the target before calling.
ActionTry it
Cancel a change request for a Neki shard configuration profile
Cancel a change request for a Neki shard configuration profile. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404. This is destructive: confirm the target before calling.
ActionTry it
Cancel a change request for a Neki sidecar
Cancel a change request for a Neki sidecar. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404. This is destructive: confirm the target before calling.
ActionTry it
Cancel a queued deploy request
Cancel a queued deploy request. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources. This changes operational state and may not be safely reversible.
ActionTry it
Cancel a resize request
Cancel a resize request. PostgreSQL databases only. This is destructive: confirm the target before calling.
ActionTry it
Check deploy request storage
Checks whether the deploy request's target branch cluster has enough storage to safely deploy the schema changes. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.
ActionTry it
Close a deploy request
Close a deploy request. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.
ActionTry it
Complete a gated deploy request
Complete a gated deploy request. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources. This changes operational state and may not be safely reversible.
ActionTry it
Complete a revert
Complete a revert. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources. This changes operational state and may not be safely reversible.
ActionTry it
Complete an errored deploy
Complete an errored deploy. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources. This changes operational state and may not be safely reversible.
ActionTry it
Create a backup
Create a backup.
ActionTry it
Create a backup policy
Create a backup policy.
ActionTry it
Create a billing payment method setup
Create a hosted checkout session for adding or replacing an organization's payment method.
ActionTry it
Create a bouncer
Create a bouncer. PostgreSQL databases only.
ActionTry it
Create a branch
Create a branch.
ActionTry it
Create a database
Create a database.
ActionTry it
Create a deploy request
Create a deploy request. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.
ActionTry it
Create a log signature
Creates a signed token that can be used to access branch logs.
ActionTry it
Create a new query patterns report
Create a new query patterns report.
ActionTry it
Create a password
Create a password. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.
ActionTry it
Create a read-only replica
Create a read-only replica.
ActionTry it
Create a router for a Neki branch
Create a router for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.
ActionTry it
Create a shard configuration profile for a Neki branch
Create a shard configuration profile for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.
ActionTry it
Create a switchover
Moves the primary of a Postgres branch. On a branch with replicas the primary steps down and a replica is promoted in its place. A branch running a single instance has nothing to promote, so that instance is restarted where it stands and the branch is unreachable while it comes back. Read `method` on the response to see which one the branch got. A branch accepts one switchover at a time. A switchover that ends in the `failed` state has an unconfirmed outcome: the primary may still have moved, and nothing is rolled back. PostgreSQL databases only. This changes operational state and may not be safely reversible.
ActionTry it
Create a traffic budget
Create a traffic budget. PostgreSQL databases only.
ActionTry it
Create a traffic rule
Create a traffic rule. PostgreSQL databases only.
ActionTry it
Create a webhook
Create a webhook.
ActionTry it
Create an Insights agent run
Create an Insights agent run.
ActionTry it
Create an IP restriction entry
Create an IP restriction entry. PostgreSQL databases only.
ActionTry it
Create an organization team
Create an organization team.
ActionTry it
Create role credentials
Create role credentials. PostgreSQL databases only.
ActionTry it
Delete a backup
Delete a backup. This is destructive: confirm the target before calling.
ActionTry it
Delete a backup policy
Delete a backup policy. This is destructive: confirm the target before calling.
ActionTry it
Delete a bouncer
Delete a bouncer. PostgreSQL databases only. This is destructive: confirm the target before calling.
ActionTry it
Delete a branch
Delete a branch. This is destructive: confirm the target before calling.
ActionTry it
Delete a database
Delete a database. This is destructive: confirm the target before calling.
ActionTry it
Delete a password
Delete a password. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources. This is destructive: confirm the target before calling.
ActionTry it
Delete a query patterns report
Delete a query patterns report. This is destructive: confirm the target before calling.
ActionTry it
Delete a read-only replica
Delete a read-only replica. This is destructive: confirm the target before calling.
ActionTry it
Delete a router from a Neki branch
Delete a router from a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404. This is destructive: confirm the target before calling.
ActionTry it
Delete a shard configuration profile for a Neki branch
Delete a shard configuration profile for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404. This is destructive: confirm the target before calling.
ActionTry it
Delete a traffic budget
Delete a traffic budget. PostgreSQL databases only. This is destructive: confirm the target before calling.
ActionTry it
Delete a traffic rule
Delete a traffic rule. PostgreSQL databases only. This is destructive: confirm the target before calling.
ActionTry it
Delete a webhook
Delete a webhook. This is destructive: confirm the target before calling.
ActionTry it
Delete an IP restriction entry
Delete an IP restriction entry. PostgreSQL databases only. This is destructive: confirm the target before calling.
ActionTry it
Delete an organization team
Delete an organization team. This is destructive: confirm the target before calling.
ActionTry it
Delete an SSO domain
Delete a verified or pending SSO domain. This is destructive: confirm the target before calling.
ActionTry it
Delete role credentials
Delete role credentials. PostgreSQL databases only. This is destructive: confirm the target before calling.
ActionTry it
Delete the current billing payment method
Delete the current payment method for an organization. This is destructive: confirm the target before calling.
ActionTry it
Demote a branch
Demotes a branch from production to development. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources. This changes operational state and may not be safely reversible.
ActionTry it
Disable directory sync
Disable directory sync for the organization. Non-admin directory members are removed. This is destructive: confirm the target before calling.
ActionTry it
Disable organization SSO
Disable SSO and directory sync for the organization. This is destructive: confirm the target before calling.
ActionTry it
Disable safe migrations for a branch
Disable safe migrations for a branch. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources. This is destructive: confirm the target before calling.
ActionTry it
Dismiss a schema recommendation
Dismiss a schema recommendation.
ActionTry it
Download a finished query patterns report
Download a finished query patterns report.
ActionTry it
Enable force cutover for a deploy request
Enable force cutover for a deploy request. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources. This changes operational state and may not be safely reversible.
ActionTry it
Enable organization SSO
Enable the SSO add-on and return a URL for verifying an email domain. This changes operational state and may not be safely reversible.
ActionTry it
Enable safe migrations for a branch
Enable safe migrations for a branch. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.
ActionTry it
Get a backup
Get a backup.
ActionTry it
Get a backup policy
Get a backup policy.
ActionTry it
Get a billing payment method setup
Get the state of a billing payment method setup.
ActionTry it
Get a bouncer
Get a bouncer. PostgreSQL databases only.
ActionTry it
Get a branch
Get a branch.
ActionTry it
Get a branch change request
Get a branch change request. PostgreSQL databases only.
ActionTry it
Get a branch resize request
Get a branch resize request.
ActionTry it
Get a branch schema
Get a branch schema. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.
ActionTry it
Get a change request for a Neki admin
Get a change request for a Neki admin. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.
ActionTry it
Get a change request for a Neki branch
Get a change request for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.
ActionTry it
Get a change request for a Neki router
Get a change request for a Neki router. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.
ActionTry it
Get a change request for a Neki shard configuration profile
Get a change request for a Neki shard configuration profile. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.
ActionTry it
Get a change request for a Neki sidecar
Get a change request for a Neki sidecar. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.
ActionTry it
Get a database
Get a database.
ActionTry it
Get a deploy request
Get a deploy request. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.
ActionTry it
Get a deployment
Get the deployment for a deploy request. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.
ActionTry it
Get a maintenance schedule
Get a maintenance schedule. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.
ActionTry it
Get a password
Get a password. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.
ActionTry it
Get a read-only replica
Get a read-only replica.
ActionTry it
Get a role
Get a role. PostgreSQL databases only.
ActionTry it
Get a router for a Neki branch
Get a router for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.
ActionTry it
Get a schema recommendation
Get a schema recommendation.
ActionTry it
Get a shard configuration profile for a Neki branch
Get a shard configuration profile for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.
ActionTry it
Get a shard for a Neki branch
Get a shard for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.
ActionTry it
Get a shard in a Neki shard configuration profile
Get a shard in a Neki shard configuration profile. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.
ActionTry it
Get a sidecar for a Neki branch
Get a sidecar for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.
ActionTry it
Get a switchover
Get a switchover. PostgreSQL databases only.
ActionTry it
Get a team member
Get a team member.
ActionTry it
Get a traffic budget
Get a traffic budget. PostgreSQL databases only.
ActionTry it
Get a webhook
Get a webhook.
ActionTry it
Get an Insights agent run
Get an Insights agent run.
ActionTry it
Get an invoice
Get an invoice.
ActionTry it
Get an IP restriction entry
Get an IP restriction entry. PostgreSQL databases only.
ActionTry it
Get an organization
Get an organization.
ActionTry it
Get an organization member
Get an organization member by a user ID or membership ID returned by `list_organization_members`. The action uses PlanetScale's documented detail route first and falls back to the paginated member list when the provider returns 404 for an ID it just listed.
ActionTry it
Get an organization team
Get an organization team.
ActionTry it
Get an SSO domain
Get a registered SSO email domain and its verification state.
ActionTry it
Get bouncer resize requests
Get bouncer resize requests. PostgreSQL databases only.
ActionTry it
Get bouncer resize requests
Get bouncer resize requests. PostgreSQL databases only.
ActionTry it
Get branch change requests
Get branch change requests. PostgreSQL databases only.
ActionTry it
Get branch resize requests
Get branch resize requests.
ActionTry it
Get current metric values
Get current metric values.
ActionTry it
Get current tablet metrics
Get current tablet metrics.
ActionTry it
Get current user
Get the user associated with the current OAuth access token.
ActionTry it
Get database throttler configurations
Get database throttler configurations. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.
ActionTry it
Get deploy request throttler configurations
Get deploy request throttler configurations. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.
ActionTry it
Get invoice line items
Get the line items for an invoice.
ActionTry it
Get invoices
Get the invoices for an organization.
ActionTry it
Get OAuth token info
Inspect whether the current OAuth access token is active and return its scopes and expiry.
ActionTry it
Get organization SSO status
Get SSO add-on status, identity provider connection state, directory sync, and verified domains.
ActionTry it
Get read-only replica change requests
Get read-only replica change requests.
ActionTry it
Get table storage metrics
Get table storage metrics.
ActionTry it
Get table storage metrics by keyspace
Get table storage metrics by keyspace.
ActionTry it
Get the admin for a Neki branch
Get the admin for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.
ActionTry it
Get the current billing payment method
Get the current payment method for an organization.
ActionTry it
Get the data topology for a Neki branch
Get the data topology for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.
ActionTry it
Get the default postgres role
Get the default postgres role. PostgreSQL databases only.
ActionTry it
Get the default shard configuration profile for a Neki branch
Get the default shard configuration profile for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.
ActionTry it
Get the deploy queue
The deploy queue returns the current list of deploy requests in the order they will be deployed. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.
ActionTry it
Get time-series metrics
Retrieve 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]] } ] } ```.
ActionTry it
Get time-series metrics for SQL queries
Get time-series metrics for SQL queries.
ActionTry it
Get time-series metrics grouped by query tags
Get time-series metrics grouped by query tags.
ActionTry it
Get time-series tablet metrics
Get time-series tablet metrics.
ActionTry it
Lint a branch schema
Lint a branch schema. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.
ActionTry it
List admin size SKUs for a Neki branch
List admin size SKUs for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.
ActionTry it
List audit logs
List audit logs.
ActionTry it
List available cluster sizes
List available cluster sizes for an organization.
ActionTry it
List available Postgres versions
List the published Postgres versions available to the requested engine. PostgreSQL databases only.
ActionTry it
List backup policies
List backup policies.
ActionTry it
List backups
List backups.
ActionTry it
List bouncers
List bouncers. PostgreSQL databases only.
ActionTry it
List branch anomalies
List branch anomalies.
ActionTry it
List branch queries
List branch queries.
ActionTry it
List branch query errors
List branch query errors.
ActionTry it
List branches
List branches.
ActionTry it
List change requests for a Neki admin
List change requests for a Neki admin. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.
ActionTry it
List change requests for a Neki branch
List change requests for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.
ActionTry it
List change requests for a Neki router
List change requests for a Neki router. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.
ActionTry it
List change requests for a Neki shard configuration profile
List change requests for a Neki shard configuration profile. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.
ActionTry it
List change requests for a Neki sidecar
List change requests for a Neki sidecar. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.
ActionTry it
List cluster extensions
List cluster extensions. PostgreSQL databases only.
ActionTry it
List cluster parameters
Returns the parameters for a branch. To update the parameters, use the "update_branch_change_request" endpoint. PostgreSQL databases only.
ActionTry it
List database regions
List database regions.
ActionTry it
List databases
List databases.
ActionTry it
List deploy operations
List deploy operations for a deploy request. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.
ActionTry it
List deploy request reviews
List deploy request reviews. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.
ActionTry it
List deploy requests
List deploy requests for a database. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.
ActionTry it
List extensions for a Neki shard configuration profile
List extensions for a Neki shard configuration profile. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.
ActionTry it
List generated query patterns reports
List generated query patterns reports.
ActionTry it
List Insights agent runs
List Insights agent runs.
ActionTry it
List Insights Agent schedules
List Insights Agent schedules.
ActionTry it
List IP restriction entries
List IP restriction entries. PostgreSQL databases only.
ActionTry it
List maintenance schedules
List maintenance schedules. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.
ActionTry it
List maintenance windows
List maintenance windows. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.
ActionTry it
List organization members
List organization members.
ActionTry it
List organization SSO domains
List email domains registered for organization SSO.
ActionTry it
List organizations
When using a service token, returns the list of organizations the service token has access to. When using an OAuth token, returns the list of organizations the user has access to.
ActionTry it
List parameters for a Neki admin
List parameters for a Neki admin. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.
ActionTry it
List parameters for a Neki router
List parameters for a Neki router. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.
ActionTry it
List parameters for a Neki shard configuration profile
List parameters for a Neki shard configuration profile. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.
ActionTry it
List parameters for a Neki sidecar
List parameters for a Neki sidecar. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.
ActionTry it
List passwords
List passwords. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.
ActionTry it
List queries for an error fingerprint
List queries for an error fingerprint.
ActionTry it
List query statistics grouped by tag
List query statistics grouped by tag.
ActionTry it
List query tags
List query tags.
ActionTry it
List read-only regions
List read-only regions for the database's default branch.
ActionTry it
List read-only replicas
List read-only replicas.
ActionTry it
List regions for an organization
List regions for an organization.
ActionTry it
List roles
List roles. PostgreSQL databases only.
ActionTry it
List router size SKUs for a Neki branch
List router size SKUs for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.
ActionTry it
List routers for a Neki branch
List routers for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.
ActionTry it
List schema recommendations
List schema recommendations.
ActionTry it
List shard configuration profiles for a Neki branch
List shard configuration profiles for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.
ActionTry it
List shards for a Neki branch
List shards for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.
ActionTry it
List shards for a Neki shard configuration profile
List shards for a Neki shard configuration profile. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.
ActionTry it
List sidecars for a Neki branch
List sidecars for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.
ActionTry it
List switchovers
List switchovers. PostgreSQL databases only.
ActionTry it
List team members
List team members.
ActionTry it
List teams in an organization
List teams in an organization.
ActionTry it
List traffic budgets
List traffic budgets. PostgreSQL databases only.
ActionTry it
List traffic budgets affecting a query fingerprint
List traffic budgets affecting a query fingerprint. PostgreSQL databases only.
ActionTry it
List webhooks
List webhooks for a database.
ActionTry it
Open the directory sync portal
Return a URL for configuring directory sync. Requires SSO to be enabled.
ActionTry it
Open the SSO configuration portal
Return a URL for configuring the identity provider. Requires at least one verified domain.
ActionTry it
Promote a branch
Promotes a branch from development to production. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources. This changes operational state and may not be safely reversible.
ActionTry it
Queue a deploy request
Queue a deploy request. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources. This changes operational state and may not be safely reversible.
ActionTry it
Reassign objects owned by one role to another role
Reassign objects owned by one role to another role. PostgreSQL databases only. This changes operational state and may not be safely reversible.
ActionTry it
Remove a member from a team
Remove a member from a team. This is destructive: confirm the target before calling.
ActionTry it
Remove a member from an organization
Remove a member from an organization. This is destructive: confirm the target before calling.
ActionTry it
Remove a shard from a Neki branch
Remove a shard from a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404. This is destructive: confirm the target before calling.
ActionTry it
Remove a shard from a Neki shard configuration profile
Remove a shard from a Neki shard configuration profile. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404. This is destructive: confirm the target before calling.
ActionTry it
Remove shards from a Neki shard configuration profile
Remove shards from a Neki shard configuration profile. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404. This is destructive: confirm the target before calling.
ActionTry it
Renew a password
Renew a password. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources. This changes operational state and may not be safely reversible.
ActionTry it
Renew role expiration
Renew role expiration. PostgreSQL databases only. This changes operational state and may not be safely reversible.
ActionTry it
Reset a role's password
Reset a role's password. PostgreSQL databases only. This changes operational state and may not be safely reversible.
ActionTry it
Reset default credentials
Reset default credentials. PostgreSQL databases only. This changes operational state and may not be safely reversible.
ActionTry it
Retrieve a branch anomaly
Retrieve a branch anomaly.
ActionTry it
Retrieve a branch query
Retrieve a branch query.
ActionTry it
Retrieve a query tag
Retrieve a query tag.
ActionTry it
Retrieve a summary of query statistics
Retrieve a summary of query statistics.
ActionTry it
Retrieve query statistics
Retrieve query statistics.
ActionTry it
Review a deploy request
Review a deploy request by either approving or commenting on the deploy request. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.
ActionTry it
Run maintenance for a Neki shard configuration profile
Run maintenance for a Neki shard configuration profile. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404. This changes operational state and may not be safely reversible.
ActionTry it
Run maintenance for a Postgres branch
Run maintenance for a Postgres branch. PostgreSQL databases only. This changes operational state and may not be safely reversible.
ActionTry it
Run maintenance for selected Neki shard configuration profiles
Run maintenance for selected Neki shard configuration profiles. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404. This changes operational state and may not be safely reversible.
ActionTry it
Set the data topology for a Neki branch
Set the data topology for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.
ActionTry it
Set the default shard configuration profile for a Neki branch
Set the default shard configuration profile for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.
ActionTry it
Show the status of a query patterns report
Show the status of a query patterns report.
ActionTry it
Skip revert period
Skips the revert period for a deploy request. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources. This changes operational state and may not be safely reversible.
ActionTry it
Start SSO domain verification
Enable SSO if needed and return a URL for verifying an email domain.
ActionTry it
Test a webhook
Sends a test event to the webhook. This changes operational state and may not be safely reversible.
ActionTry it
Update a backup
Update a backup.
ActionTry it
Update a backup policy
Update a backup policy.
ActionTry it
Update a branch
Update a branch.
ActionTry it
Update a password
Update a password. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.
ActionTry it
Update a read-only replica
Update a read-only replica.
ActionTry it
Update a router for a Neki branch
Update a router for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.
ActionTry it
Update a shard configuration profile for a Neki branch
Update a shard configuration profile for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.
ActionTry it
Update a shard for a Neki branch
Update a shard for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.
ActionTry it
Update a shard in a Neki shard configuration profile
Update a shard in a Neki shard configuration profile. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.
ActionTry it
Update a sidecar for a Neki branch
Update a sidecar for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.
ActionTry it
Update a traffic budget
Update a traffic budget. PostgreSQL databases only.
ActionTry it
Update a webhook
Update a webhook.
ActionTry it
Update an Insights Agent schedule
Update an Insights Agent schedule.
ActionTry it
Update an IP restriction entry
Update an IP restriction entry. PostgreSQL databases only.
ActionTry it
Update an organization
Update an organization.
ActionTry it
Update an organization team
Update an organization team.
ActionTry it
Update auto-apply for deploy request
Enables or disabled the auto-apply setting for a deploy request. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.
ActionTry it
Update auto-delete branch for deploy request
Enables or disabled the auto-delete branch setting for a deploy request. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.
ActionTry it
Update database settings
Update database settings.
ActionTry it
Update database throttler configurations
Update database throttler configurations. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.
ActionTry it
Update deploy request throttler configurations
Update deploy request throttler configurations. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.
ActionTry it
Update organization member role
Update organization member role.
ActionTry it
Update role name
Update role name. PostgreSQL databases only.
ActionTry it
Update safe migrations for a branch
Update safe migrations for a branch. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.
ActionTry it
Update the admin for a Neki branch
Update the admin for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.
ActionTry it
Upsert a bouncer resize request
Upsert a bouncer resize request. PostgreSQL databases only.
ActionTry it
Upsert a change request for cluster size, replicas, storage, or parameters
Upsert a change request for cluster size, replicas, storage, or parameters. PostgreSQL databases only.
ActionTry it
Upsert a resize request
Upsert a resize request.
ActionTry it
How the PlanetScale integration works
The PlanetScale integration connects your Dench AI CRM directly to PlanetScale, so agents can read and act on your PlanetScale data as part of everyday work — answering questions in chat, keeping your CRM in sync, and running automations without anyone copying data between tools.
245 actions are available for agents to invoke on your behalf. Every call runs through PlanetScale's own authorization, scoped to the account you connect.
Set up PlanetScale in Dench
- 1
Sign in to your Dench workspace and open Integrations.
- 2
Find PlanetScale and click Connect — you'll authorize access through PlanetScale's own sign-in flow. No API keys or code required.
- 3
Ask an agent to use PlanetScale in chat, or call it from an automation.
- 4
Manage or disconnect the connection any time from workspace settings.
Frequently asked questions
How does the PlanetScale integration work with Dench?
The Dench PlanetScale integration connects your AI CRM to PlanetScale, so AI agents can work with your PlanetScale data as part of chats, automations, and CRM workflows. You connect your account once, and every agent in your workspace can use it — governed by your workspace permissions.
What actions can AI agents perform with PlanetScale via Dench?
The PlanetScale integration currently exposes 245 actions, including Add a member to a team, Add a shard to a Neki shard configuration profile, Add shards to a Neki branch, Add shards to a Neki shard configuration profile, Assign shards to a Neki shard configuration profile, and Cancel a change request. Agents invoke them on your behalf from chat or from automations.
Do I need to write code to connect PlanetScale to Dench?
No. You connect PlanetScale from your Dench workspace using PlanetScale's own sign-in and authorization flow — no API keys to copy, no glue code to maintain.
Is the PlanetScale integration secure?
Connections are authorized through PlanetScale's own authentication flow, and Dench stores only the authorization needed to act on your behalf. You can review and disconnect the PlanetScale connection from your workspace settings at any time.