Skip to content

Latest commit

 

History

History
71 lines (48 loc) · 1.95 KB

scan_import.rst

File metadata and controls

71 lines (48 loc) · 1.95 KB
Raw

scan_import

POST /users/{uid}/scannedinstances/{siid}/scans/{sid}/imports

Summary

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

Request to import a scan report to your Appliance Library, creating a new appliance.

This response body is an scan import ticket that provides the meta-data of the appliance to be created from the scan report. The actual import is done asynchronously. To poll the status of this import, use scanImportStatus-get.

To cancel an import use scanImport-cancel

Security Summary

  • Requires Authentication: true
  • Entitlements Required: migration_access

URI Parameters

  • uid (required): the user name (login name) of the user-object
  • siid (required): the id of the scannedinstance-object
  • sid (required): the id of the scan-object

HTTP Request Body Parameters

A scanImport-object object

Example Request

curl "https://uforge.example.com/api/users/{uid}/scannedinstances/{siid}/scans/{sid}/imports" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:scanImport xmlns:ns0="http://www.usharesoft.com/uforge">
    <applianceName>Import Example</applianceName>
    <applianceVersion>1.0</applianceVersion>
    <orgUri>orgs/1</orgUri>
</ns0:scanImport>
  • appliance-object
  • machinescan-api-resources
  • machinescaninstance-api-resources
  • scan-object
  • scanImportStatus-get
  • scanImport-cancel
  • scanImport-delete
  • scanImport-getAll
  • scanimport-object
  • scannedinstance-object