Zerto Virtual Replication APIs : Local Site API : Format
  
Format
Json, XML
Request Format
The request body is empty.
Json Response Format
The following is an example response Json body for https://zvm_ip:port/v1/localsite.
{
  "BandwidthThrottlingInMBs": 0.625,
  "ContactEmail": "String content",
  "ContactName": "String content",
  "ContactPhone": "String content",
  "IsReplicationToSelfEnabled": Boolean,
  "Link": {
    "href": "String content",
    "identifier": "String content",
    "rel": "String content",
    "type": "String content"
  },
  "Location": "String content",
  "SiteIdentifier": "String content",
  "SiteName": "String content",
  "UtcOffsetInMinutes":2147483647,
  "Version": "String content"
}
The following is an example response Json body for https://zvm_ip:port/v1/localsite/pairingstatuses.
["String content"]
XML Response Format
For the XML response format, see “Local Site API XML Response Format”, on page 230.
Response Values
Response values for https://zvm_ip:port/v1/localsite.
Parameter
Description
BandwidthThrottlingInMBs
The maximum allocated replication bandwidth for each VRA bandwidth group.
The response reflects the bandwidth throttling as defined for that point in time.
The bandwidth throttling is defined in the Site Settings window in the Performance and Throttling tab. The number represents megabits per second.
The bandwidth throttling values of the API are in megabytes per second. Therefore, the values are the results of the calculation X/8 MB, where X is the number of megabits stated in the Site Settings window, in the Performance and Throttling tab.
For example: Bandwidth throttling was defined as follows:
■ From 14:00 to 16:00: unlimited
■ For the rest of the day: 10 Mb/s.
The API is run at 18:00, and therefore the response will show 10/8 MB/s, or 1.25 MB/s.
A value of -1 means that the bandwidth throttling is unlimited.
ContactEmail
The email address defined in the Zerto User Interface Site Information dialog.
ContactName
The name of the contact person defined in the Zerto User Interface Site Information dialog.
ContactPhone
The phone number of the contact defined in the Zerto User InterfaceSite Information dialog.
IsReplicationToSelfEnabled
True: Protected virtual machines can be recovered to this protected site.
False: Protected virtual machines can only be recovered to a different recovery site.
Link
The link details.
href
The URL used.
identifier
The internal site identifier.
rel
The next path level for the API relative to the current path.
type
The API interface service.
Location
The location of the site defined during installation or in the Site Information dialog.
SiteIdentifier
The internal site identifier.
SiteName
The name of the site defined during installation or in the Site Information dialog.
UtcOffsetInMinutes
The offset of the site time from UTC in minutes.
Version
The Zerto Virtual Manager version.
Response values for https://zvm_ip:port/v1/localsite/pairingstatuses.
Response: Description
Pairing statuses:
Paired: The site is paired.
Pairing: The site is in the process of being paired.
Unpaired: The site is not paired.
PowerShell Scripts
For complete PowerShell Scripts, see “Code Samples”, on page 20.