scanImage_downloadFile¶
-
GET /users/{uid}/scannedinstances/{siid}/scans/{sid}/images/{itid}/downloads/{fileName}
Downloads a generated machine image from a scan.
This request is the same as scanImage_download
Note
You can only download a generated machine image if the initial generation request included the compress
flag. For more information, see scanImage_generate.
The machine image can be downloaded without authentication if an downloadId
is added as a query parameter
. To retrieve the downloadId, use 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 userfileName
(required): the file name of the image to downloadsiid
(required): the id of the scannedInstanceitid
(required): the id of the imagesid
(required): the id of the scan
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"
See also
- Machine Scan API Resources
- Machine Scan Instance API Resources
- scan
- scanImageGenerationStatus_get
- scanImageGeneration_cancel
- scanImage_download
- scanImage_generate
- scanImage_get
- scanImage_getAll
- scanImage_publish
- scanPublishedImageStatus_get
- scanPublishedImage_cancel
- scanPublishedImage_delete
- scanPublishedImage_get
- scannedInstance