API Reference

Projects

Branches

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Create a new project branch

post/v0/projects/{project}/branches

Create a new branch for a project.

The branch inherits the config files from the revision pointed to by the branch_from parameter. In addition, if the revision is a branch name, the branch will also inherit custom code changes from that branch.

Path ParametersExpand Collapse

project: optional string

Body ParametersExpand Collapse

branch: string

Branch name

branch_from: string

Branch or commit SHA to branch from

force: optional boolean

Whether to throw an error if the branch already exists. Defaults to false.

ReturnsExpand Collapse

ProjectBranch = object { 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: object { repo, sha }

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

repo: object { branch, name, owner }

branch: string

name: string

owner: string

sha: string

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

id: string

Build ID

config_commit: string

created_at: string

documented_spec: object { content, type } or object { expires, type, url }

Accepts one of the following:

UnionMember0 = object { content, type }

content: string

type: "content"

UnionMember1 = object { expires, type, url }

expires: string

type: "url"

url: string

object: "build"

org: string

project: string

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

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

commit: object { status } or object { status } or object { status } or object { completed, status }

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha }

repo: object { branch, name, owner }

branch: string

name: string

owner: string

sha: string

conclusion: "error" or "warning" or "note" or 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: object { number, repo }

number: number

repo: object { name, owner }

name: string

owner: string

status: "completed"

install_url: string

lint: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

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

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

object: "build_target"

status: "not_started" or "codegen" or "postgen" or "completed"

Accepts one of the following:

"not_started"

"codegen"

"postgen"

"completed"

test: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

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

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

build: optional CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

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

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

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

commit: object { status } or object { status } or object { status } or object { completed, status }

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha }

repo: object { branch, name, owner }

branch: string

name: string

owner: string

sha: string

conclusion: "error" or "warning" or "note" or 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: object { number, repo }

number: number

repo: object { name, owner }

name: string

owner: string

status: "completed"

install_url: string

lint: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

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

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

object: "build_target"

status: "not_started" or "codegen" or "postgen" or "completed"

Accepts one of the following:

"not_started"

"codegen"

"postgen"

"completed"

test: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

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

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

build: optional CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

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

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

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

commit: object { status } or object { status } or object { status } or object { completed, status }

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha }

repo: object { branch, name, owner }

branch: string

name: string

owner: string

sha: string

conclusion: "error" or "warning" or "note" or 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: object { number, repo }

number: number

repo: object { name, owner }

name: string

owner: string

status: "completed"

install_url: string

lint: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

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

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

object: "build_target"

status: "not_started" or "codegen" or "postgen" or "completed"

Accepts one of the following:

"not_started"

"codegen"

"postgen"

"completed"

test: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

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

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

build: optional CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

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

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

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

commit: object { status } or object { status } or object { status } or object { completed, status }

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha }

repo: object { branch, name, owner }

branch: string

name: string

owner: string

sha: string

conclusion: "error" or "warning" or "note" or 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: object { number, repo }

number: number

repo: object { name, owner }

name: string

owner: string

status: "completed"

install_url: string

lint: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

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

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

object: "build_target"

status: "not_started" or "codegen" or "postgen" or "completed"

Accepts one of the following:

"not_started"

"codegen"

"postgen"

"completed"

test: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

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

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

build: optional CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

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

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

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

commit: object { status } or object { status } or object { status } or object { completed, status }

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha }

repo: object { branch, name, owner }

branch: string

name: string

owner: string

sha: string

conclusion: "error" or "warning" or "note" or 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: object { number, repo }

number: number

repo: object { name, owner }

name: string

owner: string

status: "completed"

install_url: string

lint: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

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

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

object: "build_target"

status: "not_started" or "codegen" or "postgen" or "completed"

Accepts one of the following:

"not_started"

"codegen"

"postgen"

"completed"

test: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

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

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

build: optional CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

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

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

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

commit: object { status } or object { status } or object { status } or object { completed, status }

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha }

