Skip to content
Gradient SDK Docs
  • Auto
  • Light
  • Dark

GPU Droplets

GPU Droplets

GPU Droplets

Create a New Droplet
post/v2/droplets
Delete an Existing Droplet
delete/v2/droplets/{droplet_id}
Deleting Droplets by Tag
delete/v2/droplets
List All Droplets
get/v2/droplets
List all Firewalls Applied to a Droplet
get/v2/droplets/{droplet_id}/firewalls
List All Available Kernels for a Droplet
get/v2/droplets/{droplet_id}/kernels
List Neighbors for a Droplet
get/v2/droplets/{droplet_id}/neighbors
List Snapshots for a Droplet
get/v2/droplets/{droplet_id}/snapshots
Retrieve an Existing Droplet
get/v2/droplets/{droplet_id}
Droplet Backup Policy
DropletBackupPolicyobject
ShowShow
hourenum
optional
0 OR 4 OR 8 OR 3 more

The hour of the day that the backup window will start.

Hide ParametersShow Parameters
0
4
8
12
16
20
planenum
optional
"daily" OR "weekly"

The backup plan used for the Droplet. The plan can be either daily or weekly.

Hide ParametersShow Parameters
"daily"
"weekly"
retention_period_daysnumber
optional

The number of days the backup will be retained.

weekdayenum
optional
"SUN" OR "MON" OR "TUE" OR 4 more

The day of the week on which the backup will occur.

Hide ParametersShow Parameters
"SUN"
"MON"
"TUE"
"WED"
"THU"
"FRI"
"SAT"
window_length_hoursnumber
optional

The length of the backup window starting from hour.

GPU DropletsAccount

GPU DropletsAccountKeys

Create a New SSH Key
post/v2/account/keys
Delete an SSH Key
delete/v2/account/keys/{ssh_key_identifier}
List All SSH Keys
get/v2/account/keys
Retrieve an Existing SSH Key
get/v2/account/keys/{ssh_key_identifier}
Update an SSH Key's Name
put/v2/account/keys/{ssh_key_identifier}

GPU DropletsActions

Acting on Tagged Droplets
post/v2/droplets/actions
Initiate a Droplet Action
post/v2/droplets/{droplet_id}/actions
List Actions for a Droplet
get/v2/droplets/{droplet_id}/actions
Retrieve a Droplet Action
get/v2/droplets/{droplet_id}/actions/{action_id}

GPU DropletsAutoscale

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

GPU DropletsBackups

List Backups for a Droplet
get/v2/droplets/{droplet_id}/backups
List Backup Policies for All Existing Droplets
get/v2/droplets/backups/policies
List Supported Droplet Backup Policies
get/v2/droplets/backups/supported_policies
Retrieve the Backup Policy for an Existing Droplet
get/v2/droplets/{droplet_id}/backups/policy

GPU DropletsDestroy With Associated Resources

Check Status of a Droplet Destroy with Associated Resources Request
get/v2/droplets/{droplet_id}/destroy_with_associated_resources/status
Destroy a Droplet and All of its Associated Resources (Dangerous)
delete/v2/droplets/{droplet_id}/destroy_with_associated_resources/dangerous
Selectively Destroy a Droplet and its Associated Resources
delete/v2/droplets/{droplet_id}/destroy_with_associated_resources/selective
List Associated Resources for a Droplet
get/v2/droplets/{droplet_id}/destroy_with_associated_resources
Retry a Droplet Destroy with Associated Resources Request
post/v2/droplets/{droplet_id}/destroy_with_associated_resources/retry
Associated Resource
AssociatedResourceobject

An objects containing information about a resource associated with a Droplet.

ShowShow
idstring
optional

The unique identifier for the resource associated with the Droplet.

coststring
optional

The cost of the resource in USD per month if the resource is retained after the Droplet is destroyed.

namestring
optional

The name of the resource associated with the Droplet.

