Skip to content

Latest commit

 

History

History
58 lines (38 loc) · 1.81 KB

scanInstance_getAll.rst

File metadata and controls

58 lines (38 loc) · 1.81 KB
Raw

scanInstance_getAll

GET /users/{uid}/scannedinstances

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.4

Retrieves all the scanned instances.

A scanned instance is an object representing a live running instance (physical machine, VM, container). Each time the system is scanned, the scan report is stored under the scanned instance object.

A list of scannedinstance-object objects are returned.

You can use a set of query parameters to retrieve a subset of these scanned instances. This includes: - name: retrieves the scanned instance with a specific name - ids: retrieves a list of scanned instances that matches the id list provided - index: - max: - orderBy: a field name contained in scannedinstance-object to order by - asc: boolean to determine to sort the list in ascending order (if false, sort in descending order)

Security Summary

  • Requires Authentication: true
  • Entitlements Required: migration_access

URI Parameters

  • uid (required): the user name (login name) of the user-object

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/scannedinstances" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"
  • machinescan-api-resources
  • scan-object
  • scanInstance-create
  • scanInstance-delete
  • scanInstance-deleteAll
  • scanInstance-get
  • scannedInstanceScan-getAll
  • scannedinstance-object