Promote a Snapshot to a Template

POST /snapshot/{id}:promote

Path parameters

  • id string(uuid) Required

Body Required

  • name string Required

    Template name

    Minimum length is 1, maximum length is 255.

  • Template description

    Maximum length is 4096.

  • Template default user

    Minimum length is 1, maximum length is 255.

  • Enable SSH key-based login in the template

  • Enable password-based login in the template


  • 200 application/json


    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.

POST /snapshot/{id}:promote
curl \
 -X POST{id}:promote \
 -H "Content-Type: application/json" \
 -d '{"name":"string","description":"string","default-user":"string","ssh-key-enabled":true,"password-enabled":true}'
Request example
  "name": "string",
  "description": "string",
  "default-user": "string",
  "ssh-key-enabled": true,
  "password-enabled": true
Response examples (200)
  "id": "string",
  "reason": "incorrect",
  "reference": {
    "id": "string",
    "link": "string",
    "command": "string"
  "message": "string",
  "state": "failure"