Give Feedback

pydo.autoscalepools.list()

Generated on 8 May 2026 from pydo version v0.34.0

Copy page as Markdown View page as Markdown

Usage

client.autoscalepools.list(
    per_page=20,
    page=1,
    name=None,
)

Returns JSONRaises HttpResponseError

Description

To list all autoscale pools in your team, send a GET request to /v2/droplets/autoscale. The response body will be a JSON object with a key of autoscale_pools containing an array of autoscale pool objects. These each contain the standard autoscale pool attributes.

Parameters

per_page integer optional

Number of items returned per page

Min: 1

Max: 200

Default: 20

page integer optional

Which 'page' of paginated results to return.

Min: 1

Default: 1

name string optional

The name of the autoscale pool

Pagination

This method returns paginated results. The response includes a links.pages object with URLs for navigating between pages. To retrieve the next page, parse the next URL and pass the page parameter:

from urllib.parse import urlparse, parse_qs

resp = client.autoscalepools.list()
pages = resp.get("links", {}).get("pages", {})

while "next" in pages:
    parsed = urlparse(pages["next"])
    page = int(parse_qs(parsed.query)["page"][0])
    resp = client.autoscalepools.list(page=page)
    pages = resp.get("links", {}).get("pages", {})

Response Example

Show Response Example

{
  "autoscale_pools": [
    {
      "id": "0d3db13e-a604-4944-9827-7ec2642d32ac",
      "name": "test-autoscaler-group-01",
      "config": {
        "min_instances": 1,
        "max_instances": 5,
        "target_cpu_utilization": 0.5,
        "cooldown_minutes": 10
      },
      "droplet_template": {
        "name": "droplet-name",
        "size": "c-2",
        "region": "tor1",
        "image": "ubuntu-20-04-x64",
        "tags": [
          "my-tag"
        ],
        "ssh_keys": [
          "3b:16:e4:bf:8b:00:8b:b8:59:8c:a9:d3:f0:19:fa:45"
        ],
        "vpc_uuid": "760e09ef-dc84-11e8-981e-3cfdfeaae000",
        "with_droplet_agent": true,
        "project_id": "746c6152-2fa2-11ed-92d3-27aaa54e4988",
        "public_networking": true,
        "ipv6": true,
        "user_data": "#cloud-config\nruncmd:\n  - touch /test.txt\n"
      },
      "created_at": "2020-11-19T20:27:18Z",
      "updated_at": "2020-12-01T00:42:16Z",
      "current_utilization": {
        "memory": 0.3588531587713522,
        "cpu": 0.0007338008770232183
      },
      "status": "active",
      "active_resources_count": 1
    }
  ],
  "links": {
    "pages": null
  },
  "meta": {
    "total": 1
  }
}

More Information

See /v2/droplets/autoscale in the API reference for additional detail on responses, headers, parameters, and more.