List Scaling Policies

GET

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

const url = 'https://dashboard.quantcdn.io/api/v3/organizations/example/applications/example/environments/example/scaling-policies?metric=CPUUtilization';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://dashboard.quantcdn.io/api/v3/organizations/example/applications/example/environments/example/scaling-policies?metric=CPUUtilization' \
  --header 'Authorization: Bearer <token>'

Retrieves all active target tracking scaling policies for the environment. Returns an array of policies, each with its metric, target value, cooldowns, and resource label (if applicable).

Authorizations

BearerAuth

Parameters

Path Parameters

organisation

required

string

application

required

string

environment

required

string

Query Parameters

metric

string

Allowed values: CPUUtilization MemoryUtilization RPS

Optional. Filter policies by metric type.

policyName

string

Optional. Filter policies by exact policy name.

Responses

200

List of scaling policies for the environment.

application/json

object

policies

Array<object>

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

Example

{
  "policies": [
    {
      "metric": "CPUUtilization"
    }
  ]
}