Rebase a project branch

client.projects.branches.rebase(, ?, ?): ProjectBranch { branch, config_commit, latest_build, 3 more }

put/v0/projects/{project}/branches/{branch}/rebase

Rebase a project branch.

The branch is rebased onto the base branch or commit SHA, inheriting any config and custom code changes.

ParametersExpand Collapse

branch: string

params: BranchRebaseParams { project, base }

project?: string

Path param:

base?: string

Query param: The branch or commit SHA to rebase onto. Defaults to "main".

ReturnsExpand Collapse

ProjectBranch { branch, config_commit, latest_build, 3 more }

A project branch names a line of development for a project. Like a Git branch, it points to a Git commit with a set of config files. In addition, a project branch also points to a set of custom code changes, corresponding to Git branches in the staging repos.

branch: string

Branch name

config_commit: ConfigCommit { repo, sha }

A Git commit that points to the latest set of config files on a given branch.

repo: Repo { branch, name, owner }

branch: string

owner: string

sha: string

latest_build: Build { id, config_commit, created_at, 6 more } | null

id: string

Build ID

config_commit: string

created_at: string

documented_spec: UnionMember0 { content, type } | UnionMember1 { expires, type, url } | null

Accepts one of the following:

UnionMember0 { content, type }

content: string

type: "content"

Accepts one of the following:

"content"

UnionMember1 { expires, type, url }

expires: string

type: "url"

Accepts one of the following:

"url"

url: string

object: "build"

Accepts one of the following:

"build"

org: string

project: string

targets: Targets { cli, csharp, go, 8 more }

cli?: BuildTarget { commit, install_url, lint, 4 more }

commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { completed, status }

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha } | null

repo: Repo { branch, name, owner }

branch: string

owner: string

sha: string

conclusion: "error" | "warning" | "note" | 9 more

Accepts one of the following:

"error"

"warning"

"note"

"success"

"merge_conflict"

"upstream_merge_conflict"

"fatal"

"payment_required"

"cancelled"

"timed_out"

"noop"

"version_bump"

merge_conflict_pr: MergeConflictPr | null

number: number

repo: Repo { name, owner }

owner: string

status: "completed"

Accepts one of the following:

"completed"

install_url: string | null

lint: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

object: "build_target"

Accepts one of the following:

"build_target"

status: "not_started" | "codegen" | "postgen" | "completed"

Accepts one of the following:

"not_started"

"codegen"

"postgen"

"completed"

test: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

build?: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

csharp?: BuildTarget { commit, install_url, lint, 4 more }

commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { completed, status }

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha } | null

repo: Repo { branch, name, owner }

branch: string

owner: string

sha: string

conclusion: "error" | "warning" | "note" | 9 more

Accepts one of the following:

"error"

"warning"

"note"

"success"

"merge_conflict"

"upstream_merge_conflict"

"fatal"

"payment_required"

"cancelled"

"timed_out"

"noop"

"version_bump"

merge_conflict_pr: MergeConflictPr | null

number: number

repo: Repo { name, owner }

owner: string

status: "completed"

Accepts one of the following:

"completed"

install_url: string | null

lint: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

object: "build_target"

Accepts one of the following:

"build_target"

status: "not_started" | "codegen" | "postgen" | "completed"

Accepts one of the following:

"not_started"

"codegen"

"postgen"

"completed"

test: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

build?: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

go?: BuildTarget { commit, install_url, lint, 4 more }

commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { completed, status }

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha } | null

repo: Repo { branch, name, owner }

branch: string

owner: string

sha: string

conclusion: "error" | "warning" | "note" | 9 more

Accepts one of the following:

"error"

"warning"

"note"

"success"

"merge_conflict"

"upstream_merge_conflict"

"fatal"

"payment_required"

"cancelled"

"timed_out"

"noop"

"version_bump"

merge_conflict_pr: MergeConflictPr | null

number: number

repo: Repo { name, owner }

owner: string

status: "completed"

Accepts one of the following:

"completed"

install_url: string | null

lint: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

object: "build_target"

Accepts one of the following:

"build_target"

status: "not_started" | "codegen" | "postgen" | "completed"

Accepts one of the following:

"not_started"

"codegen"

"postgen"

"completed"

test: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

build?: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

java?: BuildTarget { commit, install_url, lint, 4 more }

commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { completed, status }

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha } | null

repo: Repo { branch, name, owner }

branch: string

owner: string

sha: string

conclusion: "error" | "warning" | "note" | 9 more

