Skip to content
  • Auto
  • Light
  • Dark

List

List Associated Resources for a Droplet
gpu_droplets.destroy_with_associated_resources.list(intdroplet_id) -> DestroyWithAssociatedResourceListResponse
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
droplet_id: int
ReturnsExpand Collapse
class DestroyWithAssociatedResourceListResponse:
floating_ips: Optional[List[AssociatedResource]]

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

id: Optional[str]

The unique identifier for the resource associated with the Droplet.

cost: Optional[str]

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

name: Optional[str]

The name of the resource associated with the Droplet.

reserved_ips: Optional[List[AssociatedResource]]

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

id: Optional[str]

The unique identifier for the resource associated with the Droplet.

cost: Optional[str]

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

name: Optional[str]

The name of the resource associated with the Droplet.

snapshots: Optional[List[AssociatedResource]]

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

id: Optional[str]

The unique identifier for the resource associated with the Droplet.

cost: Optional[str]

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

name: Optional[str]

The name of the resource associated with the Droplet.

volume_snapshots: Optional[List[AssociatedResource]]

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

id: Optional[str]

The unique identifier for the resource associated with the Droplet.

cost: Optional[str]

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

name: Optional[str]

The name of the resource associated with the Droplet.

volumes: Optional[List[AssociatedResource]]

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

id: Optional[str]

The unique identifier for the resource associated with the Droplet.

cost: Optional[str]

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

name: Optional[str]

The name of the resource associated with the Droplet.

from gradient import Gradient

client = Gradient()
destroy_with_associated_resources = client.gpu_droplets.destroy_with_associated_resources.list(
    1,
)
print(destroy_with_associated_resources.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"
    }
  ]
}