Skip to content

Latest commit

 

History

History
59 lines (40 loc) · 1.77 KB

applianceExport_download.rst

File metadata and controls

59 lines (40 loc) · 1.77 KB
Raw

applianceExport_download

GET /users/{uid}/appliances/{aid}/exports/{eid}/downloads

Summary

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

Downloads the archive of an exported appliance. The archive is a .tar.gz file. The archive contains the meta-data file of the appliance-object and any 3rd party software or configuration scripts associated with the appliance-object.

An archive can be used with the hammr command-line tool.

Warning

you can only download an archive once the creation of the archive is complete. Use applianceExportStatus-get to check the status of an export prior to a download request.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user-object
  • eid (required): the id of the export ticket (provided after appliance-export)
  • aid (required): the id of the appliance-object

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/exports/{eid}/downloads" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"
  • appliance-object
  • applianceExport-cancel
  • applianceExport-delete
  • applianceExport-download
  • applianceExport-get
  • applianceExport-getAll
  • applianceImport-getAllStatus
  • appliance-export
  • applianceexport-object