GPU Droplets
GPU Droplets
Create a New Droplet
Delete an Existing Droplet
Deleting Droplets by Tag
List All Droplets
List all Firewalls Applied to a Droplet
List All Available Kernels for a Droplet
List Neighbors for a Droplet
List Snapshots for a Droplet
Retrieve an Existing Droplet
ModelsExpand Collapse
DropletBackupPolicy = object { hour, plan, retention_period_days, 2 more }
hour: optional 0 or 4 or 8 or 3 moreThe hour of the day that the backup window will start.
The hour of the day that the backup window will start.
plan: optional "daily" or "weekly"The backup plan used for the Droplet. The plan can be either daily or weekly.
The backup plan used for the Droplet. The plan can be either daily or weekly.
The number of days the backup will be retained.
weekday: optional "SUN" or "MON" or "TUE" or 4 moreThe day of the week on which the backup will occur.
The day of the week on which the backup will occur.
The length of the backup window starting from hour.
GPU DropletsAccount
GPU DropletsAccountKeys
Create a New SSH Key
Delete an SSH Key
List All SSH Keys
Retrieve an Existing SSH Key
Update an SSH Key's Name
ModelsExpand Collapse
SSHKeys = object { name, public_key, id, fingerprint }
A human-readable display name for this key, used to easily identify the SSH keys when they are displayed.
The entire public key string that was uploaded. Embedded into the root user's authorized_keys file if you include this key during Droplet creation.
A unique identification number for this key. Can be used to embed a specific SSH key into a Droplet.
A unique identifier that differentiates this key from other keys using a format that SSH recognizes. The fingerprint is created when the key is added to your account.
GPU DropletsActions
Acting on Tagged Droplets
Initiate a Droplet Action
List Actions for a Droplet
Retrieve a Droplet Action
GPU DropletsAutoscale
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.
GPU DropletsBackups
List Backups for a Droplet
List Backup Policies for All Existing Droplets
List Supported Droplet Backup Policies
Retrieve the Backup Policy for an Existing Droplet
GPU DropletsDestroy With Associated Resources
Check Status of a Droplet Destroy with Associated Resources Request
Destroy a Droplet and All of its Associated Resources (Dangerous)
Selectively Destroy a Droplet and its Associated Resources
List Associated Resources for a Droplet
Retry a Droplet Destroy with Associated Resources Request
ModelsExpand Collapse
AssociatedResource = object { id, cost, name } An objects containing information about a resource associated with a Droplet.
An objects containing information about a resource associated with a Droplet.
The unique identifier for the resource associated with the Droplet.
The cost of the resource in USD per month if the resource is retained after the Droplet is destroyed.
The name of the resource associated with the Droplet.
DestroyedAssociatedResource = object { id, destroyed_at, error_message, name } An object containing information about a resource scheduled for deletion.
An object containing information about a resource scheduled for deletion.
The unique identifier for the resource scheduled for deletion.
A time value given in ISO8601 combined date and time format indicating when the resource was destroyed if the request was successful.
A string indicating that the resource was not successfully destroyed and providing additional information.
The name of the resource scheduled for deletion.
GPU DropletsFirewalls
Create a New Firewall
Delete a Firewall
List All Firewalls
Retrieve an Existing Firewall
Update a Firewall
ModelsExpand Collapse
Firewall = object { id, created_at, droplet_ids, 6 more }
A unique ID that can be used to identify and reference a firewall.
A time value given in ISO8601 combined date and time format that represents when the firewall was created.
An array containing the IDs of the Droplets assigned to the firewall.
Requires droplet:read scope.
inbound_rules: optional array of object { ports, protocol, sources }
The ports on which traffic will be allowed specified as a string containing a single port, a range (e.g. "8000-9000"), or "0" when all ports are open for a protocol. For ICMP rules this parameter will always return "0".
protocol: "tcp" or "udp" or "icmp"The type of traffic to be allowed. This may be one of tcp, udp, or icmp.
The type of traffic to be allowed. This may be one of tcp, udp, or icmp.
An object specifying locations from which inbound traffic will be accepted.
An object specifying locations from which inbound traffic will be accepted.
An array of strings containing the IPv4 addresses, IPv6 addresses, IPv4 CIDRs, and/or IPv6 CIDRs to which the firewall will allow traffic.
An array containing the IDs of the Droplets to which the firewall will allow traffic.
An array containing the IDs of the Kubernetes clusters to which the firewall will allow traffic.
An array containing the IDs of the load balancers to which the firewall will allow traffic.
A flat array of tag names as strings to be applied to the resource. Tag names must exist in order to be referenced in a request.
Requires tag:create and tag:read scopes.
A human-readable name for a firewall. The name must begin with an alphanumeric character. Subsequent characters must either be alphanumeric characters, a period (.), or a dash (-).
outbound_rules: optional array of object { destinations, ports, protocol }
An object specifying locations to which outbound traffic that will be allowed.
An object specifying locations to which outbound traffic that will be allowed.
An array of strings containing the IPv4 addresses, IPv6 addresses, IPv4 CIDRs, and/or IPv6 CIDRs to which the firewall will allow traffic.
An array containing the IDs of the Droplets to which the firewall will allow traffic.
An array containing the IDs of the Kubernetes clusters to which the firewall will allow traffic.
An array containing the IDs of the load balancers to which the firewall will allow traffic.
A flat array of tag names as strings to be applied to the resource. Tag names must exist in order to be referenced in a request.
Requires tag:create and tag:read scopes.
The ports on which traffic will be allowed specified as a string containing a single port, a range (e.g. "8000-9000"), or "0" when all ports are open for a protocol. For ICMP rules this parameter will always return "0".
protocol: "tcp" or "udp" or "icmp"The type of traffic to be allowed. This may be one of tcp, udp, or icmp.
The type of traffic to be allowed. This may be one of tcp, udp, or icmp.
pending_changes: optional array of object { droplet_id, removing, status } An array of objects each containing the fields "droplet_id", "removing", and "status". It is provided to detail exactly which Droplets are having their security policies updated. When empty, all changes have been successfully applied.
An array of objects each containing the fields "droplet_id", "removing", and "status". It is provided to detail exactly which Droplets are having their security policies updated. When empty, all changes have been successfully applied.
status: optional "waiting" or "succeeded" or "failed"A status string indicating the current state of the firewall. This can be "waiting", "succeeded", or "failed".
A status string indicating the current state of the firewall. This can be "waiting", "succeeded", or "failed".
A flat array of tag names as strings to be applied to the resource. Tag names must exist in order to be referenced in a request.
Requires tag:create and tag:read scopes.
GPU DropletsFirewallsDroplets
Add Droplets to a Firewall
Remove Droplets from a Firewall
GPU DropletsFirewallsRules
Add Rules to a Firewall
Remove Rules from a Firewall
GPU DropletsFirewallsTags
Add Tags to a Firewall
Remove Tags from a Firewall
GPU DropletsFloating IPs
Create a New Floating IP
Delete a Floating IP
List All Floating IPs
Retrieve an Existing Floating IP
ModelsExpand Collapse
FloatingIP = object { droplet, ip, locked, 2 more }
The Droplet that the floating IP has been assigned to. When you query a floating IP, if it is assigned to a Droplet, the entire Droplet object will be returned. If it is not assigned, the value will be null.
Requires droplet:read scope.
The Droplet that the floating IP has been assigned to. When you query a floating IP, if it is assigned to a Droplet, the entire Droplet object will be returned. If it is not assigned, the value will be null.
Requires droplet:read scope.
If the floating IP is not assigned to a Droplet, the value will be null.
Droplet = object { id, backup_ids, created_at, 20 more }
A unique identifier for each Droplet instance. This is automatically generated upon Droplet creation.
An array of backup IDs of any backups that have been taken of the Droplet instance. Droplet backups are enabled at the time of the instance creation.
Requires image:read scope.
A time value given in ISO8601 combined date and time format that represents when the Droplet was created.
The size of the Droplet's disk in gigabytes.
An array of features enabled on this Droplet.
The Droplet's image.
Requires image:read scope.
The Droplet's image.
Requires image:read scope.
A unique number that can be used to identify and reference a specific image.
A time value given in ISO8601 combined date and time format that represents when the image was created.
An optional free-form text field to describe an image.
distribution: optional "Arch Linux" or "CentOS" or "CoreOS" or 10 moreThe name of a custom image's distribution. Currently, the valid values are Arch Linux, CentOS, CoreOS, Debian, Fedora, Fedora Atomic, FreeBSD, Gentoo, openSUSE, RancherOS, Rocky Linux, Ubuntu, and Unknown. Any other value will be accepted but ignored, and Unknown will be used in its place.
The name of a custom image's distribution. Currently, the valid values are Arch Linux, CentOS, CoreOS, Debian, Fedora, Fedora Atomic, FreeBSD, Gentoo, openSUSE, RancherOS, Rocky Linux, Ubuntu, and Unknown. Any other value will be accepted but ignored, and Unknown will be used in its place.
A string containing information about errors that may occur when importing a custom image.
The minimum disk size in GB required for a Droplet to use this image.
The display name that has been given to an image. This is what is shown in the control panel and is generally a descriptive title for the image in question.
This is a boolean value that indicates whether the image in question is public or not. An image that is public is available to all accounts. A non-public image is only accessible from your account.
regions: optional array of "ams1" or "ams2" or "ams3" or 12 moreThis attribute is an array of the regions that the image is available in. The regions are represented by their identifying slug values.
This attribute is an array of the regions that the image is available in. The regions are represented by their identifying slug values.
The size of the image in gigabytes.
A uniquely identifying string that is associated with each of the DigitalOcean-provided public images. These can be used to reference a public image as an alternative to the numeric id.
status: optional "NEW" or "available" or "pending" or 2 moreA status string indicating the state of a custom image. This may be NEW,
available, pending, deleted, or retired.
A status string indicating the state of a custom image. This may be NEW,
available, pending, deleted, or retired.
A flat array of tag names as strings to be applied to the resource. Tag names may be for either existing or new tags.
Requires tag:create scope.
type: optional "base" or "snapshot" or "backup" or 2 moreDescribes the kind of image. It may be one of base, snapshot, backup, custom, or admin. Respectively, this specifies whether an image is a DigitalOcean base OS image, user-generated Droplet snapshot, automatically created Droplet backup, user-provided virtual machine image, or an image used for DigitalOcean managed resources (e.g. DOKS worker nodes).
Describes the kind of image. It may be one of base, snapshot, backup, custom, or admin. Respectively, this specifies whether an image is a DigitalOcean base OS image, user-generated Droplet snapshot, automatically created Droplet backup, user-provided virtual machine image, or an image used for DigitalOcean managed resources (e.g. DOKS worker nodes).
A boolean value indicating whether the Droplet has been locked, preventing actions by users.
Memory of the Droplet in megabytes.
The human-readable name set for the Droplet instance.
networks: object { v4, v6 } The details of the network that are configured for the Droplet instance. This is an object that contains keys for IPv4 and IPv6. The value of each of these is an array that contains objects describing an individual IP resource allocated to the Droplet. These will define attributes like the IP address, netmask, and gateway of the specific network depending on the type of network it is.
The details of the network that are configured for the Droplet instance. This is an object that contains keys for IPv4 and IPv6. The value of each of these is an array that contains objects describing an individual IP resource allocated to the Droplet. These will define attributes like the IP address, netmask, and gateway of the specific network depending on the type of network it is.
The gateway of the specified IPv4 network interface.
For private interfaces, a gateway is not provided. This is denoted by
returning nil as its value.
The IP address of the IPv4 network interface.
The netmask of the IPv4 network interface.
type: optional "public" or "private"The type of the IPv4 network interface.
The type of the IPv4 network interface.
The gateway of the specified IPv6 network interface.
The IP address of the IPv6 network interface.
The netmask of the IPv6 network interface.
type: optional "public"The type of the IPv6 network interface.
Note: IPv6 private networking is not currently supported.
The type of the IPv6 network interface.
Note: IPv6 private networking is not currently supported.
The details of the Droplet's backups feature, if backups are configured for the Droplet. This object contains keys for the start and end times of the window during which the backup will start.
The details of the Droplet's backups feature, if backups are configured for the Droplet. This object contains keys for the start and end times of the window during which the backup will start.
A time value given in ISO8601 combined date and time format specifying the end of the Droplet's backup window.
A time value given in ISO8601 combined date and time format specifying the start of the Droplet's backup window.
This is a boolean value that represents whether new Droplets can be created in this region.
This attribute is set to an array which contains features available in this region
The display name of the region. This will be a full name that is used in the control panel and other interfaces.
This attribute is set to an array which contains the identifying slugs for the sizes available in this region. sizes:read is required to view.
A human-readable string that is used as a unique identifier for each region.
This is a boolean value that represents whether new Droplets can be created with this size.
A string describing the class of Droplets created from this size. For example: Basic, General Purpose, CPU-Optimized, Memory-Optimized, or Storage-Optimized.
The amount of disk space set aside for Droplets of this size. The value is represented in gigabytes.
The amount of RAM allocated to Droplets created of this size. The value is represented in megabytes.
This describes the price of the Droplet size as measured hourly. The value is measured in US dollars.
This attribute describes the monthly cost of this Droplet size if the Droplet is kept for an entire month. The value is measured in US dollars.
An array containing the region slugs where this size is available for Droplet creates.
A human-readable string that is used to uniquely identify each size.
The amount of transfer bandwidth that is available for Droplets created in this size. This only counts traffic on the public interface. The value is given in terabytes.
The number of CPUs allocated to Droplets of this size.
An array of objects containing information about the disks available to Droplets created with this size.
An array of objects containing information about the disks available to Droplets created with this size.
size: optional object { amount, unit }
The amount of space allocated to the disk.
The unit of measure for the disk size.
type: optional "local" or "scratch"The type of disk. All Droplets contain a local disk. Additionally, GPU Droplets can also have a scratch disk for non-persistent data.
The type of disk. All Droplets contain a local disk. Additionally, GPU Droplets can also have a scratch disk for non-persistent data.
An object containing information about the GPU capabilities of Droplets created with this size.
An object containing information about the GPU capabilities of Droplets created with this size.
The number of GPUs allocated to the Droplet.
The model of the GPU.
vram: optional object { amount, unit }
The amount of VRAM allocated to the GPU.
The unit of measure for the VRAM.
The unique slug identifier for the size of this Droplet.
An array of snapshot IDs of any snapshots created from the Droplet instance.
Requires image:read scope.
status: "new" or "active" or "off" or "archive"A status string indicating the state of the Droplet instance. This may be "new", "active", "off", or "archive".
A status string indicating the state of the Droplet instance. This may be "new", "active", "off", or "archive".
An array of Tags the Droplet has been tagged with.
Requires tag:read scope.
The number of virtual CPUs.
A flat array including the unique identifier for each Block Storage volume attached to the Droplet.
Requires block_storage:read scope.
An array of objects containing information about the disks available to the Droplet.
An array of objects containing information about the disks available to the Droplet.
size: optional object { amount, unit }
The amount of space allocated to the disk.
The unit of measure for the disk size.
type: optional "local" or "scratch"The type of disk. All Droplets contain a local disk. Additionally, GPU Droplets can also have a scratch disk for non-persistent data.
The type of disk. All Droplets contain a local disk. Additionally, GPU Droplets can also have a scratch disk for non-persistent data.
An object containing information about the GPU capabilities of Droplets created with this size.
An object containing information about the GPU capabilities of Droplets created with this size.
The number of GPUs allocated to the Droplet.
The model of the GPU.
vram: optional object { amount, unit }
The amount of VRAM allocated to the GPU.
The unit of measure for the VRAM.
Note: All Droplets created after March 2017 use internal kernels by default.
These Droplets will have this attribute set to null.
The current kernel
for Droplets with externally managed kernels. This will initially be set to
the kernel of the base image when the Droplet is created.
Note: All Droplets created after March 2017 use internal kernels by default.
These Droplets will have this attribute set to null.
The current kernel for Droplets with externally managed kernels. This will initially be set to the kernel of the base image when the Droplet is created.
A unique number used to identify and reference a specific kernel.
The display name of the kernel. This is shown in the web UI and is generally a descriptive title for the kernel in question.
A standard kernel version string representing the version, patch, and release information.
A string specifying the UUID of the VPC to which the Droplet is assigned.
Requires vpc:read scope.
The public IP address of the floating IP. It also serves as its identifier.
A boolean value indicating whether or not the floating IP has pending actions preventing new ones from being submitted.
The UUID of the project to which the reserved IP currently belongs.
Requires project:read scope.
The region that the floating IP is reserved to. When you query a floating IP, the entire region object will be returned.
GPU DropletsFloating IPsActions
Initiate a Floating IP Action
List All Actions for a Floating IP
Retrieve an Existing Floating IP Action
GPU DropletsImages
Create a Custom Image
Delete an Image
List All Images
Retrieve an Existing Image
Update an Image
GPU DropletsImagesActions
Initiate an Image Action
List All Actions for an Image
Retrieve an Existing Action
GPU DropletsLoad Balancers
Create a New Load Balancer
Delete a Load Balancer
Delete a Global Load Balancer CDN Cache
List All Load Balancers
Retrieve an Existing Load Balancer
Update a Load Balancer
ModelsExpand Collapse
Domains = object { certificate_id, is_managed, name } An object specifying domain configurations for a Global load balancer.
An object specifying domain configurations for a Global load balancer.
The ID of the TLS certificate used for SSL termination.
A boolean value indicating if the domain is already managed by DigitalOcean. If true, all A and AAAA records required to enable Global load balancers will be automatically added.
FQDN to associate with a Global load balancer.
ForwardingRule = object { entry_port, entry_protocol, target_port, 3 more } An object specifying a forwarding rule for a load balancer.
An object specifying a forwarding rule for a load balancer.
An integer representing the port on which the load balancer instance will listen.
entry_protocol: "http" or "https" or "http2" or 3 moreThe protocol used for traffic to the load balancer. The possible values are: http, https, http2, http3, tcp, or udp. If you set the entry_protocol to udp, the target_protocol must be set to udp. When using UDP, the load balancer requires that you set up a health check with a port that uses TCP, HTTP, or HTTPS to work properly.
The protocol used for traffic to the load balancer. The possible values are: http, https, http2, http3, tcp, or udp. If you set the entry_protocol to udp, the target_protocol must be set to udp. When using UDP, the load balancer requires that you set up a health check with a port that uses TCP, HTTP, or HTTPS to work properly.
An integer representing the port on the backend Droplets to which the load balancer will send traffic.
target_protocol: "http" or "https" or "http2" or 2 moreThe protocol used for traffic from the load balancer to the backend Droplets. The possible values are: http, https, http2, tcp, or udp. If you set the target_protocol to udp, the entry_protocol must be set to udp. When using UDP, the load balancer requires that you set up a health check with a port that uses TCP, HTTP, or HTTPS to work properly.
The protocol used for traffic from the load balancer to the backend Droplets. The possible values are: http, https, http2, tcp, or udp. If you set the target_protocol to udp, the entry_protocol must be set to udp. When using UDP, the load balancer requires that you set up a health check with a port that uses TCP, HTTP, or HTTPS to work properly.
The ID of the TLS certificate used for SSL termination if enabled.
A boolean value indicating whether SSL encrypted traffic will be passed through to the backend Droplets.
GlbSettings = object { cdn, failover_threshold, region_priorities, 2 more } An object specifying forwarding configurations for a Global load balancer.
An object specifying forwarding configurations for a Global load balancer.
cdn: optional object { is_enabled } An object specifying CDN configurations for a Global load balancer.
An object specifying CDN configurations for a Global load balancer.
A boolean flag to enable CDN caching.
An integer value as a percentage to indicate failure threshold to decide how the regional priorities will take effect. A value of 50 would indicate that the Global load balancer will choose a lower priority region to forward traffic to once this failure threshold has been reached for the higher priority region.
A map of region string to an integer priority value indicating preference for which regional target a Global load balancer will forward traffic to. A lower value indicates a higher priority.
An integer representing the port on the target backends which the load balancer will forward traffic to.
target_protocol: optional "http" or "https" or "http2"The protocol used for forwarding traffic from the load balancer to the target backends. The possible values are http, https and http2.
The protocol used for forwarding traffic from the load balancer to the target backends. The possible values are http, https and http2.
HealthCheck = object { check_interval_seconds, healthy_threshold, path, 4 more } An object specifying health check settings for the load balancer.
An object specifying health check settings for the load balancer.
The number of seconds between between two consecutive health checks.
The number of times a health check must pass for a backend Droplet to be marked "healthy" and be re-added to the pool.
The path on the backend Droplets to which the load balancer instance will send a request.
An integer representing the port on the backend Droplets on which the health check will attempt a connection.
protocol: optional "http" or "https" or "tcp"The protocol used for health checks sent to the backend Droplets. The possible values are http, https, or tcp.
The protocol used for health checks sent to the backend Droplets. The possible values are http, https, or tcp.
The number of seconds the load balancer instance will wait for a response until marking a health check as failed.
The number of times a health check must fail for a backend Droplet to be marked "unhealthy" and be removed from the pool.
LbFirewall = object { allow, deny } An object specifying allow and deny rules to control traffic to the load balancer.
An object specifying allow and deny rules to control traffic to the load balancer.
the rules for allowing traffic to the load balancer (in the form 'ip:1.2.3.4' or 'cidr:1.2.0.0/16')
the rules for denying traffic to the load balancer (in the form 'ip:1.2.3.4' or 'cidr:1.2.0.0/16')
LoadBalancer = object { forwarding_rules, id, algorithm, 27 more }
An array of objects specifying the forwarding rules for a load balancer.
An array of objects specifying the forwarding rules for a load balancer.
An integer representing the port on which the load balancer instance will listen.
entry_protocol: "http" or "https" or "http2" or 3 moreThe protocol used for traffic to the load balancer. The possible values are: http, https, http2, http3, tcp, or udp. If you set the entry_protocol to udp, the target_protocol must be set to udp. When using UDP, the load balancer requires that you set up a health check with a port that uses TCP, HTTP, or HTTPS to work properly.
The protocol used for traffic to the load balancer. The possible values are: http, https, http2, http3, tcp, or udp. If you set the entry_protocol to udp, the target_protocol must be set to udp. When using UDP, the load balancer requires that you set up a health check with a port that uses TCP, HTTP, or HTTPS to work properly.
An integer representing the port on the backend Droplets to which the load balancer will send traffic.
target_protocol: "http" or "https" or "http2" or 2 moreThe protocol used for traffic from the load balancer to the backend Droplets. The possible values are: http, https, http2, tcp, or udp. If you set the target_protocol to udp, the entry_protocol must be set to udp. When using UDP, the load balancer requires that you set up a health check with a port that uses TCP, HTTP, or HTTPS to work properly.
The protocol used for traffic from the load balancer to the backend Droplets. The possible values are: http, https, http2, tcp, or udp. If you set the target_protocol to udp, the entry_protocol must be set to udp. When using UDP, the load balancer requires that you set up a health check with a port that uses TCP, HTTP, or HTTPS to work properly.
The ID of the TLS certificate used for SSL termination if enabled.
A boolean value indicating whether SSL encrypted traffic will be passed through to the backend Droplets.
A unique ID that can be used to identify and reference a load balancer.
Deprecatedalgorithm: optional "round_robin" or "least_connections"This field has been deprecated. You can no longer specify an algorithm for load balancers.
This field has been deprecated. You can no longer specify an algorithm for load balancers.
A time value given in ISO8601 combined date and time format that represents when the load balancer was created.
A boolean value indicating whether to disable automatic DNS record creation for Let's Encrypt certificates that are added to the load balancer.
An array of objects specifying the domain configurations for a Global load balancer.
An array of objects specifying the domain configurations for a Global load balancer.
The ID of the TLS certificate used for SSL termination.
A boolean value indicating if the domain is already managed by DigitalOcean. If true, all A and AAAA records required to enable Global load balancers will be automatically added.
FQDN to associate with a Global load balancer.
An array containing the IDs of the Droplets assigned to the load balancer.
A boolean value indicating whether HTTP keepalive connections are maintained to target Droplets.
A boolean value indicating whether PROXY Protocol is in use.
An object specifying allow and deny rules to control traffic to the load balancer.
An object specifying allow and deny rules to control traffic to the load balancer.
the rules for allowing traffic to the load balancer (in the form 'ip:1.2.3.4' or 'cidr:1.2.0.0/16')
the rules for denying traffic to the load balancer (in the form 'ip:1.2.3.4' or 'cidr:1.2.0.0/16')
An object specifying forwarding configurations for a Global load balancer.
An object specifying forwarding configurations for a Global load balancer.
cdn: optional object { is_enabled } An object specifying CDN configurations for a Global load balancer.
An object specifying CDN configurations for a Global load balancer.
A boolean flag to enable CDN caching.
An integer value as a percentage to indicate failure threshold to decide how the regional priorities will take effect. A value of 50 would indicate that the Global load balancer will choose a lower priority region to forward traffic to once this failure threshold has been reached for the higher priority region.
A map of region string to an integer priority value indicating preference for which regional target a Global load balancer will forward traffic to. A lower value indicates a higher priority.
An integer representing the port on the target backends which the load balancer will forward traffic to.
target_protocol: optional "http" or "https" or "http2"The protocol used for forwarding traffic from the load balancer to the target backends. The possible values are http, https and http2.
The protocol used for forwarding traffic from the load balancer to the target backends. The possible values are http, https and http2.
An object specifying health check settings for the load balancer.
An object specifying health check settings for the load balancer.
The number of seconds between between two consecutive health checks.
The number of times a health check must pass for a backend Droplet to be marked "healthy" and be re-added to the pool.
The path on the backend Droplets to which the load balancer instance will send a request.
An integer representing the port on the backend Droplets on which the health check will attempt a connection.
protocol: optional "http" or "https" or "tcp"The protocol used for health checks sent to the backend Droplets. The possible values are http, https, or tcp.
The protocol used for health checks sent to the backend Droplets. The possible values are http, https, or tcp.
The number of seconds the load balancer instance will wait for a response until marking a health check as failed.
The number of times a health check must fail for a backend Droplet to be marked "unhealthy" and be removed from the pool.
An integer value which configures the idle timeout for HTTP requests to the target droplets.
An attribute containing the public-facing IP address of the load balancer.
An attribute containing the public-facing IPv6 address of the load balancer.
A human-readable name for a load balancer instance.
network: optional "EXTERNAL" or "INTERNAL"A string indicating whether the load balancer should be external or internal. Internal load balancers have no public IPs and are only accessible to resources on the same VPC network. This property cannot be updated after creating the load balancer.
A string indicating whether the load balancer should be external or internal. Internal load balancers have no public IPs and are only accessible to resources on the same VPC network. This property cannot be updated after creating the load balancer.
network_stack: optional "IPV4" or "DUALSTACK"A string indicating whether the load balancer will support IPv4 or both IPv4 and IPv6 networking. This property cannot be updated after creating the load balancer.
A string indicating whether the load balancer will support IPv4 or both IPv4 and IPv6 networking. This property cannot be updated after creating the load balancer.
The ID of the project that the load balancer is associated with. If no ID is provided at creation, the load balancer associates with the user's default project. If an invalid project ID is provided, the load balancer will not be created.
A boolean value indicating whether HTTP requests to the load balancer on port 80 will be redirected to HTTPS on port 443.
The region where the load balancer instance is located. When setting a region, the value should be the slug identifier for the region. When you query a load balancer, an entire region object will be returned.
The region where the load balancer instance is located. When setting a region, the value should be the slug identifier for the region. When you query a load balancer, an entire region object will be returned.
This is a boolean value that represents whether new Droplets can be created in this region.
This attribute is set to an array which contains features available in this region
The display name of the region. This will be a full name that is used in the control panel and other interfaces.
This attribute is set to an array which contains the identifying slugs for the sizes available in this region. sizes:read is required to view.
A human-readable string that is used as a unique identifier for each region.
Deprecatedsize: optional "lb-small" or "lb-medium" or "lb-large"This field has been replaced by the size_unit field for all regions except in AMS2, NYC2, and SFO1. Each available load balancer size now equates to the load balancer having a set number of nodes.
lb-small = 1 nodelb-medium = 3 nodeslb-large = 6 nodes
You can resize load balancers after creation up to once per hour. You cannot resize a load balancer within the first hour of its creation.
This field has been replaced by the size_unit field for all regions except in AMS2, NYC2, and SFO1. Each available load balancer size now equates to the load balancer having a set number of nodes.
lb-small= 1 nodelb-medium= 3 nodeslb-large= 6 nodes
You can resize load balancers after creation up to once per hour. You cannot resize a load balancer within the first hour of its creation.
How many nodes the load balancer contains. Each additional node increases the load balancer's ability to manage more connections. Load balancers can be scaled up or down, and you can change the number of nodes after creation up to once per hour. This field is currently not available in the AMS2, NYC2, or SFO1 regions. Use the size field to scale load balancers that reside in these regions.
status: optional "new" or "active" or "errored"A status string indicating the current state of the load balancer. This can be new, active, or errored.
A status string indicating the current state of the load balancer. This can be new, active, or errored.
An object specifying sticky sessions settings for the load balancer.
An object specifying sticky sessions settings for the load balancer.
The name of the cookie sent to the client. This attribute is only returned when using cookies for the sticky sessions type.
The number of seconds until the cookie set by the load balancer expires. This attribute is only returned when using cookies for the sticky sessions type.
type: optional "cookies" or "none"An attribute indicating how and if requests from a client will be persistently served by the same backend Droplet. The possible values are cookies or none.
An attribute indicating how and if requests from a client will be persistently served by the same backend Droplet. The possible values are cookies or none.
The name of a Droplet tag corresponding to Droplets assigned to the load balancer.
An array containing the UUIDs of the Regional load balancers to be used as target backends for a Global load balancer.
tls_cipher_policy: optional "DEFAULT" or "STRONG"A string indicating the policy for the TLS cipher suites used by the load balancer. The possible values are DEFAULT or STRONG. The default value is DEFAULT.
A string indicating the policy for the TLS cipher suites used by the load balancer. The possible values are DEFAULT or STRONG. The default value is DEFAULT.
type: optional "REGIONAL" or "REGIONAL_NETWORK" or "GLOBAL"A string indicating whether the load balancer should be a standard regional HTTP load balancer, a regional network load balancer that routes traffic at the TCP/UDP transport layer, or a global load balancer.
A string indicating whether the load balancer should be a standard regional HTTP load balancer, a regional network load balancer that routes traffic at the TCP/UDP transport layer, or a global load balancer.
A string specifying the UUID of the VPC to which the load balancer is assigned.
StickySessions = object { cookie_name, cookie_ttl_seconds, type } An object specifying sticky sessions settings for the load balancer.
An object specifying sticky sessions settings for the load balancer.
The name of the cookie sent to the client. This attribute is only returned when using cookies for the sticky sessions type.
The number of seconds until the cookie set by the load balancer expires. This attribute is only returned when using cookies for the sticky sessions type.
type: optional "cookies" or "none"An attribute indicating how and if requests from a client will be persistently served by the same backend Droplet. The possible values are cookies or none.
An attribute indicating how and if requests from a client will be persistently served by the same backend Droplet. The possible values are cookies or none.
GPU DropletsLoad BalancersDroplets
Add Droplets to a Load Balancer
Remove Droplets from a Load Balancer
GPU DropletsLoad BalancersForwarding Rules
Add Forwarding Rules to a Load Balancer
Remove Forwarding Rules from a Load Balancer
GPU DropletsSizes
List All Droplet Sizes
GPU DropletsSnapshots
Delete a Snapshot
List All Snapshots
Retrieve an Existing Snapshot
GPU DropletsVolumes
Create a New Block Storage Volume
Delete a Block Storage Volume
Delete a Block Storage Volume by Name
List All Block Storage Volumes
Retrieve an Existing Block Storage Volume
GPU DropletsVolumesActions
Initiate A Block Storage Action By Volume Id
Initiate A Block Storage Action By Volume Name
List All Actions for a Volume
Retrieve an Existing Volume Action
ModelsExpand Collapse
This is the type of action that the object represents. For example, this could be "attach_volume" to represent the state of a volume attach action.