Skip to main content

Get Auto Scaling Group Details

Returns the full configuration and live node list for a single auto scaling group, including the elastic and scheduled policy detail and every currently running node (id, private/public IP, status). Use the group id returned by List.

GET/api/v1/scaler/scalegroups/{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 request.

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

    Region of the group.

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

Responses

200Successful response
object

Full configuration and live node list for one auto scaling group.

codeinteger
example200
dataobject
errorsobject
messagestring
exampleSuccess