Skip to content

Latest commit

 

History

History
71 lines (50 loc) · 2.16 KB

scanImage_downloadFile.rst

File metadata and controls

71 lines (50 loc) · 2.16 KB
Raw

scanImage_downloadFile

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 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 user-object
  • fileName (required): the file name of the image to download
  • siid (required): the id of the scannedinstance-object
  • itid (required): the id of the image-object
  • sid (required): the id of the 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"
  • machinescan-api-resources
  • machinescaninstance-api-resources
  • scan-object
  • scanImageGenerationStatus-get
  • scanImageGeneration-cancel
  • scanImage-download
  • scanImage-generate
  • scanImage-get
  • scanImage-getAll
  • scanImage-publish
  • scanPublishedImageStatus-get
  • scanPublishedImage-cancel
  • scanPublishedImage-delete
  • scanPublishedImage-get
  • scannedinstance-object