Sign in

v1

latestOpenAPI 3.0.02026-07-14169146300.3 KB
Environments

Get a database branch

Fetches the specified database branch by its name.

get/v1/projects/{ref}/branches/{name}

Path parameters

refstring required
Example:abcdefghijklmnopqrst

Project ref

namestring required
Example:preview-login-page

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'