Skip to content
QuantCDN

Partially Update Environment Compose Definition

PATCH
/api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/compose

Partially updates top-level fields of the environment’s compose definition, such as architecture, task-level CPU/Memory, or min/max scaling capacity. Only fields included in the request body are modified. The ‘containers’ array, if provided, REPLACES the existing containers array; if omitted, the existing containers are NOT modified by this PATCH operation. (For modifying individual containers, use PATCH /containers/{containerName}). This triggers a validation, registers a new task definition, and updates the service.

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

Partial compose definition updates. All fields are optional.

object
architecture
string
nullable
taskCpu
string
nullable
taskMemory
string
nullable
minCapacity
integer
nullable
maxCapacity
integer
nullable >= 1
containers
Array<object>
nullable
object
spotConfiguration
object
strategy
string
Allowed values: off spot-only mixed-safe mixed-aggressive
enableCrossEnvNetworking
boolean
nullable
enableCrossAppNetworking
boolean
nullable

Responses

202

Request accepted, compose definition partial update is processing. Returns the full updated compose definition.

object
architecture
string
ARM64
taskCpu
string
512
taskMemory
string
2048
minCapacity
integer
1
maxCapacity
integer
1
containers
Array<object>
object
spotConfiguration
object
strategy
string
off
tolerateDowntime
boolean
true
enableCrossEnvNetworking
boolean
true
enableCrossAppNetworking
boolean
true

400

Invalid compose definition or validation failed.

object
message
string
errors
object

404

Application or environment not found