Skip to content

Latest commit

 

History

History
72 lines (51 loc) · 2.31 KB

containerTemplateImage_download.rst

File metadata and controls

72 lines (51 loc) · 2.31 KB
Raw

containerTemplateImage_download

GET /users/{uid}/mysoftware/{msid}/templates/{tid}/images/{itid}/downloads

Summary

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

Downloads a generated machine image.

This request is the same as containerTemplateImage-downloadFile

Note

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

The machine image can be downloaded without authentication if an downloadId is added as a query parameter. To retrieve the downloadId, use containerTemplateImage-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
  • msid (required): the id of the mySoftware-object
  • itid (required): the id of the image-object
  • tid (required): the id of the containertemplate-object

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/mysoftware/{msid}/templates/{tid}/images/{itid}/downloads" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"
  • containerTemplateImageGeneration-cancel
  • containerTemplateImageGeneration-get
  • containerTemplateImagePublish-cancel
  • containerTemplateImagePublish-get
  • containerTemplateImagePublished-delete
  • containerTemplateImagePublished-get
  • containerTemplateImage-delete
  • containerTemplateImage-downloadFile
  • containerTemplateImage-get
  • containerTemplateImage-publish
  • containerTemplate-create
  • containerTemplate-generate
  • containerTemplate-get
  • containerTemplate-getAll
  • containertemplate-object
  • image-object
  • imagepkgs-object