Get a branch's state

GET

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

curl --request GET \
  --url 'https://api-dev.wrktr.com/api/orgs/example/projects/example/branches/state?branch=example' \
  --header 'Authorization: Bearer <token>'

Whether it’s an experiment or set to land when ready, other branches changing the same files, and its landing once it has landed.

Authorizations

• bearer
• None

Parameters

Path Parameters

org

required

string

project

required

string

Query Parameters

branch

required

string

Responses

200

BranchState

Media typeapplication/json

object

branch

required

string

experiment

required

boolean

autoLand

required

Any of:

object

object

by

required

string

since

required

Any of:

number

number

string

string

Allowed values: Infinity -Infinity NaN

waiting

required

Any of:

string

string

null

null

null

null

overlaps

required

Array<object>

object

branch

required

string

paths

required

Array<string>

landing

required

Any of:

object

object

sha

required

string

branch

required

Any of:

string

string

null

null

title

required

string

landedBy

required

string

landedAt

required

Any of:

number

number

string

string

Allowed values: Infinity -Infinity NaN

null

null

Example

{
  "autoLand": {
    "since": "Infinity"
  },
  "landing": {
    "landedAt": "Infinity"
  }
}

401

Unauthorized

Media typeapplication/json

object

_tag

required

string

Allowed values: Unauthorized

message

required

string

Example

{
  "_tag": "Unauthorized"
}

404

ProjectNotFound | BranchNotFound

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ProjectNotFound

project

required

string

object

object

_tag

required

string

Allowed values: BranchNotFound

project

required

string

branch

required

string

Example

{
  "_tag": "ProjectNotFound"
}