scanImage_downloadFile.rst

scanImage_downloadFile

.. function:: GET /users/{uid}/scannedinstances/{siid}/scans/{sid}/images/{itid}/downloads/{fileName}

Summary

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

Downloads a generated machine image from a scan.

This request is the same as :ref:`scanImage-download`

Note

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

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

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`
• fileName (required): the file name of the image to download
• siid (required): the id of the :ref:`scannedinstance-object`
• itid (required): the id of the :ref:`image-object`
• sid (required): the id of the :ref:`scan-object`

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/scannedinstances/{siid}/scans/{sid}/images/{itid}/downloads/{fileName}" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

.. seealso::

         * :ref:`machinescan-api-resources`
         * :ref:`machinescaninstance-api-resources`
         * :ref:`scan-object`
         * :ref:`scanImageGenerationStatus-get`
         * :ref:`scanImageGeneration-cancel`
         * :ref:`scanImage-download`
         * :ref:`scanImage-generate`
         * :ref:`scanImage-get`
         * :ref:`scanImage-getAll`
         * :ref:`scanImage-publish`
         * :ref:`scanPublishedImageStatus-get`
         * :ref:`scanPublishedImage-cancel`
         * :ref:`scanPublishedImage-delete`
         * :ref:`scanPublishedImage-get`
         * :ref:`scannedinstance-object`