Skip to content
GitHub

Return an app to an earlier release now, past approvals, a freeze, the scan gate and a pause. People with approval rights only; the reason is kept.

POST
/api/v1/projects/{project}/environments/{environment}/apps/{app}/emergency-rollback
curl --request POST \
--url https://example.com/api/v1/projects/example/environments/example/apps/example/emergency-rollback \
--header 'Content-Type: application/json' \
--data '{ "reason": "example", "release": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'
project
required
string

Project name

environment
required
string

Environment short name

app
required
string

App name

Media typeapplication/json
object
reason
required

Why this cannot wait; kept on the run and in the audit log.

string
release

The release to return to; the newest earlier release that ran successfully when omitted.

string | null format: uuid
Examplegenerated
{
"reason": "example",
"release": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}
Media typeapplication/json

A deployment run and where it stands.

object
run
required
string format: uuid
operation
required
string format: uuid
generation
required

The target generation this run owns.

integer format: int64
phase
required

planned, awaitingApproval, pendingDelivery, acceptedByCluster, applying, succeeded, failed, superseded, cancelled, …

string
approvals_required

Distinct approvals the environment’s policy requires before delivery.

integer format: int32
approval_expires_at

When a run waiting for approval is cancelled (Unix milliseconds).

integer | null format: int64
plan_hash

The hash approvers confirm (hex), when approvals are required.

string | null
warnings

What admission could not check, e.g. that the pods will be scheduled.

Array<string>
Examplegenerated
{
"run": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"operation": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"generation": 1,
"phase": "example",
"approvals_required": 1,
"approval_expires_at": 1,
"plan_hash": "example",
"warnings": [
"example"
]
}
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"
}

No earlier release ran successfully

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"
}
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"
}