Promote the app to another environment of the same project.

POST

/api/v1/projects/{project}/environments/{environment}/apps/{app}/promote

curl --request POST \
  --url https://example.com/api/v1/projects/example/environments/example/apps/example/promote \
  --header 'Content-Type: application/json' \
  --data '{ "to_environment": "production", "dry_run": true }'

Parameters

Path Parameters

project

required

string

Project name

environment

required

string

Environment short name (source)

app

required

string

App name

Request Body^required

Media typeapplication/json

object

to_environment

required

Target environment (short name) in the same project.

string

Example

production

dry_run

Only report what would change.

boolean

Responses

200

Media typeapplication/json

object

dry_run

required

boolean

created

required

The app did not exist in the target and was (or would be) created.

boolean

changes

required

Human-readable diff; values of environment variables are never shown.

Array<string>

warnings

required

E.g. secrets referenced by the app that are missing in the target.

Array<string>

app

One of:

null

null

object

object

name

required

string

project

required

string

environment

required

Environment short name.

string

namespace

required

string

image

string | null

git_repo

string | null

url

string | null

ready

required

boolean

reason

Available, Progressing, RolloutFailed, Scheduled, AwaitingBuild, …

string | null

message

string | null

processes

required

Array<object>

object

name

required

string

command

required

Array<string>

port

integer | null format: int32

size

required

string

min_replicas

required

integer format: int32

max_replicas

required

integer format: int32

schedule

Cron expression of scheduled processes.

string | null

protocol

required

http or tcp.

string

env

required

Values are only included in the app detail, for callers allowed to read secrets.

Array<object>

Environment variable: a plain value or a secret reference.

object

name

required

string

value

string | null

secret

One of:

null

null

object

object

name

required

string

key

required

string

domains

required

Array<string>

volumes

required

Array<object>

Persistent volume (kept when the app is deleted, unless requested).

object

name

required

string

mount_path

required

string

size

Capacity such as 5Gi. Can grow, never shrink.

string

created_at

string | null

Example

{
  "app": {
    "env": [
      {
        "name": "LOG_LEVEL"
      }
    ],
    "volumes": [
      {
        "name": "data",
        "mount_path": "/data",
        "size": "5Gi"
      }
    ]
  }
}

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

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

422

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