PUT /v2/droplets/autoscale/{autoscale_pool_id}
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.
Servers
- https://api.digitalocean.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
autoscale_pool_id |
String | Yes |
A unique identifier for an autoscale pool. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
droplet_template |
Object | Yes | |
droplet_template.vpc_uuid |
String | No |
The VPC where the Droplets in the autoscale pool will be created. The VPC must be in the region where you want to create the Droplets. |
droplet_template.region |
String | Yes |
The datacenter in which all of the Droplets will be created. Possible values:
|
droplet_template.project_id |
String | No |
The project that the Droplets in the autoscale pool will belong to. |
droplet_template.name |
String | No |
The name(s) to be applied to all Droplets in the autoscale pool. |
droplet_template.size |
String | Yes |
The Droplet size to be used for all Droplets in the autoscale pool. |
droplet_template.user_data |
String | No |
A string containing user data that cloud-init consumes to configure a Droplet on first boot. User data is often a cloud-config file or Bash script. It must be plain text and may not exceed 64 KiB in size. |
droplet_template.ssh_keys[] |
Array | Yes |
The SSH keys to be installed on the Droplets in the autoscale pool. You can either specify the key ID or the fingerprint. |
droplet_template.tags[] |
Array | No |
The tags to apply to each of the Droplets in the autoscale pool. |
droplet_template.with_droplet_agent |
Boolean | No |
Installs the Droplet agent. This must be set to true to monitor Droplets for resource utilization scaling. |
droplet_template.image |
String | Yes |
The Droplet image to be used for all Droplets in the autoscale pool. You may specify the slug or the image ID. |
droplet_template.ipv6 |
Boolean | No |
Assigns a unique IPv6 address to each of the Droplets in the autoscale pool. |
name |
String | Yes |
The human-readable name of the autoscale pool. This field cannot be updated |
config |
Object | Yes |
The scaling configuration for an autoscale pool, which is how the pool scales up and down (either by resource utilization or static configuration). |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.