v1

latestOpenAPI 3.0.3Proprietary2026-07-26162247330.6 KB

Branch

Retrieve branch details

Retrieves information about the specified branch. A branch_id value has a br- prefix.

Each Neon project is initially created with a root and default branch named main. A project can contain one or more branches. A parent branch is identified by a parent_id value, which is the id of the parent branch. For related information, see Manage branches.

get/projects/{project_id}/branches/{branch_id}

Response

Returned information about the specified branch

Example response

{
  "branch": {
    "id": "br-wispy-meadow-118737",
    "project_id": "spring-example-302709",
    "parent_id": "br-aged-salad-637688",
    "parent_lsn": "0/1DE2850",
    "name": "dev2",
    "protected": false,
    "current_state": "ready",
    "state_changed_at": "2022-11-30T20:09:48Z",
    "creation_source": "console",
    "created_at": "2022-11-30T19:09:48Z",
    "updated_at": "2022-12-01T19:53:05Z",
    "default": true,
    "init_source": "parent-data",
    "data_transfer_bytes": 72911987,
    "written_data_bytes": 542998300,
    "compute_time_seconds": 823880990,
    "active_time_seconds": 922200,
    "cpu_used_sec": 461100
  },
  "annotation": {
    "value": {
      "github-commit-ref": "github-branch-name"
    }
  }
}