v8

latestOpenAPI 3.0.0Apache 2.0raw.githubusercontent.com2025-10-165266542.4 MB

DigitalOcean-public.v2-new_Images

Update an Image

To update an image, send a PUT request to /v2/images/$IMAGE_ID. Set the name attribute to the new value you would like to use. For custom images, the description and distribution attributes may also be updated.

put/v2/images/{image_id}

Path parameters

image_idinteger required

A unique number that can be used to identify and reference a specific image.

Request body

namestring

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.

The name of a custom image's distribution. Currently, the valid values are Arch Linux, CentOS, CoreOS, Debian, Fedora, Fedora Atomic, FreeBSD, Gentoo, openSUSE, RancherOS, Rocky Linux, Ubuntu, and Unknown. Any other value will be accepted but ignored, and Unknown will be used in its place.

descriptionstring

An optional free-form text field to describe an image.

Example request

{
  "name": "Nifty New Snapshot",
  "distribution": "Ubuntu",
  "description": " "
}

Response

The response will be a JSON object with a key set to 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": " "
  }
}