Create Image from a Server

POST

/servers/{id}/actions/create_image

Creates an Image (snapshot) from a Server by copying the contents of its disks. This creates a snapshot of the current state of the disk and copies it into an Image. If the Server is currently running you must make sure that its disk content is consistent. Otherwise, the created Image may not be readable.

To make sure disk content is consistent, we recommend to shut down the Server prior to creating an Image.

You can either create a backup Image that is bound to the Server and therefore will be deleted when the Server is deleted, or you can create an snapshot Image which is completely independent of the Server it was created from and will survive Server deletion. Backup Images are only available when the backup option is enabled for the Server. Snapshot Images are billed on a per GB basis.

Request

Path Params

Body Params application/json

Examples

Responses

🟢201The `image` key in the reply contains an the created Image, which is an object with this structure The `action` key in the reply contains an Action object with this structure

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.hetzner.cloud/v1/servers//actions/create_image' \
--header 'Content-Type: application/json' \
--data-raw '{
    "description": "my image",
    "labels": {
        "labelkey": "value"
    },
    "type": "snapshot"
}'

Response Example

{
    "action": {
        "command": "create_image",
        "error": {
            "code": "action_failed",
            "message": "Action failed"
        },
        "finished": "2016-01-30T23:56:00.000Z",
        "id": 13,
        "progress": 100,
        "resources": [
            {
                "id": 42,
                "type": "server"
            }
        ],
        "started": "2016-01-30T23:55:00.000Z",
        "status": "success"
    },
    "image": {
        "bound_to": null,
        "created": "2016-01-30T23:50:00.000Z",
        "created_from": {
            "id": 1,
            "name": "Server"
        },
        "deleted": null,
        "deprecated": "2018-02-28T00:00:00.000Z",
        "description": "my image",
        "disk_size": 10,
        "id": 4711,
        "image_size": 2.3,
        "labels": {
            "env": "dev"
        },
        "name": null,
        "os_flavor": "ubuntu",
        "os_version": "20.04",
        "protection": {
            "delete": false
        },
        "rapid_deploy": false,
        "status": "creating",
        "type": "snapshot"
    }
}

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

Change the Type of a Server

Detach a Server from a Network