scan_delete.rst

scan_delete

.. function:: DELETE /users/{uid}/scannedinstances/{siid}/scans/{sid}

Summary

• Method: DELETE
• Response Code: 204 / 200
• Response Formats:
• Since: UForge 3.4

Removes a scan from a parent scanned instance. The scan report and related uploaded overlays are deleted.

Security Summary

• Requires Authentication: true
• Entitlements Required: migration_access

URI Parameters

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

HTTP Request Body Parameters

None

Example Request

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

.. seealso::

         * :ref:`machinescaninstance-api-resources`
         * :ref:`scan-object`
         * :ref:`scanFileArchive-download`
         * :ref:`scanFile-getAll`
         * :ref:`scanInstallProfile-get`
         * :ref:`scanOverlay-download`
         * :ref:`scanOverlay-upload`
         * :ref:`scanOverlay-uploadChunk`
         * :ref:`scanPackageBinary-getAll`
         * :ref:`scanPackageFile-get`
         * :ref:`scanPackage-getAll`
         * :ref:`scanPartition-upload`
         * :ref:`scanSync-create`
         * :ref:`scanSync-get`
         * :ref:`scanSync-getFiles`
         * :ref:`scan-cancel`
         * :ref:`scan-compare`
         * :ref:`scan-create`
         * :ref:`scan-get`
         * :ref:`scan-multipartCreate`
         * :ref:`scannedInstanceScan-deleteAll`
         * :ref:`scannedInstanceScan-getAll`
         * :ref:`scannedinstance-object`
         * :ref:`scansync-object`
         * :ref:`userScan-getAll`