pydo.snapshots.delete()

Generated on 25 November 2024 from pydo version v0.6.0

Description

Both Droplet and volume snapshots are managed through the /v2/snapshots/ endpoint. To delete a snapshot, send a DELETE request to /v2/snapshots/$SNAPSHOT_ID.

A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed.

Parameters

Name Type Required Description Default Value
snapshot_id JSON True Either the ID of an existing snapshot. This will be an integer for a Droplet snapshot or a string for a volume snapshot.

Request Sample

import os
from pydo import Client

client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN"))

resp = client.snapshots.delete(snapshot_id="fbe805e8")

Responses

See the API spec for this endpoint to view additional detail on responses, headers, parameters, and more.

The action was successful and the response body is empty.

Bad Request

Click to expand an example response. 
{
  "id": "bad_request",
  "message": "the resource is not a snapshot",
  "request_id": "bbd8d7d4-2beb-4be1-a374-338e6165e32d"
}

Unauthorized

Click to expand an example response. 
{
  "id": "unauthorized",
  "message": "Unable to authenticate you."
}

The resource was not found.

Click to expand an example response. 
{
  "id": "not_found",
  "message": "The resource you requested could not be found."
}

API Rate limit exceeded

Click to expand an example response. 
{
  "id": "too_many_requests",
  "message": "API Rate limit exceeded."
}

Server error.

Click to expand an example response. 
{
  "id": "server_error",
  "message": "Unexpected server-side error"
}

Unexpected error

Click to expand an example response. 
{
  "id": "example_error",
  "message": "some error message"
}
Control Panel Blog Pricing Careers Terms Privacy Status API Docs Tutorials Support