Get a branch's checks

GET

/api/orgs/{org}/projects/{project}/ci

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

The CI run for the head, or the latest run if the head hasn’t been checked yet.

Authorizations

• bearer
• None

Parameters

Path Parameters

org

required

string

project

required

string

Query Parameters

branch

required

string

Responses

200

BranchCi

Media typeapplication/json

object

branch

required

string

headSha

required

string

configured

required

boolean

run

required

Any of:

object

object

id

required

string

branch

required

string

head

required

string

status

required

string

Allowed values: queued running passed failed error cancelled invalid

message

required

Any of:

string

string

null

null

checks

required

Array<object>

object

name

required

string

status

required

string

Allowed values: queued running passed failed error cancelled

exitCode

required

Any of:

unknown

Any of:

number

number

string

string

Allowed values: Infinity -Infinity NaN

null

null

durationMs

required

Any of:

unknown

Any of:

number

number

string

string

Allowed values: Infinity -Infinity NaN

null

null

required

required

boolean

tail

required

string

hasLog

required

boolean

cached

required

boolean

retry

required

Any of:

object

object

attempt

required

Any of:

number

number

string

string

Allowed values: Infinity -Infinity NaN

attempts

required

Any of:

number

number

string

string

Allowed values: Infinity -Infinity NaN

reason

required

string

null

null

createdAt

required

Any of:

number

number

string

string

Allowed values: Infinity -Infinity NaN

startedAt

required

Any of:

unknown

Any of:

number

number

string

string

Allowed values: Infinity -Infinity NaN

null

null

finishedAt

required

Any of:

unknown

Any of:

number

number

string

string

Allowed values: Infinity -Infinity NaN

null

null

heartbeatAt

required

Any of:

unknown

Any of:

number

number

string

string

Allowed values: Infinity -Infinity NaN

null

null

null

null

Example

{
  "run": {
    "status": "queued",
    "checks": [
      {
        "status": "queued",
        "exitCode": "Infinity",
        "durationMs": "Infinity",
        "retry": {
          "attempt": "Infinity",
          "attempts": "Infinity"
        }
      }
    ],
    "createdAt": "Infinity",
    "startedAt": "Infinity",
    "finishedAt": "Infinity",
    "heartbeatAt": "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"
}