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

The fine-grained token must include the following permissions to access this endpoint:

branching_development_create
or
branching_production_create

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": "00000000-0000-0000-0000-000000000000",
3
  "name": "lorem",
4
  "project_ref": "lorem",
5
  "parent_project_ref": "lorem",
6
  "is_default": true,
7
  "git_branch": "lorem",
8
  "pr_number": -9007199254740991,
9
  "latest_check_run_id": 42,
10
  "persistent": true,
11
  "status": "CREATING_PROJECT",
12
  "created_at": "4404-02-29T04:24Z",
13
  "updated_at": "4404-02-29T04:24Z",
14
  "review_requested_at": "4404-02-29T04:24Z",
15
  "with_data": true,
16
  "notify_url": "https://github.com/NeuraLegion/brokencrystals",
17
  "deletion_scheduled_at": "4404-02-29T04:24Z",
18
  "preview_project_status": "INACTIVE"
19
}

1
{
2
  "type": "object",
3
  "properties": {
4
    "id": {
5
      "type": "string",
6
      "format": "uuid",
7
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
8
    },
9
    "name": {
10
      "type": "string"
11
    },
12
    "project_ref": {
13
      "type": "string"
14
    },
15
    "parent_project_ref": {
16
      "type": "string"
17
    },
18
    "is_default": {
19
      "type": "boolean"
20
    },
21
    "git_branch": {
22
      "type": "string"
23
    },
24
    "pr_number": {
25
      "type": "integer",
26
      "format": "int32",
27
      "minimum": -9007199254740991,
28
      "maximum": 9007199254740991
29
    },
30
    "latest_check_run_id": {
31
      "description": "This field is deprecated and will not be populated.",
32
      "deprecated": true,
33
      "type": "number"
34
    },
35
    "persistent": {
36
      "type": "boolean"
37
    },
38
    "status": {
39
      "type": "string",
40
      "enum": [
41
        "CREATING_PROJECT",
42
        "RUNNING_MIGRATIONS",
43
        "MIGRATIONS_PASSED",
44
        "MIGRATIONS_FAILED",
45
        "FUNCTIONS_DEPLOYED",
46
        "FUNCTIONS_FAILED"
47
      ],
48
      "description": "This field is deprecated. List action runs to get branch status instead.",
49
      "deprecated": true
50
    },
51
    "created_at": {
52
      "type": "string",
53
      "format": "date-time",
54
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
55
    },
56
    "updated_at": {
57
      "type": "string",
58
      "format": "date-time",
59
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
60
    },
61
    "review_requested_at": {
62
      "type": "string",
63
      "format": "date-time",
64
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
65
    },
66
    "with_data": {
67
      "type": "boolean"
68
    },
69
    "notify_url": {
70
      "type": "string",
71
      "format": "uri"
72
    },
73
    "deletion_scheduled_at": {
74
      "type": "string",
75
      "format": "date-time",
76
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
77
    },
78
    "preview_project_status": {
79
      "type": "string",
80
      "enum": [
81
        "INACTIVE",
82
        "ACTIVE_HEALTHY",
83
        "ACTIVE_UNHEALTHY",
84
        "COMING_UP",
85
        "UNKNOWN",
86
        "GOING_DOWN",
87
        "INIT_FAILED",
88
        "REMOVED",
89
        "RESTORING",
90
        "UPGRADING",
91
        "PAUSING",
92
        "RESTORE_FAILED",
93
        "RESTARTING",
94
        "PAUSE_FAILED",
95
        "RESIZING"
96
      ]
97
    }
98
  },
99
  "required": [
100
    "id",
101
    "name",
102
    "project_ref",
103
    "parent_project_ref",
104
    "is_default",
105
    "persistent",
106
    "status",
107
    "created_at",
108
    "updated_at",
109
    "with_data"
110
  ]
111
}