List Replicators
This request lists all the registered Replicator instances. This includes the local Replicator Service running on the appliance, dedicated external Replicator Appliance instances, and half-paired Replicator Services.
Request
URI
GET
https://{api_host}/replicators
COPY
Query Parameters
string
sites
Optional
Optional comma-separated sites on which operation should be executed on.
sites example
site1,site2
Header Parameters
string
operationID
Optional
Operation ID for correlating logs across multiple services
Responses
200
OK
[
{
"id": "9664de13-6150-4315-9f59-2d85eb4c302f",
"owner": "tenant1",
"site": "on-prem-dc1",
"description": "on-prem replicator 1",
"apiUrl": "https://replicator1:8043",
"certThumbprint": "SHA-256:0D:80:21:91:C7:DC:94:BC:9D:E8:A7:04:0F:6B:F1:09:5C:AA:97:C8:4A:72:E5:CF:5E:8F:84:A7:B9:CC:8C:85",
"pairingCookie": "lBvDMttZLLnWVZwC+85ufqiNt4M=",
"state": {
"incomingCommError": {
"code": "Forbidden",
"msg": "Permission denied.",
"args": [],
"stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
},
"outgoingCommError": {
"code": "Forbidden",
"msg": "Permission denied.",
"args": [],
"stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}
},
"isInMaintenanceMode": false,
"apiVersion": "4.5",
"dataAddress": "lwd://localhost:44045",
"buildVersion": "4.5.0.5801221-9aeebc925e"
}
]
401
The returned error codes include (but are not limited to): NotAuthenticated
Returns ApiError of type(s) application/vnd.vmware.h4-v4.7+json;charset=UTF-8
{
"args": [],
"code": "Forbidden",
"msg": "Permission denied.",
"stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}array of string
args
Optional
Positional arguments.
string
code
Optional
Specific error code.
string
msg
Optional
Detailed error message.
string
stacktrace
Optional
Exception stacktrace.
500
The returned error codes include (but are not limited to): GeneralServerFailure
Returns ApiError of type(s) application/vnd.vmware.h4-v4.7+json;charset=UTF-8
{
"args": [],
"code": "Forbidden",
"msg": "Permission denied.",
"stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}array of string
args
Optional
Positional arguments.
string
code
Optional
Specific error code.
string
msg
Optional
Detailed error message.
string
stacktrace
Optional
Exception stacktrace.