List

List Associated Resources for a Droplet

client.gpuDroplets.destroyWithAssociatedResources.list(, ?): DestroyWithAssociatedResourceListResponse { floating_ips, reserved_ips, snapshots, 2 more }

get/v2/droplets/{droplet_id}/destroy_with_associated_resources

To list the associated billable resources that can be destroyed along with a Droplet, send a GET request to the /v2/droplets/$DROPLET_ID/destroy_with_associated_resources endpoint.

This endpoint will only return resources that you are authorized to see. For example, to see associated Reserved IPs, include the reserved_ip:read scope.

The response will be a JSON object containing snapshots, volumes, and volume_snapshots keys. Each will be set to an array of objects containing information about the associated resources.

ParametersExpand Collapse

dropletID: number

ReturnsExpand Collapse

DestroyWithAssociatedResourceListResponse { floating_ips, reserved_ips, snapshots, 2 more }

floating_ips?: Array<AssociatedResource { id, cost, name } >

Floating IPs that are associated with this Droplet.
Requires reserved_ip:read scope.

id?: string

The unique identifier for the resource associated with the Droplet.

cost?: string

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

name?: string

The name of the resource associated with the Droplet.

reserved_ips?: Array<AssociatedResource { id, cost, name } >

Reserved IPs that are associated with this Droplet.
Requires reserved_ip:read scope.

id?: string

The unique identifier for the resource associated with the Droplet.

cost?: string

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

name?: string

The name of the resource associated with the Droplet.

snapshots?: Array<AssociatedResource { id, cost, name } >

Snapshots that are associated with this Droplet.
Requires image:read scope.

id?: string

The unique identifier for the resource associated with the Droplet.

cost?: string

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

name?: string

The name of the resource associated with the Droplet.

volume_snapshots?: Array<AssociatedResource { id, cost, name } >

Volume Snapshots that are associated with this Droplet.
Requires block_storage_snapshot:read scope.

id?: string

The unique identifier for the resource associated with the Droplet.

cost?: string

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

name?: string

The name of the resource associated with the Droplet.

volumes?: Array<AssociatedResource { id, cost, name } >

Volumes that are associated with this Droplet.
Requires block_storage:read scope.

id?: string

The unique identifier for the resource associated with the Droplet.

cost?: string

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

name?: string

The name of the resource associated with the Droplet.

List Associated Resources for a Droplet

import Gradient from '@digitalocean/gradient';

const client = new Gradient();

const destroyWithAssociatedResources = await client.gpuDroplets.destroyWithAssociatedResources.list(3164444);

console.log(destroyWithAssociatedResources.floating_ips);

{
  "floating_ips": [
    {
      "id": "61486916",
      "cost": "0.05",
      "name": "ubuntu-s-1vcpu-1gb-nyc1-01-1585758823330"
    }
  ],
  "reserved_ips": [
    {
      "id": "61486916",
      "cost": "0.05",
      "name": "ubuntu-s-1vcpu-1gb-nyc1-01-1585758823330"
    }
  ],
  "snapshots": [
    {
      "id": "61486916",
      "cost": "0.05",
      "name": "ubuntu-s-1vcpu-1gb-nyc1-01-1585758823330"
    }
  ],
  "volume_snapshots": [
    {
      "id": "61486916",
      "cost": "0.05",
      "name": "ubuntu-s-1vcpu-1gb-nyc1-01-1585758823330"
    }
  ],
  "volumes": [
    {
      "id": "61486916",
      "cost": "0.05",
      "name": "ubuntu-s-1vcpu-1gb-nyc1-01-1585758823330"
    }
  ]
}

Returns Examples

{
  "floating_ips": [
    {
      "id": "61486916",
      "cost": "0.05",
      "name": "ubuntu-s-1vcpu-1gb-nyc1-01-1585758823330"
    }
  ],
  "reserved_ips": [
    {
      "id": "61486916",
      "cost": "0.05",
      "name": "ubuntu-s-1vcpu-1gb-nyc1-01-1585758823330"
    }
  ],
  "snapshots": [
    {
      "id": "61486916",
      "cost": "0.05",
      "name": "ubuntu-s-1vcpu-1gb-nyc1-01-1585758823330"
    }
  ],
  "volume_snapshots": [
    {
      "id": "61486916",
      "cost": "0.05",
      "name": "ubuntu-s-1vcpu-1gb-nyc1-01-1585758823330"
    }
  ],
  "volumes": [
    {
      "id": "61486916",
      "cost": "0.05",
      "name": "ubuntu-s-1vcpu-1gb-nyc1-01-1585758823330"
    }
  ]
}