machineImagePublished_download.rst

machineImagePublished_download

.. function:: GET /users/{uid}/appliances/{aid}/pimages/{pitid}/downloads

Summary

• Method: GET
• Response Code: 200 / 304
• Response Formats: */*
• Since: UForge 3.0

Downloads a published machine image.

This request is the same as :ref:`machineImage-downloadFile`

Note

You can only download a published machine image if the initial machine image generation request included the compress flag. For more information, see :ref:`machineImage-generate`.

The published machine image can be downloaded without authentication if an downloadId is added as a query parameter. To retrieve the downloadId, use :ref:`machineImagePublished-getAll`.

Note

The downloadId can only be used once, afterwards it expires, and a new downloadId must be retrieved.

Security Summary

• Requires Authentication: false
• Entitlements Required: None

URI Parameters

• uid (required): the user name (login name) of the :ref:`user-object`
• aid (required): the id of the :ref:`appliance-object`
• pitid (required): the id of the :ref:`publishimage-object`

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/pimages/{pitid}/downloads" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

.. seealso::

         * :ref:`appliance-object`
         * :ref:`machineImageGeneration-cancel`
         * :ref:`machineImagePublishedStatus-getAll`
         * :ref:`machineImagePublished-deleteAll`
         * :ref:`machineImagePublished-getAll`
         * :ref:`machineImageStatus-get`
         * :ref:`machineImageStatus-getAll`
         * :ref:`machineImage-delete`
         * :ref:`machineImage-deleteAll`
         * :ref:`machineImage-download`
         * :ref:`machineImage-downloadFile`
         * :ref:`machineImage-generate`
         * :ref:`machineImage-get`
         * :ref:`machineImage-getAll`
         * :ref:`machineImage-publish`
         * :ref:`machineImage-regenerate`
         * :ref:`publishimage-object`