How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Digital Ocean Droplets API

A [Droplet](https://docs.digitalocean.com/products/droplets/) is a DigitalOceanvirtual machine. By sending requests to the Droplet endpoint, you canlist, create, or delete Droplets.Some of the attributes will have an object value. The `region` and `image`objects will all contain the standard attributes of their associatedtypes. Find more information about each of these objects in theirrespective sections.

Digital Ocean Droplets API is one of 37 APIs that Digital Ocean publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Droplets. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 19 operations across 16 paths, and defines 46 schemas. It is described by OpenAPI 3.0.0, at version 2.0.

Requests are made against a single base URL, https://api.digitalocean.com.

19 operations 16 paths 46 schemas 4 DELETE13 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.0
Base URL
https://api.digitalocean.com/v2
Authentication
HTTP Bearer
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Digital Ocean Droplets API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearer_auth). By default, every request must be authenticated.

  • bearer_auth — OAuth Authentication In order to interact with the DigitalOcean API, you or your application must authenticate. The DigitalOcean API handles this through OAuth…

Paths & Operations 19

Across 16 paths, the API surfaces 19 operations — 4 DELETE, 13 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Droplets 19

A [Droplet](https://docs.digitalocean.com/products/droplets/) is a DigitalOcean virtual machine. By sending requests to the Droplet endpoint, you can list, create, or delete Dropl…

GET
/v2/droplets
List All Droplets
droplets_list 5 params → 200401429500default
POST
/v2/droplets
Create a New Droplet
droplets_create body → 202401429500default
DELETE
/v2/droplets
Deleting Droplets by Tag
droplets_destroy_byTag 1 param → 204401404429500default
GET
/v2/droplets/{droplet_id}
Retrieve an Existing Droplet
droplets_get 1 param → 200401404429500default
DELETE
/v2/droplets/{droplet_id}
Delete an Existing Droplet
droplets_destroy 1 param → 204401404429500default
GET
/v2/droplets/{droplet_id}/backups
List Backups for a Droplet
droplets_list_backups 3 params → 200401404429500default
GET
/v2/droplets/{droplet_id}/backups/policy
Retrieve the Backup Policy for an Existing Droplet
droplets_get_backup_policy 1 param → 200401404429500default
GET
/v2/droplets/backups/policies
List Backup Policies for All Existing Droplets
droplets_list_backup_policies 2 params → 200401404429500default
GET
/v2/droplets/backups/supported_policies
List Supported Droplet Backup Policies
droplets_list_supported_backup_policies → 200401404429500default
GET
/v2/droplets/{droplet_id}/snapshots
List Snapshots for a Droplet
droplets_list_snapshots 3 params → 200401404429500default
GET
/v2/droplets/{droplet_id}/kernels
List All Available Kernels for a Droplet
droplets_list_kernels 3 params → 200401404429500default
GET
/v2/droplets/{droplet_id}/firewalls
List all Firewalls Applied to a Droplet
droplets_list_firewalls 3 params → 200401404429500default
GET
/v2/droplets/{droplet_id}/neighbors
List Neighbors for a Droplet
droplets_list_neighbors 1 param → 200401404429500default
GET
/v2/droplets/{droplet_id}/destroy_with_associated_resources
List Associated Resources for a Droplet
droplets_list_associatedResources 1 param → 200401404429500default
DELETE
/v2/droplets/{droplet_id}/destroy_with_associated_resources/selective
Selectively Destroy a Droplet and its Associated Resources
droplets_destroy_withAssociatedResourcesSelective 1 param body → 202401404429500default
DELETE
/v2/droplets/{droplet_id}/destroy_with_associated_resources/dangerous
Destroy a Droplet and All of its Associated Resources (Dangerous)
droplets_destroy_withAssociatedResourcesDangerous 2 params → 202401404429500default
GET
/v2/droplets/{droplet_id}/destroy_with_associated_resources/status
Check Status of a Droplet Destroy with Associated Resources Request
droplets_get_DestroyAssociatedResourcesStatus 1 param → 200401404429500default
POST
/v2/droplets/{droplet_id}/destroy_with_associated_resources/retry
Retry a Droplet Destroy with Associated Resources Request
droplets_destroy_retryWithAssociatedResources 1 param → 202401404409429500default
GET
/v2/reports/droplet_neighbors_ids
List All Droplet Neighbors
droplets_list_neighborsIds → 200401404429500default

Schemas 46

The contract defines 46 schemas that model the data the API accepts and returns. The most detailed are droplet (23 properties), droplet_create (14 properties), image (14 properties), size (12 properties). Each schema is shown below with its type and property counts.

link_to_prev_page
object
1 property
destroyed_associated_resource
object
An object containing information about a resource scheduled for deletion.
4 properties
droplet_backup_policy_record
object
4 properties
image_description
string
An optional free-form text field to describe an image.
pagination
object
1 property
backward_links
kernel
object
Note: All Droplets created after March 2017 use internal kernels by default. These Droplets will have this attribute set to null. The current [kernel](https://…
3 properties
droplet
object
23 properties 19 required
network_v4
object
4 properties
regions_array
array
This attribute is an array of the regions that the image is available in. The regions are represented by their identifying slug values.
gpu_info
object
An object containing information about the GPU capabilities of Droplets created with this size.
3 properties
droplet_create
object
14 properties 2 required
droplet_backup_policy
object
5 properties
droplet_single_create
firewall_rule_target
object
5 properties
error
object
3 properties 2 required
supported_droplet_backup_policy
object
5 properties
tags_array
array
A flat array of tag names as strings to be applied to the resource. Tag names may be for either existing or new tags.
firewall
object
size
object
12 properties 10 required
snapshots_base
object
5 properties 5 required
associated_resource_status
object
An objects containing information about a resources scheduled for deletion.
4 properties
neighbor_ids
object
1 property
region_slug
string
The slug identifier for the region where the resource will initially be available.
firewall_rules
object
2 properties
action_link
object
The linked actions can be used to check the status of a Droplet's create event.
3 properties
image_name
string
The display name that has been given to an image. This is what is shown in the control panel and is generally a descriptive title for the image in question.
meta_properties
object
Information about the response itself.
1 property
associated_resource
object
An objects containing information about a resource associated with a Droplet.
3 properties
link_to_next_page
object
1 property
distribution
string
The name of a custom image's distribution. Currently, the valid values are Arch Linux, CentOS, CoreOS, Debian, Fedora, Fedora Atomic, FreeBSD, Gentoo, openSUSE…
network_v6
object
4 properties
link_to_last_page
object
1 property
page_links
object
1 property
existing_tags_array
array
A flat array of tag names as strings to be applied to the resource. Tag names must exist in order to be referenced in a request.
droplet_snapshot
droplet_multi_create
forward_links
region
object
5 properties 5 required
selective_destroy_associated_resource
object
An object containing information about a resource to be scheduled for deletion.
5 properties
link_to_first_page
object
1 property
disk_info
object
2 properties
meta
object
1 property 1 required
droplet_next_backup_window
object
2 properties
image
object
14 properties
firewall_rule_base
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

digital-ocean-droplets-api-openapi.yml Raw ↑

Other APIs Digital Ocean publishes across the network.

Digital Ocean 1-Click Applications API
Digital Ocean Account API
Digital Ocean Actions API
Digital Ocean Apps API
Digital Ocean Billing API
Digital Ocean Block Storage Actions API
Digital Ocean Block Storage API
Digital Ocean CDN Endpoints API
Digital Ocean Certificates API
Digital Ocean Container Registry API
Digital Ocean Databases API
Digital Ocean Domain Records API
Where this information came from

This is an independent, third-party profile of Digital Ocean Droplets API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.