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 Images API

A DigitalOcean [image](https://docs.digitalocean.com/products/images/) can beused to create a Droplet and may come in a number of flavors. Currently,there are five types of images: snapshots, backups, applications,distributions, and custom images.* [Snapshots](https://docs.digitalocean.com/products/snapshots/) providea full copy of an existing Droplet instance taken on demand.* [Backups](https://docs.digitalocean.com/products/backups/) are similarto snapshots but are created automatically at regular intervals whenenabled for a Droplet.* [Custom images](https://docs.digitalocean.com/products/custom-images/)are Linux-based virtual machine images (raw, qcow2, vhdx, vdi, and vmdkformats are supported) that you may upload for use on DigitalOcean.* Distributions are the public Linux distributions that are available tobe used as a base to create Droplets.* Applications, or [1-Click Apps](https://docs.digitalocean.com/products/marketplace/),are distributions pre-configured with additional software.To interact with images, you will generally send requests to the imagesendpoint at /v2/images.

Digital Ocean Images 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 Image. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 2 paths, and defines 20 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.

5 operations 2 paths 20 schemas 1 DELETE2 GET1 POST1 PUT

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 Images 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 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Images 5

A DigitalOcean [image](https://docs.digitalocean.com/products/images/) can be used to create a Droplet and may come in a number of flavors. Currently, there are five types of imag…

GET
/v2/images
List All Images
images_list 5 params → 200401429500default
POST
/v2/images
Create a Custom Image
images_create_custom body → 202401429500default
GET
/v2/images/{image_id}
Retrieve an Existing Image
images_get 1 param → 200401404429500default
PUT
/v2/images/{image_id}
Update an Image
images_update 1 param body → 200401404429500default
DELETE
/v2/images/{image_id}
Delete an Image
images_delete 1 param → 204401404429500default

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are image (14 properties), error (3 properties), image_update (3 properties), link_to_next_page (1 property). Each schema is shown below with its type and property counts.

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…
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.
link_to_prev_page
object
1 property
page_links
object
1 property
link_to_last_page
object
1 property
region_slug
string
The slug identifier for the region where the resource will initially be available.
forward_links
image_new_custom
object
3 required
image_description
string
An optional free-form text field to describe an image.
pagination
object
1 property
link_to_first_page
object
1 property
error
object
3 properties 2 required
backward_links
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
meta
object
1 property 1 required
image
object
14 properties
link_to_next_page
object
1 property
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.
image_update
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

digital-ocean-images-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 Images 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.