DigitalOcean API (unofficial showcase)
PUT/v2/droplets/autoscale/{autoscale_pool_id}

Replace an autoscale pool configuration

Replaces the configuration of an existing autoscale pool with the full representation supplied in the request. Include name, config, and droplet_template, and provide the required region, image, size, and SSH keys in the Droplet template. A 200 response returns the updated pool details.

1 parameter · 3 body fields
autoscale_pool_idstringrequired
The unique identifier of the autoscale pool to replace.

The full autoscale pool representation, including its name, scaling configuration, and Droplet template.

namestringrequired
The human-readable name of the autoscale pool. This field cannot be updated
configobjectrequired
The scaling configuration for an autoscale pool, which is how the pool scales up and down (either by resource utilization or static configuration).
droplet_templateobjectrequired
The template for the pool's Droplets, including their region, image, size, and SSH keys. It can also specify names, tags, a VPC, project, networking options, and user data.

6 status codes
200Returns an `autoscale_pool` object with its identifier, name, configuration, Droplet template, utilization, timestamps, status, and active resource count.
autoscale_poolobjectoptional
401Returned when authentication credentials are invalid.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
404Returned when the autoscale pool cannot be found.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
429Returned when the API rate limit has been exceeded.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
500Returned when a server error occurs.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
defaultThere was an unexpected error.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.

Error handling

A 401 is returned when authentication credentials are invalid. A 404 is returned when the autoscale pool cannot be found. A 429 is returned when the API rate limit has been exceeded. A 500 is returned when a server error occurs. The autoscale_pool_id path parameter identifies the pool; if you send a request body, include name, config, and droplet_template, with region, image, size, and ssh_keys in the template.