repo: object { branch, name, owner }

branch: string

name: string

owner: string

sha: string

conclusion: "error" or "warning" or "note" or 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: object { number, repo }

number: number

repo: object { name, owner }

name: string

owner: string

status: "completed"

install_url: string

lint: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

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

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

object: "build_target"

status: "not_started" or "codegen" or "postgen" or "completed"

Accepts one of the following:

"not_started"

"codegen"

"postgen"

"completed"

test: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

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

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

build: optional CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

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

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

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

commit: object { status } or object { status } or object { status } or object { completed, status }

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha }

repo: object { branch, name, owner }

branch: string

name: string

owner: string

sha: string

conclusion: "error" or "warning" or "note" or 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: object { number, repo }

number: number

repo: object { name, owner }

name: string

owner: string

status: "completed"

install_url: string

lint: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

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

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

object: "build_target"

status: "not_started" or "codegen" or "postgen" or "completed"

Accepts one of the following:

"not_started"

"codegen"

"postgen"

"completed"

test: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

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

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

build: optional CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

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

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

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

commit: object { status } or object { status } or object { status } or object { completed, status }

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha }

repo: object { branch, name, owner }

branch: string

name: string

owner: string

sha: string

conclusion: "error" or "warning" or "note" or 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: object { number, repo }

number: number

repo: object { name, owner }

name: string

owner: string

status: "completed"

install_url: string

lint: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

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

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

object: "build_target"

status: "not_started" or "codegen" or "postgen" or "completed"

Accepts one of the following:

"not_started"

"codegen"

"postgen"

"completed"

test: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

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

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

build: optional CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

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

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

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

commit: object { status } or object { status } or object { status } or object { completed, status }

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha }

repo: object { branch, name, owner }

branch: string

name: string

owner: string

sha: string

conclusion: "error" or "warning" or "note" or 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: object { number, repo }

number: number

repo: object { name, owner }

name: string

owner: string

status: "completed"

install_url: string

lint: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

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

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

object: "build_target"

status: "not_started" or "codegen" or "postgen" or "completed"

Accepts one of the following:

"not_started"

"codegen"

"postgen"

"completed"

test: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

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

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

build: optional CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

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

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

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

commit: object { status } or object { status } or object { status } or object { completed, status }

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha }

repo: object { branch, name, owner }

branch: string

name: string

owner: string

sha: string

conclusion: "error" or "warning" or "note" or 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: object { number, repo }

number: number

repo: object { name, owner }

name: string

owner: string

status: "completed"

install_url: string

lint: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

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

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

object: "build_target"

status: "not_started" or "codegen" or "postgen" or "completed"

Accepts one of the following:

"not_started"

"codegen"

"postgen"

"completed"

test: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

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

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

build: optional CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

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

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

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

commit: object { status } or object { status } or object { status } or object { completed, status }

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha }

repo: object { branch, name, owner }

branch: string

name: string

owner: string

sha: string

conclusion: "error" or "warning" or "note" or 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: object { number, repo }

number: number

repo: object { name, owner }

name: string

owner: string

status: "completed"

install_url: string

lint: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

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

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

object: "build_target"

status: "not_started" or "codegen" or "postgen" or "completed"

Accepts one of the following:

"not_started"

"codegen"

"postgen"

"completed"

test: CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

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

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

build: optional CheckStep

Accepts one of the following:

NotStarted = object { status }

status: "not_started"

Queued = object { status }

status: "queued"

InProgress = object { status }

status: "in_progress"

Completed = object { completed, status }

completed: object { conclusion, url }

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

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string

status: "completed"

updated_at: string

object: "project_branch"

org: string

project: string

Project name

Create a new project branch

HTTP

HTTP

TypeScript

Python

Java

Go

curl https://api.stainless.com/v0/projects/$PROJECT/branches \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $STAINLESS_API_KEY" \
    -d '{
          "branch": "branch",
          "branch_from": "branch_from"
        }'

200 example

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

200 example

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