PlanetScale
Manage PlanetScale organizations, databases, branches, deploy requests, backups, workflows, insights, and infrastructure through delegated OAuth access.
245 actionsSign in with PlanetScale
What your bot can do in PlanetScale
Looks up
- Check deploy request storageChecks whether the deploy request's target branch cluster has enough storage to safely deploy the schema changes.
- Download a finished query patterns reportDownload a finished query patterns report.
- Get a backupGet a backup.
- Get a backup policyGet a backup policy.
- Get a billing payment method setupGet the state of a billing payment method setup.
- Get a bouncerGet a bouncer.
- Get a branchGet a branch.
- Get a branch change requestGet a branch change request.
- Get a branch resize requestGet a branch resize request.
- Get a branch schemaGet a branch schema.
Show 120 more
- Get a change request for a Neki adminGet a change request for a Neki admin.
- Get a change request for a Neki branchGet a change request for a Neki branch.
- Get a change request for a Neki routerGet a change request for a Neki router.
- Get a change request for a Neki shard configuration profileGet a change request for a Neki shard configuration profile.
- Get a change request for a Neki sidecarGet a change request for a Neki sidecar.
- Get a databaseGet a database.
- Get a deploy requestGet a deploy request.
- Get a deploymentGet the deployment for a deploy request.
- Get a maintenance scheduleGet a maintenance schedule.
- Get a passwordGet a password.
- Get a read-only replicaGet a read-only replica.
- Get a roleGet a role.
- Get a router for a Neki branchGet a router for a Neki branch.
- Get a schema recommendationGet a schema recommendation.
- Get a shard configuration profile for a Neki branchGet a shard configuration profile for a Neki branch.
- Get a shard for a Neki branchGet a shard for a Neki branch.
- Get a shard in a Neki shard configuration profileGet a shard in a Neki shard configuration profile.
- Get a sidecar for a Neki branchGet a sidecar for a Neki branch.
- Get a switchoverGet a switchover.
- Get a team memberGet a team member.
- Get a traffic budgetGet a traffic budget.
- Get a webhookGet a webhook.
- Get an Insights agent runGet an Insights agent run.
- Get an invoiceGet an invoice.
- Get an IP restriction entryGet an IP restriction entry.
- Get an organizationGet an organization.
- Get an organization memberGet an organization member by a user ID or membership ID returned by list_organization_members.
- Get an organization teamGet an organization team.
- Get an SSO domainGet a registered SSO email domain and its verification state.
- Get bouncer resize requestsGet bouncer resize requests.
- Get bouncer resize requestsGet bouncer resize requests.
- Get branch change requestsGet branch change requests.
- Get branch resize requestsGet branch resize requests.
- Get current metric valuesGet current metric values.
- Get current tablet metricsGet current tablet metrics.
- Get current userGet the user associated with the current OAuth access token.
- Get database throttler configurationsGet database throttler configurations.
- Get deploy request throttler configurationsGet deploy request throttler configurations.
- Get invoice line itemsGet the line items for an invoice.
- Get invoicesGet the invoices for an organization.
- Get OAuth token infoInspect whether the current OAuth access token is active and return its scopes and expiry.
- Get organization SSO statusGet SSO add-on status, identity provider connection state, directory sync, and verified domains.
- Get read-only replica change requestsGet read-only replica change requests.
- Get table storage metricsGet table storage metrics.
- Get table storage metrics by keyspaceGet table storage metrics by keyspace.
- Get the admin for a Neki branchGet the admin for a Neki branch.
- Get the current billing payment methodGet the current payment method for an organization.
- Get the data topology for a Neki branchGet the data topology for a Neki branch.
- Get the default postgres roleGet the default postgres role.
- Get the default shard configuration profile for a Neki branchGet the default shard configuration profile for a Neki branch.
- Get the deploy queueThe deploy queue returns the current list of deploy requests in the order they will be deployed.
- Get time-series metricsRetrieve time-series metrics for a database branch.
- Get time-series metrics for SQL queriesGet time-series metrics for SQL queries.
- Get time-series metrics grouped by query tagsGet time-series metrics grouped by query tags.
- Get time-series tablet metricsGet time-series tablet metrics.
- Lint a branch schemaLint a branch schema.
- List admin size SKUs for a Neki branchList admin size SKUs for a Neki branch.
- List audit logsList audit logs.
- List available cluster sizesList available cluster sizes for an organization.
- List available Postgres versionsList the published Postgres versions available to the requested engine.
- List backup policiesList backup policies.
- List backupsList backups.
- List bouncersList bouncers.
- List branch anomaliesList branch anomalies.
- List branch queriesList branch queries.
- List branch query errorsList branch query errors.
- List branchesList branches.
- List change requests for a Neki adminList change requests for a Neki admin.
- List change requests for a Neki branchList change requests for a Neki branch.
- List change requests for a Neki routerList change requests for a Neki router.
- List change requests for a Neki shard configuration profileList change requests for a Neki shard configuration profile.
- List change requests for a Neki sidecarList change requests for a Neki sidecar.
- List cluster extensionsList cluster extensions.
- List cluster parametersReturns the parameters for a branch.
- List database regionsList database regions.
- List databasesList databases.
- List deploy operationsList deploy operations for a deploy request.
- List deploy request reviewsList deploy request reviews.
- List deploy requestsList deploy requests for a database.
- List extensions for a Neki shard configuration profileList extensions for a Neki shard configuration profile.
- List generated query patterns reportsList generated query patterns reports.
- List Insights agent runsList Insights agent runs.
- List Insights Agent schedulesList Insights Agent schedules.
- List IP restriction entriesList IP restriction entries.
- List maintenance schedulesList maintenance schedules.
- List maintenance windowsList maintenance windows.
- List organization membersList organization members.
- List organization SSO domainsList email domains registered for organization SSO.
- List organizationsWhen using a service token, returns the list of organizations the service token has access to.
- List parameters for a Neki adminList parameters for a Neki admin.
- List parameters for a Neki routerList parameters for a Neki router.
- List parameters for a Neki shard configuration profileList parameters for a Neki shard configuration profile.
- List parameters for a Neki sidecarList parameters for a Neki sidecar.
- List passwordsList passwords.
- List queries for an error fingerprintList queries for an error fingerprint.
- List query statistics grouped by tagList query statistics grouped by tag.
- List query tagsList query tags.
- List read-only regionsList read-only regions for the database's default branch.
- List read-only replicasList read-only replicas.
- List regions for an organizationList regions for an organization.
- List rolesList roles.
- List router size SKUs for a Neki branchList router size SKUs for a Neki branch.
- List routers for a Neki branchList routers for a Neki branch.
- List schema recommendationsList schema recommendations.
- List shard configuration profiles for a Neki branchList shard configuration profiles for a Neki branch.
- List shards for a Neki branchList shards for a Neki branch.
- List shards for a Neki shard configuration profileList shards for a Neki shard configuration profile.
- List sidecars for a Neki branchList sidecars for a Neki branch.
- List switchoversList switchovers.
- List team membersList team members.
- List teams in an organizationList teams in an organization.
- List traffic budgetsList traffic budgets.
- List traffic budgets affecting a query fingerprintList traffic budgets affecting a query fingerprint.
- List webhooksList webhooks for a database.
- Retrieve a branch anomalyRetrieve a branch anomaly.
- Retrieve a branch queryRetrieve a branch query.
- Retrieve a query tagRetrieve a query tag.
- Retrieve a summary of query statisticsRetrieve a summary of query statistics.
- Retrieve query statisticsRetrieve query statistics.
- Show the status of a query patterns reportShow the status of a query patterns report.
Takes action
- Add a member to a teamAdd a member to a team.
- Add a shard to a Neki shard configuration profileAdd a shard to a Neki shard configuration profile.
- Add shards to a Neki branchAdd shards to a Neki branch.
- Add shards to a Neki shard configuration profileAdd shards to a Neki shard configuration profile.
- Assign shards to a Neki shard configuration profileAssign shards to a Neki shard configuration profile.
- Cancel a change requestCancel a branch resize change request.
- Cancel a change request for a Neki adminCancel a change request for a Neki admin.
- Cancel a change request for a Neki branchCancel a change request for a Neki branch.
- Cancel a change request for a Neki routerCancel a change request for a Neki router.
- Cancel a change request for a Neki shard configuration profileCancel a change request for a Neki shard configuration profile.
Show 105 more
- Cancel a change request for a Neki sidecarCancel a change request for a Neki sidecar.
- Cancel a queued deploy requestCancel a queued deploy request.
- Cancel a resize requestCancel a resize request.
- Close a deploy requestClose a deploy request.
- Complete a gated deploy requestComplete a gated deploy request.
- Complete a revertComplete a revert.
- Complete an errored deployComplete an errored deploy.
- Create a backupCreate a backup.
- Create a backup policyCreate a backup policy.
- Create a billing payment method setupCreate a hosted checkout session for adding or replacing an organization's payment method.
- Create a bouncerCreate a bouncer.
- Create a branchCreate a branch.
- Create a databaseCreate a database.
- Create a deploy requestCreate a deploy request.
- Create a log signatureCreates a signed token that can be used to access branch logs.
- Create a new query patterns reportCreate a new query patterns report.
- Create a passwordCreate a password.
- Create a read-only replicaCreate a read-only replica.
- Create a router for a Neki branchCreate a router for a Neki branch.
- Create a shard configuration profile for a Neki branchCreate a shard configuration profile for a Neki branch.
- Create a switchoverMoves the primary of a Postgres branch.
- Create a traffic budgetCreate a traffic budget.
- Create a traffic ruleCreate a traffic rule.
- Create a webhookCreate a webhook.
- Create an Insights agent runCreate an Insights agent run.
- Create an IP restriction entryCreate an IP restriction entry.
- Create an organization teamCreate an organization team.
- Create role credentialsCreate role credentials.
- Delete a backupDelete a backup.
- Delete a backup policyDelete a backup policy.
- Delete a bouncerDelete a bouncer.
- Delete a branchDelete a branch.
- Delete a databaseDelete a database.
- Delete a passwordDelete a password.
- Delete a query patterns reportDelete a query patterns report.
- Delete a read-only replicaDelete a read-only replica.
- Delete a router from a Neki branchDelete a router from a Neki branch.
- Delete a shard configuration profile for a Neki branchDelete a shard configuration profile for a Neki branch.
- Delete a traffic budgetDelete a traffic budget.
- Delete a traffic ruleDelete a traffic rule.
- Delete a webhookDelete a webhook.
- Delete an IP restriction entryDelete an IP restriction entry.
- Delete an organization teamDelete an organization team.
- Delete an SSO domainDelete a verified or pending SSO domain.
- Delete role credentialsDelete role credentials.
- Delete the current billing payment methodDelete the current payment method for an organization.
- Demote a branchDemotes a branch from production to development.
- Disable directory syncDisable directory sync for the organization.
- Disable organization SSODisable SSO and directory sync for the organization.
- Disable safe migrations for a branchDisable safe migrations for a branch.
- Dismiss a schema recommendationDismiss a schema recommendation.
- Enable force cutover for a deploy requestEnable force cutover for a deploy request.
- Enable organization SSOEnable the SSO add-on and return a URL for verifying an email domain.
- Enable safe migrations for a branchEnable safe migrations for a branch.
- Open the directory sync portalReturn a URL for configuring directory sync.
- Open the SSO configuration portalReturn a URL for configuring the identity provider.
- Promote a branchPromotes a branch from development to production.
- Queue a deploy requestQueue a deploy request.
- Reassign objects owned by one role to another roleReassign objects owned by one role to another role.
- Remove a member from a teamRemove a member from a team.
- Remove a member from an organizationRemove a member from an organization.
- Remove a shard from a Neki branchRemove a shard from a Neki branch.
- Remove a shard from a Neki shard configuration profileRemove a shard from a Neki shard configuration profile.
- Remove shards from a Neki shard configuration profileRemove shards from a Neki shard configuration profile.
- Renew a passwordRenew a password.
- Renew role expirationRenew role expiration.
- Reset a role's passwordReset a role's password.
- Reset default credentialsReset default credentials.
- Review a deploy requestReview a deploy request by either approving or commenting on the deploy request.
- Run maintenance for a Neki shard configuration profileRun maintenance for a Neki shard configuration profile.
- Run maintenance for a Postgres branchRun maintenance for a Postgres branch.
- Run maintenance for selected Neki shard configuration profilesRun maintenance for selected Neki shard configuration profiles.
- Set the data topology for a Neki branchSet the data topology for a Neki branch.
- Set the default shard configuration profile for a Neki branchSet the default shard configuration profile for a Neki branch.
- Skip revert periodSkips the revert period for a deploy request.
- Start SSO domain verificationEnable SSO if needed and return a URL for verifying an email domain.
- Test a webhookSends a test event to the webhook.
- Update a backupUpdate a backup.
- Update a backup policyUpdate a backup policy.
- Update a branchUpdate a branch.
- Update a passwordUpdate a password.
- Update a read-only replicaUpdate a read-only replica.
- Update a router for a Neki branchUpdate a router for a Neki branch.
- Update a shard configuration profile for a Neki branchUpdate a shard configuration profile for a Neki branch.
- Update a shard for a Neki branchUpdate a shard for a Neki branch.
- Update a shard in a Neki shard configuration profileUpdate a shard in a Neki shard configuration profile.
- Update a sidecar for a Neki branchUpdate a sidecar for a Neki branch.
- Update a traffic budgetUpdate a traffic budget.
- Update a webhookUpdate a webhook.
- Update an Insights Agent scheduleUpdate an Insights Agent schedule.
- Update an IP restriction entryUpdate an IP restriction entry.
- Update an organizationUpdate an organization.
- Update an organization teamUpdate an organization team.
- Update auto-apply for deploy requestEnables or disabled the auto-apply setting for a deploy request.
- Update auto-delete branch for deploy requestEnables or disabled the auto-delete branch setting for a deploy request.
- Update database settingsUpdate database settings.
- Update database throttler configurationsUpdate database throttler configurations.
- Update deploy request throttler configurationsUpdate deploy request throttler configurations.
- Update organization member roleUpdate organization member role.
- Update role nameUpdate role name.
- Update safe migrations for a branchUpdate safe migrations for a branch.
- Update the admin for a Neki branchUpdate the admin for a Neki branch.
- Upsert a bouncer resize requestUpsert a bouncer resize request.
- Upsert a change request for cluster size, replicas, storage, or parametersUpsert a change request for cluster size, replicas, storage, or parameters.
- Upsert a resize requestUpsert a resize request.