List all branches | Management API Reference

List all database branches

get/v1/projects/{ref}/branches

Returns all database branches of the specified project.

OAuth scopes

environment:read

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

branching_development_read
or
branching_production_read

Path parameters

ref
Required
string
Project ref

Response codes

Response (200)

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

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