Accepts one of the following:

"error"

"warning"

"note"

"success"

"merge_conflict"

"upstream_merge_conflict"

"fatal"

"payment_required"

"cancelled"

"timed_out"

"noop"

"version_bump"

merge_conflict_pr: MergeConflictPr | null

number: number

repo: Repo { name, owner }

owner: string

status: "completed"

Accepts one of the following:

"completed"

install_url: string | null

lint: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

object: "build_target"

Accepts one of the following:

"build_target"

status: "not_started" | "codegen" | "postgen" | "completed"

Accepts one of the following:

"not_started"

"codegen"

"postgen"

"completed"

test: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

build?: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

kotlin?: BuildTarget { commit, install_url, lint, 4 more }

commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { completed, status }

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha } | null

repo: Repo { branch, name, owner }

branch: string

owner: string

sha: string

conclusion: "error" | "warning" | "note" | 9 more

Accepts one of the following:

"error"

"warning"

"note"

"success"

"merge_conflict"

"upstream_merge_conflict"

"fatal"

"payment_required"

"cancelled"

"timed_out"

"noop"

"version_bump"

merge_conflict_pr: MergeConflictPr | null

number: number

repo: Repo { name, owner }

owner: string

status: "completed"

Accepts one of the following:

"completed"

install_url: string | null

lint: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

object: "build_target"

Accepts one of the following:

"build_target"

status: "not_started" | "codegen" | "postgen" | "completed"

Accepts one of the following:

"not_started"

"codegen"

"postgen"

"completed"

test: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

build?: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

node?: BuildTarget { commit, install_url, lint, 4 more }

commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { completed, status }

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha } | null

repo: Repo { branch, name, owner }

branch: string

owner: string

sha: string

conclusion: "error" | "warning" | "note" | 9 more

Accepts one of the following:

"error"

"warning"

"note"

"success"

"merge_conflict"

"upstream_merge_conflict"

"fatal"

"payment_required"

"cancelled"

"timed_out"

"noop"

"version_bump"

merge_conflict_pr: MergeConflictPr | null

number: number

repo: Repo { name, owner }

owner: string

status: "completed"

Accepts one of the following:

"completed"

install_url: string | null

lint: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

object: "build_target"

Accepts one of the following:

"build_target"

status: "not_started" | "codegen" | "postgen" | "completed"

Accepts one of the following:

"not_started"

"codegen"

"postgen"

"completed"

test: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

build?: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

php?: BuildTarget { commit, install_url, lint, 4 more }

commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { completed, status }

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha } | null

repo: Repo { branch, name, owner }

branch: string

owner: string

sha: string

conclusion: "error" | "warning" | "note" | 9 more

Accepts one of the following:

"error"

"warning"

"note"

"success"

"merge_conflict"

"upstream_merge_conflict"

"fatal"

"payment_required"

"cancelled"

"timed_out"

"noop"

"version_bump"

merge_conflict_pr: MergeConflictPr | null

number: number

repo: Repo { name, owner }

owner: string

status: "completed"

Accepts one of the following:

"completed"

install_url: string | null

lint: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

object: "build_target"

Accepts one of the following:

"build_target"

status: "not_started" | "codegen" | "postgen" | "completed"

Accepts one of the following:

"not_started"

"codegen"

"postgen"

"completed"

test: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

build?: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

python?: BuildTarget { commit, install_url, lint, 4 more }

commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { completed, status }

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha } | null

repo: Repo { branch, name, owner }

branch: string

owner: string

sha: string

conclusion: "error" | "warning" | "note" | 9 more

Accepts one of the following:

"error"

"warning"

"note"

"success"

"merge_conflict"

"upstream_merge_conflict"

"fatal"

"payment_required"

"cancelled"

"timed_out"

"noop"

"version_bump"

merge_conflict_pr: MergeConflictPr | null

number: number

repo: Repo { name, owner }

owner: string

status: "completed"

Accepts one of the following:

"completed"

install_url: string | null

lint: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

object: "build_target"

Accepts one of the following:

"build_target"

status: "not_started" | "codegen" | "postgen" | "completed"

Accepts one of the following:

"not_started"

"codegen"

"postgen"

"completed"

test: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

build?: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

ruby?: BuildTarget { commit, install_url, lint, 4 more }

commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { completed, status }

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha } | null

repo: Repo { branch, name, owner }

branch: string

owner: string

sha: string

conclusion: "error" | "warning" | "note" | 9 more

Accepts one of the following:

"error"

"warning"

