List environments

GET

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

const url = 'https://api.wrktr.com/api/orgs/example/projects/example/environments';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

curl --request GET \
  --url https://api.wrktr.com/api/orgs/example/projects/example/environments \
  --header 'Authorization: Bearer <token>'

As the default branch’s wrktr.json declares them: what’s live in each, what’s running, and what a promotion would ship.

Authorizations

bearer
None

Parameters

Path Parameters

org

required

string

project

required

string

Responses

200

EnvironmentsView

application/json

object

environments

required

Array<object>

object

name

required

string

required

string

Allowed values: land promote

from

required

Any of:

string
null

string

url

required

Any of:

string
null

string

verify

Any of:

object
null

Any of:

object
null

object

check

required

Any of:

string
null

string

setUp

Any of:

boolean
null

boolean

needs

Any of:

Array<string>
null

Array<string>

changed

required

Array<string>

steps

required

Array<string>

secrets

required

Array<string>

live

required

Any of:

object
null

object

required

string

environment

required

string

number

required

Any of:

number
string

number

commit

required

string

title

required

string

branch

required

Any of:

string
null

string

trigger

required

string

Allowed values: land promote rollback rerun

required

Any of:

string
null

string

createdAt

required

Any of:

number
string

number

startedAt

required

Any of:

unknown
null

Any of:

number
string

number

finishedAt

required

Any of:

unknown
null

Any of:

number
string

number

state

required

string

Allowed values: queued running passed failed error cancelled

message

required

Any of:

string
null

string

base

required

Any of:

string
null

string

steps

required

Array<object>

object

name

required

string

run

required

string

state

required

string

Allowed values: pending running passed failed error skipped cancelled

startedAt

required

Any of:

unknown
null

Any of:

number
string

number

finishedAt

required

Any of:

unknown
null

Any of:

number
string

number

exitCode

required

Any of:

unknown
null

Any of:

number
string

number

tail

required

string

hasLog

required

boolean

verify

Any of:

object
null

Any of:

object
null

object

state

required

string

Allowed values: checking serving not-serving unverified

checkedAt

required

Any of:

unknown
null

Any of:

number
string

number

seen

required

Any of:

string
null

string

message

required

Any of:

string
null

string

workers

Any of:

Array<object>
null

Array<object>

object

version

required

string

compatibilityDate

required

Any of:

string
null

string

active

required

Any of:

object
null

object

required

string

environment

required

string

number

required

Any of:

number
string

number

commit

required

string

title

required

string

branch

required

Any of:

string
null

string

trigger

required

string

Allowed values: land promote rollback rerun

required

Any of:

string
null

string

createdAt

required

Any of:

number
string

number

startedAt

required

Any of:

unknown
null

Any of:

number
string

number

finishedAt

required

Any of:

unknown
null

Any of:

number
string

number

state

required

string

Allowed values: queued running passed failed error cancelled

message

required

Any of:

string
null

string

base

required

Any of:

string
null

string

steps

required

Array<object>

object

name

required

string

run

required

string

state

required

string

Allowed values: pending running passed failed error skipped cancelled

startedAt

required

Any of:

unknown
null

Any of:

number
string

number

finishedAt

required

Any of:

unknown
null

Any of:

number
string

number

exitCode

required

Any of:

unknown
null

Any of:

number
string

number

tail

required

string

hasLog

required

boolean

verify

Any of:

object
null

Any of:

object
null

object

state

required

string

Allowed values: checking serving not-serving unverified

checkedAt

required

Any of:

unknown
null

Any of:

number
string

number

seen

required

Any of:

string
null

string

message

required

Any of:

string
null

string

workers

Any of:

Array<object>
null

Array<object>

object

version

required

string

compatibilityDate

required

Any of:

string
null

string

latest

required

Any of:

object
null

object

required

string

environment

required

string

number

required

Any of:

number
string

number

commit

required

string

title

required

string

branch

required

Any of:

string
null

string

trigger

required

string

Allowed values: land promote rollback rerun

required

Any of:

string
null

string

createdAt

required

Any of:

number
string

number

startedAt

required

Any of:

unknown
null

Any of:

number
string

number

finishedAt

required

Any of:

unknown
null

Any of:

number
string

number

state

required

string

Allowed values: queued running passed failed error cancelled

message

required

Any of:

string
null

string

base

required

Any of:

string
null

string

steps

required

Array<object>

object

name

required

string

run

required

string

state

required

string

Allowed values: pending running passed failed error skipped cancelled

startedAt

required

Any of:

unknown
null

Any of:

number
string

number

finishedAt

required

Any of:

unknown
null

Any of:

number
string

number

exitCode

required

Any of:

unknown
null

Any of:

number
string

number

tail

required

string

hasLog

required

boolean

verify

Any of:

object
null

Any of:

