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 }
A unique identifier for each autoscale pool instance. This is automatically generated upon autoscale pool creation.
The number of active Droplets in the autoscale pool.
config: AutoscalePoolStaticConfig { target_number_instances } or AutoscalePoolDynamicConfig { max_instances, min_instances, cooldown_minutes, 2 more } The scaling configuration for an autoscale pool, which is how the pool scales up and down (either by resource utilization or static configuration).
The scaling configuration for an autoscale pool, which is how the pool scales up and down (either by resource utilization or static configuration).
AutoscalePoolStaticConfig = object { target_number_instances }
Fixed number of instances in an autoscale pool.
AutoscalePoolDynamicConfig = object { max_instances, min_instances, cooldown_minutes, 2 more }
The maximum number of Droplets in an autoscale pool.
The minimum number of Droplets in an autoscale pool.
The number of minutes to wait between scaling events in an autoscale pool. Defaults to 10 minutes.
Target CPU utilization as a decimal.
Target memory utilization as a decimal.
A time value given in ISO8601 combined date and time format that represents when the autoscale pool was created.
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 moreThe datacenter in which all of the Droplets will be created.
The datacenter in which all of the Droplets will be created.
The Droplet size to be used for all Droplets in the autoscale pool.
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.
Assigns a unique IPv6 address to each of the Droplets in the autoscale pool.
The name(s) to be applied to all Droplets in the autoscale pool.
The project that the Droplets in the autoscale pool will belong to.
Requires project:read scope.
The tags to apply to each of the Droplets in the autoscale pool.
Requires tag:read scope.
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.
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.
Installs the Droplet agent. This must be set to true to monitor Droplets for resource utilization scaling.
The human-readable name set for the autoscale pool.
status: "active" or "deleting" or "error"The current status of the autoscale pool.
The current status of the autoscale pool.
A time value given in ISO8601 combined date and time format that represents when the autoscale pool was last updated.
The average CPU utilization of the autoscale pool.
The average memory utilization of the autoscale pool.
AutoscalePoolDropletTemplate = object { image, region, size, 8 more }
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 moreThe datacenter in which all of the Droplets will be created.
The datacenter in which all of the Droplets will be created.
The Droplet size to be used for all Droplets in the autoscale pool.
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.
Assigns a unique IPv6 address to each of the Droplets in the autoscale pool.
The name(s) to be applied to all Droplets in the autoscale pool.
The project that the Droplets in the autoscale pool will belong to.
Requires project:read scope.
The tags to apply to each of the Droplets in the autoscale pool.
Requires tag:read scope.
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.
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.
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 }
The maximum number of Droplets in an autoscale pool.
The minimum number of Droplets in an autoscale pool.
The number of minutes to wait between scaling events in an autoscale pool. Defaults to 10 minutes.
Target CPU utilization as a decimal.
Target memory utilization as a decimal.
AutoscalePoolStaticConfig = object { target_number_instances }
Fixed number of instances in an autoscale pool.
CurrentUtilization = object { cpu, memory }
The average CPU utilization of the autoscale pool.
The average memory utilization of the autoscale pool.