GPU Droplets
GPU Droplets
Create a New Droplet
client.gpuDroplets.create(GPUDropletCreateParamsbody, RequestOptionsoptions?): GPUDropletCreateResponse
/v2/droplets
Delete an Existing Droplet
client.gpuDroplets.delete(numberdropletID, RequestOptionsoptions?): void
/v2/droplets/{droplet_id}
Deleting Droplets by Tag
client.gpuDroplets.deleteByTag(GPUDropletDeleteByTagParams { tag_name } params, RequestOptionsoptions?): void
/v2/droplets
List All Droplets
client.gpuDroplets.list(GPUDropletListParams { name, page, per_page, 2 more } query?, RequestOptionsoptions?): GPUDropletListResponse { meta, droplets, links }
/v2/droplets
List all Firewalls Applied to a Droplet
client.gpuDroplets.listFirewalls(numberdropletID, GPUDropletListFirewallsParams { page, per_page } query?, RequestOptionsoptions?): GPUDropletListFirewallsResponse { meta, firewalls, links }
/v2/droplets/{droplet_id}/firewalls
List All Available Kernels for a Droplet
client.gpuDroplets.listKernels(numberdropletID, GPUDropletListKernelsParams { page, per_page } query?, RequestOptionsoptions?): GPUDropletListKernelsResponse { meta, kernels, links }
/v2/droplets/{droplet_id}/kernels
List Neighbors for a Droplet
client.gpuDroplets.listNeighbors(numberdropletID, RequestOptionsoptions?): GPUDropletListNeighborsResponse { droplets }
/v2/droplets/{droplet_id}/neighbors
List Snapshots for a Droplet
client.gpuDroplets.listSnapshots(numberdropletID, GPUDropletListSnapshotsParams { page, per_page } query?, RequestOptionsoptions?): GPUDropletListSnapshotsResponse { meta, links, snapshots }
/v2/droplets/{droplet_id}/snapshots
Retrieve an Existing Droplet
client.gpuDroplets.retrieve(numberdropletID, RequestOptionsoptions?): GPUDropletRetrieveResponse { droplet }
/v2/droplets/{droplet_id}
Models
GPU DropletsAccount
GPU DropletsAccountKeys
Create a New SSH Key
client.gpuDroplets.account.keys.create(KeyCreateParams { name, public_key } body, RequestOptionsoptions?): KeyCreateResponse { ssh_key }
/v2/account/keys
Delete an SSH Key
client.gpuDroplets.account.keys.delete(number | stringsshKeyIdentifier, RequestOptionsoptions?): void
/v2/account/keys/{ssh_key_identifier}
List All SSH Keys
client.gpuDroplets.account.keys.list(KeyListParams { page, per_page } query?, RequestOptionsoptions?): KeyListResponse { meta, links, ssh_keys }
/v2/account/keys
Retrieve an Existing SSH Key
client.gpuDroplets.account.keys.retrieve(number | stringsshKeyIdentifier, RequestOptionsoptions?): KeyRetrieveResponse { ssh_key }
/v2/account/keys/{ssh_key_identifier}
Update an SSH Key's Name
client.gpuDroplets.account.keys.update(number | stringsshKeyIdentifier, KeyUpdateParams { name } body, RequestOptionsoptions?): KeyUpdateResponse { ssh_key }
/v2/account/keys/{ssh_key_identifier}
Models
GPU DropletsActions
Acting on Tagged Droplets
client.gpuDroplets.actions.bulkInitiate(ActionBulkInitiateParamsparams, RequestOptionsoptions?): ActionBulkInitiateResponse { actions }
/v2/droplets/actions
Initiate a Droplet Action
client.gpuDroplets.actions.initiate(numberdropletID, ActionInitiateParamsbody, RequestOptionsoptions?): ActionInitiateResponse { action }
/v2/droplets/{droplet_id}/actions
List Actions for a Droplet
client.gpuDroplets.actions.list(numberdropletID, ActionListParams { page, per_page } query?, RequestOptionsoptions?): ActionListResponse { meta, actions, links }
/v2/droplets/{droplet_id}/actions
Retrieve a Droplet Action
client.gpuDroplets.actions.retrieve(numberactionID, ActionRetrieveParams { droplet_id } params, RequestOptionsoptions?): ActionRetrieveResponse { action }
/v2/droplets/{droplet_id}/actions/{action_id}
GPU DropletsAutoscale
Create a New Autoscale Pool
client.gpuDroplets.autoscale.create(AutoscaleCreateParams { config, droplet_template, name } body, RequestOptionsoptions?): AutoscaleCreateResponse { autoscale_pool }
/v2/droplets/autoscale
Delete autoscale pool
client.gpuDroplets.autoscale.delete(stringautoscalePoolID, RequestOptionsoptions?): void
/v2/droplets/autoscale/{autoscale_pool_id}
Delete autoscale pool and resources
client.gpuDroplets.autoscale.deleteDangerous(stringautoscalePoolID, AutoscaleDeleteDangerousParams { xDangerous } params, RequestOptionsoptions?): void
/v2/droplets/autoscale/{autoscale_pool_id}/dangerous
List All Autoscale Pools
client.gpuDroplets.autoscale.list(AutoscaleListParams { name, page, per_page } query?, RequestOptionsoptions?): AutoscaleListResponse { meta, autoscale_pools, links }
/v2/droplets/autoscale
List history events
client.gpuDroplets.autoscale.listHistory(stringautoscalePoolID, AutoscaleListHistoryParams { page, per_page } query?, RequestOptionsoptions?): AutoscaleListHistoryResponse { meta, history, links }
/v2/droplets/autoscale/{autoscale_pool_id}/history
List members
client.gpuDroplets.autoscale.listMembers(stringautoscalePoolID, AutoscaleListMembersParams { page, per_page } query?, RequestOptionsoptions?): AutoscaleListMembersResponse { meta, droplets, links }
/v2/droplets/autoscale/{autoscale_pool_id}/members
Retrieve an Existing Autoscale Pool
client.gpuDroplets.autoscale.retrieve(stringautoscalePoolID, RequestOptionsoptions?): AutoscaleRetrieveResponse { autoscale_pool }
/v2/droplets/autoscale/{autoscale_pool_id}
Update Autoscale Pool
client.gpuDroplets.autoscale.update(stringautoscalePoolID, AutoscaleUpdateParams { config, droplet_template, name } body, RequestOptionsoptions?): AutoscaleUpdateResponse { autoscale_pool }
/v2/droplets/autoscale/{autoscale_pool_id}
Models
GPU DropletsBackups
List Backups for a Droplet
client.gpuDroplets.backups.list(numberdropletID, BackupListParams { page, per_page } query?, RequestOptionsoptions?): BackupListResponse { meta, backups, links }
/v2/droplets/{droplet_id}/backups
List Backup Policies for All Existing Droplets
client.gpuDroplets.backups.listPolicies(BackupListPoliciesParams { page, per_page } query?, RequestOptionsoptions?): BackupListPoliciesResponse { meta, links, policies }
/v2/droplets/backups/policies
List Supported Droplet Backup Policies
client.gpuDroplets.backups.listSupportedPolicies(RequestOptionsoptions?): BackupListSupportedPoliciesResponse { supported_policies }
/v2/droplets/backups/supported_policies
Retrieve the Backup Policy for an Existing Droplet
client.gpuDroplets.backups.retrievePolicy(numberdropletID, RequestOptionsoptions?): BackupRetrievePolicyResponse { policy }
/v2/droplets/{droplet_id}/backups/policy
GPU DropletsDestroy With Associated Resources
Check Status of a Droplet Destroy with Associated Resources Request
client.gpuDroplets.destroyWithAssociatedResources.checkStatus(numberdropletID, RequestOptionsoptions?): DestroyWithAssociatedResourceCheckStatusResponse { completed_at, droplet, failures, resources }
/v2/droplets/{droplet_id}/destroy_with_associated_resources/status
Destroy a Droplet and All of its Associated Resources (Dangerous)
client.gpuDroplets.destroyWithAssociatedResources.deleteDangerous(numberdropletID, DestroyWithAssociatedResourceDeleteDangerousParams { xDangerous } params, RequestOptionsoptions?): void
/v2/droplets/{droplet_id}/destroy_with_associated_resources/dangerous
Selectively Destroy a Droplet and its Associated Resources
client.gpuDroplets.destroyWithAssociatedResources.deleteSelective(numberdropletID, DestroyWithAssociatedResourceDeleteSelectiveParams { floating_ips, reserved_ips, snapshots, 2 more } body?, RequestOptionsoptions?): void
/v2/droplets/{droplet_id}/destroy_with_associated_resources/selective
List Associated Resources for a Droplet
client.gpuDroplets.destroyWithAssociatedResources.list(numberdropletID, RequestOptionsoptions?): DestroyWithAssociatedResourceListResponse { floating_ips, reserved_ips, snapshots, 2 more }
/v2/droplets/{droplet_id}/destroy_with_associated_resources
Retry a Droplet Destroy with Associated Resources Request
client.gpuDroplets.destroyWithAssociatedResources.retry(numberdropletID, RequestOptionsoptions?): void
/v2/droplets/{droplet_id}/destroy_with_associated_resources/retry
Models
GPU DropletsFirewalls
Create a New Firewall
client.gpuDroplets.firewalls.create(FirewallCreateParams { body } params?, RequestOptionsoptions?): FirewallCreateResponse { firewall }
/v2/firewalls
Delete a Firewall
client.gpuDroplets.firewalls.delete(stringfirewallID, RequestOptionsoptions?): void
/v2/firewalls/{firewall_id}
List All Firewalls
client.gpuDroplets.firewalls.list(FirewallListParams { page, per_page } query?, RequestOptionsoptions?): FirewallListResponse { meta, firewalls, links }
/v2/firewalls
Retrieve an Existing Firewall
client.gpuDroplets.firewalls.retrieve(stringfirewallID, RequestOptionsoptions?): FirewallRetrieveResponse { firewall }
/v2/firewalls/{firewall_id}
Update a Firewall
client.gpuDroplets.firewalls.update(stringfirewallID, FirewallUpdateParams { firewall } params, RequestOptionsoptions?): FirewallUpdateResponse { firewall }
/v2/firewalls/{firewall_id}
Models
GPU DropletsFirewallsDroplets
Add Droplets to a Firewall
client.gpuDroplets.firewalls.droplets.add(stringfirewallID, DropletAddParams { droplet_ids } body, RequestOptionsoptions?): void
/v2/firewalls/{firewall_id}/droplets
Remove Droplets from a Firewall
client.gpuDroplets.firewalls.droplets.remove(stringfirewallID, DropletRemoveParams { droplet_ids } body, RequestOptionsoptions?): void
/v2/firewalls/{firewall_id}/droplets
GPU DropletsFirewallsRules
Add Rules to a Firewall
client.gpuDroplets.firewalls.rules.add(stringfirewallID, RuleAddParams { inbound_rules, outbound_rules } body?, RequestOptionsoptions?): void
/v2/firewalls/{firewall_id}/rules
Remove Rules from a Firewall
client.gpuDroplets.firewalls.rules.remove(stringfirewallID, RuleRemoveParams { inbound_rules, outbound_rules } body?, RequestOptionsoptions?): void
/v2/firewalls/{firewall_id}/rules
GPU DropletsFirewallsTags
Add Tags to a Firewall
client.gpuDroplets.firewalls.tags.add(stringfirewallID, TagAddParams { tags } body, RequestOptionsoptions?): void
/v2/firewalls/{firewall_id}/tags
Remove Tags from a Firewall
client.gpuDroplets.firewalls.tags.remove(stringfirewallID, TagRemoveParams { tags } body, RequestOptionsoptions?): void
/v2/firewalls/{firewall_id}/tags
GPU DropletsFloating IPs
Create a New Floating IP
client.gpuDroplets.floatingIPs.create(FloatingIPCreateParamsbody, RequestOptionsoptions?): FloatingIPCreateResponse { floating_ip, links }
/v2/floating_ips
Delete a Floating IP
client.gpuDroplets.floatingIPs.delete(stringfloatingIP, RequestOptionsoptions?): void
/v2/floating_ips/{floating_ip}
List All Floating IPs
client.gpuDroplets.floatingIPs.list(FloatingIPListParams { page, per_page } query?, RequestOptionsoptions?): FloatingIPListResponse { meta, floating_ips, links }
/v2/floating_ips
Retrieve an Existing Floating IP
client.gpuDroplets.floatingIPs.retrieve(stringfloatingIP, RequestOptionsoptions?): FloatingIPRetrieveResponse { floating_ip }
/v2/floating_ips/{floating_ip}
Models
GPU DropletsFloating IPsActions
Initiate a Floating IP Action
client.gpuDroplets.floatingIPs.actions.create(stringfloatingIP, ActionCreateParamsbody, RequestOptionsoptions?): ActionCreateResponse { action }
/v2/floating_ips/{floating_ip}/actions
List All Actions for a Floating IP
client.gpuDroplets.floatingIPs.actions.list(stringfloatingIP, RequestOptionsoptions?): ActionListResponse { meta, actions, links }
/v2/floating_ips/{floating_ip}/actions
Retrieve an Existing Floating IP Action
client.gpuDroplets.floatingIPs.actions.retrieve(numberactionID, ActionRetrieveParams { floating_ip } params, RequestOptionsoptions?): ActionRetrieveResponse { action }
/v2/floating_ips/{floating_ip}/actions/{action_id}
GPU DropletsImages
Create a Custom Image
client.gpuDroplets.images.create(ImageCreateParams { description, distribution, name, 3 more } body, RequestOptionsoptions?): ImageCreateResponse { image }
/v2/images
Delete an Image
client.gpuDroplets.images.delete(numberimageID, RequestOptionsoptions?): void
/v2/images/{image_id}
List All Images
client.gpuDroplets.images.list(ImageListParams { page, per_page, _private, 2 more } query?, RequestOptionsoptions?): ImageListResponse { images, meta, links }
/v2/images
Retrieve an Existing Image
client.gpuDroplets.images.retrieve(number | stringimageID, RequestOptionsoptions?): ImageRetrieveResponse { image }
/v2/images/{image_id}
Update an Image
client.gpuDroplets.images.update(numberimageID, ImageUpdateParams { description, distribution, name } body, RequestOptionsoptions?): ImageUpdateResponse { image }
/v2/images/{image_id}
GPU DropletsImagesActions
Initiate an Image Action
client.gpuDroplets.images.actions.create(numberimageID, ActionCreateParamsbody, RequestOptionsoptions?): Action { id, completed_at, region, 6 more }
/v2/images/{image_id}/actions
List All Actions for an Image
client.gpuDroplets.images.actions.list(numberimageID, RequestOptionsoptions?): ActionListResponse { meta, actions, links }
/v2/images/{image_id}/actions
Retrieve an Existing Action
client.gpuDroplets.images.actions.retrieve(numberactionID, ActionRetrieveParams { image_id } params, RequestOptionsoptions?): Action { id, completed_at, region, 6 more }
/v2/images/{image_id}/actions/{action_id}
GPU DropletsLoad Balancers
Create a New Load Balancer
client.gpuDroplets.loadBalancers.create(LoadBalancerCreateParamsbody, RequestOptionsoptions?): LoadBalancerCreateResponse { load_balancer }
/v2/load_balancers
Delete a Load Balancer
client.gpuDroplets.loadBalancers.delete(stringlbID, RequestOptionsoptions?): void
/v2/load_balancers/{lb_id}
Delete a Global Load Balancer CDN Cache
client.gpuDroplets.loadBalancers.deleteCache(stringlbID, RequestOptionsoptions?): void
/v2/load_balancers/{lb_id}/cache
List All Load Balancers
client.gpuDroplets.loadBalancers.list(LoadBalancerListParams { page, per_page } query?, RequestOptionsoptions?): LoadBalancerListResponse { meta, links, load_balancers }
/v2/load_balancers
Retrieve an Existing Load Balancer
client.gpuDroplets.loadBalancers.retrieve(stringlbID, RequestOptionsoptions?): LoadBalancerRetrieveResponse { load_balancer }
/v2/load_balancers/{lb_id}
Update a Load Balancer
client.gpuDroplets.loadBalancers.update(stringlbID, LoadBalancerUpdateParamsbody, RequestOptionsoptions?): LoadBalancerUpdateResponse { load_balancer }
/v2/load_balancers/{lb_id}
Models
GPU DropletsLoad BalancersDroplets
Add Droplets to a Load Balancer
client.gpuDroplets.loadBalancers.droplets.add(stringlbID, DropletAddParams { droplet_ids } body, RequestOptionsoptions?): void
/v2/load_balancers/{lb_id}/droplets
Remove Droplets from a Load Balancer
client.gpuDroplets.loadBalancers.droplets.remove(stringlbID, DropletRemoveParams { droplet_ids } body, RequestOptionsoptions?): void
/v2/load_balancers/{lb_id}/droplets
GPU DropletsLoad BalancersForwarding Rules
Add Forwarding Rules to a Load Balancer
client.gpuDroplets.loadBalancers.forwardingRules.add(stringlbID, ForwardingRuleAddParams { forwarding_rules } body, RequestOptionsoptions?): void
/v2/load_balancers/{lb_id}/forwarding_rules
Remove Forwarding Rules from a Load Balancer
client.gpuDroplets.loadBalancers.forwardingRules.remove(stringlbID, ForwardingRuleRemoveParams { forwarding_rules } body, RequestOptionsoptions?): void
/v2/load_balancers/{lb_id}/forwarding_rules
GPU DropletsSizes
List All Droplet Sizes
client.gpuDroplets.sizes.list(SizeListParams { page, per_page } query?, RequestOptionsoptions?): SizeListResponse { meta, sizes, links }
/v2/sizes
GPU DropletsSnapshots
Delete a Snapshot
client.gpuDroplets.snapshots.delete(number | stringsnapshotID, RequestOptionsoptions?): void
/v2/snapshots/{snapshot_id}
List All Snapshots
client.gpuDroplets.snapshots.list(SnapshotListParams { page, per_page, resource_type } query?, RequestOptionsoptions?): SnapshotListResponse { meta, links, snapshots }
/v2/snapshots
Retrieve an Existing Snapshot
client.gpuDroplets.snapshots.retrieve(number | stringsnapshotID, RequestOptionsoptions?): SnapshotRetrieveResponse { snapshot }
/v2/snapshots/{snapshot_id}
GPU DropletsVolumes
Create a New Block Storage Volume
client.gpuDroplets.volumes.create(VolumeCreateParamsbody, RequestOptionsoptions?): VolumeCreateResponse { volume }
/v2/volumes
Delete a Block Storage Volume
client.gpuDroplets.volumes.delete(stringvolumeID, RequestOptionsoptions?): void
/v2/volumes/{volume_id}
Delete a Block Storage Volume by Name
client.gpuDroplets.volumes.deleteByName(VolumeDeleteByNameParams { name, region } params?, RequestOptionsoptions?): void
/v2/volumes
List All Block Storage Volumes
client.gpuDroplets.volumes.list(VolumeListParams { name, page, per_page, region } query?, RequestOptionsoptions?): VolumeListResponse { meta, volumes, links }
/v2/volumes
Retrieve an Existing Block Storage Volume
client.gpuDroplets.volumes.retrieve(stringvolumeID, RequestOptionsoptions?): VolumeRetrieveResponse { volume }
/v2/volumes/{volume_id}
GPU DropletsVolumesActions
Initiate A Block Storage Action By Volume Id
client.gpuDroplets.volumes.actions.initiateByID(stringvolumeID, ActionInitiateByIDParamsparams, RequestOptionsoptions?): ActionInitiateByIDResponse { action }
/v2/volumes/{volume_id}/actions
Initiate A Block Storage Action By Volume Name
client.gpuDroplets.volumes.actions.initiateByName(ActionInitiateByNameParamsparams, RequestOptionsoptions?): ActionInitiateByNameResponse { action }
/v2/volumes/actions
List All Actions for a Volume
client.gpuDroplets.volumes.actions.list(stringvolumeID, ActionListParams { page, per_page } query?, RequestOptionsoptions?): ActionListResponse { meta, actions, links }
/v2/volumes/{volume_id}/actions
Retrieve an Existing Volume Action
client.gpuDroplets.volumes.actions.retrieve(numberactionID, ActionRetrieveParams { volume_id, page, per_page } params, RequestOptionsoptions?): ActionRetrieveResponse { action }
/v2/volumes/{volume_id}/actions/{action_id}
Models
GPU DropletsVolumesSnapshots
Create Snapshot from a Volume
client.gpuDroplets.volumes.snapshots.create(stringvolumeID, SnapshotCreateParams { name, tags } body, RequestOptionsoptions?): SnapshotCreateResponse { snapshot }
/v2/volumes/{volume_id}/snapshots
Delete a Volume Snapshot
client.gpuDroplets.volumes.snapshots.delete(stringsnapshotID, RequestOptionsoptions?): void
/v2/volumes/snapshots/{snapshot_id}
List Snapshots for a Volume
client.gpuDroplets.volumes.snapshots.list(stringvolumeID, SnapshotListParams { page, per_page } query?, RequestOptionsoptions?): SnapshotListResponse { meta, links, snapshots }
/v2/volumes/{volume_id}/snapshots
Retrieve an Existing Volume Snapshot
client.gpuDroplets.volumes.snapshots.retrieve(stringsnapshotID, RequestOptionsoptions?): SnapshotRetrieveResponse { snapshot }
/v2/volumes/snapshots/{snapshot_id}