scanSync_create.rst

scanSync_create

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

Summary

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

Creates a scanSync object.

A scanSync is an object that contains all the information required to synchronize files from a source to a target instance (or machine or workload).

Please refer to :ref:`scansync-object` for a complete list of all the scanSync attributes.

Note

This POST request does not require any HTTP body. All the information is passed via the URL request.

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}/sync" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

.. seealso::

         * :ref:`machinescaninstance-api-resources`
         * :ref:`scan-object`
         * :ref:`scanFileArchive-download`
         * :ref:`scanInstallProfile-get`
         * :ref:`scanPackageBinary-getAll`
         * :ref:`scanPackage-getAll`
         * :ref:`scanPartition-upload`
         * :ref:`scanSync-get`
         * :ref:`scanSync-getFiles`
         * :ref:`scan-create`
         * :ref:`scan-delete`
         * :ref:`scan-get`
         * :ref:`scannedInstanceScan-deleteAll`
         * :ref:`scannedInstanceScan-getAll`
         * :ref:`scannedinstance-object`
         * :ref:`scansync-object`