Skip to main content

Update Auto Scaling Group Configuration

Updates a group's configuration: its name, min_nodes / max_nodes, the backing plan_id, the policy_type, and the elastic (policy) and scheduled (scheduled_policy) rules. The same min/max and policy validation as Create applies (max_nodes <= 60, the scheduled-policy ordering rules, and at least one of policy / scheduled_policy). For a private cluster set is_private: true and omit plan_id.

PUT/api/v1/scaler/scalegroups/update/{scaler_id}/

Path parameters

  • scaler_idPathintegerrequired

    The id of the auto scaling group, as returned by List.

    • required
    • must be a valid auto scaling group ID
    example12345

Query parameters

  • project_idQueryintegerrequired

    Identifier of the project to scope the request to. Required integer project ID.

    • required
    • must be a valid integer project ID
    example{{project_id}}
  • apikeyQuerystringrequired

    API key used to authenticate the update request.

    • required
    • non-empty string
    example{{api_key}}
  • locationQuerystringrequired

    Region of the group being updated.

    • required
    • must be a valid region name (e.g., Delhi, Chennai)
    example{{location}}

Request body

application/json

object

Update payload for an auto scaling group's configuration and scaling policies. The same min/max and policy validation as create applies.

namestringrequired

Display name of the group.

exampleweb-autoscale-group
  • required
  • max length 40 characters
plan_idinteger

ID of the compute plan backing each node. Required when is_private is false.

example1088
  • required when is_private is false
is_privateboolean

Whether the group runs on a private cluster.

examplefalse
  • optional
  • defaults to false
min_nodesintegerrequired

Minimum number of running nodes.

example1
  • required
  • integer >= 0
max_nodesintegerrequired

Maximum number of running nodes.

example5
  • required
  • must not exceed 60 (MAX_NODES_PER_GROUP)
policy_typestringDefault | Custom

Whether the elastic policy uses a Default metric or a Custom parameter.

exampleDefault
policyarray

Elastic scaling rules (scale-up and scale-down). See Create for field detail.

scheduled_policyarray

Scheduled scaling rules (scale-up and scale-down). See Create for field detail.

Responses

200Successful response
object

Update confirmation.

codeinteger
example200
dataobject
errorsobject
messagestring
exampleservice updated sucessfully, service_name: web-autoscale-group