v8

latestOpenAPI 3.0.0Apache 2.0raw.githubusercontent.com2025-10-165266542.4 MB
DigitalOcean-public.v2-new_Droplet Autoscale Pools

List All Autoscale Pools

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.

get/v2/droplets/autoscale

Query parameters

per_pageinteger

Number of items returned per page

pageinteger

Which 'page' of paginated results to return.

namestring

The name of the autoscale pool

Response

A JSON object with a key of autoscale_pools.

Example response

{
  "autoscale_pools": [
    {
      "id": "0d3db13e-a604-4944-9827-7ec2642d32ac",
      "name": "my-autoscale-pool",
      "config": {
        "target_number_instances": 3
      },
      "droplet_template": {
        "name": "my-droplet-name",
        "region": "tor1",
        "size": "c-2",
        "image": "ubuntu-20-04-x64",
        "ssh_keys": [
          "88:66:90:d2:68:d5:b5:85:e3:26:26:11:31:57:e6:f8"
        ],
        "tags": [
          "my-tag"
        ],
        "vpc_uuid": "760e09ef-dc84-11e8-981e-3cfdfeaae000",
        "with_droplet_agent": true,
        "project_id": "746c6152-2fa2-11ed-92d3-27aaa54e4988",
        "ipv6": true,
        "user_data": "#cloud-config\nruncmd:\n  - touch /test.txt\n"
      },
      "current_utilization": {
        "memory": 0.3588531587713522,
        "cpu": 0.0007338008770232183
      },
      "created_at": "2020-07-28T18:00:00Z",
      "updated_at": "2020-07-28T18:00:00Z",
      "status": "active",
      "active_resources_count": 1
    }
  ],
  "links": {
    "pages": {
      "last": "https://api.digitalocean.com/v2/images?page=2",
      "next": "https://api.digitalocean.com/v2/images?page=2"
    }
  },
  "meta": {
    "total": 1
  }
}