PlanetScale logo

PlanetScale

Manage PlanetScale organizations, databases, branches, deploy requests, backups, workflows, insights, and infrastructure through delegated OAuth access.

245 actions Integration catalog
Request access
Connect PlanetScale once you're in Boring.
01 · WHAT THE AGENT CAN DO

Actions

Every capability is a discrete, logged action the agent calls by name — scoped to what you authorize and recorded in the run trace.

Add a member to a teamPLANETSCALE_ADD_ORGANIZATION_TEAM_MEMBER
Add a member to a team.
Assign shards to a Neki shard configuration profilePLANETSCALE_ASSIGN_SHARD_CONFIGURATION_PROFILE_SHARDS
Assign shards to a Neki shard configuration profile. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.
Add shards to a Neki shard configuration profilePLANETSCALE_BULK_CREATE_SHARD_CONFIGURATION_PROFILE_SHARDS
Add shards to a Neki shard configuration profile. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.
Cancel a change request for a Neki adminPLANETSCALE_CANCEL_ADMIN_CHANGE_REQUEST
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.
Cancel a resize requestPLANETSCALE_CANCEL_BOUNCER_RESIZE_REQUEST
Cancel a resize request. PostgreSQL databases only. This is destructive: confirm the target before calling.
Cancel a change requestPLANETSCALE_CANCEL_BRANCH_CHANGE_REQUEST
Cancel a branch resize change request. Vitess/MySQL databases only. This is destructive: confirm the target before calling.
Cancel a queued deploy requestPLANETSCALE_CANCEL_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.
Cancel a change request for a Neki branchPLANETSCALE_CANCEL_NEKI_CHANGE_REQUEST
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.
Cancel a change request for a Neki routerPLANETSCALE_CANCEL_ROUTER_CHANGE_REQUEST
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.
Cancel a change request for a Neki shard configuration profilePLANETSCALE_CANCEL_SHARD_CONFIGURATION_PROFILE_CHANGE_REQUEST
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.
Cancel a change request for a Neki sidecarPLANETSCALE_CANCEL_SIDECAR_CHANGE_REQUEST
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.
Check deploy request storagePLANETSCALE_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.
Close a deploy requestPLANETSCALE_CLOSE_DEPLOY_REQUEST
Close a deploy request. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.
Complete an errored deployPLANETSCALE_COMPLETE_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.
Complete a gated deploy requestPLANETSCALE_COMPLETE_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.
Complete a revertPLANETSCALE_COMPLETE_REVERT
Complete a revert. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources. This changes operational state and may not be safely reversible.
Open the SSO configuration portalPLANETSCALE_CONFIGURE_ORGANIZATION_SSO
Return a URL for configuring the identity provider. Requires at least one verified domain.
Create a backupPLANETSCALE_CREATE_BACKUP
Create a backup.
Create a backup policyPLANETSCALE_CREATE_BACKUP_POLICY
Create a backup policy.
Create a bouncerPLANETSCALE_CREATE_BOUNCER
Create a bouncer. PostgreSQL databases only.
Create a branchPLANETSCALE_CREATE_BRANCH
Create a branch.
Create a log signaturePLANETSCALE_CREATE_BRANCH_LOG_SIGNATURE
Creates a signed token that can be used to access branch logs.
Create a databasePLANETSCALE_CREATE_DATABASE
Create a database.
Create an IP restriction entryPLANETSCALE_CREATE_DATABASE_POSTGRES_CIDR
Create an IP restriction entry. PostgreSQL databases only.
Create a deploy requestPLANETSCALE_CREATE_DEPLOY_REQUEST
Create a deploy request. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.
Create an Insights agent runPLANETSCALE_CREATE_INSIGHTS_AGENT_RUN
Create an Insights agent run.
Start SSO domain verificationPLANETSCALE_CREATE_ORGANIZATION_SSO_DOMAIN
Enable SSO if needed and return a URL for verifying an email domain.
Create an organization teamPLANETSCALE_CREATE_ORGANIZATION_TEAM
Create an organization team.
Create a passwordPLANETSCALE_CREATE_PASSWORD
Create a password. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.
Create a billing payment method setupPLANETSCALE_CREATE_PAYMENT_METHOD_SETUP
Create a hosted checkout session for adding or replacing an organization's payment method.
Create a new query patterns reportPLANETSCALE_CREATE_QUERY_PATTERNS_REPORT
Create a new query patterns report.
Create a read-only replicaPLANETSCALE_CREATE_READ_ONLY_REPLICA
Create a read-only replica.
Create role credentialsPLANETSCALE_CREATE_ROLE
Create role credentials. PostgreSQL databases only.
Create a router for a Neki branchPLANETSCALE_CREATE_ROUTER
Create a router for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.
Add shards to a Neki branchPLANETSCALE_CREATE_SHARD
Add shards to a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.
Create a shard configuration profile for a Neki branchPLANETSCALE_CREATE_SHARD_CONFIGURATION_PROFILE
Create a shard configuration profile for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.
Add a shard to a Neki shard configuration profilePLANETSCALE_CREATE_SHARD_CONFIGURATION_PROFILE_SHARD
Add a shard to a Neki shard configuration profile. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.
Create a switchoverPLANETSCALE_CREATE_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.
Create a traffic budgetPLANETSCALE_CREATE_TRAFFIC_BUDGET
Create a traffic budget. PostgreSQL databases only.
Create a traffic rulePLANETSCALE_CREATE_TRAFFIC_RULE
Create a traffic rule. PostgreSQL databases only.
Create a webhookPLANETSCALE_CREATE_WEBHOOK
Create a webhook.
Delete a backupPLANETSCALE_DELETE_BACKUP
Delete a backup. This is destructive: confirm the target before calling.
Delete a backup policyPLANETSCALE_DELETE_BACKUP_POLICY
Delete a backup policy. This is destructive: confirm the target before calling.
Delete a bouncerPLANETSCALE_DELETE_BOUNCER
Delete a bouncer. PostgreSQL databases only. This is destructive: confirm the target before calling.
Delete a branchPLANETSCALE_DELETE_BRANCH
Delete a branch. This is destructive: confirm the target before calling.
Delete a databasePLANETSCALE_DELETE_DATABASE
Delete a database. This is destructive: confirm the target before calling.
Delete an IP restriction entryPLANETSCALE_DELETE_DATABASE_POSTGRES_CIDR
Delete an IP restriction entry. PostgreSQL databases only. This is destructive: confirm the target before calling.
Delete the current billing payment methodPLANETSCALE_DELETE_ORGANIZATION_BILLING_PAYMENT_METHOD
Delete the current payment method for an organization. This is destructive: confirm the target before calling.
Delete an SSO domainPLANETSCALE_DELETE_ORGANIZATION_SSO_DOMAIN
Delete a verified or pending SSO domain. This is destructive: confirm the target before calling.
Delete an organization teamPLANETSCALE_DELETE_ORGANIZATION_TEAM
Delete an organization team. This is destructive: confirm the target before calling.
Delete a passwordPLANETSCALE_DELETE_PASSWORD
Delete a password. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources. This is destructive: confirm the target before calling.
Delete a query patterns reportPLANETSCALE_DELETE_QUERY_PATTERNS_REPORT
Delete a query patterns report. This is destructive: confirm the target before calling.
Delete a read-only replicaPLANETSCALE_DELETE_READ_ONLY_REPLICA
Delete a read-only replica. This is destructive: confirm the target before calling.
Delete role credentialsPLANETSCALE_DELETE_ROLE
Delete role credentials. PostgreSQL databases only. This is destructive: confirm the target before calling.
Delete a router from a Neki branchPLANETSCALE_DELETE_ROUTER
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.
Remove a shard from a Neki branchPLANETSCALE_DELETE_SHARD
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.
Delete a shard configuration profile for a Neki branchPLANETSCALE_DELETE_SHARD_CONFIGURATION_PROFILE
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.
Remove a shard from a Neki shard configuration profilePLANETSCALE_DELETE_SHARD_CONFIGURATION_PROFILE_SHARD
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.
Remove shards from a Neki shard configuration profilePLANETSCALE_DELETE_SHARD_CONFIGURATION_PROFILE_SHARDS
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.
Delete a traffic budgetPLANETSCALE_DELETE_TRAFFIC_BUDGET
Delete a traffic budget. PostgreSQL databases only. This is destructive: confirm the target before calling.
Showing the first 60 of 245 actions.