Skip to main content
Toggle baseIsEphemeral/targetIsEphemeral to work with ephemeral refs. The method returns the API message plus the resolved branch metadata so you can confirm creation before pushing commits.

Options

string
required
Source branch to copy from. Combine with baseIsEphemeral when promoting from the ephemeral namespace.
string
required
Destination branch name. May match baseBranch when moving between namespaces.
string
true when the source branch lives in the ephemeral namespace (defaults to false).
string
true to create/update an ephemeral branch instead of the default namespace.
object[]
Ordered per-ref policy rules ({ pattern, ops? }) embedded in the per-call JWT. First match wins. Python: ref_policies. Go: RefPolicies with type storage.RefPolicyList. See the Branch Protection guide.

Response

string
Confirmation message
string
The created branch name
boolean
Whether the branch is in the ephemeral namespace
string
The tip commit SHA of the new branch