Sign in
DigitalOcean-public.v2-new_Droplet Autoscale Pools

Update Autoscale Pool

To update the configuration of an existing autoscale pool, send a PUT request to /v2/droplets/autoscale/$AUTOSCALE_POOL_ID. The request must contain a full representation of the autoscale pool including existing attributes.

put/v2/droplets/autoscale/{autoscale_pool_id}

Path parameters

autoscale_pool_idstring required

A unique identifier for an autoscale pool.

Request body

namestring required

The human-readable name of the autoscale pool. This field cannot be updated

Example request

{
  "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"
  }
}

Response

Accepted

Example response

{
  "autoscale_pool": {
    "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
  }
}

Changes

Changed in 4 of the 8 revisions of this API.14