Skip to content

Latest commit

 

History

History
71 lines (50 loc) · 2.13 KB

machineImagePublished_download.rst

File metadata and controls

71 lines (50 loc) · 2.13 KB
Raw

machineImagePublished_download

GET /users/{uid}/appliances/{aid}/pimages/{pitid}/downloads

Summary

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

Downloads a published machine image.

This request is the same as machineImage-downloadFile

Note

You can only download a published machine image if the initial machine image generation request included the compress flag. For more information, see machineImage-generate.

The published machine image can be downloaded without authentication if an downloadId is added as a query parameter. To retrieve the downloadId, use machineImagePublished-getAll.

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
  • aid (required): the id of the appliance-object
  • pitid (required): the id of the publishimage-object

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/pimages/{pitid}/downloads" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"
  • appliance-object
  • machineImageGeneration-cancel
  • machineImagePublishedStatus-getAll
  • machineImagePublished-deleteAll
  • machineImagePublished-getAll
  • machineImageStatus-get
  • machineImageStatus-getAll
  • machineImage-delete
  • machineImage-deleteAll
  • machineImage-download
  • machineImage-downloadFile
  • machineImage-generate
  • machineImage-get
  • machineImage-getAll
  • machineImage-publish
  • machineImage-regenerate
  • publishimage-object