api-anomalies2

api-branch_bouncer_resizes1

api-branch_maintenances1

api-branch_resizes3

api-query_insights4

api-query_insights_errors2

api-query_insights_tags3

api-query_insights_traffic_budgets1

api-read_only_replica_changes1

BackupPolicies5

Backups5

Billing payment method2

Billing payment method setup2

Bouncer resizes3

Bouncers4

Branch changes4

Cluster extensions1

Cluster parameters1

Database branch keyspaces6

Database branch passwords6

Database branches13

Database Postgres IP restrictions5

Databases9

Deploy requests21

Invoices3

Keyspace resizes4

Keyspace VSchemas2

MaintenanceSchedules2

MaintenanceWindows1

Metrics8

OAuth applications5

OAuth tokens1

Organization members4

Organization SSO6

Organization SSO domains4

Organization teams5

Organizations6

Query Insights reports5

Read-only replicas4

Regions1

Roles10

Schema recommendations3

Service tokens4

Switchovers3

Team members4

Traffic budgets5

Traffic rules2

Users1

Webhooks6

Workflows12

Deploy requests

Complete a revert

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:

Service Token Accesses create_deploy_request

OAuth Scopes

Resource	Scopes
Organization	deploy_deploy_requests
Database	deploy_deploy_requests

post/organizations/{organization}/databases/{database}/deploy-requests/{number}/revert

Path parameters

organizationstring required

The name of the deploy request's organization

databasestring required

The name of the deploy request's database

numberinteger required

The number of the deploy request

Response

Returns the deploy request that was reverted

idstring required

The ID of the deploy request

numberinteger required

The number of the deploy request

branchstring required

The name of the branch the deploy request was created from

branch_idstring required

The ID of the branch the deploy request was created from

branch_deletedboolean required

Whether or not the deploy request branch was deleted

branch_deleted_atstring nullable required

When the deploy request branch was deleted

into_branchstring required

The name of the branch the deploy request will be merged into

into_branch_shardedboolean required

Whether or not the branch the deploy request will be merged into is sharded

into_branch_shard_countinteger required

The number of shards the branch the deploy request will be merged into has

into_branch_keyspace_countinteger required

The number of keyspaces the branch the deploy request will be merged into has

approvedboolean required

Whether or not the deploy request is approved

state'open' | 'closed' required

Whether the deploy request is open or closed

The deployment state of the deploy request

num_commentsinteger required

The number of comments on the deploy request

html_urlstring required

The PlanetScale app address for the deploy request

notesstring required

Notes on the deploy request

html_bodystring required

The HTML body of the deploy request

created_atstring required

When the deploy request was created

updated_atstring required

When the deploy request was last updated

closed_atstring nullable required

When the deploy request was closed

deployed_atstring nullable required

When the deploy request was deployed

Changes

Changed in 4 of the 24 revisions of this API.394

Jul 8, 2026fa19f33052411See the full diff
- ○
  added the required property into_branch_keyspace_count to the response with the 200 status
  response-required-property-added
Jun 1, 202672506953f367373See the full diff
- ▲
  the response property branch_deleted_at became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property branch_deleted_by became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property closed_at became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property closed_by became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property deployed_at became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property deployment/actor became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property deployment/cancelled_actor became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property deployment/cutover_actor became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property deployment/cutover_at became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property deployment/deploy_check_errors became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property deployment/deploy_operation_summaries/items/table_recently_used_at became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property deployment/deploy_operation_summaries/items/throttled_at became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property deployment/deploy_operations/items/deploy_error_docs_url became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property deployment/deploy_operations/items/deploy_errors became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property deployment/deploy_operations/items/eta_seconds became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property deployment/deploy_operations/items/progress_percentage became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property deployment/deploy_operations/items/removed_foreign_key_names became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property deployment/deploy_operations/items/table_recently_used_at became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property deployment/deploy_operations/items/throttled_at became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property deployment/deployment_revert_request became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property deployment/finished_at became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property deployment/locked_table_name became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property deployment/queued_at became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property deployment/ready_to_cutover_at became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property deployment/schema_last_updated_at became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property deployment/started_at became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property deployment/submitted_at became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property deployment/throttler_configurations became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property branch_deleted_by became optional for the status 200
  response-property-became-optional
- ▲
  the response property closed_by became optional for the status 200
  response-property-became-optional
- ▲
  the response property deployment/actor became optional for the status 200
  response-property-became-optional
- ▲
  the response property deployment/cancelled_actor became optional for the status 200
  response-property-became-optional
- ▲
  the response property deployment/cutover_actor became optional for the status 200
  response-property-became-optional
- ▲
  the response property deployment/deploy_check_errors became optional for the status 200
  response-property-became-optional
- ▲
  the response property deployment/locked_table_name became optional for the status 200
  response-property-became-optional
- ▲
  the response property deployment/throttler_configurations became optional for the status 200
  response-property-became-optional
- ▲
  the deployment/throttler_configurations response's property type/format changed from array/ to object/ for status 200
  response-property-type-changed
- ○
  added the required property deployment/force_cutover_requested_at to the response with the 200 status
  response-required-property-added
- ○
  added the required property deployment/queue_pause_reason to the response with the 200 status
  response-required-property-added
- ○
  added the required property deployment/queue_paused to the response with the 200 status
  response-required-property-added
Dec 9, 2025d710019068fb1See the full diff
- ▲
  for the path request parameter number, the type/format was changed from number/ to integer/
  request-parameter-type-changed
Dec 6, 2025477c6ebdabdf1See the full diff
- ▲
  for the path request parameter number, the type/format was changed from string/ to number/
  request-parameter-type-changed

Full history