Documentation Center

sync

Manually starts the synchronization of a delivery group.

Description

All distribution profiles which are named in the names parameter will begin sychronization. The distribution server will confirm the version of all configuration packages and publications with every delivery server. Any previously failed attempts to re-synchronize a delivery server will be attempted again.

Parameters

action
sync
names
A comma delimited list of distribution profile names to synchronize.

Example URL

http://<host>:<port>/<context>/web/package.xql?action=sync&names=<value>

Successful Result

Check the Distribution Event Log for additional details, or your systems logs/livecontent.distribution.log. This function returns a standard API result element (<result status='SUCCESS' statusCode='0' message='Localized Message' messageKey='message.key'/>). A statusCode of 0 indicates a successful execution. Any other statusCode indicates a failure.

Failed Result

Accessing this API feature requires the "Manage application" permission, and the function will throw a permission exception if the permission is not available.