This API has a deprecated equivalent from v7.0U1.
Start Links Sync Providers
DescriptionInitiates synchronization between the local and remote replicas for the sync provider. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
Request
URLURL
https://{api_host}/api/hvc/links/{link}/sync/providers/{provider}?action=start
Path Parameters
Path Parameters
string
link
Required
Unique identifier of the link The parameter must be an identifier for the resource type: com.vmware.vcenter.hvc.Links.
string
provider
Required
Unique identifier representing the sync provider The parameter must be an identifier for the resource type: com.vmware.vcenter.hvc.sync.Providers.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Errors
Errors
403
com.vmware.vapi.std.errors.unauthorized : if the user is not authorized to perform this operation.
404
com.vmware.vapi.std.errors.not_found : if the link associated with link does not exist if the provider associated with provider is not registered for sync
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request. | com.vmware.vapi.std.errors.resource_busy : if a sync is already running.
Code Samples
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/hvc/links/{link}/sync/providers/{provider}?action=start
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: post
x-vmw-doc-deprecated-path: /rest/hvc/links/{link}/sync/providers/{provider}?action=start
x-vmw-doc-operation: start
Availability
Added in 7.0U2
