scanImage_generate¶
-
POST /users/{uid}/scannedinstances/{siid}/scans/{sid}/images
Request to generate a machine image from a scan.
This response body is an image ticket
that provides 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 scanImageGenerationStatus_get.
Once complete, the machine image can be downloaded if the compressed
flag was provided in the request.
To cancel a generation use scanImageGeneration_cancel
Security Summary¶
- Requires Authentication:
true
- Entitlements Required:
image_generate
URI Parameters¶
uid
(required): the user name (login name) of the usersiid
(required): the id of the scannedInstancesid
(required): the id of the scan
Example Request¶
curl "https://uforge.example.com/api/users/{uid}/scannedinstances/{siid}/scans/{sid}/images" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"
Example of representation.xml content (the request body):
<ns0:image xmlns:ns0="http://www.usharesoft.com/uforge">
<compress>true</compress>
<targetFormat>
<name>VirtualBox</name>
</targetFormat>
<installProfile>
<memorySize>512</memorySize>
</installProfile>
</ns0:image>
See also
- Machine Scan API Resources
- Machine Scan Instance API Resources
- scan
- scanImageGenerationStatus_get
- scanImageGeneration_cancel
- scanImageGeneration_delete
- scanImage_download
- scanImage_downloadFile
- scanImage_get
- scanImage_getAll
- scanImage_publish
- scanPublishedImageStatus_get
- scanPublishedImage_cancel
- scanPublishedImage_delete
- scanPublishedImage_get
- scannedInstance