machineImage_generate¶

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

Request to generate a machine image from an appliance.

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 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
aid (required): the id of the appliance

HTTP Request Body Parameters¶

A image object

Example Request¶

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/images" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: 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>