Destroyed Associated Resource
DestroyedAssociatedResourceobject

An object containing information about a resource scheduled for deletion.

ShowShow
idstring
optional

The unique identifier for the resource scheduled for deletion.

destroyed_atstring
optional

A time value given in ISO8601 combined date and time format indicating when the resource was destroyed if the request was successful.

formatdate-time
error_messagestring
optional

A string indicating that the resource was not successfully destroyed and providing additional information.

namestring
optional

The name of the resource scheduled for deletion.

GPU DropletsFirewalls

Create a New Firewall
post/v2/firewalls
Delete a Firewall
delete/v2/firewalls/{firewall_id}
List All Firewalls
get/v2/firewalls
Retrieve an Existing Firewall
get/v2/firewalls/{firewall_id}
Update a Firewall
put/v2/firewalls/{firewall_id}
Firewall
Firewallobject
ShowShow
idstring
optional

A unique ID that can be used to identify and reference a firewall.

created_atstring
optional

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

formatdate-time
droplet_idsarray of number
optional

An array containing the IDs of the Droplets assigned to the firewall.

Requires droplet:read scope.

inbound_rulesarray of object
optional
Hide ParametersShow Parameters
portsstring

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".

protocolenum
"tcp" OR "udp" OR "icmp"

The type of traffic to be allowed. This may be one of tcp, udp, or icmp.

Hide ParametersShow Parameters
"tcp"
"udp"
"icmp"
sourcesaddressesarray of stringdroplet_idsarray of numberkubernetes_idsarray of stringload_balancer_uidsarray of stringtagsarray of stringFirewallRuleTarget

An object specifying locations from which inbound traffic will be accepted.

namestring
optional

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_rulesarray of object
optional
Hide ParametersShow Parameters
destinationsaddressesarray of stringdroplet_idsarray of numberkubernetes_idsarray of stringload_balancer_uidsarray of stringtagsarray of stringFirewallRuleTarget

An object specifying locations to which outbound traffic that will be allowed.

portsstring

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".

protocolenum
"tcp" OR "udp" OR "icmp"

The type of traffic to be allowed. This may be one of tcp, udp, or icmp.

Hide ParametersShow Parameters
"tcp"
"udp"
"icmp"
pending_changesarray of object
optional

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.

Hide ParametersShow Parameters
droplet_idnumber
optional
removingboolean
optional
statusstring
optional
statusenum
optional
"waiting" OR "succeeded" OR "failed"

A status string indicating the current state of the firewall. This can be "waiting", "succeeded", or "failed".

Hide ParametersShow Parameters
"waiting"
"succeeded"
"failed"
tagsarray of string
optional

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
post/v2/firewalls/{firewall_id}/droplets
Remove Droplets from a Firewall
delete/v2/firewalls/{firewall_id}/droplets

GPU DropletsFirewallsRules

Add Rules to a Firewall
post/v2/firewalls/{firewall_id}/rules
Remove Rules from a Firewall
delete/v2/firewalls/{firewall_id}/rules

GPU DropletsFirewallsTags

Add Tags to a Firewall
post/v2/firewalls/{firewall_id}/tags
Remove Tags from a Firewall
delete/v2/firewalls/{firewall_id}/tags

GPU DropletsFloating IPs

Create a New Floating IP
post/v2/floating_ips
Delete a Floating IP
delete/v2/floating_ips/{floating_ip}
List All Floating IPs
get/v2/floating_ips
Retrieve an Existing Floating IP
get/v2/floating_ips/{floating_ip}
Floating IP
FloatingIPobject
ShowShow
dropletunion
optional
unknown OR idnumberbackup_idsarray of numbercreated_atstringdisknumberfeaturesarray of stringimageImagelockedbooleanmemorynumbernamestringnetworksobjectnext_backup_windowDropletNextBackupWindowregionRegionsizeSizesize_slugstringsnapshot_idsarray of numberstatusenumtagsarray of stringvcpusnumbervolume_idsarray of stringdisk_infoarray of DiskInfogpu_infoGPUInfokernelKernelvpc_uuidstringDroplet

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.

