scanPublishedImage_get.rst

scanPublishedImage_get

.. function:: GET /users/{uid}/scannedinstances/{siid}/scans/{sid}/images/{itid}/pimages/{pitid}

Summary

• Method: GET
• Response Code: 200 / 304
• Response Formats: application/xml application/json
• Since: UForge 3.4

Retrieve a published machine image for a scan.

Security Summary

• Requires Authentication: true
• Entitlements Required: migration_publish

URI Parameters

• uid (required): the user name (login name) of the :ref:`user-object`
• siid (required): the id of the :ref:`scannedinstance-object`
• itid (required): the id of the :ref:`image-object`
• pitid (required): the id of the :ref:`publishimage-object` to delete
• 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}/pimages/{pitid}" -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:`scanImageGeneration-delete`
         * :ref:`scanImage-generate`
         * :ref:`scanImage-get`
         * :ref:`scanImage-getAll`
         * :ref:`scanImage-publish`
         * :ref:`scanPublishedImageStatus-get`
         * :ref:`scanPublishedImage-cancel`
         * :ref:`scanPublishedImage-delete`
         * :ref:`scannedinstance-object`