"note"

"success"

"merge_conflict"

"upstream_merge_conflict"

"fatal"

"payment_required"

"cancelled"

"timed_out"

"noop"

"version_bump"

merge_conflict_pr: MergeConflictPr | null

number: number

repo: Repo { name, owner }

owner: string

status: "completed"

Accepts one of the following:

"completed"

install_url: string | null

lint: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

object: "build_target"

Accepts one of the following:

"build_target"

status: "not_started" | "codegen" | "postgen" | "completed"

Accepts one of the following:

"not_started"

"codegen"

"postgen"

"completed"

test: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

build?: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

terraform?: BuildTarget { commit, install_url, lint, 4 more }

commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { completed, status }

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha } | null

repo: Repo { branch, name, owner }

branch: string

owner: string

sha: string

conclusion: "error" | "warning" | "note" | 9 more

Accepts one of the following:

"error"

"warning"

"note"

"success"

"merge_conflict"

"upstream_merge_conflict"

"fatal"

"payment_required"

"cancelled"

"timed_out"

"noop"

"version_bump"

merge_conflict_pr: MergeConflictPr | null

number: number

repo: Repo { name, owner }

owner: string

status: "completed"

Accepts one of the following:

"completed"

install_url: string | null

lint: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

object: "build_target"

Accepts one of the following:

"build_target"

status: "not_started" | "codegen" | "postgen" | "completed"

Accepts one of the following:

"not_started"

"codegen"

"postgen"

"completed"

test: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

build?: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

typescript?: BuildTarget { commit, install_url, lint, 4 more }

commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { completed, status }

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha } | null

repo: Repo { branch, name, owner }

branch: string

owner: string

sha: string

conclusion: "error" | "warning" | "note" | 9 more

Accepts one of the following:

"error"

"warning"

"note"

"success"

"merge_conflict"

"upstream_merge_conflict"

"fatal"

"payment_required"

"cancelled"

"timed_out"

"noop"

"version_bump"

merge_conflict_pr: MergeConflictPr | null

number: number

repo: Repo { name, owner }

owner: string

status: "completed"

Accepts one of the following:

"completed"

install_url: string | null

lint: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

object: "build_target"

Accepts one of the following:

"build_target"

status: "not_started" | "codegen" | "postgen" | "completed"

Accepts one of the following:

"not_started"

"codegen"

"postgen"

"completed"

test: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

build?: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

updated_at: string

object: "project_branch"

Accepts one of the following:

"project_branch"

org: string

project: string

Project name

Rebase a project branch

IMPORT STAINLESS FROM '@STAINLESS-API/SDK';

CONST CLIENT = NEW STAINLESS({
  APIKEY: 'MY API KEY',
});

CONST PROJECTBRANCH = AWAIT CLIENT.PROJECTS.BRANCHES.REBASE('BRANCH', { PROJECT: 'PROJECT' });

CONSOLE.LOG(PROJECTBRANCH.BRANCH);

{
  "branch": "branch",
  "config_commit": {
    "repo": {
      "branch": "branch",
      "name": "name",
      "owner": "owner"
    },
    "sha": "sha"
  },
  "latest_build": {
    "id": "id",
    "config_commit": "config_commit",
    "created_at": "2019-12-27T18:11:19.117Z",
    "documented_spec": {
      "content": "content",
      "type": "content"
    },
    "object": "build",
    "org": "org",
    "project": "project",
    "targets": {
      "cli": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "csharp": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "go": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "java": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "kotlin": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "node": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "php": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "python": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "ruby": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "terraform": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "typescript": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      }
    },
    "updated_at": "2019-12-27T18:11:19.117Z"
  },
  "object": "project_branch",
  "org": "org",
  "project": "project"
}

Returns Examples

{
  "branch": "branch",
  "config_commit": {
    "repo": {
      "branch": "branch",
      "name": "name",
      "owner": "owner"
    },
    "sha": "sha"
  },
  "latest_build": {
    "id": "id",
    "config_commit": "config_commit",
    "created_at": "2019-12-27T18:11:19.117Z",
    "documented_spec": {
      "content": "content",
      "type": "content"
    },
    "object": "build",
    "org": "org",
    "project": "project",
    "targets": {
      "cli": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "csharp": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "go": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "java": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "kotlin": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "node": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "php": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "python": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "ruby": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "terraform": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "typescript": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      }
    },
    "updated_at": "2019-12-27T18:11:19.117Z"
  },
  "object": "project_branch",
  "org": "org",
  "project": "project"
}