Sign in

v1

latestOpenAPI 3.0.02026-07-14169146300.3 KB
Environments

Create a database branch

Creates a database branch from the specified project.

post/v1/projects/{ref}/branches

Path parameters

refstring required
Example:abcdefghijklmnopqrst

Project ref

Request body

branch_namestring required
git_branchstring
is_defaultboolean
persistentboolean
regionstring
desired_instance_size'pico' | 'nano' | 'micro' | 'small' | 'medium' | 'large' | 'xlarge' | '2xlarge' | '4xlarge' | '8xlarge' | '12xlarge' | '16xlarge' | '24xlarge' | '24xlarge_optimized_memory' | '24xlarge_optimized_cpu' | '24xlarge_high_memory' | '48xlarge' | '48xlarge_optimized_memory' | '48xlarge_optimized_cpu' | '48xlarge_high_memory'
release_channel'internal' | 'alpha' | 'beta' | 'ga' | 'withdrawn' | 'preview'

Release channel. If not provided, GA will be used.

postgres_engine'15' | '17' | '17-oriole'

Postgres engine version. If not provided, the latest version will be used.

secretsobject
with_databoolean
notify_urlstring uri

HTTP endpoint to receive branch status updates.

Example request

{
  "branch_name": "preview-login-page",
  "git_branch": "feature/login-page",
  "persistent": true,
  "with_data": false,
  "notify_url": "https://example.com/webhooks/branches"
}

Response

idstring uuid required
namestring required
project_refstring required
parent_project_refstring required
is_defaultboolean required
git_branchstring
pr_numberinteger
latest_check_run_idnumber

This field is deprecated and will not be populated.

persistentboolean required
status'CREATING_PROJECT' | 'RUNNING_MIGRATIONS' | 'MIGRATIONS_PASSED' | 'MIGRATIONS_FAILED' | 'FUNCTIONS_DEPLOYED' | 'FUNCTIONS_FAILED' required

This field is deprecated. List action runs to get branch status instead.

created_atstring date-time required
updated_atstring date-time required
review_requested_atstring date-time
with_databoolean required
notify_urlstring uri
deletion_scheduled_atstring date-time
preview_project_status'INACTIVE' | 'ACTIVE_HEALTHY' | 'ACTIVE_UNHEALTHY' | 'COMING_UP' | 'UNKNOWN' | 'GOING_DOWN' | 'INIT_FAILED' | 'REMOVED' | 'RESTORING' | 'UPGRADING' | 'PAUSING' | 'RESTORE_FAILED' | 'RESTARTING' | 'PAUSE_FAILED' | 'RESIZING'