Skip to content
GitHub

The app's newest deployment runs, each with its timeline.

GET
/api/v1/projects/{project}/environments/{environment}/apps/{app}/deployments
curl --request GET \
  --url https://example.com/api/v1/projects/example/environments/example/apps/example/deployments

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
project
required
string

Project name

environment
required
string

Environment short name

app
required
string

App name

Query Parameters

Section titled “Query Parameters”
limit
integer format: int64

How many runs, newest first (1–50, default 10).

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
Array<object>

A deployment run with how it went.

object
run
required
string format: uuid
generation
required

The target generation (the app’s revision) this run owns.

integer format: int64
reason
required

deploy, rollback, promotion, restart, handover, build or rotation.

string
phase
required
string
outcome

succeeded, failed or cancelled once it ended.

string | null
requested_by
required

Email of whoever asked for it.

string
created_at
required
integer format: int64
image
string | null
timeline
required

Every phase it entered, oldest first.

Array<object>

One step of a run’s timeline.

object
phase
required
string
at
required

When the run entered it, Unix milliseconds.

integer format: int64
Examplegenerated
[
  {
    "run": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "generation": 1,
    "reason": "example",
    "phase": "example",
    "outcome": "example",
    "requested_by": "example",
    "created_at": 1,
    "image": "example",
    "timeline": [
      {
        "phase": "example",
        "at": 1
      }
    ]
  }
]

403

Section titled “403”
Media typeapplication/json

Problem Details body.

object
code
required

Stable machine-readable code, e.g. forbidden.

string
title
required

Short human readable title.

string
status
required

HTTP status.

integer format: int32
detail

Details, if safe to expose.

string | null
Example
{
  "code": "forbidden"
}

404

Section titled “404”
Media typeapplication/json

Problem Details body.

object
code
required

Stable machine-readable code, e.g. forbidden.

string
title
required

Short human readable title.

string
status
required

HTTP status.

integer format: int32
detail

Details, if safe to expose.

string | null
Example
{
  "code": "forbidden"
}