Create a branch | Management API Reference

Create a database branch

post/v1/projects/{ref}/branches

Creates a database branch from the specified project.

OAuth scopes

environment:write

Path parameters

ref
Required
string
Project ref

Body

branch_name
Required
string
git_branch
Optional
string
is_default
Optional
boolean
persistent
Optional
boolean
region
Optional
string
desired_instance_size
Optional
enum
release_channel
Optional
enum
postgres_engine
Optional
enum
secrets
Optional
object
with_data
Optional
boolean
notify_url
Optional
string

Response codes

Response (201)

1
{
2
  "id": "fbdf5a53-161e-4460-98ad-0e39408d8689",
3
  "name": "lorem",
4
  "project_ref": "lorem",
5
  "parent_project_ref": "lorem",
6
  "is_default": true,
7
  "git_branch": "lorem",
8
  "pr_number": 42,
9
  "latest_check_run_id": 42,
10
  "persistent": true,
11
  "status": "CREATING_PROJECT",
12
  "created_at": "2021-12-31T23:34:00Z",
13
  "updated_at": "2021-12-31T23:34:00Z",
14
  "review_requested_at": "2021-12-31T23:34:00Z",
15
  "with_data": true,
16
  "notify_url": "https://github.com/NeuraLegion/brokencrystals",
17
  "deletion_scheduled_at": "2021-12-31T23:34:00Z",
18
  "preview_project_status": "INACTIVE"
19
}