planetscale website screenshot

planetscale

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 17 APIs on the APIs.io network, including Backups API, Billing API, Bouncers API, and 14 more.

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 6 more developer resources.

45.0/100 developing ▬ flat Agent 39/100 agent ready Full breakdown ↓
scored 2026-07-28 · rubric v0.6
AccessPaidSelf serve
20 APIs 16 Features

Kin Score

Kin Score Kin Score How this is scored →
scored 2026-07-28 · rubric v0.6
Composite quality — 45.0/100 · developing
Contract Quality 19.7 / 25
Developer Ergonomics 2.6 / 20
Commercial Clarity 7.9 / 20
Operational Transparency 4.8 / 13
Governance 5.0 / 12
Discoverability 5.0 / 10
Agent readiness — 39/100 · agent ready
Machine-Readable Contract 18 / 18
Agentic Access Contract 10 / 10
MCP Server 0 / 12
Machine-Readable Auth 10 / 10
Idempotency 0 / 9
Stable Error Semantics 0 / 8
Request/Response Examples 7 / 7
Rate-Limit Signaling 7 / 7
Typed Event Surface 6 / 6
Agent Skills 0 / 5
Well-Known Catalog 0 / 4
Consent & Bot Identity 0 / 3
A2A Agent Card 0 / 8
Dry-Run / Simulate Mode 0 / 4
Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. This rating is computed from github.com/api-evangelist/planetscale: open an issue to ask a question, or submit a pull request to add artifacts. Want it done for you? Prioritized profiling — $2,500 →

APIs 20

Individual APIs this provider publishes, each with its own machine-readable definition.

PlanetScale OAuth

PlanetScale OAuth allows developers to create OAuth applications that can access users' PlanetScale accounts on their behalf. The implementation supports the Authorization Code ...

PlanetScale Serverless Driver for JavaScript

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 ...

PlanetScale CLI

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...

planetscale Backups API

Manage database branch backups, including listing, creating, and retrieving backup details.

planetscale Billing API

Access organization billing data and invoices programmatically.

planetscale Bouncers API

Manage PgBouncer connection pooling instances for database branches, including creating, listing, resizing, and deleting bouncers.

planetscale Branches API

Manage database branches for schema development and safe migrations, including creating, listing, updating, and deleting branches.

planetscale Cluster Sizes API

Retrieve available cluster size SKUs for Vitess and Postgres database branches.

planetscale Databases API

Manage PlanetScale databases, including creating, listing, updating settings, and deleting databases.

planetscale Deploy Requests API

Manage deploy requests for applying schema changes from development branches to production, including creating, reviewing, queueing, and completing deployments.

planetscale IP Restrictions API

Manage IP restriction entries for controlling database access by IP address.

planetscale Organization Members API

Manage members within an organization, including listing, retrieving, updating roles, and removing members.

planetscale Organizations API

Manage PlanetScale organizations, including listing organizations and retrieving organization details.

planetscale Passwords API

Manage branch passwords and connection credentials for connecting applications to database branches.

planetscale Query Patterns API

Analyze and report on query patterns for database branches.

planetscale Roles API

Manage role-based credentials for database access.

planetscale Schema Recommendations API

View and manage schema recommendations for optimizing database performance and structure.

planetscale Service Tokens API

Manage service tokens for API authentication, including creating, listing, and deleting tokens and their access grants.

planetscale Teams API

Manage teams within an organization, including creating teams, adding members, and controlling database access.

planetscale Webhooks API

Manage webhook configurations for database event notifications.

Scroll for all 20

Open Collections 1

Open, tool-agnostic API collections (OpenAPI-derived and Bruno).

PlanetScale Platform API

OPEN COLLECTION

Pricing Plans 1

Published pricing tiers and plan structures.

Rate Limits 1

Documented rate limits and quota policies.

Planetscale Rate Limits

3 limits

RATE LIMITS

FinOps 1

Cost, billing, and metering signals for API financial operations.

Features 16

Notable capabilities this provider offers.

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

Scroll for all 16

Event Specifications 1

AsyncAPI definitions for this provider's event-driven and streaming APIs.

PlanetScale Webhook Events

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...

ASYNCAPI

Semantic Vocabularies 1

JSON-LD contexts and semantic vocabularies used across these APIs.

Planetscale Context

0 classes · 10 properties

JSON-LD

Spectral Rules 2

Spectral governance rulesets for linting and validating these APIs.

planetscale API Rules

8 rules · 1 errors 7 warnings

SPECTRAL

planetscale API Rules

6 rules · 5 warnings 1 info

SPECTRAL

JSON Schema 23

Standalone JSON Schema definitions for this provider's data models.

Backup

8 properties

JSON SCHEMA

Bouncer

6 properties

JSON SCHEMA

Branch

13 properties

JSON SCHEMA

ClusterSize

6 properties

JSON SCHEMA

PlanetScale Database

16 properties

JSON SCHEMA

DeployRequest

12 properties

JSON SCHEMA

DeployRequestReview

5 properties

JSON SCHEMA

Error

2 properties

JSON SCHEMA

Invoice

7 properties

JSON SCHEMA

IpRestriction

4 properties

JSON SCHEMA

Organization

7 properties

JSON SCHEMA

OrganizationMember

5 properties

JSON SCHEMA

Password

10 properties

JSON SCHEMA

PasswordWithPlaintext

0 properties

JSON SCHEMA

QueryPatternsReport

4 properties

JSON SCHEMA

RoleCredentials

7 properties

JSON SCHEMA

SchemaLintError

6 properties

JSON SCHEMA

SchemaRecommendation

7 properties

JSON SCHEMA

ServiceToken

3 properties

JSON SCHEMA

ServiceTokenAccess

4 properties

JSON SCHEMA

ServiceTokenWithPlaintext

0 properties

JSON SCHEMA

Team

7 properties

JSON SCHEMA

Webhook

6 properties

JSON SCHEMA

Scroll for all 23

JSON Structure 1

JSON Structure definitions describing this provider's data shapes.

Planetscale Structure

0 properties

JSON STRUCTURE

Security Posture 2

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Planetscale Authentication

apiKey/http · 2 schemes

SECURITY

Planetscale Domain Security

TLSv1.3 · HSTS · DMARC

SECURITY

Agentic Access 1

Recommended x-agentic-access execution contracts for AI agents.

Planetscale Agentic Access

60 operations · 30 acting

60 operations · 30 acting

AGENTIC

Resources

Documentation 1

Reference material describing how the API behaves

Agent Surfaces 1

MCP servers, agent skills, and machine-readable catalogs

Design & Contract 1

Pagination, idempotency, versioning, errors, and events

Build 1

SDKs, sample code, and the tooling you integrate with

Access & Security 2

Authentication, authorization, and security posture

Company 2

The organization behind the API

Source (apis.yml)

apis.yml Raw ↑
aid: planetscale
accessModel:
  pricing: paid
  onboarding: self-serve
  trial: false
  try_now: false
  public: false
  label: Paid · Self-serve signup
  confidence: high
  source:
  - plans
  - authentication
  generated: '2026-07-22'
  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:
  - 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:
  - 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:
  - 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:
  - 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:
  - 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: 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-05-19'
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.