[{"label":"Latest (1.0.0)","version":"latest"}]
vsphere-replication-api
Pair VR
DescriptionPair to the remote vSphere Replication Management Server.
Request
URLURL
https://{api_host}//pairings
Request Body
Request Body
{
"pair_psc_info": {},
"pair_vc_id": "string"
}
pair_psc_info
Required
Information about the pair Platform Services Controller.
string
pair_vc_id
Required
The ID of the remote vCenter server.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
202 Accepted
Returns
TaskDrResponseEntity
of type application/json
Pairing 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
ResponseError
500
Internal server error - unexpected condition prevents fulfilling the request
Code Samples
cURL Command
curl -X POST -H "Content-Type: application/json" -d '{"pair_psc_info":{"password":"string","port":0,"thumbprint":"string","url":"string","username":"string"},"pair_vc_id":"string"}' https://{api_host}/pairings
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-dr-permissions:
permissions: HmsRemote.com.vmware.vcHms.Hms.Manage
x-dr-remote-site-connectivity-contract:
server-down: ERROR
[{"label":"Latest (1.0.0)","version":"latest"}]
vsphere-replication-api
On This Page
Pairing Operations
delete
get
get
post
post
