droplets_info

Generated on 20 Jun 2025 from digitalocean.cloud version v1.2.1

Synopsis

List all Droplets in your account. View the API documentation at https://docs.digitalocean.com/reference/api/api-reference/#operation/droplets_list.

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.
name
str
Used to filter list response by Droplet name returning only exact matches It is case-insensitive and can not be combined with tag_name.
state
str
Choices:
  • present (default)
  • absent
State of the resource, present to create, absent to destroy.
tag_name
str
Used to filter Droplets by a specific tag. Cannot be combined with name.
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 Droplets
  digitalocean.cloud.droplets_info:
    token: "{{ token }}"

Return Values

KeyReturnedDescription
droplets
list
always Droplets.
Sample:
[
  {
    "backup_ids": [],
    "created_at": "2022-11-30T03:15:17Z",
    "disk": 25,
    "features": [
      "droplet_agent",
      "private_networking"
    ],
    "id": 328912829,
    "image": {
      "created_at": "2022-07-18T19:40:04Z",
      "description": "Ubuntu 20.04 x86",
      "distribution": "Ubuntu",
      "id": 112929454,
      "min_disk_size": 7,
      "name": "20.04 (LTS) x64",
      "public": true,
      "regions": [
        "nyc3",
        "..."
      ],
      "size_gigabytes": 0.63,
      "slug": "ubuntu-20-04-x64",
      "status": "available",
      "tags": [],
      "type": "base"
    },
    "kernel": null,
    "locked": false,
    "memory": 8192,
    "name": "test-droplet-1",
    "networks": {
      "v4": [
        {
          "gateway": "10.108.0.1",
          "ip_address": "10.108.0.2",
          "netmask": "255.255.240.0",
          "type": "private"
        },
        {
          "gateway": "159.65.240.1",
          "ip_address": "159.65.142.211",
          "netmask": "255.255.240.0",
          "type": "public"
        }
      ],
      "v6": []
    },
    "next_backup_window": null,
    "region": {
      "available": true,
      "features": [
        "backups",
        "ipv6",
        "metadata",
        "install_agent",
        "storage",
        "image_transfer"
      ],
      "name": "New York 3",
      "sizes": [
        "s-1vcpu-1gb",
        "..."
      ],
      "slug": "nyc3"
    },
    "size": {
      "available": true,
      "description": "General Purpose",
      "disk": 25,
      "memory": 8192,
      "price_hourly": 0.09375,
      "price_monthly": 63,
      "regions": [
        "ams3",
        "..."
      ],
      "slug": "g-2vcpu-8gb",
      "transfer": 4,
      "vcpus": 2
    },
    "size_slug": "g-2vcpu-8gb",
    "snapshot_ids": [],
    "status": "active",
    "tags": [],
    "vcpus": 2,
    "volume_ids": [],
    "vpc_uuid": "30f86d25-414e-434f-852d-993ed8d6815e"
  }
]
error
dict
failure DigitalOcean API error.
Sample:
{
  "Message": "Informational error message.",
  "Reason": "Unauthorized",
  "Status Code": 401
}
msg
str
always Droplets result information.
Sample:
[
  "Current Droplets",
  "No Droplets"
]

We can't find any results for your search.

Try using different keywords or simplifying your search terms.