Update an Image

Updates the Image. You may change the description, convert a Backup Image to a Snapshot Image or change the Image labels. Only Images of type snapshot and backup can be updated.

put/images/{id}

Request

Base URL: https://api.hetzner.cloud/v1
URL: https://api.hetzner.cloud/v1/images/{id}
Auth: HTTP bearer

Path parameters

idinteger required

ID of the Image.

Example:42

ID of the Image.

Request body

descriptionstring

New description of Image.

type'snapshot'

Destination Image type to convert to.

labelsobject

User-defined labels (key/value pairs) for the Resource.

Note that the set of Labels provided in the request will overwrite the existing one.

For more information, see "Labels".

Example request

{
  "description": "My new Image description",
  "labels": {
    "environment": "prod",
    "example.com/my": "label",
    "just-a-key": ""
  }
}

Response

Request succeeded.

Example response

{
  "image": {
    "id": 42,
    "type": "snapshot",
    "status": "available",
    "name": "ubuntu-24.04",
    "description": "Ubuntu 24.04 Standard 64 bit",
    "image_size": 2.3,
    "disk_size": 10,
    "created": "2016-01-30T23:55:00Z",
    "created_from": {
      "id": 1,
      "name": "Server"
    },
    "os_flavor": "ubuntu",
    "os_version": "24.04",
    "deprecated": "2018-02-28T00:00:00Z",
    "deprecation": {
      "unavailable_after": "2023-09-01T00:00:00Z",
      "announced": "2023-06-01T00:00:00Z"
    },
    "labels": {
      "environment": "prod",
      "example.com/my": "label",
      "just-a-key": ""
    },
    "architecture": "x86"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.