appliance_export

POST /users/{uid}/appliances/{aid}/exports

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.5

Request to export the specified appliance as an archive. This creates an export ticket that contains an archive that can be downloaded. The archive contains the meta-data file of the appliance and any 3rd party software or configuration scripts associated with the appliance.

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

The response body is an export appliance ticket. To poll the status of this export, use applianceExportStatus_get. Once complete, the archive can be downloaded using applianceExport_download.

Note

No request body is required in this HTTP POST.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user
  • aid (required): the id of the appliance to be exported

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/exports" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

See also