Land a branch

POST

/api/orgs/{org}/projects/{project}/branches/land

const url = 'https://api.wrktr.com/api/orgs/example/projects/example/branches/land';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"branch":"example","force":true,"expectedHead":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.wrktr.com/api/orgs/example/projects/example/branches/land \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "example", "force": true, "expectedHead": "example" }'

Merges the branch into the default branch with a merge commit, made by the server. Only when the branch already contains the default branch’s head, so the merge can’t conflict (BranchBehind otherwise), and only once it’s ready: checks pass, the review approves the head and no blocking thread is open (LandBlocked says what’s missing). force lands it anyway.

Authorizations

bearer

Parameters

Path Parameters

org

required

string

project

required

string

Request Body^required

application/json

object

branch

required

string

force

Any of:

boolean
null

boolean

expectedHead

Any of:

string
null

string

Example^generated

{
  "branch": "example",
  "force": true,
  "expectedHead": "example"
}

Responses

200

LandResult

application/json

object

branch

required

string

into

required

string

sha

required

string

Example^generated

{
  "branch": "example",
  "into": "example",
  "sha": "example"
}

401

Unauthorized

application/json

object

_tag

required

string

Allowed values: Unauthorized

message

required

string

Example

{
  "_tag": "Unauthorized"
}

404

ProjectNotFound | BranchNotFound

application/json

Any of:

object
object

object

_tag

required

string

Allowed values: ProjectNotFound

project

required

string

Example

{
  "_tag": "ProjectNotFound"
}

409

application/json

Any of:

object

_tag

required

string

Allowed values: BranchBehind

branch

required

string

base

required

string

Example

{
  "_tag": "BranchBehind"
}

Land a branch

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Examplegenerated

Responses

200

Examplegenerated

401

Example

404

Example

409

Example

Request Body^required

Example^generated

Example^generated