Get All Replications
Get a list of all the incoming or outgoing replications from a vCenter Server.
The ID of the pairing between this vSphere Replication server and the remote one.
The name of the field by which to filter the result data. Must be used in combination with filter parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1
The filter value by which to filter the result data. Must be used in combination with filter_prop parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1&filter=vm-2
Define desired sort by field of the result data. If order_by is not specified, ascending is used as default.
nameDefine desired sort order by field of the result data. Must be used in combination with sort_by. Supported values: asc, ascending, desc, descending.
Specify the limit size of the result data. In combination with offset parameter provides paging functionality. If none - configuration property 'defaultResponsePageSize' in REST API configuration file is taken into account. If configuration property is not defined - default value of 100 is taken into account.
10The amount of elements to skip in the response. In combination with limit parameter provides paging functionality. Must be used in combination with limit parameter. If none - default value of 0 is taken into account. Example: https://dr-server/api/vms?limit=10&offset=10
10Filter replications by their source vCenter Server.
Requesting extended info for the replications might lead to slower API response.
List of all replications.
{
"list": [
{
"name": "string",
"id": "string",
"vm_id": "string",
"source_site_name": "string",
"source_vc_id": "string",
"target_site_name": "string",
"target_vc_id": "string",
"status": {
"status": "string",
"rpo_violation": false
},
"rpo": 0,
"type": "string",
"replication_server_name": "string",
"recovery_solution": "string",
"configuration_state": "string",
"configuration_error": {
"message": "string",
"details": "string"
},
"last_group_error": {
"message": "string",
"details": "string"
},
"recovery_state": "string",
"recovery_error": "string",
"target_replication_server_uuid": "string",
"last_sync_time": 0,
"last_sync_duration": 0,
"last_sync_size": 0,
"current_rpo_violation": 0,
"quiescing_enabled": false,
"network_compression_enabled": false,
"encryption_enabled": false,
"auto_replicate_new_disks_enabled": false,
"mpit_enabled": false,
"mpit_instances": 0,
"mpit_days": 0,
"sync_progress": {
"progress": 0,
"checksum_current": 0,
"checksum_total": 0,
"transferred_current": 0,
"transferred_total": 0
},
"vm_data_sets_replication_enabled": false
}
],
"_meta": {
"errors": [
{
"code": "string",
"message": "string",
"field": "string"
}
],
"total": 0,
"offset": 0,
"limit": 0,
"links": {
"next": {
"href": "string"
},
"self": {
"href": "string"
},
"previous": {
"href": "string"
}
}
}
}Bad request - the server could not understand the request due to invalid syntax or invalid request body content
{
"error_code": "string",
"message": "string",
"op_id": "string"
}The code of the error.
The message of the error.
The ID of the operation.
Unauthorized - the client must authenticate itself to get the requested response
Forbidden - not sufficient access rights to fulfill the request
{
"error_code": "string",
"message": "string",
"op_id": "string"
}The code of the error.
The message of the error.
The ID of the operation.
Not Found - server cannot find the requested in URL resource
Internal server error - unexpected condition prevents fulfilling the request
{
"error_code": "string",
"message": "string",
"op_id": "string"
}The code of the error.
The message of the error.
The ID of the operation.