Skip to content
QuantCDN

Update Environment Compose Definition

PUT
/api/v3/organizations/{organisation}/applications/{application}/environments/{environment}

Replaces the entire task definition for the environment based on the provided multi-container compose definition. This will create a new task definition revision and update the ECS service, triggering a redeployment. Optionally accepts minCapacity and maxCapacity at the root level for convenience.

Authorizations

Parameters

Path Parameters

organisation
required
string

The organisation ID

application
required
string

The application ID

environment
required
string

The environment ID

Request Body required

object
composeDefinition
required
object
containers
Array<object>
object
name
required

Name of the container

string
/^[a-zA-Z0-9_-]+$/
imageReference
required
object
type
required

Specifies whether the image is internal (ECR) or external (e.g., Docker Hub)

string
Allowed values: internal external
identifier
required

The image identifier. For ‘internal’ type, this is the image tag. For ‘external’ type, this is the full image name.

string
cpu

Container-level CPU units

integer
nullable
memory

Container-level memory hard limit (MiB)

integer
nullable
memoryReservation

Container-level memory soft limit (MiB)

integer
nullable
exposedPorts

List of container ports to expose

Array<integer>
nullable
mountPoints
Array<object>
nullable
object
sourceVolume
required

The name of the logical volume

string
containerPath
required

The path inside the container where the volume is mounted

string
readOnly
boolean
environment

Environment variables specific to this container

Array<object>
nullable
object
name
required

Environment variable name

string
value
required

Environment variable value

string
secrets

Secrets mapped to environment variables

Array<object>
nullable
object
name
required

The environment variable name to be set in the container

string
valueFrom
required

The key of the secret in the environment’s ‘app-secrets’ store

string
healthCheck

Container health check configuration

object
command

The command to run to determine if the container is healthy

Array<string>
interval

Time period (seconds) between health checks

integer
default: 30 >= 5 <= 300
timeout

Time period (seconds) to wait for a health check to return

integer
default: 5 >= 2 <= 60
retries

Number of times to retry a failed health check

integer
default: 3 >= 1 <= 10
startPeriod

Grace period (seconds) to ignore unhealthy checks after container starts

integer
nullable <= 300
dependsOn

Container startup dependencies

Array<object>
nullable
object
containerName
required

The name of the container this container depends on

string
condition

The condition to wait for on the dependency

string
Allowed values: START HEALTHY COMPLETE SUCCESS
command
Array<string>
nullable
entryPoint
Array<string>
nullable
workingDirectory
string
nullable
essential
boolean
default: true nullable
readonlyRootFilesystem
boolean
nullable
user
string
nullable
originProtection

Enable origin protection for all exposed ports on this container

boolean
nullable
architecture
string
taskCpu
integer
taskMemory
integer
taskRoleArn
string
minCapacity
integer
maxCapacity
integer
minCapacity

Optional. Minimum number of tasks for auto-scaling. If provided at root level, will be merged into composeDefinition.

integer
nullable
maxCapacity

Optional. Maximum number of tasks for auto-scaling. If provided at root level, will be merged into composeDefinition.

integer
nullable >= 1

Responses

202

Request accepted, compose definition update is processing.

400

Invalid compose definition or validation failed.

object
message
string
errors
object

404

Application or environment not found