Create a branch | Management API Reference

Create a database branch

post/v2/projects/{ref}/branches

Creates a database branch from the specified project. Compute and disk size can be set here so the branch is provisioned at the requested size, instead of being resized after creation.

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

data
Required
object

Response codes

Response (201)

1
{
2
  "data": {
3
    "type": "branch",
4
    "id": "00000000-0000-0000-0000-000000000000",
5
    "attributes": {
6
      "name": "lorem",
7
      "project_ref": "lorem",
8
      "parent_project_ref": "lorem",
9
      "is_default": true,
10
      "persistent": true,
11
      "with_data": true,
12
      "git_branch": "lorem",
13
      "notify_url": "https://github.com/NeuraLegion/brokencrystals",
14
      "created_at": "2021-12-31T23:34:00Z",
15
      "updated_at": "2021-12-31T23:34:00Z"
16
    }
17
  }
18
}

1
{
2
  "type": "object",
3
  "properties": {
4
    "data": {
5
      "type": "object",
6
      "properties": {
7
        "type": {
8
          "type": "string",
9
          "description": "Resource type.",
10
          "enum": [
11
            "branch"
12
          ]
13
        },
14
        "id": {
15
          "type": "string",
16
          "format": "uuid",
17
          "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)$",
18
          "description": "ID of the branch."
19
        },
20
        "attributes": {
21
          "type": "object",
22
          "properties": {
23
            "name": {
24
              "type": "string",
25
              "description": "Name of the branch."
26
            },
27
            "project_ref": {
28
              "type": "string",
29
              "description": "Ref of the project backing this branch."
30
            },
31
            "parent_project_ref": {
32
              "type": "string",
33
              "description": "Ref of the project it branches from."
34
            },
35
            "is_default": {
36
              "type": "boolean",
37
              "description": "Whether this is the default branch of the project."
38
            },
39
            "persistent": {
40
              "type": "boolean",
41
              "description": "Whether the branch is kept when its git branch is deleted or its PR is merged."
42
            },
43
            "with_data": {
44
              "type": "boolean",
45
              "description": "Whether the branch is seeded from the project's data."
46
            },
47
            "git_branch": {
48
              "description": "Git branch being tracked.",
49
              "type": "string"
50
            },
51
            "notify_url": {
52
              "description": "HTTP endpoint receiving branch status updates.",
53
              "type": "string",
54
              "format": "uri"
55
            },
56
            "created_at": {
57
              "type": "string",
58
              "format": "date-time",
59
              "description": "Creation timestamp."
60
            },
61
            "updated_at": {
62
              "type": "string",
63
              "format": "date-time",
64
              "description": "Last update timestamp."
65
            }
66
          },
67
          "required": [
68
            "name",
69
            "project_ref",
70
            "parent_project_ref",
71
            "is_default",
72
            "persistent",
73
            "with_data",
74
            "created_at",
75
            "updated_at"
76
          ]
77
        }
78
      },
79
      "required": [
80
        "type",
81
        "id",
82
        "attributes"
83
      ]
84
    }
85
  },
86
  "required": [
87
    "data"
88
  ]
89
}