Hide ParametersShow Parameters
Nullunknown

If the floating IP is not assigned to a Droplet, the value will be null.

idnumberbackup_idsarray of numbercreated_atstringdisknumberfeaturesarray of stringimageImagelockedbooleanmemorynumbernamestringnetworksobjectnext_backup_windowDropletNextBackupWindowregionRegionsizeSizesize_slugstringsnapshot_idsarray of numberstatusenumtagsarray of stringvcpusnumbervolume_idsarray of stringdisk_infoarray of DiskInfogpu_infoGPUInfokernelKernelvpc_uuidstringDroplet
ipstring
optional

The public IP address of the floating IP. It also serves as its identifier.

formatipv4
lockedboolean
optional

A boolean value indicating whether or not the floating IP has pending actions preventing new ones from being submitted.

project_idstring
optional

The UUID of the project to which the reserved IP currently belongs.

Requires project:read scope.

formatuuid
regionintersection
optional
availablebooleanfeaturesarray of stringnamestringsizesarray of stringslugstringRegion

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
post/v2/floating_ips/{floating_ip}/actions
List All Actions for a Floating IP
get/v2/floating_ips/{floating_ip}/actions
Retrieve an Existing Floating IP Action
get/v2/floating_ips/{floating_ip}/actions/{action_id}

GPU DropletsImages

Create a Custom Image
post/v2/images
Delete an Image
delete/v2/images/{image_id}
List All Images
get/v2/images
Retrieve an Existing Image
get/v2/images/{image_id}
Update an Image
put/v2/images/{image_id}

GPU DropletsImagesActions

Initiate an Image Action
post/v2/images/{image_id}/actions
List All Actions for an Image
get/v2/images/{image_id}/actions
Retrieve an Existing Action
get/v2/images/{image_id}/actions/{action_id}

GPU DropletsLoad Balancers

Create a New Load Balancer
post/v2/load_balancers
Delete a Load Balancer
delete/v2/load_balancers/{lb_id}
Delete a Global Load Balancer CDN Cache
delete/v2/load_balancers/{lb_id}/cache
List All Load Balancers
get/v2/load_balancers
Retrieve an Existing Load Balancer
get/v2/load_balancers/{lb_id}
Update a Load Balancer
put/v2/load_balancers/{lb_id}
Domains
Domainsobject

An object specifying domain configurations for a Global load balancer.

ShowShow
certificate_idstring
optional

The ID of the TLS certificate used for SSL termination.

is_managedboolean
optional

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.

namestring
optional

FQDN to associate with a Global load balancer.

Forwarding Rule
ForwardingRuleobject

An object specifying a forwarding rule for a load balancer.

ShowShow
entry_portnumber

An integer representing the port on which the load balancer instance will listen.

entry_protocolenum
"http" OR "https" OR "http2" OR 3 more

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.

Hide ParametersShow Parameters
"http"
"https"
"http2"
"http3"
"tcp"
"udp"
target_portnumber

An integer representing the port on the backend Droplets to which the load balancer will send traffic.

target_protocolenum
"http" OR "https" OR "http2" OR 2 more

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.

Hide ParametersShow Parameters
"http"
"https"
"http2"
"tcp"
"udp"
certificate_idstring
optional

The ID of the TLS certificate used for SSL termination if enabled.

tls_passthroughboolean
optional

A boolean value indicating whether SSL encrypted traffic will be passed through to the backend Droplets.

Glb Settings
GlbSettingsobject

An object specifying forwarding configurations for a Global load balancer.

ShowShow
cdnobject
optional

An object specifying CDN configurations for a Global load balancer.

Hide ParametersShow Parameters
is_enabledboolean
optional

A boolean flag to enable CDN caching.

