Update an Image

PUT

/images/{id}

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.

Note that when updating labels, the current set of labels will be replaced with the labels provided in the request body. So, for example, if you want to add a new label, you have to provide all existing labels plus the new label in the request body.

Request

Path Params

Body Params application/json

Examples

Responses

🟢200The image key in the reply contains the modified Image object

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://api.hetzner.cloud/v1/images/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "description": "My new Image description",
    "labels": {
        "labelkey": "value"
    },
    "type": "snapshot"
}'

Response Example

{
    "image": {
        "bound_to": null,
        "build_id": "c313fe40383af26094a5a92026054320ab55abc7",
        "created": "2016-01-30T23:50:00.000Z",
        "created_from": {
            "id": 1,
            "name": "Server"
        },
        "deleted": null,
        "deprecated": "2018-02-28T00:00:00.000Z",
        "description": "My new Image description",
        "disk_size": 10,
        "id": 4711,
        "image_size": 2.3,
        "labels": {
            "labelkey": "value"
        },
        "name": null,
        "os_flavor": "ubuntu",
        "os_version": "20.04",
        "protection": {
            "delete": false
        },
        "rapid_deploy": false,
        "status": "available",
        "type": "snapshot"
    }
}

Modified at 2023-08-16 03:09:21

Get an Image

Get all Actions for an Image