v8

latestOpenAPI 3.0.0Apache 2.0raw.githubusercontent.com2025-10-165266542.4 MB
DigitalOcean-public.v2-new_Images

Retrieve an Existing Image

To retrieve information about an image, send a GET request to /v2/images/$IDENTIFIER.

get/v2/images/{image_id}

Path parameters

integer required
OR
string required

A unique number (id) or string (slug) used to identify and reference a specific image.

Public images can be identified by image id or slug.

Private images must be identified by image id.

Response

The response will be a JSON object with a key called image. The value of this will be an image object containing the standard image attributes.

Example response

{
  "image": {
    "id": 7555620,
    "name": "Nifty New Snapshot",
    "type": "snapshot",
    "distribution": "Ubuntu",
    "slug": "nifty1",
    "public": true,
    "regions": [
      "nyc1",
      "nyc2"
    ],
    "created_at": "2020-05-04T22:23:02Z",
    "min_disk_size": 20,
    "size_gigabytes": 2.34,
    "description": " ",
    "tags": [
      "base-image",
      "prod"
    ],
    "status": "NEW",
    "error_message": " "
  }
}