DigitalOcean API (unofficial showcase)
POST/v2/droplets/autoscale

Create an autoscale pool

Creates a new autoscale pool with a scaling configuration and a template for the Droplets it manages. Supply name, config, and droplet_template; the template must specify region, image, size, and ssh_keys. A 202 response returns the pool details, including its identifier and status.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

3 body fields

Autoscale pool details, 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.

5 status codes
202Returns 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.
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 429 is returned when the API rate limit has been exceeded. A 500 is returned when a server error occurs. If you send a request body, include name, config, and droplet_template; the template must include region, image, size, and ssh_keys, and config must satisfy one of its supported configuration shapes.