machineImage_regenerate

POST /users/{uid}/appliances/{aid}/images/{itid}

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.2

Request to re-generate a machine image from a previous generation request. The meta-data of the previous generation request will be re-used.

This response body is a new image ticket providing the meta-data of the machine image that is to be generated. The actual generation is done asynchronously. To poll the status of this generation, use machineImageStatus_get.

Once complete, the machine image can be downloaded if the compressed flag was provided in the request.

To cancel a generation use machineImageGeneration_cancel

Note

to generate a machine image, the appliance must have as a minimum an os profile.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: image_generate

URI Parameters

  • uid (required): the user name (login name) of the user
  • itid (required): the id of the image
  • aid (required): the id of the appliance

HTTP Request Body Parameters

None