failover_thresholdnumber
optional

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.

region_prioritiesmap
optional

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.

target_portnumber
optional

An integer representing the port on the target backends which the load balancer will forward traffic to.

target_protocolenum
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.

Hide ParametersShow Parameters
"http"
"https"
"http2"
Health Check
HealthCheckobject

An object specifying health check settings for the load balancer.

ShowShow
check_interval_secondsnumber
optional

The number of seconds between between two consecutive health checks.

healthy_thresholdnumber
optional

The number of times a health check must pass for a backend Droplet to be marked "healthy" and be re-added to the pool.

pathstring
optional

The path on the backend Droplets to which the load balancer instance will send a request.

portnumber
optional

An integer representing the port on the backend Droplets on which the health check will attempt a connection.

protocolenum
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.

Hide ParametersShow Parameters
"http"
"https"
"tcp"
response_timeout_secondsnumber
optional

The number of seconds the load balancer instance will wait for a response until marking a health check as failed.

unhealthy_thresholdnumber
optional

The number of times a health check must fail for a backend Droplet to be marked "unhealthy" and be removed from the pool.

Lb Firewall
LbFirewallobject

An object specifying allow and deny rules to control traffic to the load balancer.

ShowShow
allowarray of string
optional

the rules for allowing traffic to the load balancer (in the form 'ip:1.2.3.4' or 'cidr:1.2.0.0/16')

denyarray of string
optional

the rules for denying traffic to the load balancer (in the form 'ip:1.2.3.4' or 'cidr:1.2.0.0/16')

Load Balancer
LoadBalancerobject
ShowShow
forwarding_rulesarray of entry_portnumberentry_protocolenumtarget_portnumbertarget_protocolenumcertificate_idstringtls_passthroughbooleanForwardingRule

An array of objects specifying the forwarding rules for a load balancer.

idstring
optional

A unique ID that can be used to identify and reference a load balancer.

formatuuid
algorithmenum
optional
deprecated
"round_robin" OR "least_connections"

This field has been deprecated. You can no longer specify an algorithm for load balancers.

Hide ParametersShow Parameters
"round_robin"
"least_connections"
created_atstring
optional

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

formatdate-time
disable_lets_encrypt_dns_recordsboolean
optional

A boolean value indicating whether to disable automatic DNS record creation for Let's Encrypt certificates that are added to the load balancer.

domainsarray of certificate_idstringis_managedbooleannamestringDomains
optional

An array of objects specifying the domain configurations for a Global load balancer.

droplet_idsarray of number
optional

An array containing the IDs of the Droplets assigned to the load balancer.

enable_backend_keepaliveboolean
optional

A boolean value indicating whether HTTP keepalive connections are maintained to target Droplets.

enable_proxy_protocolboolean
optional

A boolean value indicating whether PROXY Protocol is in use.

firewallallowarray of stringdenyarray of stringLbFirewall
optional

An object specifying allow and deny rules to control traffic to the load balancer.

glb_settingscdnobjectfailover_thresholdnumberregion_prioritiesmaptarget_portnumbertarget_protocolenumGlbSettings
optional

An object specifying forwarding configurations for a Global load balancer.

health_checkcheck_interval_secondsnumberhealthy_thresholdnumberpathstringportnumberprotocolenumresponse_timeout_secondsnumberunhealthy_thresholdnumberHealthCheck
optional

An object specifying health check settings for the load balancer.

http_idle_timeout_secondsnumber
optional

An integer value which configures the idle timeout for HTTP requests to the target droplets.

minimum30
maximum600
ipstring
optional

An attribute containing the public-facing IP address of the load balancer.

ipv6string
optional

An attribute containing the public-facing IPv6 address of the load balancer.

namestring
optional

A human-readable name for a load balancer instance.

networkenum
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.

Hide ParametersShow Parameters
"EXTERNAL"
"INTERNAL"
network_stackenum
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.

