Skip to content
Management API Reference

Update database branch config

patch/v1/branches/{branch_id_or_ref}

Updates the configuration of the specified database branch

OAuth scopes

  • environment:write

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

  • branching_development_write
  • or
  • branching_production_write

Path parameters

  • branch_id_or_ref
    Required
    any of the following options

    Branch ref or deprecated branch ID

Body

  • branch_name
    Optional
    string
  • git_branch
    Optional
    string
  • reset_on_push
    Optional
    Deprecatedboolean
  • persistent
    Optional
    boolean
  • status
    Optional
    enum
  • request_review
    Optional
    boolean
  • notify_url
    Optional
    string

Response codes

  • 200
  • 500

Response (200)

{
  "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"
}