Skip to main content
POST
Restore a deleted branch

Authorizations

X-API-Key
string
header
required

Headers

customer
string
required

Workspace identifier

Path Parameters

projectId
string
required

Project UUID, not a slug. Resolve a slug with GET /project/slug/{slug} using the same workspace and credentials, then pass the returned id.

id
string
required

Body

application/json
expected_chain_ids
string[]

The ids of the chain a restore preview showed, in its order. When present, the restore refuses with 409 if the chain it would restore now differs, so what was confirmed is what happens. Omit to restore whatever the chain is now.

expected_rebase_ids
string[]

The ids of the chain members the preview said would be rebased as part of the restore. When present alongside expected_chain_ids, the restore refuses with 409 if a different set would be rebased now, so a rebase is never performed unseen.

Response

200 - application/json
created_at
string
required
created_by_id
string | null
required
description
string
required
editor_group_ids
string[]
required
has_children
boolean
required
id
string
required
is_deleted
boolean
required
is_iteration
boolean
required
is_protected
boolean
required
is_variant
boolean
required
labels
object[]
required
last_rebased_at
string | null
required
last_touched_at
string | null
required
merged_at
string | null
required
name
string
required
number
number
required
owner_id
string | null
required
parent_name
string | null
required
ready_for_review
boolean
required
require_review
boolean
required
required_reviewer_ids
string[]
required
updated_at
string
required
updated_by_id
string | null
required
upstream_branch_ids
string[]
required
baseline_id
string | null
branch_extraction_enabled
boolean
change_request_diff_summary
object
change_request_title
string | null
comment_count
number
designated_reviewer_ids
string[]
parent
string | null
reviews
object[]