Autoscale

Autoscale

Autoscale

Create a New Autoscale Pool

post/v2/droplets/autoscale

Delete autoscale pool

delete/v2/droplets/autoscale/{autoscale_pool_id}

Delete autoscale pool and resources

delete/v2/droplets/autoscale/{autoscale_pool_id}/dangerous

List All Autoscale Pools

get/v2/droplets/autoscale

List history events

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

List members

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

Retrieve an Existing Autoscale Pool

get/v2/droplets/autoscale/{autoscale_pool_id}

Update Autoscale Pool

put/v2/droplets/autoscale/{autoscale_pool_id}

Autoscale Pool

AutoscalePoolobject

ShowShow

idstring

A unique identifier for each autoscale pool instance. This is automatically generated upon autoscale pool creation.

active_resources_countnumber

The number of active Droplets in the autoscale pool.

configunion

The scaling configuration for an autoscale pool, which is how the pool scales up and down (either by resource utilization or static configuration).

One of the following 2 object variants:

Hide ParametersShow Parameters

target_number_instancesnumberAutoscalePoolStaticConfig

max_instancesnumbermin_instancesnumbercooldown_minutesnumbertarget_cpu_utilizationnumbertarget_memory_utilizationnumberAutoscalePoolDynamicConfig

created_atstring

A time value given in ISO8601 combined date and time format that represents when the autoscale pool was created.

formatdate-time

droplet_templateimagestringregionenumsizestringssh_keysarray of stringipv6booleannamestringproject_idstringtagsarray of stringuser_datastringvpc_uuidstringwith_droplet_agentbooleanAutoscalePoolDropletTemplate

namestring

The human-readable name set for the autoscale pool.

statusenum

"active" OR "deleting" OR "error"

The current status of the autoscale pool.

Hide ParametersShow Parameters

"active"

"deleting"

"error"

updated_atstring

A time value given in ISO8601 combined date and time format that represents when the autoscale pool was last updated.

formatdate-time

current_utilizationcpunumbermemorynumberCurrentUtilization

optional

Autoscale Pool Droplet Template

AutoscalePoolDropletTemplateobject

ShowShow

imagestring

The Droplet image to be used for all Droplets in the autoscale pool. You may specify the slug or the image ID.

regionenum

"nyc1" OR "nyc2" OR "nyc3" OR 11 more

The datacenter in which all of the Droplets will be created.

Hide ParametersShow Parameters

"nyc1"

"nyc2"

"nyc3"

"ams2"

"ams3"

"sfo1"

"sfo2"

"sfo3"

"sgp1"

"lon1"

"fra1"

"tor1"

"blr1"

"syd1"

sizestring

The Droplet size to be used for all Droplets in the autoscale pool.

ssh_keysarray of string

The SSH keys to be installed on the Droplets in the autoscale pool. You can either specify the key ID or the fingerprint. Requires ssh_key:read scope.

ipv6boolean

optional

Assigns a unique IPv6 address to each of the Droplets in the autoscale pool.

namestring

optional

The name(s) to be applied to all Droplets in the autoscale pool.

project_idstring

optional

The project that the Droplets in the autoscale pool will belong to. Requires project:read scope.

tagsarray of string

optional

The tags to apply to each of the Droplets in the autoscale pool. Requires tag:read scope.

user_datastring

optional

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.

vpc_uuidstring

optional

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. Requires vpc:read scope.

with_droplet_agentboolean

optional

Installs the Droplet agent. This must be set to true to monitor Droplets for resource utilization scaling.

Autoscale Pool Dynamic Config

AutoscalePoolDynamicConfigobject

ShowShow

max_instancesnumber

The maximum number of Droplets in an autoscale pool.

minimum1

maximum1000

min_instancesnumber

The minimum number of Droplets in an autoscale pool.

minimum1

maximum500

cooldown_minutesnumber

optional

The number of minutes to wait between scaling events in an autoscale pool. Defaults to 10 minutes.

minimum5

maximum20

target_cpu_utilizationnumber

optional

Target CPU utilization as a decimal.

formatfloat

minimum0.05

maximum1

target_memory_utilizationnumber

optional

Target memory utilization as a decimal.

formatfloat

minimum0.05

maximum1

Autoscale Pool Static Config

AutoscalePoolStaticConfigobject

ShowShow

target_number_instancesnumber

Fixed number of instances in an autoscale pool.

minimum1

maximum1000

Current Utilization

CurrentUtilizationobject

ShowShow

cpunumber

optional

The average CPU utilization of the autoscale pool.

formatfloat

minimum0

maximum1

memorynumber

optional

The average memory utilization of the autoscale pool.

formatfloat

minimum0

maximum1