Reset a Compute instance to a base/target template

PUT /instance/{id}:reset

This operation re-installs a Compute instance to a base template. If target template is provided it will be used to recreated instance from. Warning: the operation wipes all data stored on the disk.

Path parameters

  • id string(uuid) Required
application/json

Body Required

  • template object

    Instance Template

    Hide template attributes Show template attributes
    • Template description

      Maximum length is 255.

    • Enable SSH key-based login

    • name string

      Template name

      Minimum length is 1, maximum length is 255.

    • Template default user

      Minimum length is 1, maximum length is 255.

    • size integer(int64)

      Template size

      Minimum value is 0.

    • Enable password-based login

    • checksum string

      Template MD5 checksum

    • Boot mode (default: legacy)

      Values are legacy or uefi.

    • zones array[string]

      Zones availability

      Values are ch-dk-2, de-muc-1, ch-gva-2, at-vie-1, de-fra-1, bg-sof-1, or at-vie-2.

    • url string

      Template source URL

  • disk-size integer(int64)

    Instance disk size in GiB

    Minimum value is 10, maximum value is 51200.

Responses

  • 200 application/json

    200

    Hide response attributes Show response attributes object
    • id string(uuid)

      Operation ID

    • reason string

      Operation failure reason

      Values are incorrect, unknown, unavailable, forbidden, busy, fault, partial, not-found, interrupted, unsupported, or conflict.

    • Related resource reference

      Hide reference attributes Show reference attributes
      • id string(uuid)

        Reference ID

      • command string

        Command name

    • message string

      Operation message

    • state string

      Operation status

      Values are failure, pending, success, or timeout.

PUT /instance/{id}:reset
curl \
 -X PUT https://api-ch-gva-2.exoscale.com/v2/instance/{id}:reset \
 -H "Content-Type: application/json" \
 -d '{"template":{"description":"string","ssh-key-enabled":true,"name":"string","default-user":"string","size":42,"password-enabled":true,"checksum":"string","boot-mode":"legacy","zones":["ch-dk-2"],"url":"string"},"disk-size":42}'
Request example
{
  "template": {
    "description": "string",
    "ssh-key-enabled": true,
    "name": "string",
    "default-user": "string",
    "size": 42,
    "password-enabled": true,
    "checksum": "string",
    "boot-mode": "legacy",
    "zones": [
      "ch-dk-2"
    ],
    "url": "string"
  },
  "disk-size": 42
}
Response examples (200)
{
  "id": "string",
  "reason": "incorrect",
  "reference": {
    "id": "string",
    "link": "string",
    "command": "string"
  },
  "message": "string",
  "state": "failure"
}