List Members

API Reference

GPU Droplets

Autoscale

List members

get/v2/droplets/autoscale/{autoscale_pool_id}/members

To list the Droplets in an autoscale pool, send a GET request to /v2/droplets/autoscale/$AUTOSCALE_POOL_ID/members.

The response body will be a JSON object with a key of droplets. This will be set to an array containing information about each of the Droplets in the autoscale pool.

Path ParametersExpand Collapse

autoscale_pool_id: string

Query ParametersExpand Collapse

page: optional number

Which 'page' of paginated results to return.

minimum1

per_page: optional number

Number of items returned per page

minimum1

maximum200

ReturnsExpand Collapse

meta: MetaProperties

Information about the response itself.

droplets: optional array of object { created_at, current_utilization, droplet_id, 3 more }

created_at: string

The creation time of the Droplet in ISO8601 combined date and time format.

formatdate-time

current_utilization: object { cpu, memory }

cpu: optional number

The CPU utilization average of the individual Droplet.

formatfloat

memory: optional number

The memory utilization average of the individual Droplet.

formatfloat

droplet_id: number

The unique identifier of the Droplet.

health_status: string

The health status of the Droplet.

status: "provisioning" or "active" or "deleting" or "off"

The power status of the Droplet.

Accepts one of the following:

"provisioning"

"active"

"deleting"

"off"

updated_at: string

The last updated time of the Droplet in ISO8601 combined date and time format.

formatdate-time

links: optional PageLinks

HTTPPython

curl https://api.digitalocean.com/v2/droplets/autoscale/$AUTOSCALE_POOL_ID/members \
    -H "Authorization: Bearer $DIGITALOCEAN_ACCESS_TOKEN"

200 example

{
  "droplets": [
    {
      "droplet_id": 123456,
      "created_at": "2020-11-19T20:27:18Z",
      "updated_at": "2020-12-01T00:42:16Z",
      "health_status": "healthy",
      "status": "active",
      "current_utilization": {
        "memory": 0.3588531587713522,
        "cpu": 0.0007338008770232183
      }
    }
  ],
  "links": {
    "pages": null
  },
  "meta": {
    "total": 1
  }
}

Returns Examples

200 example

{
  "droplets": [
    {
      "droplet_id": 123456,
      "created_at": "2020-11-19T20:27:18Z",
      "updated_at": "2020-12-01T00:42:16Z",
      "health_status": "healthy",
      "status": "active",
      "current_utilization": {
        "memory": 0.3588531587713522,
        "cpu": 0.0007338008770232183
      }
    }
  ],
  "links": {
    "pages": null
  },
  "meta": {
    "total": 1
  }
}