# PlanetScale: API Reference > PlanetScale is a relational database platform for Vitess, Neki, and Postgres that gives you scale, performance, and reliability without sacrificing developer experience. ## API Reference ### Introduction - [Getting started with PlanetScale API](https://planetscale.com/docs/api/reference/getting-started-with-planetscale-api.md): Learn how to start using the PlanetScale API. - [Rate limits](https://planetscale.com/docs/api/reference/rate-limits.md): The current rate limit on the PlanetScale API is 600 requests per minute. This rate limit is subject to change. - [Pagination](https://planetscale.com/docs/api/reference/pagination.md): How to paginate API responses - [PlanetScale API and OAuth applications](https://planetscale.com/docs/api/planetscale-api-oauth-applications.md): The PlanetScale API allows you to manage your PlanetScale databases programmatically. - [Service tokens](https://planetscale.com/docs/api/service-tokens.md): PlanetScale provides the ability to create service tokens for your PlanetScale organization via the CLI or directly in the UI. - [OpenAPI Spec](https://planetscale.com/docs/api/openapi-spec.md): Download the PlanetScale API OpenAPI 3.0 specification ### Webhooks in PlanetScale - [Webhooks](https://planetscale.com/docs/api/webhooks.md) - [Webhook events reference](https://planetscale.com/docs/api/webhook-events.md): Webhooks in PlanetScale allow you to trigger an HTTP POST callback to a configured URL when specific events happen within your PlanetScale organization. ### Authentication - [Service tokens](https://planetscale.com/docs/api/reference/service-tokens.md): Using service tokens with the PlanetScale API. - [OAuth](https://planetscale.com/docs/api/reference/oauth.md): Using PlanetScale OAuth enables your users to connect their accounts to PlanetScale. - [OAuth access scopes](https://planetscale.com/docs/api/reference/oauth-access-scopes.md): The full list of OAuth application access scopes. #### OAuth tokens - [Create or refresh OAuth token](https://planetscale.com/docs/api/reference/oauth/create-token.md): Exchange an authorization code for an access token or refresh an expired token - [Revoke OAuth token](https://planetscale.com/docs/api/reference/oauth/revoke-token.md): Revoke an OAuth access token or refresh token - [Get OAuth token info](https://planetscale.com/docs/api/reference/oauth/token-info.md): Retrieve information about the current OAuth access token ### General API endpoints #### Audit logs - [List audit logs](https://planetscale.com/docs/api/reference/list_audit_logs.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: #### Backup policies - [List backup policies](https://planetscale.com/docs/api/reference/list_backup_policies.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Create a backup policy](https://planetscale.com/docs/api/reference/create_backup_policy.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get a backup policy](https://planetscale.com/docs/api/reference/get_backup_policy.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Update a backup policy](https://planetscale.com/docs/api/reference/update_backup_policy.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Delete a backup policy](https://planetscale.com/docs/api/reference/delete_backup_policy.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: #### Backups - [List backups](https://planetscale.com/docs/api/reference/list_backups.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Create a backup](https://planetscale.com/docs/api/reference/create_backup.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get a backup](https://planetscale.com/docs/api/reference/get_backup.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Delete a backup](https://planetscale.com/docs/api/reference/delete_backup.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Update a backup](https://planetscale.com/docs/api/reference/update_backup.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: #### Billing payment methods - [Get the current billing payment method](https://planetscale.com/docs/api/reference/get_organization_billing_payment_method.md): Get the current payment method for an organization ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Delete the current billing payment method](https://planetscale.com/docs/api/reference/delete_organization_billing_payment_method.md): Delete the current payment method for an organization ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: #### Cluster sizes - [List available cluster sizes](https://planetscale.com/docs/api/reference/list_cluster_size_skus.md): List available cluster sizes for an organization ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: #### Database branches - [List branches](https://planetscale.com/docs/api/reference/list_branches.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Create a branch](https://planetscale.com/docs/api/reference/create_branch.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get a branch](https://planetscale.com/docs/api/reference/get_branch.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Update a branch](https://planetscale.com/docs/api/reference/update_branch.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Delete a branch](https://planetscale.com/docs/api/reference/delete_branch.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: #### Databases - [List databases](https://planetscale.com/docs/api/reference/list_databases.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Create a database](https://planetscale.com/docs/api/reference/create_database.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get a database](https://planetscale.com/docs/api/reference/get_database.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Update database settings](https://planetscale.com/docs/api/reference/update_database_settings.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Delete a database](https://planetscale.com/docs/api/reference/delete_database.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [List read-only regions](https://planetscale.com/docs/api/reference/list_read_only_regions.md): List read-only regions for the database's default branch ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [List database regions](https://planetscale.com/docs/api/reference/list_database_regions.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: #### Invoices - [Get invoices](https://planetscale.com/docs/api/reference/list_invoices.md): Get the invoices for an organization ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get an invoice](https://planetscale.com/docs/api/reference/get_invoice.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get invoice line items](https://planetscale.com/docs/api/reference/get_invoice_line_items.md): Get the line items for an invoice ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: #### Metrics - [Get table storage metrics by keyspace](https://planetscale.com/docs/api/reference/get_branch_keyspace_table_metrics.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get time-series metrics](https://planetscale.com/docs/api/reference/get_branch_metrics.md): Retrieve time-series metrics for a database branch. - [Get time-series metrics for SQL queries](https://planetscale.com/docs/api/reference/get_branch_query_metrics.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get table storage metrics](https://planetscale.com/docs/api/reference/get_branch_table_metrics.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get time-series metrics grouped by query tags](https://planetscale.com/docs/api/reference/get_branch_tag_metrics.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get current metric values](https://planetscale.com/docs/api/reference/get_instant_branch_metrics.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get current tablet metrics](https://planetscale.com/docs/api/reference/get_instant_tablet_metrics.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get time-series tablet metrics](https://planetscale.com/docs/api/reference/get_tablet_metrics.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: #### OAuth applications - [List OAuth applications](https://planetscale.com/docs/api/reference/list_oauth_applications.md): ### Authorization A service token must have at least one of the following access in order to use this API endpoint: - [Get an OAuth application](https://planetscale.com/docs/api/reference/get_oauth_application.md): ### Authorization A service token must have at least one of the following access in order to use this API endpoint: - [Get an OAuth token](https://planetscale.com/docs/api/reference/get_oauth_token.md): ### Authorization A service token must have at least one of the following access in order to use this API endpoint: - [Delete an OAuth token](https://planetscale.com/docs/api/reference/delete_oauth_token.md): ### Authorization A service token must have at least one of the following access in order to use this API endpoint: #### OAuth tokens - [Create or renew an OAuth token](https://planetscale.com/docs/api/reference/create_oauth_token.md): Create an OAuth token from an authorization grant code, or refresh an OAuth token from a refresh token ### Authorization A service token must have at least one of the following access in order to use this API endpoint: #### Organization members - [List organization members](https://planetscale.com/docs/api/reference/list_organization_members.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get an organization member](https://planetscale.com/docs/api/reference/get_organization_membership.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Update organization member role](https://planetscale.com/docs/api/reference/update_organization_membership.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Remove a member from an organization](https://planetscale.com/docs/api/reference/remove_organization_member.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: #### Organizations - [List organizations](https://planetscale.com/docs/api/reference/list_organizations.md): 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. ### Authorization A OAuth token must have at least one of the following scopes in order to use this API endpoint: - [Get an organization](https://planetscale.com/docs/api/reference/get_organization.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Update an organization](https://planetscale.com/docs/api/reference/update_organization.md): ### Authorization A OAuth token must have at least one of the following scopes in order to use this API endpoint: - [List regions for an organization](https://planetscale.com/docs/api/reference/list_regions_for_organization.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: #### Organization teams - [List teams in an organization](https://planetscale.com/docs/api/reference/list_organization_teams.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Create an organization team](https://planetscale.com/docs/api/reference/create_organization_team.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get an organization team](https://planetscale.com/docs/api/reference/get_organization_team.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Update an organization team](https://planetscale.com/docs/api/reference/update_organization_team.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Delete an organization team](https://planetscale.com/docs/api/reference/delete_organization_team.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [List team members](https://planetscale.com/docs/api/reference/list_organization_team_members.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Add a member to a team](https://planetscale.com/docs/api/reference/add_organization_team_member.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get a team member](https://planetscale.com/docs/api/reference/get_organization_team_member.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Remove a member from a team](https://planetscale.com/docs/api/reference/remove_organization_team_member.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: #### Query insights - [List branch queries](https://planetscale.com/docs/api/reference/list_branch_queries.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Retrieve query statistics](https://planetscale.com/docs/api/reference/get_query_statistics.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Retrieve a summary of query statistics](https://planetscale.com/docs/api/reference/get_query_summary.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Retrieve a branch query](https://planetscale.com/docs/api/reference/get_branch_query.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [List branch query errors](https://planetscale.com/docs/api/reference/list_branch_query_errors.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [List queries for an error fingerprint](https://planetscale.com/docs/api/reference/get_branch_query_error.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [List branch anomalies](https://planetscale.com/docs/api/reference/list_branch_anomalies.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Retrieve a branch anomaly](https://planetscale.com/docs/api/reference/get_branch_anomaly.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [List query tags](https://planetscale.com/docs/api/reference/list_branch_query_tags.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [List query statistics grouped by tag](https://planetscale.com/docs/api/reference/list_branch_query_tag_summaries.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Retrieve a query tag](https://planetscale.com/docs/api/reference/get_branch_query_tag.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: #### Query Insights reports - [List generated query patterns reports](https://planetscale.com/docs/api/reference/list_generated_query_patterns_reports.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Create a new query patterns report](https://planetscale.com/docs/api/reference/create_query_patterns_report.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Show the status of a query patterns report](https://planetscale.com/docs/api/reference/get_query_patterns_report_status.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Delete a query patterns report](https://planetscale.com/docs/api/reference/delete_query_patterns_report.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Download a finished query patterns report](https://planetscale.com/docs/api/reference/get_query_patterns_report.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: #### Schema recommendations - [List schema recommendations](https://planetscale.com/docs/api/reference/list_schema_recommendations.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get a schema recommendation](https://planetscale.com/docs/api/reference/get_schema_recommendation.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Dismiss a schema recommendation](https://planetscale.com/docs/api/reference/dismiss_schema_recommendation.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: #### Regions - [List public regions](https://planetscale.com/docs/api/reference/list_public_regions.md): Endpoint is available without authentication. #### Service tokens - [Create a service token](https://planetscale.com/docs/api/reference/create_service_token.md): Create a new service token for the organization. ### Authorization A service token must have at least one of the following access in order to use this API endpoint: - [Delete a service token](https://planetscale.com/docs/api/reference/delete_service_token.md): Delete a service token from the organization. ### Authorization A service token must have at least one of the following access in order to use this API endpoint: - [Get a service token](https://planetscale.com/docs/api/reference/get_service_token.md): Get information about a service token. ### Authorization A service token must have at least one of the following access in order to use this API endpoint: - [List service tokens](https://planetscale.com/docs/api/reference/list_service_tokens.md): List service tokens for an organization. ### Authorization A service token must have at least one of the following access in order to use this API endpoint: #### Users - [Get current user](https://planetscale.com/docs/api/reference/get_current_user.md): Get the user associated with this service token ### Authorization A OAuth token must have at least one of the following scopes in order to use this API endpoint: #### Webhooks - [List webhooks](https://planetscale.com/docs/api/reference/list_webhooks.md): List webhooks for a database ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Create a webhook](https://planetscale.com/docs/api/reference/create_webhook.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get a webhook](https://planetscale.com/docs/api/reference/get_webhook.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Update a webhook](https://planetscale.com/docs/api/reference/update_webhook.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Delete a webhook](https://planetscale.com/docs/api/reference/delete_webhook.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Test a webhook](https://planetscale.com/docs/api/reference/test_webhook.md): Sends a test event to the webhook ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: ### Postgres API endpoints #### Branch changes - [Get branch change requests](https://planetscale.com/docs/api/reference/list_branch_change_requests.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get a branch change request](https://planetscale.com/docs/api/reference/get_branch_change_request.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Upsert a change request for cluster size, replicas, storage, or parameters](https://planetscale.com/docs/api/reference/update_branch_change_request.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Cancel a change request](https://planetscale.com/docs/api/reference/cancel_branch_change_request.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: #### Cluster extensions - [List cluster extensions](https://planetscale.com/docs/api/reference/list_extensions.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: #### Cluster parameters - [List cluster parameters](https://planetscale.com/docs/api/reference/list_parameters.md): Returns the parameters for a branch. To update the parameters, use the "update_branch_change_request" endpoint. #### Dedicated PgBouncers - [List bouncers](https://planetscale.com/docs/api/reference/list_bouncers.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Create a bouncer](https://planetscale.com/docs/api/reference/create_bouncer.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get a bouncer](https://planetscale.com/docs/api/reference/get_bouncer.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Delete a bouncer](https://planetscale.com/docs/api/reference/delete_bouncer.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get bouncer resize requests](https://planetscale.com/docs/api/reference/list_branch_bouncer_resize_requests.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get bouncer resize requests](https://planetscale.com/docs/api/reference/list_bouncer_resize_requests.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Upsert a bouncer resize request](https://planetscale.com/docs/api/reference/update_bouncer_resize_request.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Cancel a resize request](https://planetscale.com/docs/api/reference/cancel_bouncer_resize_request.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: #### IP restrictions - [List IP restriction entries](https://planetscale.com/docs/api/reference/list_database_postgres_cidrs.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Create an IP restriction entry](https://planetscale.com/docs/api/reference/create_database_postgres_cidr.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get an IP restriction entry](https://planetscale.com/docs/api/reference/get_database_postgres_cidr.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Update an IP restriction entry](https://planetscale.com/docs/api/reference/update_database_postgres_cidr.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Delete an IP restriction entry](https://planetscale.com/docs/api/reference/delete_database_postgres_cidr.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: #### Roles - [Create role credentials](https://planetscale.com/docs/api/reference/create_role.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Delete role credentials](https://planetscale.com/docs/api/reference/delete_role.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get the default postgres role](https://planetscale.com/docs/api/reference/get_default_role.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get a role](https://planetscale.com/docs/api/reference/get_role.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [List roles](https://planetscale.com/docs/api/reference/list_roles.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Reassign objects owned by one role to another role](https://planetscale.com/docs/api/reference/reassign_role_objects.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Renew role expiration](https://planetscale.com/docs/api/reference/renew_role.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Reset default credentials](https://planetscale.com/docs/api/reference/reset_default_role.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Reset a role's password](https://planetscale.com/docs/api/reference/reset_role.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Update role name](https://planetscale.com/docs/api/reference/update_role.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: #### Switchovers - [List switchovers](https://planetscale.com/docs/api/reference/list_switchovers.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Create a switchover](https://planetscale.com/docs/api/reference/create_switchover.md): Moves the primary of a Postgres branch. - [Get a switchover](https://planetscale.com/docs/api/reference/get_switchover.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: #### Traffic budgets - [List traffic budgets](https://planetscale.com/docs/api/reference/list_traffic_budgets.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Create a traffic budget](https://planetscale.com/docs/api/reference/create_traffic_budget.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get a traffic budget](https://planetscale.com/docs/api/reference/get_traffic_budget.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Update a traffic budget](https://planetscale.com/docs/api/reference/update_traffic_budget.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Delete a traffic budget](https://planetscale.com/docs/api/reference/delete_traffic_budget.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [List traffic budgets affecting a query fingerprint](https://planetscale.com/docs/api/reference/list_traffic_budgets_for_query.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: #### Traffic rules - [Create a traffic rule](https://planetscale.com/docs/api/reference/create_traffic_rule.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Delete a traffic rule](https://planetscale.com/docs/api/reference/delete_traffic_rule.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: ### Neki API endpoints #### Admins - [Get the admin for a branch](https://planetscale.com/docs/api/reference/get_admin.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Update the admin for a branch](https://planetscale.com/docs/api/reference/update_admin.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [List admin size SKUs for a branch](https://planetscale.com/docs/api/reference/list_admin_size_skus.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [List change requests for an admin](https://planetscale.com/docs/api/reference/list_admin_change_requests.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get a change request for an admin](https://planetscale.com/docs/api/reference/get_admin_change_request.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Cancel a change request for an admin](https://planetscale.com/docs/api/reference/cancel_admin_change_request.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [List parameters for an admin](https://planetscale.com/docs/api/reference/list_admin_parameters.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: #### Configuration profiles - [List configuration profiles for a branch](https://planetscale.com/docs/api/reference/list_shard_configuration_profiles.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Create a configuration profile for a branch](https://planetscale.com/docs/api/reference/create_shard_configuration_profile.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get a configuration profile for a branch](https://planetscale.com/docs/api/reference/get_shard_configuration_profile.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Update a configuration profile for a branch](https://planetscale.com/docs/api/reference/update_shard_configuration_profile.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Delete a configuration profile for a branch](https://planetscale.com/docs/api/reference/delete_shard_configuration_profile.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Run maintenance for selected configuration profiles](https://planetscale.com/docs/api/reference/run_shard_configuration_profiles_maintenance.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Run maintenance for a configuration profile](https://planetscale.com/docs/api/reference/run_shard_configuration_profile_maintenance.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [List change requests for a configuration profile](https://planetscale.com/docs/api/reference/list_shard_configuration_profile_change_requests.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get a change request for a configuration profile](https://planetscale.com/docs/api/reference/get_shard_configuration_profile_change_request.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Cancel a change request for a configuration profile](https://planetscale.com/docs/api/reference/cancel_shard_configuration_profile_change_request.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [List extensions for a configuration profile](https://planetscale.com/docs/api/reference/list_shard_configuration_profile_extensions.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Enable or disable an extension for a configuration profile](https://planetscale.com/docs/api/reference/update_shard_configuration_profile_extension.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [List parameters for a configuration profile](https://planetscale.com/docs/api/reference/list_shard_configuration_profile_parameters.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: #### Configuration profile shards - [List shards for a configuration profile](https://planetscale.com/docs/api/reference/list_shard_configuration_profile_shards.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Add a shard to a configuration profile](https://planetscale.com/docs/api/reference/create_shard_configuration_profile_shard.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Add shards to a configuration profile](https://planetscale.com/docs/api/reference/bulk_create_shard_configuration_profile_shards.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Assign shards to a configuration profile](https://planetscale.com/docs/api/reference/assign_shard_configuration_profile_shards.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Remove shards from a configuration profile](https://planetscale.com/docs/api/reference/delete_shard_configuration_profile_shards.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get a shard in a configuration profile](https://planetscale.com/docs/api/reference/get_shard_configuration_profile_shard.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Update a shard in a configuration profile](https://planetscale.com/docs/api/reference/update_shard_configuration_profile_shard.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Remove a shard from a configuration profile](https://planetscale.com/docs/api/reference/delete_shard_configuration_profile_shard.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: #### Data topology - [Get the data topology for a branch](https://planetscale.com/docs/api/reference/get_data_topology.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Set the data topology for a branch](https://planetscale.com/docs/api/reference/update_data_topology.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: #### Default configuration profile - [Get the default configuration profile for a branch](https://planetscale.com/docs/api/reference/get_default_shard_configuration_profile.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Set the default configuration profile for a branch](https://planetscale.com/docs/api/reference/set_default_shard_configuration_profile.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: #### Neki changes - [List change requests for a branch](https://planetscale.com/docs/api/reference/list_neki_change_requests.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get a change request for a branch](https://planetscale.com/docs/api/reference/get_neki_change_request.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Cancel a change request for a branch](https://planetscale.com/docs/api/reference/cancel_neki_change_request.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: #### Routers - [List router size SKUs for a branch](https://planetscale.com/docs/api/reference/list_router_size_skus.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [List routers for a branch](https://planetscale.com/docs/api/reference/list_routers.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Create a router for a branch](https://planetscale.com/docs/api/reference/create_router.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get a router for a branch](https://planetscale.com/docs/api/reference/get_router.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Update a router for a branch](https://planetscale.com/docs/api/reference/update_router.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Delete a router from a branch](https://planetscale.com/docs/api/reference/delete_router.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [List change requests for a router](https://planetscale.com/docs/api/reference/list_router_change_requests.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get a change request for a router](https://planetscale.com/docs/api/reference/get_router_change_request.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Cancel a change request for a router](https://planetscale.com/docs/api/reference/cancel_router_change_request.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [List parameters for a router](https://planetscale.com/docs/api/reference/list_router_parameters.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: #### Shards - [List shards for a branch](https://planetscale.com/docs/api/reference/list_shards.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Add shards to a branch](https://planetscale.com/docs/api/reference/create_shard.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get a shard for a branch](https://planetscale.com/docs/api/reference/get_shard.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Update a shard for a branch](https://planetscale.com/docs/api/reference/update_shard.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Remove a shard from a branch](https://planetscale.com/docs/api/reference/delete_shard.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: #### Sidecars - [List sidecars for a branch](https://planetscale.com/docs/api/reference/list_sidecars.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get a sidecar for a branch](https://planetscale.com/docs/api/reference/get_sidecar.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Update a sidecar for a branch](https://planetscale.com/docs/api/reference/update_sidecar.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [List change requests for a sidecar](https://planetscale.com/docs/api/reference/list_sidecar_change_requests.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get a change request for a sidecar](https://planetscale.com/docs/api/reference/get_sidecar_change_request.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Cancel a change request for a sidecar](https://planetscale.com/docs/api/reference/cancel_sidecar_change_request.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [List parameters for a sidecar](https://planetscale.com/docs/api/reference/list_sidecar_parameters.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: ### Vitess API endpoints #### Branch cluster size - [Change a branch cluster configuration](https://planetscale.com/docs/api/reference/update_branch_cluster_config.md): ### Authorization A service token must have at least one of the following access in order to use this API endpoint: #### Branch promotion - [Demote a branch](https://planetscale.com/docs/api/reference/demote_branch.md): Demotes a branch from production to development ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Promote a branch](https://planetscale.com/docs/api/reference/promote_branch.md): Promotes a branch from development to production ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: #### Branch schema - [Get a branch schema](https://planetscale.com/docs/api/reference/get_branch_schema.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Lint a branch schema](https://planetscale.com/docs/api/reference/lint_branch_schema.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: #### Database branch keyspaces - [Get keyspaces](https://planetscale.com/docs/api/reference/list_keyspaces.md): ### Authorization A service token must have at least one of the following access in order to use this API endpoint: - [Create a keyspace](https://planetscale.com/docs/api/reference/create_keyspace.md): ### Authorization A service token must have at least one of the following access in order to use this API endpoint: - [Get a keyspace](https://planetscale.com/docs/api/reference/get_keyspace.md): ### Authorization A service token must have at least one of the following access in order to use this API endpoint: - [Delete a keyspace](https://planetscale.com/docs/api/reference/delete_keyspace.md): ### Authorization A service token must have at least one of the following access in order to use this API endpoint: - [Configure keyspace settings](https://planetscale.com/docs/api/reference/update_keyspace.md): ### Authorization A service token must have at least one of the following access in order to use this API endpoint: - [Get keyspace rollout status](https://planetscale.com/docs/api/reference/get_keyspace_rollout_status.md): ### Authorization A service token must have at least one of the following access in order to use this API endpoint: #### Database branch passwords - [List passwords](https://planetscale.com/docs/api/reference/list_passwords.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Create a password](https://planetscale.com/docs/api/reference/create_password.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get a password](https://planetscale.com/docs/api/reference/get_password.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Update a password](https://planetscale.com/docs/api/reference/update_password.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Delete a password](https://planetscale.com/docs/api/reference/delete_password.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Renew a password](https://planetscale.com/docs/api/reference/renew_password.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: #### Deploy request throttling - [Get database throttler configurations](https://planetscale.com/docs/api/reference/get_database_throttler.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Update database throttler configurations](https://planetscale.com/docs/api/reference/update_database_throttler.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: #### Deploy requests - [Get the deploy queue](https://planetscale.com/docs/api/reference/get_deploy_queue.md): The deploy queue returns the current list of deploy requests in the order they will be deployed. - [List deploy requests](https://planetscale.com/docs/api/reference/list_deploy_requests.md): List deploy requests for a database ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Create a deploy request](https://planetscale.com/docs/api/reference/create_deploy_request.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get a deploy request](https://planetscale.com/docs/api/reference/get_deploy_request.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Close a deploy request](https://planetscale.com/docs/api/reference/close_deploy_request.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Complete a gated deploy request](https://planetscale.com/docs/api/reference/complete_gated_deploy_request.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Update auto-apply for deploy request](https://planetscale.com/docs/api/reference/update_auto_apply.md): Enables or disabled the auto-apply setting for a deploy request ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Update auto-delete branch for deploy request](https://planetscale.com/docs/api/reference/update_auto_delete_branch.md): Enables or disabled the auto-delete branch setting for a deploy request ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Cancel a queued deploy request](https://planetscale.com/docs/api/reference/cancel_deploy_request.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Complete an errored deploy](https://planetscale.com/docs/api/reference/complete_errored_deploy.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Queue a deploy request](https://planetscale.com/docs/api/reference/queue_deploy_request.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get a deployment](https://planetscale.com/docs/api/reference/get_deployment.md): Get the deployment for a deploy request ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [List deploy operations](https://planetscale.com/docs/api/reference/list_deploy_operations.md): List deploy operations for a deploy request ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Complete a revert](https://planetscale.com/docs/api/reference/complete_revert.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [List deploy request reviews](https://planetscale.com/docs/api/reference/list_deploy_request_reviews.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Review a deploy request](https://planetscale.com/docs/api/reference/review_deploy_request.md): Review a deploy request by either approving or commenting on the deploy request ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Skip revert period](https://planetscale.com/docs/api/reference/skip_revert_period.md): Skips the revert period for a deploy request ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Check deploy request storage](https://planetscale.com/docs/api/reference/check_deploy_request_storage.md): Checks whether the deploy request's target branch cluster has enough storage to safely deploy the schema changes. ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Enable force cutover for a deploy request](https://planetscale.com/docs/api/reference/force_cutover_deploy_request.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get deploy request throttler configurations](https://planetscale.com/docs/api/reference/get_deploy_request_throttler.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Update deploy request throttler configurations](https://planetscale.com/docs/api/reference/update_deploy_request_throttler.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: #### Keyspace VSchemas - [Get the VSchema for the keyspace](https://planetscale.com/docs/api/reference/get_keyspace_vschema.md): ### Authorization A service token must have at least one of the following access in order to use this API endpoint: - [Update the VSchema for the keyspace](https://planetscale.com/docs/api/reference/update_keyspace_vschema.md): ### Authorization A service token must have at least one of the following access in order to use this API endpoint: #### Maintenance schedules - [List maintenance schedules](https://planetscale.com/docs/api/reference/list_maintenance_schedules.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [Get a maintenance schedule](https://planetscale.com/docs/api/reference/get_maintenance_schedule.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: - [List maintenance windows](https://planetscale.com/docs/api/reference/list_maintenance_windows.md): ### Authorization A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: #### Safe migrations - [Enable safe migrations for a branch](https://planetscale.com/docs/api/reference/enable_safe_migrations.md) - [Disable safe migrations for a branch](https://planetscale.com/docs/api/reference/disable_safe_migrations.md) #### Workflows - [List workflows](https://planetscale.com/docs/api/reference/list_workflows.md) - [Create a workflow](https://planetscale.com/docs/api/reference/create_workflow.md) - [Get a workflow](https://planetscale.com/docs/api/reference/get_workflow.md) - [Cancel a workflow](https://planetscale.com/docs/api/reference/workflow_cancel.md) - [Complete a workflow](https://planetscale.com/docs/api/reference/workflow_complete.md) - [Cutover traffic](https://planetscale.com/docs/api/reference/workflow_cutover.md) - [Retry a failed workflow](https://planetscale.com/docs/api/reference/workflow_retry.md) - [Reverse traffic cutover](https://planetscale.com/docs/api/reference/workflow_reverse_cutover.md) - [Reverse traffic](https://planetscale.com/docs/api/reference/workflow_reverse_traffic.md) - [Switch primary traffic](https://planetscale.com/docs/api/reference/workflow_switch_primaries.md) - [Switch replica traffic](https://planetscale.com/docs/api/reference/workflow_switch_replicas.md) - [Verify workflow data](https://planetscale.com/docs/api/reference/verify_workflow.md) ## OpenAPI Specs - [openapi](/docs/openapi.yaml)