Skip to content
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

  • 201
  • 500

Response (201)

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "lorem",
  "project_ref": "lorem",
  "parent_project_ref": "lorem",
  "is_default": true,
  "git_branch": "lorem",
  "pr_number": -9007199254740991,
  "latest_check_run_id": 42,
  "persistent": true,
  "status": "CREATING_PROJECT",
  "created_at": "4404-02-29T04:24Z",
  "updated_at": "4404-02-29T04:24Z",
  "review_requested_at": "4404-02-29T04:24Z",
  "with_data": true,
  "notify_url": "https://github.com/NeuraLegion/brokencrystals",
  "deletion_scheduled_at": "4404-02-29T04:24Z",
  "preview_project_status": "INACTIVE"
}