[{"label":"Latest (1.0.0)","version":"latest"}]
vsphere-replication-api
Pause Replication
DescriptionPause the replication for a virtual machine from the source site to a remote vCenter Server site.
Request
URLURL
https://{api_host}//pairings/{pairing_id}/replications/{replication_id}/actions/pause
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
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
202 Accepted
Returns
TaskDrResponseEntity
of type application/json
Pause replication task
{
"_meta": {
"errors": [
{
"code": "string",
"field": "string",
"message": "string"
}
]
}
}
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
cURL Command
curl -X POST https://{api_host}/pairings/{pairing_id}/replications/{replication_id}/actions/pause
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-dr-permissions:
permissions:
- System.View
- Host.Hbr.HbrManagement
- VirtualMachine.Hbr.ConfigureReplication
x-dr-remote-site-connectivity-contract:
not-authenticated: ERROR
server-down: ERROR
[{"label":"Latest (1.0.0)","version":"latest"}]
vsphere-replication-api
On This Page
Replication Operations
post
delete
get
post
post
post
post
