List Cloud Sites / Get Information About a Specific Cloud Site
Display a list of all cloud sites by running the following API.
METHOD | URL |
---|---|
GET | https://zcm_ip:port/v1/sites |
Display information about a specific cloud site by its ID by running the following API.
METHOD | URL |
---|---|
GET | https://zcm_ip:port/v1/sites/{siteidentifier} |
Where:
zcm_ip | The IP address of the Zerto Cloud Manager where the API is run. |
port |
The port to access the Zerto Cloud Manager. The default port is 9989. |
siteidentifier | Internal identifier for the cloud site. |
Request
The request body is empty.
Response
The following is an example response Json body of a list of all cloud sites and, without the array statement, of a specific cloud site.
[{
"CloudSiteType": "VCenter",
"ContactInfo": {
"Email": "null",
"Phone": "null"
},
"HostName": "172.20.184.59",
"IsConnected": true,
"IsEditEnabled": true,
"IsRemoveEnabled": false,
"Link": {
"href": "https://172.20.184.51:9989/v1/sites/fceaad70-78a1-40f7-8a01-419fc4766f8c",
"identifier": "fceaad70-78a1-40f7-8a01-419fc4766f8c",
"rel": "null",
"type": "CloudSitesApi"
},
"NumberOfZorgs": 2,
"Port": 9669,
"SiteIdentifier": "fceaad70-78a1-40f7-8a01-419fc4766f8c",
"SiteName": "CloudServiceProvider-1-VC",
"ZcmGui": {
"GuiHost": "172.20.184.59",
"GuiPort": 9669,
"ServerIdentifier": "null",
"SessionIdentifier": "8UP9VXCXEYJXCSLEKLA97NH68VJATNKMZCYFF6Z2MZTNJ5Y6FBYQ"
},
"ZcmVersion": "5.5.0"
"ZvmConnectionDescription": "Site identifier was changed. Please remove the site and then reconnect to it"
}
]
PARAMETER | TYPE | DESCRIPTION |
---|---|---|
CloudSiteType | String | Cloud site type - vCenter or vCD. |
ContactInfo | User contact information. | |
|
String | User contact email. |
Phone |
String | User contact phone number. |
HostName | String | Name of the site host. |
IsConnected | Boolean | Boolean value, indicating whether the site is connected to ZCM. |
IsEditEnabled | Boolean |
Boolean value, indicating whether the site parameters can be modified. |
IsRemoveEnabled | Boolean | Boolean value, indicating whether the cam be removed. |
Link | Link information for the URL. | |
href |
String | URL for API call(s) to the resource. |
identifier |
String |
The unique internal identifier of the resource. |
rel |
String | Next path level for the API relative to the current path. |
type |
String | API interface type. |
NumberOfZorgs | Integer | Number of ZORGS |
Port | Integer | Port number. |
SiteIdentifier |
String |
Internal identifier for the site. |
SiteName | String | Cloud site name. |
ZcmGui | Zerto Cloud Manager User Interface information. | |
GuiHost |
String | The VM hosting ZCM. |
GuiPort |
Integer | The port to access the ZCM UI. The default port is 9669. |
ServerIdentifier |
String | Internal identifier for the server hosting ZCM. |
SessionIdentifier |
String | Internal identifier for the current session. |
ZcmVersion | String | Zerto Cloud Manager version. |
ZvmConnectionDescription |
String |
Appears when the site identifier is changed and notifies the user to remove the site and then reconnect it. |
Back to Sites APIs
Back to List of APIs
See also Starting and Ending a Session