[{"label":"Latest (1.0.0)","version":"latest"}]
vsphere-replication-api

Sync Replication

Description

Sync the latest changes for a virtual machine with a configured replication to the target vCenter Server site.

Request

Request

URL

URL


post
https://{api_host}//pairings/{pairing_id}/replications/{replication_id}/actions/sync
Copy

Path Parameters

Path Parameters

string
pairing_id Required

The ID of the pairing between this vSphere Replication server and the remote one.


string
replication_id Required

The ID of a replication


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

202 Accepted

Returns TaskDrResponseEntity of type application/json

Sync VM replication task

{
	"_meta": {
		"errors": [
			{
				"code": "string",
				"field": "string",
				"message": "string"
			}
		]
	}
}
_meta Optional

Response meta data. Contains data about the response payload data.

Errors

Errors

ResponseError
400

Bad request - the server could not understand the request due to invalid syntax or invalid request body content


401

Unauthorized - the client must authenticate itself to get the requested response


ResponseError
403

Forbidden - not sufficient access rights to fulfill the request


404

Not Found - server cannot find the requested in URL resource


ResponseError
500

Internal server error - unexpected condition prevents fulfilling the request

Code Samples

Code Samples

cURL Command

curl -X POST https://{api_host}/pairings/{pairing_id}/replications/{replication_id}/actions/sync
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-dr-permissions:
    permissions:
        - System.View
        - Host.Hbr.HbrManagement
x-dr-remote-site-connectivity-contract:
    not-authenticated: OK
    server-down: ERROR


Feedback

Was this page helpful?