Hide ParametersShow Parameters
"IPV4"
"DUALSTACK"
project_idstring
optional

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.

redirect_http_to_httpsboolean
optional

A boolean value indicating whether HTTP requests to the load balancer on port 80 will be redirected to HTTPS on port 443.

regionavailablebooleanfeaturesarray of stringnamestringsizesarray of stringslugstringRegion
optional

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.

sizeenum
optional
deprecated
"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 node
  • lb-medium = 3 nodes
  • lb-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.

Hide ParametersShow Parameters
"lb-small"
"lb-medium"
"lb-large"
size_unitnumber
optional

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.

minimum1
maximum100
statusenum
optional
"new" OR "active" OR "errored"

A status string indicating the current state of the load balancer. This can be new, active, or errored.

Hide ParametersShow Parameters
"new"
"active"
"errored"
sticky_sessionscookie_namestringcookie_ttl_secondsnumbertypeenumStickySessions
optional

An object specifying sticky sessions settings for the load balancer.

tagstring
optional

The name of a Droplet tag corresponding to Droplets assigned to the load balancer.

target_load_balancer_idsarray of string
optional

An array containing the UUIDs of the Regional load balancers to be used as target backends for a Global load balancer.

tls_cipher_policyenum
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.

Hide ParametersShow Parameters
"DEFAULT"
"STRONG"
typeenum
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.

Hide ParametersShow Parameters
"REGIONAL"
"REGIONAL_NETWORK"
"GLOBAL"
vpc_uuidstring
optional

A string specifying the UUID of the VPC to which the load balancer is assigned.

formatuuid
Sticky Sessions
StickySessionsobject

An object specifying sticky sessions settings for the load balancer.

ShowShow
typeenum
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.

Hide ParametersShow Parameters
"cookies"
"none"

GPU DropletsLoad BalancersDroplets

Add Droplets to a Load Balancer
post/v2/load_balancers/{lb_id}/droplets
Remove Droplets from a Load Balancer
delete/v2/load_balancers/{lb_id}/droplets

GPU DropletsLoad BalancersForwarding Rules

Add Forwarding Rules to a Load Balancer
post/v2/load_balancers/{lb_id}/forwarding_rules
Remove Forwarding Rules from a Load Balancer
delete/v2/load_balancers/{lb_id}/forwarding_rules

GPU DropletsSizes

List All Droplet Sizes
get/v2/sizes

GPU DropletsSnapshots

Delete a Snapshot
delete/v2/snapshots/{snapshot_id}
List All Snapshots
get/v2/snapshots
Retrieve an Existing Snapshot
get/v2/snapshots/{snapshot_id}

GPU DropletsVolumes

Create a New Block Storage Volume
post/v2/volumes
Delete a Block Storage Volume
delete/v2/volumes/{volume_id}
Delete a Block Storage Volume by Name
delete/v2/volumes
List All Block Storage Volumes
get/v2/volumes
Retrieve an Existing Block Storage Volume
get/v2/volumes/{volume_id}

GPU DropletsVolumesActions

Initiate A Block Storage Action By Volume Id
post/v2/volumes/{volume_id}/actions
Initiate A Block Storage Action By Volume Name
post/v2/volumes/actions
List All Actions for a Volume
get/v2/volumes/{volume_id}/actions
Retrieve an Existing Volume Action
get/v2/volumes/{volume_id}/actions/{action_id}
Volume Action
VolumeActionintersection
ShowShow
resource_idnumber
optional
typestring
optional

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.

GPU DropletsVolumesSnapshots

Create Snapshot from a Volume
post/v2/volumes/{volume_id}/snapshots
Delete a Volume Snapshot
delete/v2/volumes/snapshots/{snapshot_id}
List Snapshots for a Volume
get/v2/volumes/{volume_id}/snapshots
Retrieve an Existing Volume Snapshot
get/v2/volumes/snapshots/{snapshot_id}