Give Feedback

droplet_autoscale_pools_info

Generated on 11 Feb 2026 from digitalocean.cloud version v1.2.1

Synopsis

List all Droplet Autoscale Pools on your account. Droplet Autoscale Pools allow you to automatically scale the number of Droplets in a pool based on resource utilization or scheduled times. View the API documentation at https://docs.digitalocean.com/reference/api/api-reference/#tag/Droplet-Autoscale-Pools.

Requirements

pydo >= 0.1.3
azure-core >= 1.26.1

Parameters

Parameter	Choices / Default	Description
`client_override_options` dict		Client override options (developer use). For example, can be used to override the DigitalOcean API endpoint for an internal test suite. If provided, these options will knock out existing options.
`module_override_options` dict		Module override options (developer use). Can be used to override module options to support experimental or future options. If provided, these options will knock out existing options.
`state` str	Choices: `present` (default) `absent`	State of the resource, `present` to create, `absent` to destroy.
`timeout` int	Default: `300`	Polling timeout in seconds.
`token` str		DigitalOcean API token. There are several environment variables which can be used to provide this value. `DIGITALOCEAN_ACCESS_TOKEN`, `DIGITALOCEAN_TOKEN`, `DO_API_TOKEN`, `DO_API_KEY`, `DO_OAUTH_TOKEN` and `OAUTH_TOKEN`

Examples

- name: Get Droplet Autoscale Pools
  digitalocean.cloud.droplet_autoscale_pools_info:
    token: "{{ token }}"

Return Values

Key Returned Description

Key	Returned	Description
`droplet_autoscale_pools` list	always	Droplet Autoscale Pools. Sample: `[ { "config": { "cooldown_minutes": 5, "max_instances": 10, "min_instances": 1, "target_cpu_utilization": 0.7 }, "created_at": "2020-03-13T19:20:47.442049222Z", "current_utilization": { "cpu": 0.45, "memory": 0.32 }, "droplet_template": { "image": "ubuntu-22-04-x64", "region": "nyc1", "size": "s-1vcpu-1gb" }, "id": "5a4981aa-9653-4bd1-bef5-d6bff52042e4", "name": "my-autoscale-pool", "status": "active" } ]`
`error` dict	failure	DigitalOcean API error. Sample: `{ "Message": "Informational error message.", "Reason": "Unauthorized", "Status Code": 401 }`
`msg` str	always	Droplet Autoscale Pools result information. Sample: `[ "Current Droplet Autoscale Pools", "No Droplet Autoscale Pools" ]`

droplet_autoscale_pools
list

always

Droplet Autoscale Pools.
Sample:

[
  {
    "config": {
      "cooldown_minutes": 5,
      "max_instances": 10,
      "min_instances": 1,
      "target_cpu_utilization": 0.7
    },
    "created_at": "2020-03-13T19:20:47.442049222Z",
    "current_utilization": {
      "cpu": 0.45,
      "memory": 0.32
    },
    "droplet_template": {
      "image": "ubuntu-22-04-x64",
      "region": "nyc1",
      "size": "s-1vcpu-1gb"
    },
    "id": "5a4981aa-9653-4bd1-bef5-d6bff52042e4",
    "name": "my-autoscale-pool",
    "status": "active"
  }
]

error
dict

failure

DigitalOcean API error.
Sample:

{
  "Message": "Informational error message.",
  "Reason": "Unauthorized",
  "Status Code": 401
}

msg
str