Autoscale
Autoscale
Create a New Autoscale Pool
Delete autoscale pool
Delete autoscale pool and resources
List All Autoscale Pools
List history events
List members
Retrieve an Existing Autoscale Pool
Update Autoscale Pool
ModelsExpand Collapse
AutoscalePool = object { id, active_resources_count, config, 6 more }
id: string
A unique identifier for each autoscale pool instance. This is automatically generated upon autoscale pool creation.
active_resources_count: number
The number of active Droplets in the autoscale pool.
The scaling configuration for an autoscale pool, which is how the pool scales up and down (either by resource utilization or static configuration).
created_at: string
A time value given in ISO8601 combined date and time format that represents when the autoscale pool was created.
name: string
The human-readable name set for the autoscale pool.
status: "active" or "deleting" or "error"
The current status of the autoscale pool.
updated_at: string
A time value given in ISO8601 combined date and time format that represents when the autoscale pool was last updated.
AutoscalePoolDropletTemplate = object { image, region, size, 8 more }
image: string
The Droplet image to be used for all Droplets in the autoscale pool. You may specify the slug or the image ID.
region: "nyc1" or "nyc2" or "nyc3" or 11 more
The datacenter in which all of the Droplets will be created.
size: string
The Droplet size to be used for all Droplets in the autoscale pool.
ssh_keys: array 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.
ipv6: optional boolean
Assigns a unique IPv6 address to each of the Droplets in the autoscale pool.
name: optional string
The name(s) to be applied to all Droplets in the autoscale pool.
project_id: optional string
The project that the Droplets in the autoscale pool will belong to.
Requires project:read scope.
tags: optional array of string
The tags to apply to each of the Droplets in the autoscale pool.
Requires tag:read scope.
user_data: optional string
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_uuid: optional string
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_agent: optional boolean
Installs the Droplet agent. This must be set to true to monitor Droplets for resource utilization scaling.
AutoscalePoolDynamicConfig = object { max_instances, min_instances, cooldown_minutes, 2 more }
max_instances: number
The maximum number of Droplets in an autoscale pool.
min_instances: number
The minimum number of Droplets in an autoscale pool.
cooldown_minutes: optional number
The number of minutes to wait between scaling events in an autoscale pool. Defaults to 10 minutes.
target_cpu_utilization: optional number
Target CPU utilization as a decimal.
target_memory_utilization: optional number
Target memory utilization as a decimal.
AutoscalePoolStaticConfig = object { target_number_instances }
target_number_instances: number
Fixed number of instances in an autoscale pool.
CurrentUtilization = object { cpu, memory }
cpu: optional number
The average CPU utilization of the autoscale pool.
memory: optional number
The average memory utilization of the autoscale pool.