object
null

object

state

required

string

Allowed values: checking serving not-serving unverified

checkedAt

required

Any of:

unknown
null

Any of:

number
string

number

seen

required

Any of:

string
null

string

message

required

Any of:

string
null

string

workers

Any of:

Array<object>
null

Array<object>

object

version

required

string

compatibilityDate

required

Any of:

string
null

string

promotable

required

Any of:

object
null

object

commit

required

string

title

required

string

ships

required

Array<object>

object

sha

required

string

title

required

string

branch

required

Any of:

string
null

string

author

required

Any of:

string
null

string

required

Any of:

unknown
null

Any of:

number
string

number

behind

required

Any of:

number
string

number

problem

required

Any of:

string
null

string

recent

required

Array<object>

object

required

string

environment

required

string

number

required

Any of:

number
string

number

commit

required

string

title

required

string

branch

required

Any of:

string
null

string

trigger

required

string

Allowed values: land promote rollback rerun

required

Any of:

string
null

string

createdAt

required

Any of:

number
string

number

startedAt

required

Any of:

unknown
null

Any of:

number
string

number

finishedAt

required

Any of:

unknown
null

Any of:

number
string

number

state

required

string

Allowed values: queued running passed failed error cancelled

message

required

Any of:

string
null

string

base

required

Any of:

string
null

string

steps

required

Array<object>

object

name

required

string

run

required

string

state

required

string

Allowed values: pending running passed failed error skipped cancelled

startedAt

required

Any of:

unknown
null

Any of:

number
string

number

finishedAt

required

Any of:

unknown
null

Any of:

number
string

number

exitCode

required

Any of:

unknown
null

Any of:

number
string

number

tail

required

string

hasLog

required

boolean

verify

Any of:

object
null

Any of:

object
null

object

state

required

string

Allowed values: checking serving not-serving unverified

checkedAt

required

Any of:

unknown
null

Any of:

number
string

number

seen

required

Any of:

string
null

string

message

required

Any of:

string
null

string

workers

Any of:

Array<object>
null

Array<object>

object

version

required

string

compatibilityDate

required

Any of:

string
null

string

defaultBranch

required

string

head

required

Any of:

object
null

object

sha

required

string

title

required

string

branch

required

Any of:

string
null

string

author

required

Any of:

string
null

string

required

Any of:

unknown
null

Any of:

number
string

number

Example

{
  "environments": [
    {
      "on": "land",
      "live": {
        "number": "Infinity",
        "trigger": "land",
        "createdAt": "Infinity",
        "startedAt": "Infinity",
        "finishedAt": "Infinity",
        "state": "queued",
        "steps": [
          {
            "state": "pending",
            "startedAt": "Infinity",
            "finishedAt": "Infinity",
            "exitCode": "Infinity"
          }
        ],
        "verify": {
          "state": "checking",
          "checkedAt": "Infinity"
        }
      },
      "active": {
        "number": "Infinity",
        "trigger": "land",
        "createdAt": "Infinity",
        "startedAt": "Infinity",
        "finishedAt": "Infinity",
        "state": "queued",
        "steps": [
          {
            "state": "pending",
            "startedAt": "Infinity",
            "finishedAt": "Infinity",
            "exitCode": "Infinity"
          }
        ],
        "verify": {
          "state": "checking",
          "checkedAt": "Infinity"
        }
      },
      "latest": {
        "number": "Infinity",
        "trigger": "land",
        "createdAt": "Infinity",
        "startedAt": "Infinity",
        "finishedAt": "Infinity",
        "state": "queued",
        "steps": [
          {
            "state": "pending",
            "startedAt": "Infinity",
            "finishedAt": "Infinity",
            "exitCode": "Infinity"
          }
        ],
        "verify": {
          "state": "checking",
          "checkedAt": "Infinity"
        }
      },
      "ships": [
        {
          "at": "Infinity"
        }
      ],
      "behind": "Infinity"
    }
  ],
  "recent": [
    {
      "number": "Infinity",
      "trigger": "land",
      "createdAt": "Infinity",
      "startedAt": "Infinity",
      "finishedAt": "Infinity",
      "state": "queued",
      "steps": [
        {
          "state": "pending",
          "startedAt": "Infinity",
          "finishedAt": "Infinity",
          "exitCode": "Infinity"
        }
      ],
      "verify": {
        "state": "checking",
        "checkedAt": "Infinity"
      }
    }
  ],
  "head": {
    "at": "Infinity"
  }
}

401

Unauthorized

application/json

object

_tag

required

string

Allowed values: Unauthorized

message

required

string

Example

{
  "_tag": "Unauthorized"
}

404

ProjectNotFound

application/json

object

_tag

required

string

Allowed values: ProjectNotFound

project

required

string

Example

{
  "_tag": "ProjectNotFound"
}