Check Status

API Reference

GPU Droplets

Destroy 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 }

get/v2/droplets/{droplet_id}/destroy_with_associated_resources/status

To check on the status of a request to destroy a Droplet with its associated resources, send a GET request to the /v2/droplets/$DROPLET_ID/destroy_with_associated_resources/status endpoint.

ParametersExpand Collapse

dropletID: number

ReturnsExpand Collapse

DestroyWithAssociatedResourceCheckStatusResponse { completed_at, droplet, failures, resources }

An objects containing information about a resources scheduled for deletion.

completed_at?: string

A time value given in ISO8601 combined date and time format indicating when the requested action was completed.

formatdate-time

droplet?: DestroyedAssociatedResource { id, destroyed_at, error_message, name }

An object containing information about a resource scheduled for deletion.

id?: string

The unique identifier for the resource scheduled for deletion.

destroyed_at?: string

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_message?: string

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

name?: string

The name of the resource scheduled for deletion.

failures?: number

A count of the associated resources that failed to be destroyed, if any.

resources?: Resources { floating_ips, reserved_ips, snapshots, 2 more }

An object containing additional information about resource related to a Droplet requested to be destroyed.

floating_ips?: Array<DestroyedAssociatedResource { id, destroyed_at, error_message, name } >

id?: string

The unique identifier for the resource scheduled for deletion.

destroyed_at?: string

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_message?: string

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

name?: string

The name of the resource scheduled for deletion.

reserved_ips?: Array<DestroyedAssociatedResource { id, destroyed_at, error_message, name } >

id?: string

The unique identifier for the resource scheduled for deletion.

destroyed_at?: string

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_message?: string

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

name?: string

The name of the resource scheduled for deletion.

snapshots?: Array<DestroyedAssociatedResource { id, destroyed_at, error_message, name } >

id?: string

The unique identifier for the resource scheduled for deletion.

destroyed_at?: string

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_message?: string

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

name?: string

The name of the resource scheduled for deletion.

volume_snapshots?: Array<DestroyedAssociatedResource { id, destroyed_at, error_message, name } >

id?: string

The unique identifier for the resource scheduled for deletion.

destroyed_at?: string

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_message?: string

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

name?: string

The name of the resource scheduled for deletion.

volumes?: Array<DestroyedAssociatedResource { id, destroyed_at, error_message, name } >

id?: string

The unique identifier for the resource scheduled for deletion.

destroyed_at?: string

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_message?: string

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

name?: string

The name of the resource scheduled for deletion.

Check Status of a Droplet Destroy with Associated Resources Request

typescript

• http
• typescript
• python

import Gradient from '@digitalocean/gradient';

const client = new Gradient();

const response = await client.gpuDroplets.destroyWithAssociatedResources.checkStatus(3164444);

console.log(response.completed_at);

200 example

{
  "completed_at": "2020-04-01T18:11:49Z",
  "droplet": {
    "id": "61486916",
    "destroyed_at": "2020-04-01T18:11:49Z",
    "error_message": " ",
    "name": "ubuntu-s-1vcpu-1gb-nyc1-01-1585758823330"
  },
  "failures": 0,
  "resources": {
    "floating_ips": [
      {
        "id": "61486916",
        "destroyed_at": "2020-04-01T18:11:49Z",
        "error_message": " ",
        "name": "ubuntu-s-1vcpu-1gb-nyc1-01-1585758823330"
      }
    ],
    "reserved_ips": [
      {
        "id": "61486916",
        "destroyed_at": "2020-04-01T18:11:49Z",
        "error_message": " ",
        "name": "ubuntu-s-1vcpu-1gb-nyc1-01-1585758823330"
      }
    ],
    "snapshots": [
      {
        "id": "61486916",
        "destroyed_at": "2020-04-01T18:11:49Z",
        "error_message": " ",
        "name": "ubuntu-s-1vcpu-1gb-nyc1-01-1585758823330"
      }
    ],
    "volume_snapshots": [
      {
        "id": "61486916",
        "destroyed_at": "2020-04-01T18:11:49Z",
        "error_message": " ",
        "name": "ubuntu-s-1vcpu-1gb-nyc1-01-1585758823330"
      }
    ],
    "volumes": [
      {
        "id": "61486916",
        "destroyed_at": "2020-04-01T18:11:49Z",
        "error_message": " ",
        "name": "ubuntu-s-1vcpu-1gb-nyc1-01-1585758823330"
      }
    ]
  }
}

Returns Examples

200 example

{
  "completed_at": "2020-04-01T18:11:49Z",
  "droplet": {
    "id": "61486916",
    "destroyed_at": "2020-04-01T18:11:49Z",
    "error_message": " ",
    "name": "ubuntu-s-1vcpu-1gb-nyc1-01-1585758823330"
  },
  "failures": 0,
  "resources": {
    "floating_ips": [
      {
        "id": "61486916",
        "destroyed_at": "2020-04-01T18:11:49Z",
        "error_message": " ",
        "name": "ubuntu-s-1vcpu-1gb-nyc1-01-1585758823330"
      }
    ],
    "reserved_ips": [
      {
        "id": "61486916",
        "destroyed_at": "2020-04-01T18:11:49Z",
        "error_message": " ",
        "name": "ubuntu-s-1vcpu-1gb-nyc1-01-1585758823330"
      }
    ],
    "snapshots": [
      {
        "id": "61486916",
        "destroyed_at": "2020-04-01T18:11:49Z",
        "error_message": " ",
        "name": "ubuntu-s-1vcpu-1gb-nyc1-01-1585758823330"
      }
    ],
    "volume_snapshots": [
      {
        "id": "61486916",
        "destroyed_at": "2020-04-01T18:11:49Z",
        "error_message": " ",
        "name": "ubuntu-s-1vcpu-1gb-nyc1-01-1585758823330"
      }
    ],
    "volumes": [
      {
        "id": "61486916",
        "destroyed_at": "2020-04-01T18:11:49Z",
        "error_message": " ",
        "name": "ubuntu-s-1vcpu-1gb-nyc1-01-1585758823330"
      }
    ]
  }
}