Sign in

v17

latestOpenAPI 3.0.1raw.githubusercontent.com2026-07-08165682.0 MB
Branch changes

Upsert a change request for cluster size, replicas, storage, or parameters

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 write_database

OAuth Scopes

ResourceScopes
Organizationwrite_databases
Databasewrite_database
patch/organizations/{organization}/databases/{database}/branches/{branch}/changes

Path parameters

organizationstring required

Organization name slug from list_organizations. Example: acme.

databasestring required

Database name slug from list_databases. Example: app-db.

branchstring required

Branch name from list_branches. Example: main.

Request body

cluster_sizestring

The size of the cluster. Available sizes can be found using the 'List cluster sizes' endpoint.

replicasinteger

The total number of replicas

parametersobject

Cluster configuration parameters nested by namespace (e.g., {"pgconf": {"max_connections": "200"}}). Use the 'List cluster parameters' endpoint to retrieve available parameters. Supported namespaces include 'patroni', 'pgconf', and 'pgbouncer'.

Response

Returns the branch change request

idstring required

The ID of the branch change request

restartinteger[] required

The ports requiring a restart when changes are applied

state'queued' | 'pending' | 'resizing' | 'canceled' | 'completed' required

The state of the branch change request

started_atstring nullable required

The time the branch change request started

completed_atstring nullable required

The time the branch change request completed

created_atstring required

The time the branch change request was created

updated_atstring required

The time the branch change request was last updated

cluster_namestring required

The SKU representing the branch cluster

cluster_display_namestring required

The SKU representing the branch cluster for display

cluster_metalboolean required

Whether or not this is a metal database

replicasinteger required

The total number of replicas

parametersobject required

The branch parameters

previous_cluster_namestring required

The previous SKU representing the branch cluster

previous_cluster_display_namestring required

The previous SKU representing the branch cluster for display

previous_cluster_metalboolean required

Whether or not the previous SKU was a metal database

previous_replicasinteger required

The previous total number of replicas

previous_parametersobject required

The previous branch parameters

minimum_storage_bytesinteger required

The minimum storage size in bytes

maximum_storage_bytesinteger required

The maximum storage size in bytes

storage_autoscalingboolean required

Whether storage autoscaling is enabled

storage_shrinkingboolean required

Whether storage shrinking is enabled when autoscaling is enabled

storage_type'gp3' | 'io2' | 'pd_ssd' required

The storage type (gp3 or io2)

storage_iopsinteger required

The storage IOPS

storage_throughput_mibsinteger required

The storage throughput in MiB/s

previous_minimum_storage_bytesinteger required

The previous minimum storage size in bytes

previous_maximum_storage_bytesinteger required

The previous maximum storage size in bytes

previous_storage_autoscalingboolean required

Whether storage autoscaling was previously enabled

previous_storage_shrinkingboolean required

Whether storage shrinking was previously enabled

previous_storage_typestring required

The previous storage type

previous_storage_iopsinteger required

The previous storage IOPS

previous_storage_throughput_mibsinteger required

The previous storage throughput in MiB/s