Zerto Virtual Replication APIs : Local Site API
  
Local Site API
/v1/localsite returns information about the local site processing the API.
URI
Local site information
https://zvm_ip:port/v1/localsite
Valid pairing statuses
https://zvm_ip:port/v1/localsite/pairingstatuses
Where:
zvm_ip
The IP address of the Zerto Virtual Manager where the API is run.
port
The port to access the Zerto Virtual Manager. The default port is 9669.
HTTP Method
GET
Security
The API is exposed over HTTPS. Client code must use the x-zerto-session HTTP authorization header.
See Also
Starting a session: https://zvm_ip:port/v1/session – POST Method
Return the details of the peer sites – Peer Sites API
Return the list of all hypervisor sites – Virtualization Sites API
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.
{
  "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.
Response Values
Response values for https://zvm_ip:port/v1/localsite.
Parameter
Description
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.