Add a Cloud Site

METHOD
POST	https://zcm_ip:port/v1/sites/

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.

Request

The following is an example request for a Json body.

[{
  "HostName": "String content"
  "Port": Integer,
  "accessCode": "String content",
  "externalHostName": "String content"
}]

PARAMETER

type

DESCRIPTION

HostName

string content

IP address host name of the site to connect to.

Port

integer

The HTTPS port of the site ZVM. The default port is 9669.

accessCode

string content

The unique access code generated by the site Zerto Virtual Manager.

To retrieve the access code:

Go to Site Settings > Site Information.

In the Cloud Manager section, copy the ZCM access code.

externalHostName

string content

IP or URL used by the Tenant UI plugin.

Response

The following is an example response Json body.

[{
  Link": {
    "rel": null,
    "href": "https://10.171.31.239:9989/v1/sites/c9aaf5c6-ed1f-4e32-acf5-bf4feff14ef2",
    "type": "CloudSitesApi",
"identifier": "c9aaf5c6-ed1f-4e32-acf5-bf4feff14ef2"
},
  "SiteIdentifier": "c9aaf5c6-ed1f-4e32-acf5-bf4feff14ef2",
  "SiteName": "QA_VCD_udig_10.171.17.0_Site2",
"CloudSiteType": "VCD",
  "HostName": "10.171.31.240",
  "ExternalHostName": "",
  "IsConnected": true,
  "IsEditEnabled": true,
  "IsRemoveEnabled": false,
  "NumberOfZorgs": 1,
  "ContactInfo": {
  "Email": null,
  "Phone": null
},
  "ZvmGui": {
    "GuiHost": "10.171.31.240",
    ;"GuiPort": 9669,
  "SessionIdentifier": "4KKL4FE67C4P4TQXWA5Z5PK2V9YLT72TUPUZKJ87LW9ER5C797DA",
  "ServerIdentifier": null
},
  "Port": 9669,
  "ZvmVersion": "9.5.0",
  "ZvmConnectionDescription": ""
}]

PARAMETER	TYPE	DESCRIPTION
Link		Link information for the URL.
rel	String	Next path level for the API relative to the current path.
href	String	URL for API call(s) to the resource.
type	String	API interface type.
identifier	String	The unique internal identifier of the resource.
SiteIdentifier	String	Internal identifier for the site.
SiteName	String	Cloud site name.
CloudSiteType	String	Cloud site type - vCenter or vCD.
HostName	String	Name of the site host.
ExternalHostName	String	Name of the site external 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.
NumberOfZorgs	Integer	Number of ZORGS
ContactInfo		User contact information.
Email	String	User contact email.
Phone	String	User contact phone number.
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.
Port	Integer	Port number.
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