[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]
vsphere-replication-api
Get VR Server
DescriptionGet information about a registered vSphere Replication server.
Request
URLURL
https://{api_host}//replication-servers/{replication_server_id}
Path Parameters
Path Parameters
string
replication_server_id
Required
The UUID of the vSphere Replication server
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK
Returns
ReplicationServerInfoDrResponseEntity
of type application/json
{
"_meta": {
"errors": [
{
"code": "string",
"field": "string",
"message": "string"
}
]
},
"configuration_url": "string",
"connected": false,
"decommissioned": false,
"fault": "string",
"hostname": "string",
"id": "string",
"internally_managed": false,
"name": "string",
"replication_count": 0,
"uuid": "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
PowerCLI Client SDK Example
Invoke-VrGetVrServer -replicationServerId "MyreplicationServerId"
cURL Command
curl https://{api_host}/replication-servers/{replication_server_id}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-dr-permissions:
permissions: HmsReplication.com.vmware.vcHms.Replication.View
[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]
vsphere-replication-api
On This Page
Server Operations
get
get
post
post
delete