Skip to main content

List Auto Scaling Groups

Returns a paginated list of the auto scaling groups in the project. Each entry summarises the group's configuration (plan, image, min/max nodes, elastic and scheduled policy, encryption flag) and its current provision_status and running/desired node counts. Use page_no and per_page to page through results; total_count and total_page_number are returned at the top level.

GET/api/v1/scaler/scalegroups

Query parameters

  • page_noQueryintegeroptional

    1-based page number to retrieve.

    • optional
    • positive integer
    • defaults to 1 when omitted
    example1
  • per_pageQueryintegeroptional

    Number of groups to return per page.

    • optional
    • positive integer
    • defaults to 5 when omitted
    example5
  • 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 to filter groups by.

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

Responses

200Successful response
object

Paginated list of auto scaling groups.

codeinteger
example200
dataarray
errorsobject
messagestring
exampleSuccess
total_page_numberinteger
example1
total_countinteger
example2