PlanetScale is a serverless MySQL database platform powered by Vitess, providing horizontal scaling, branching workflows, non-blocking schema changes, and other developer-friendly database features.
Planetscale publishes 20 API contracts indexed on the APIs.io network, including Backups API, Billing API, Bouncers API, and 17 more. Tagged areas include Database, MySQL, PostgreSQL, and Serverless.
The Planetscale catalog on APIs.io includes 1 event-driven AsyncAPI specification, 1 JSON-LD context, and 2 Spectral governance rulesets.
Planetscale’s developer surface includes authentication, engineering blog, and 11 more developer resources.
Regulatory Posture applies to this provider. Its tags matched the
Horizontal (data, software, accessibility, platform) regime, so
Regulatory Posture carries 15 points of the composite.
If this regime is wrong for your business, say so on your
provider repo — the
applicability map is public and we will correct it.
Create-or-Update Ergonomics applies to this provider. This API accepts writes, so it
carries 10 points of the composite. It is scored from the published contracts
themselves: whether a caller can create-or-update in one call, whether the write accepts a key the caller already
holds, and whether the response says which branch ran. Without that, every write needs a search-and-branch in
front of it, and the first time that check is skipped a duplicate record is created.
Scored against the observed mean rather than raw — a provider at the catalog average is unchanged by this facet,
not penalised by it.
The six quality facets above are damped to 75 points between them,
because the conditional facet above carries the other
25. That is why each facet's contribution is shown against a damped
maximum: raising a quality facet moves the composite by 75% of its nominal
weight, not 100%. The full arithmetic is at apis.io/rating/.
Show this score on your site.
It updates itself when the score changes. Paste this where you link to your API docs:
<a href="https://apis.io/providers/planetscale/"><img src="https://apis.io/badge/planetscale/card.svg" alt="Planetscale on APIs.io — Kin Score by API Evangelist"></a>
Other styles, a README pill and a shields.io endpoint are on the badge page.
Raise your score.
Agent readiness — checks not met, largest first (exact, from this profile):
MCP Server+12 pts — deployment.mode + probe verdict on the mcp/ manifest, not the pointer; an unprobed slug falls back to authorship
Idempotency+9 pts — OpenAPI mutating operations declare an idempotency key — a header, a request-body property, or a named de-duplication token whose own description says so (verified); else common[].type matches /idempoten/i (documented)
Stable Error Semantics+8 pts — OpenAPI $refs a shared error schema across 4xx/5xx responses (verified), else common[].type includes ErrorCatalog / ErrorCodes / DeclineCodes
A2A Agent Card+8 pts — a2a/-a2a.yml manifest, graded on conformance.grade against A2A 1.0.0
Delegated User Identity+6 pts — a served discovery document listing authorization_code in grant_types_supported (served), else an oauth2 authorizationCode flow or openIdConnect declared in an OpenAPI (documented)
8 more unmet checks in the Agent Readiness table above.
Kin Score — facets with the most composite points still available (weight × headroom):
The Kin Score Market layer reads a provider inside its market:
its position, and how deep its integrations go. Depth is only comparable within a position. Provisional and unweighted:
not part of the Kin Score or agent readiness.
Registered MCP server and declares compatibility are report only — not weighted.
Undeclared means we found nothing we can read, so there is no number: we never infer integrations.
Standards this provider implements or carries. De facto ones are profiled and measured by the API Commons; formal ones come from the standards directory and are linked by the provider's own tags. The evidence column says how each claim was established — not that it was made.
PlanetScale OAuth allows developers to create OAuth applications that can access users' PlanetScale accounts on their behalf. The implementation supports the Authorization Code ...
The PlanetScale Serverless Driver for JavaScript is a Fetch API-compatible database driver designed for serverless and edge compute platforms such as Cloudflare Workers, Vercel ...
The PlanetScale CLI (pscale) is a command-line tool that brings PlanetScale database management to the terminal. It allows developers to create, delete, and list databases and b...
Manage deploy requests for applying schema changes from development branches to production, including creating, reviewing, queueing, and completing deployments.
Not yet checked against Planetscale's own pricing page. Compiled by API Evangelist on 2026-05-04 from planetscale.com/pricing; confirm before you rely on a figure.
PlanetScale webhooks deliver HTTP POST callbacks to a configured URL when specific events occur within a PlanetScale organization. Webhooks enable real-time notifications for da...
name: Planetscale
aid: planetscale
deliveryModel:
model: unknown
open_source: false
commercial: false
callable_host: true
label: Delivery model not determined — needs a product licence on record
confidence: low
source:
- openapi
generated: '2026-08-28'
method: derived
specificationVersion: '0.23'
accessModel:
pricing: paid
onboarding: unknown
trial: false
try_now: false
public: false
label: Paid
confidence: medium
source:
- plans
- authentication
- security
generated: '2026-11-06'
method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/planetscale.png
url: https://raw.githubusercontent.com/api-evangelist/planetscale/refs/heads/main/apis.yml
apis:
- aid: planetscale:oauth
name: PlanetScale OAuth
tags:
- Application
- Authentication
- Authorization
- OAuth
tags_raw:
- Applications
- Authentication
- Authorization
- OAuth
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
baseURL: https://api.planetscale.com
humanURL: https://planetscale.com/docs/api/planetscale-api-oauth-applications
properties:
- url: https://planetscale.com/docs/api/planetscale-api-oauth-applications
type: Documentation
description: PlanetScale OAuth allows developers to create OAuth applications that can access users' PlanetScale accounts
on their behalf. The implementation supports the Authorization Code grant type, enabling third-party applications to authenticate
users and obtain delegated access to PlanetScale resources. This is particularly useful for building integrations and
tools that need to interact with organization-level PlanetScale endpoints on behalf of multiple users.
- aid: planetscale:serverless-driver
name: PlanetScale Serverless Driver for JavaScript
tags:
- Driver
- Edge Computing
- JavaScript
- MySQL
- SDK
- Serverless
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
baseURL: https://api.example.com
humanURL: https://planetscale.com/docs/tutorials/using-the-serverless-driver
properties:
- url: https://planetscale.com/docs/tutorials/using-the-serverless-driver
type: Documentation
description: The PlanetScale Serverless Driver for JavaScript is a Fetch API-compatible database driver designed for serverless
and edge compute platforms such as Cloudflare Workers, Vercel Edge Functions, and Netlify Edge Functions. It enables developers
to query PlanetScale databases over HTTP connections, bypassing the TCP restrictions common in edge environments.
- aid: planetscale:cli
name: PlanetScale CLI
tags:
- CLI
- Command Line
- Database Management
- Developer Tools
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
baseURL: https://api.example.com
humanURL: https://planetscale.com/docs/reference/planetscale-cli
properties:
- url: https://planetscale.com/docs/reference/planetscale-cli
type: Documentation
description: The PlanetScale CLI (pscale) is a command-line tool that brings PlanetScale database management to the terminal.
It allows developers to create, delete, and list databases and branches, open interactive MySQL shells for database branches,
and manage deploy requests directly from the command line. The CLI is available via Homebrew and as a downloadable binary,
and includes a Model Context Protocol (MCP) server that provides AI tools with direct access to PlanetScale databases.
- aid: planetscale:planetscale-backups-api
name: planetscale Backups API
description: Manage database branch backups, including listing, creating, and retrieving backup details.
humanURL: https://api-docs.planetscale.com/reference/getting-started-with-planetscale-api
baseURL: https://api.planetscale.com/v1
tags:
- Backups
properties:
- type: OpenAPI
url: openapi/planetscale-backups-api-openapi.yml
- type: Documentation
url: https://api-docs.planetscale.com/reference/getting-started-with-planetscale-api
- type: AsyncAPI
url: asyncapi/planetscale-webhooks-asyncapi.yml
- aid: planetscale:planetscale-billing-api
name: planetscale Billing API
description: Access organization billing data and invoices programmatically.
humanURL: https://api-docs.planetscale.com/reference/getting-started-with-planetscale-api
baseURL: https://api.planetscale.com/v1
tags:
- Billing
properties:
- type: OpenAPI
url: openapi/planetscale-billing-api-openapi.yml
- type: Documentation
url: https://api-docs.planetscale.com/reference/getting-started-with-planetscale-api
- type: AsyncAPI
url: asyncapi/planetscale-webhooks-asyncapi.yml
- aid: planetscale:planetscale-bouncers-api
name: planetscale Bouncers API
description: Manage PgBouncer connection pooling instances for database branches, including creating, listing, resizing,
and deleting bouncers.
humanURL: https://api-docs.planetscale.com/reference/getting-started-with-planetscale-api
baseURL: https://api.planetscale.com/v1
tags:
- Bouncers
properties:
- type: OpenAPI
url: openapi/planetscale-bouncers-api-openapi.yml
- type: Documentation
url: https://api-docs.planetscale.com/reference/getting-started-with-planetscale-api
- type: AsyncAPI
url: asyncapi/planetscale-webhooks-asyncapi.yml
- aid: planetscale:planetscale-branches-api
name: planetscale Branches API
description: Manage database branches for schema development and safe migrations, including creating, listing, updating,
and deleting branches.
humanURL: https://api-docs.planetscale.com/reference/getting-started-with-planetscale-api
baseURL: https://api.planetscale.com/v1
tags:
- Branches
properties:
- type: OpenAPI
url: openapi/planetscale-branches-api-openapi.yml
- type: Documentation
url: https://api-docs.planetscale.com/reference/getting-started-with-planetscale-api
- type: AsyncAPI
url: asyncapi/planetscale-webhooks-asyncapi.yml
- aid: planetscale:planetscale-cluster-sizes-api
name: planetscale Cluster Sizes API
description: Retrieve available cluster size SKUs for Vitess and Postgres database branches.
humanURL: https://api-docs.planetscale.com/reference/getting-started-with-planetscale-api
baseURL: https://api.planetscale.com/v1
tags:
- Cluster Sizes
properties:
- type: OpenAPI
url: openapi/planetscale-cluster-sizes-api-openapi.yml
- type: Documentation
url: https://api-docs.planetscale.com/reference/getting-started-with-planetscale-api
- type: AsyncAPI
url: asyncapi/planetscale-webhooks-asyncapi.yml
- aid: planetscale:planetscale-databases-api
name: planetscale Databases API
description: Manage PlanetScale databases, including creating, listing, updating settings, and deleting databases.
humanURL: https://api-docs.planetscale.com/reference/getting-started-with-planetscale-api
baseURL: https://api.planetscale.com/v1
tags:
- Database
tags_raw:
- Databases
properties:
- type: OpenAPI
url: openapi/planetscale-databases-api-openapi.yml
- type: Documentation
url: https://api-docs.planetscale.com/reference/getting-started-with-planetscale-api
- type: AsyncAPI
url: asyncapi/planetscale-webhooks-asyncapi.yml
- aid: planetscale:planetscale-deploy-requests-api
name: planetscale Deploy Requests API
description: Manage deploy requests for applying schema changes from development branches to production, including creating,
reviewing, queueing, and completing deployments.
humanURL: https://api-docs.planetscale.com/reference/getting-started-with-planetscale-api
baseURL: https://api.planetscale.com/v1
tags:
- Deploy Requests
properties:
- type: OpenAPI
url: openapi/planetscale-deploy-requests-api-openapi.yml
- type: Documentation
url: https://api-docs.planetscale.com/reference/getting-started-with-planetscale-api
- type: AsyncAPI
url: asyncapi/planetscale-webhooks-asyncapi.yml
- aid: planetscale:planetscale-ip-restrictions-api
name: planetscale IP Restrictions API
description: Manage IP restriction entries for controlling database access by IP address.
humanURL: https://api-docs.planetscale.com/reference/getting-started-with-planetscale-api
baseURL: https://api.planetscale.com/v1
tags:
- IP Restrictions
properties:
- type: OpenAPI
url: openapi/planetscale-ip-restrictions-api-openapi.yml
- type: Documentation
url: https://api-docs.planetscale.com/reference/getting-started-with-planetscale-api
- type: AsyncAPI
url: asyncapi/planetscale-webhooks-asyncapi.yml
- aid: planetscale:planetscale-organization-members-api
name: planetscale Organization Members API
description: Manage members within an organization, including listing, retrieving, updating roles, and removing members.
humanURL: https://api-docs.planetscale.com/reference/getting-started-with-planetscale-api
baseURL: https://api.planetscale.com/v1
tags:
- Organization Members
properties:
- type: OpenAPI
url: openapi/planetscale-organization-members-api-openapi.yml
- type: Documentation
url: https://api-docs.planetscale.com/reference/getting-started-with-planetscale-api
- type: AsyncAPI
url: asyncapi/planetscale-webhooks-asyncapi.yml
- aid: planetscale:planetscale-organizations-api
name: planetscale Organizations API
description: Manage PlanetScale organizations, including listing organizations and retrieving organization details.
humanURL: https://api-docs.planetscale.com/reference/getting-started-with-planetscale-api
baseURL: https://api.planetscale.com/v1
tags:
- Organization
tags_raw:
- Organizations
properties:
- type: OpenAPI
url: openapi/planetscale-organizations-api-openapi.yml
- type: Documentation
url: https://api-docs.planetscale.com/reference/getting-started-with-planetscale-api
- type: AsyncAPI
url: asyncapi/planetscale-webhooks-asyncapi.yml
- aid: planetscale:planetscale-passwords-api
name: planetscale Passwords API
description: Manage branch passwords and connection credentials for connecting applications to database branches.
humanURL: https://api-docs.planetscale.com/reference/getting-started-with-planetscale-api
baseURL: https://api.planetscale.com/v1
tags:
- Passwords
properties:
- type: OpenAPI
url: openapi/planetscale-passwords-api-openapi.yml
- type: Documentation
url: https://api-docs.planetscale.com/reference/getting-started-with-planetscale-api
- type: AsyncAPI
url: asyncapi/planetscale-webhooks-asyncapi.yml
- aid: planetscale:planetscale-query-patterns-api
name: planetscale Query Patterns API
description: Analyze and report on query patterns for database branches.
humanURL: https://api-docs.planetscale.com/reference/getting-started-with-planetscale-api
baseURL: https://api.planetscale.com/v1
tags:
- Query Patterns
properties:
- type: OpenAPI
url: openapi/planetscale-query-patterns-api-openapi.yml
- type: Documentation
url: https://api-docs.planetscale.com/reference/getting-started-with-planetscale-api
- type: AsyncAPI
url: asyncapi/planetscale-webhooks-asyncapi.yml
- aid: planetscale:planetscale-roles-api
name: planetscale Roles API
description: Manage role-based credentials for database access.
humanURL: https://api-docs.planetscale.com/reference/getting-started-with-planetscale-api
baseURL: https://api.planetscale.com/v1
tags:
- Roles
properties:
- type: OpenAPI
url: openapi/planetscale-roles-api-openapi.yml
- type: Documentation
url: https://api-docs.planetscale.com/reference/getting-started-with-planetscale-api
- type: AsyncAPI
url: asyncapi/planetscale-webhooks-asyncapi.yml
- aid: planetscale:planetscale-schema-recommendations-api
name: planetscale Schema Recommendations API
description: View and manage schema recommendations for optimizing database performance and structure.
humanURL: https://api-docs.planetscale.com/reference/getting-started-with-planetscale-api
baseURL: https://api.planetscale.com/v1
tags:
- Schema Recommendations
properties:
- type: OpenAPI
url: openapi/planetscale-schema-recommendations-api-openapi.yml
- type: Documentation
url: https://api-docs.planetscale.com/reference/getting-started-with-planetscale-api
- type: AsyncAPI
url: asyncapi/planetscale-webhooks-asyncapi.yml
- aid: planetscale:planetscale-service-tokens-api
name: planetscale Service Tokens API
description: Manage service tokens for API authentication, including creating, listing, and deleting tokens and their access
grants.
humanURL: https://api-docs.planetscale.com/reference/getting-started-with-planetscale-api
baseURL: https://api.planetscale.com/v1
tags:
- Service Tokens
properties:
- type: OpenAPI
url: openapi/planetscale-service-tokens-api-openapi.yml
- type: Documentation
url: https://api-docs.planetscale.com/reference/getting-started-with-planetscale-api
- type: AsyncAPI
url: asyncapi/planetscale-webhooks-asyncapi.yml
- aid: planetscale:planetscale-teams-api
name: planetscale Teams API
description: Manage teams within an organization, including creating teams, adding members, and controlling database access.
humanURL: https://api-docs.planetscale.com/reference/getting-started-with-planetscale-api
baseURL: https://api.planetscale.com/v1
tags:
- Team
tags_raw:
- Teams
properties:
- type: OpenAPI
url: openapi/planetscale-teams-api-openapi.yml
- type: Documentation
url: https://api-docs.planetscale.com/reference/getting-started-with-planetscale-api
- type: AsyncAPI
url: asyncapi/planetscale-webhooks-asyncapi.yml
- aid: planetscale:planetscale-webhooks-api
name: planetscale Webhooks API
description: Manage webhook configurations for database event notifications.
humanURL: https://api-docs.planetscale.com/reference/getting-started-with-planetscale-api
baseURL: https://api.planetscale.com/v1
tags:
- Webhook
tags_raw:
- Webhooks
properties:
- type: OpenAPI
url: openapi/planetscale-webhooks-api-openapi.yml
- type: Documentation
url: https://api-docs.planetscale.com/reference/getting-started-with-planetscale-api
- type: AsyncAPI
url: asyncapi/planetscale-webhooks-asyncapi.yml
common:
- type: Plans
url: plans/planetscale-plans-pricing.yml
- type: RateLimits
url: rate-limits/planetscale-rate-limits.yml
- type: FinOps
url: finops/planetscale-finops.yml
- type: CapabilityMap
url: capabilities/planetscale-capability-edges.yml
name: Planetscale Business Capability Map
- type: Website
url: https://planetscale.com
- type: AgenticAccess
url: agentic-access/planetscale-agentic-access.yml
- type: DomainSecurity
url: security/planetscale-domain-security.yml
- type: Authentication
url: authentication/planetscale-authentication.yml
- url: https://planetscale.com/blog
type: Blog
- type: GitHubOrganization
url: https://github.com/planetscale
- type: LinkedIn
url: https://www.linkedin.com/company/planetscale
- type: JSONLD
url: json-ld/planetscale-context.jsonld
- type: JSONSchema
url: json-schema/planetscale-database-schema.json
- type: Features
data:
- Postgres EBS single-node from $5/mo
- Postgres EBS HA 3-node from $15/mo
- Postgres Metal 3-node from $50/mo
- Vitess Non-Metal 3-node from $39/mo
- Vitess Metal 3-node from $609/mo
- Cluster sizes from 1/16 vCPU to 96 vCPU
- arm64 and x86-64 architectures
- Multi-region deployment options
- Optional PgBouncer for Postgres
- Optional read replicas
- Branching for safe schema changes
- Deploy requests for review-and-merge schema flow
- Connection pooling built in
- Insights for query performance
- Boost for query result caching
- Management API at 240 req/min/org
sources:
- https://planetscale.com/pricing
updated: '2026-05-04'
modified: '2026-09-16'
description: PlanetScale is a serverless MySQL database platform powered by Vitess, providing horizontal scaling, branching
workflows, non-blocking schema changes, and other developer-friendly database features.
tags:
- Database
- MySQL
- PostgreSQL
- Serverless
Planetscale API — frequently asked questions
Does Planetscale have an API?
Yes. APIs.io lists 20 APIs from Planetscale, including PlanetScale OAuth, PlanetScale Serverless Driver for JavaScript and PlanetScale CLI, and 17 more.
Is there an OpenAPI specification for the Planetscale API?
Yes. APIs.io indexes 17 OpenAPI specifications for Planetscale, each linked for download from this page.
How do I authenticate with the Planetscale API?
Planetscale uses bearer-token authentication (apiKey/http · 2 schemes). The details are profiled on APIs.io as Planetscale Authentication.
How much does the Planetscale API cost?
APIs.io lists 5 pricing plans for Planetscale, with each plan's price, limits and inclusions under Pricing on this page.
Is the Planetscale API ready for AI agents?
Planetscale has a Kin Score of 28.3 out of 100 (thin) and an Agent Readiness score of 22.4 (agent-aware), scored by API Evangelist on 2026-11-06.
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.