Zerto APIs : Managing vCD APIs : vCD Virtualization Sites APIs
  
vCD Virtualization Sites APIs
In this section you can get information about Org vDCs and unprotected vCD vApps in a site.
Note: The API is exposed over HTTPS. Client code must use the x-zerto-session HTTP authorization header.
The following APIs are available:
List Org vDCs in a Site
List Networks of an Org vDC in a Site
List Storage Profiles of an Org vDC in a Site
List Unprotected vCD vApps in a Site
List Org vDCs in a Site
Use this API to get a list of Org vDCs on a specific site.
Request Body Using Json Format
Response In Json Format
Request Body Using Json Format
 
method
url
GET
https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}/orgvdcs
 
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.
siteIdentifier
The identifier of the site on which the Org vDC resides.
 
The request Json body is empty.
Response In Json Format
The following is an example response Json body.
 
[{
  "Identifier": "String content",
  "OrgVdcName": "String content"
}]
 
Parameter
Description
Identifier
The internal identifier of the Org vDC.
OrgVdcName
The Org vDC name.
 
Back to vCD Virtualization Sites APIs
Back to Managing vCD APIs
Back to All APIs
 
List Networks of an Org vDC in a Site
Use the following API to get a list of networks existing in an Org vDC on a specific site.
Request Body Using Json Format
Response In Json Format
Request Body Using Json Format
 
method
url
GET
https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}/orgvdcs/{orgvdcidentifier}/networks
 
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.
siteIdentifier
The identifier of the site on which the Org vDC resides.
orgvdcidentifier
The identifier of an Org vDC,
 
The request Json body is empty.
Response In Json Format
The following is an example response Json body.
 
[{
  "NetworkIdentifier": "String content"
  "VirtualizationNetworkName": "String content",
}]
 
Parameter
Description
NetworkIdentifier
The internal identification of the Org vDC network.
VirtualizationNetworkName
The orgVDC network name.
 
Back to vCD Virtualization Sites APIs
Back to Managing vCD APIs
Back to All APIs
List Storage Profiles of an Org vDC in a Site
Use this API to get a list of available storage profiles in an Org vDC.
Request Body Using Json Format
Response In Json Format
Request Body Using Json Format
 
method
url
GET
https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}/orgvdcs/{orgvdcidentifier}/storageprofiles
 
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.
siteIdentifier
The identifier of the site on which the Org vDC resides.
orgvdcidentifier
The identifier of an Org vDC,
 
The request Json body is empty.
Response In Json Format
The following is an example response Json body.
 
[{
  "IsEnabled": Boolean
  "StoragePolicyIdentifier": "String content",
  "StoragePolicyName": "String content",
}]
 
 
Parameter
Description
Is Enabled
True: The storage policy is enabled in vCD.
False: The storage policy is disabled in vCD
StoragePolicyIdentifier
The identifier of the storage policy.
StoragePolicyName
The name of the storage policy.
 
Back to vCD Virtualization Sites APIs
Back to Managing vCD APIs
Back to All APIs
List Unprotected vCenter Server vApps in a Site
Deprecated. See List Unprotected vCD vApps in a Site.
List Unprotected vCD vApps in a Site
Use this API to get a list of vCD vApps that are not protected in a site.
Request Body Using Json Format
 
method
url
GET
https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}/vcdvapps
 
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.
siteIdentifier
The identifier of the site on which the Org vDC resides.
 
The request Json body is empty.
Response In Json Format
The following is an example response Json body.
 
[{
  "VCDName": "String content",
  "VCDVappIdentifier": "String content"
}]
 
Parameter
Description
VCDName
The vCD vApp name that is not protected by Zerto.
VCDVappIdentifier
The internal identifier of the vCD vApp that is not protected by Zerto.
 
Back to vCD Virtualization Sites APIs
Back to Managing vCD APIs
Back to All APIs