Partially Update Environment Compose Definition

PATCH

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

curl --request PATCH \
  --url https://dashboard.quantcdn.io/api/v3/organizations/test-org/applications/test-app/environments/test-env/compose \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "architecture": "example", "taskCpu": "example", "taskMemory": "example", "minCapacity": 1, "maxCapacity": 1, "containers": [ {} ], "spotConfiguration": { "strategy": "off" }, "enableCrossEnvNetworking": true, "enableCrossAppNetworking": true }'

• QuantCDN Public Cloud
• QuantGov Cloud

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

• BearerAuth

Parameters

Path Parameters

organisation

required

string

The organisation ID

Example

test-org

application

required

string

The application ID

Example

test-app

environment

required

string

The environment ID

Example

test-env

Request Body^required

Partial compose definition updates. All fields are optional.

Media typeapplication/json

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.

Media typeapplication/json

object

architecture

string

taskCpu

string

taskMemory

string

minCapacity

integer

maxCapacity

integer

containers

Array<object>

object

spotConfiguration

object

strategy

string

tolerateDowntime

boolean

enableCrossEnvNetworking

boolean

enableCrossAppNetworking

boolean

Example

{
  "architecture": "ARM64",
  "taskCpu": "512",
  "taskMemory": "2048",
  "minCapacity": 1,
  "maxCapacity": 1,
  "spotConfiguration": {
    "strategy": "off",
    "tolerateDowntime": true
  },
  "enableCrossEnvNetworking": true,
  "enableCrossAppNetworking": true
}

400

Invalid compose definition or validation failed.

Media typeapplication/json

object

message

string

errors

object

Example^generated

{
  "message": "example",
  "errors": {}
}

404

Application or environment not found