Retrieve

API Reference

GPU Droplets

Images

Retrieve an Existing Image

get/v2/images/{image_id}

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

Path ParametersExpand Collapse

image_id: number or string

Accepts one of the following:

UnionMember0 = number

UnionMember1 = string

ReturnsExpand Collapse

image: Image

HTTPPython

curl https://api.digitalocean.com/v2/images/$IMAGE_ID \
    -H "Authorization: Bearer $DIGITALOCEAN_ACCESS_TOKEN"

200 example

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

Returns Examples

200 example

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