GET /users/{uid}/scannedinstances/{siid}/scans/{sid}/images/{itid}/downloads
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 scanImage-downloadFile
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.
- Requires Authentication:
false
- Entitlements Required:
None
uid
(required): the user name (login name) of theuser-object
siid
(required): the id of thescannedinstance-object
itid
(required): the id of theimage-object
sid
(required): the id of thescan-object
None
curl "https://uforge.example.com/api/users/{uid}/scannedinstances/{siid}/scans/{sid}/images/{itid}/downloads" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"
machinescan-api-resources
machinescaninstance-api-resources
scan-object
scanImageGenerationStatus-get
scanImageGeneration-cancel
scanImage-downloadFile
scanImage-generate
scanImage-get
scanImage-getAll
scanImage-publish
scanPublishedImageStatus-get
scanPublishedImage-cancel
scanPublishedImage-delete
scanPublishedImage-get
scannedinstance-object