Sign in
Environments

Update database branch config

Updates the configuration of the specified database branch

patch/v1/branches/{branch_id_or_ref}

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP bearer
    • fga_permissions (a scheme the document does not define)
    • fga_permissions (a scheme the document does not define)

Path parameters

string required

Project ref

OR
string uuid required

Branch ID

Request body

branch_namestring
git_branchstring
reset_on_pushboolean

This field is deprecated and will be ignored. Use v1-reset-a-branch endpoint directly instead.

persistentboolean
status'CREATING_PROJECT' | 'RUNNING_MIGRATIONS' | 'MIGRATIONS_PASSED' | 'MIGRATIONS_FAILED' | 'FUNCTIONS_DEPLOYED' | 'FUNCTIONS_FAILED'
request_reviewboolean
notify_urlstring uri

HTTP endpoint to receive branch status updates.

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

Changes

No recorded changes to this operation across all 1 revision of this API.