Skip to content

Upsert Scaling Policy

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

Creates or updates a target tracking scaling policy for the environment. Specify the metric type and target value. If a policy with the same metric or name exists, it will be updated. Optionally, provide a custom policy name via query.

Authorizations

Parameters

Path Parameters

organisation
required
string
application
required
string
environment
required
string

Query Parameters

policyName
string

Optional. Specify a custom policy name to upsert.

Request Body required

object
metric
required

Metric to track for scaling.

string
Allowed values: CPUUtilization MemoryUtilization RPS
targetValue
required

Target value. Percentage for CPU/Memory; req/sec per task for RPS.

number format: double
75
scaleInCooldownSeconds

Cooldown (seconds) before another scale-in can start.

integer
default: 300
scaleOutCooldownSeconds

Cooldown (seconds) before another scale-out can start.

integer
default: 60

Responses

200

Scaling policy created or updated successfully.

object
metric
string
Allowed values: CPUUtilization MemoryUtilization RPS
targetValue
number format: double
scaleInCooldownSeconds
integer
scaleOutCooldownSeconds
integer
policyName

Name of the underlying Application Auto Scaling policy.

string
resourceLabel

ALB ResourceLabel for RPS policies (target group identifier).

string
nullable