Home
planetscale
PlanetScale Platform API
PlanetScale Platform API
The PlanetScale Platform API provides programmatic access to manage PlanetScale serverless MySQL-compatible databases. It allows developers to create and manage databases, branches, deploy requests, passwords, backups, service tokens, organization members, teams, bouncers, and billing data. The API supports authentication via service tokens and OAuth, enabling integration into CI/CD pipelines and infrastructure-as-code workflows.
What You Can Do
GET
Listorganizations
— List organizations
/organizations
GET
Getorganization
— Get an organization
/organizations/{organization}
GET
Listorganizationmembers
— List organization members
/organizations/{organization}/members
GET
Getorganizationmember
— Get an organization member
/organizations/{organization}/members/{member_id}
PATCH
Updateorganizationmember
— Update an organization member
/organizations/{organization}/members/{member_id}
DELETE
Deleteorganizationmember
— Remove an organization member
/organizations/{organization}/members/{member_id}
GET
Listteams
— List teams
/organizations/{organization}/teams
POST
Createteam
— Create a team
/organizations/{organization}/teams
GET
Getteam
— Get a team
/organizations/{organization}/teams/{team_slug}
PATCH
Updateteam
— Update a team
/organizations/{organization}/teams/{team_slug}
DELETE
Deleteteam
— Delete a team
/organizations/{organization}/teams/{team_slug}
GET
Listdatabases
— List databases
/organizations/{organization}/databases
POST
Createdatabase
— Create a database
/organizations/{organization}/databases
GET
Getdatabase
— Get a database
/organizations/{organization}/databases/{database}
PATCH
Updatedatabasesettings
— Update database settings
/organizations/{organization}/databases/{database}
DELETE
Deletedatabase
— Delete a database
/organizations/{organization}/databases/{database}
GET
Listbranches
— List branches
/organizations/{organization}/databases/{database}/branches
POST
Createbranch
— Create a branch
/organizations/{organization}/databases/{database}/branches
GET
Getbranch
— Get a branch
/organizations/{organization}/databases/{database}/branches/{branch}
PATCH
Updatebranch
— Update a branch
/organizations/{organization}/databases/{database}/branches/{branch}
DELETE
Deletebranch
— Delete a branch
/organizations/{organization}/databases/{database}/branches/{branch}
GET
Lintbranchschema
— Lint a branch schema
/organizations/{organization}/databases/{database}/branches/{branch}/schema-lint
GET
Listdeployrequests
— List deploy requests
/organizations/{organization}/databases/{database}/deploy-requests
POST
Createdeployrequest
— Create a deploy request
/organizations/{organization}/databases/{database}/deploy-requests
GET
Getdeployrequest
— Get a deploy request
/organizations/{organization}/databases/{database}/deploy-requests/{deploy_request_number}
PATCH
Closedeployrequest
— Close a deploy request
/organizations/{organization}/databases/{database}/deploy-requests/{deploy_request_number}
POST
Queuedeployrequest
— Queue a deploy request
/organizations/{organization}/databases/{database}/deploy-requests/{deploy_request_number}/deploy
GET
Listdeployrequestreviews
— List deploy request reviews
/organizations/{organization}/databases/{database}/deploy-requests/{deploy_request_number}/reviews
POST
Reviewdeployrequest
— Review a deploy request
/organizations/{organization}/databases/{database}/deploy-requests/{deploy_request_number}/reviews
POST
Skipdeployrequestrevert
— Skip revert period
/organizations/{organization}/databases/{database}/deploy-requests/{deploy_request_number}/skip-revert
POST
Completedeployrequestrevert
— Complete a revert
/organizations/{organization}/databases/{database}/deploy-requests/{deploy_request_number}/complete-revert
GET
Getdeployqueue
— Get the deploy queue
/organizations/{organization}/databases/{database}/deploy-queue
GET
Listpasswords
— List passwords
/organizations/{organization}/databases/{database}/branches/{branch}/passwords
POST
Createpassword
— Create a password
/organizations/{organization}/databases/{database}/branches/{branch}/passwords
GET
Getpassword
— Get a password
/organizations/{organization}/databases/{database}/branches/{branch}/passwords/{password_id}
DELETE
Deletepassword
— Delete a password
/organizations/{organization}/databases/{database}/branches/{branch}/passwords/{password_id}
POST
Renewpassword
— Renew a password
/organizations/{organization}/databases/{database}/branches/{branch}/passwords/{password_id}/renew
GET
Listbackups
— List backups
/organizations/{organization}/databases/{database}/branches/{branch}/backups
POST
Createbackup
— Create a backup
/organizations/{organization}/databases/{database}/branches/{branch}/backups
GET
Getbackup
— Get a backup
/organizations/{organization}/databases/{database}/branches/{branch}/backups/{backup_id}
DELETE
Deletebackup
— Delete a backup
/organizations/{organization}/databases/{database}/branches/{branch}/backups/{backup_id}
GET
Listservicetokens
— List service tokens
/organizations/{organization}/service-tokens
POST
Createservicetoken
— Create a service token
/organizations/{organization}/service-tokens
GET
Getservicetoken
— Get a service token
/organizations/{organization}/service-tokens/{service_token_id}
DELETE
Deleteservicetoken
— Delete a service token
/organizations/{organization}/service-tokens/{service_token_id}
GET
Listservicetokenaccesses
— List service token accesses
/organizations/{organization}/service-tokens/{service_token_id}/accesses
POST
Createservicetokenaccess
— Grant service token access
/organizations/{organization}/service-tokens/{service_token_id}/accesses
GET
Listbouncers
— List bouncers
/organizations/{organization}/databases/{database}/branches/{branch}/bouncers
POST
Createbouncer
— Create a bouncer
/organizations/{organization}/databases/{database}/branches/{branch}/bouncers
GET
Getbouncer
— Get a bouncer
/organizations/{organization}/databases/{database}/branches/{branch}/bouncers/{bouncer_name}
DELETE
Deletebouncer
— Delete a bouncer
/organizations/{organization}/databases/{database}/branches/{branch}/bouncers/{bouncer_name}
GET
Listclustersizes
— List cluster sizes
/organizations/{organization}/cluster-size-skus
POST
Createrole
— Create role credentials
/organizations/{organization}/databases/{database}/branches/{branch}/roles
GET
Listiprestrictions
— List IP restrictions
/organizations/{organization}/databases/{database}/postgres-cidrs
POST
Createiprestriction
— Create an IP restriction entry
/organizations/{organization}/databases/{database}/postgres-cidrs
GET
Getquerypatternsreportstatus
— Show the status of a query patterns report
/organizations/{organization}/databases/{database}/branches/{branch}/query-patterns-report
GET
Listwebhooks
— List webhooks
/organizations/{organization}/databases/{database}/webhooks
POST
Createwebhook
— Create a webhook
/organizations/{organization}/databases/{database}/webhooks
GET
Listinvoices
— List invoices
/organizations/{organization}/invoices
GET
Listschemarecommendations
— List schema recommendations
/organizations/{organization}/databases/{database}/schema-recommendations
Capability Spec