Powered by Zoomin Software. For more details please contactZoomin

Zerto Cloud Manager RESTful APIs

Platform
Product Type
Version
Content Type
Source
This publication

List Available Resources for a ZORG

Request

Response

METHOD URL
GET

https://zcm_ip:port/v1/zorgs/{zorgidentifier}/resources?available?virtualizationSite

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.
zorgidentifier The identifier of the ZORG.
Filters

Filters are optional and any combination of filters is valid. When no filter is specified, all resources are returned. Filters are not case-sensitive

Filters

Filters are optional and any combination of filters is valid. When no filter is specified, all VPGs are returned. Filters are not case-sensitive.

FILTER DESCRIPTION
virtualizationSite

Type of resource origin. Possible values are:

Hypervisor

vCD

Request

The request body is empty.

Response

The following is an example response Json body for a hypervisor resource.

[{
  "CloudSiteName": "CloudServiceProvider-1-VC",
  "Identifier": "resgroup-418.ab3816ea-7b54-4868-aa66-00840968ff2b",
  "Link": {
    "href": "https://172.20.999.99:9989/v1/resources/datastore-11.ab3816ea-7b54-4868-aa66-0084",
    "Identifier": "resgroup-418.ab3816ea-7b54-4868-aa66-00840968ff2c",
    "rel": null,
    "type": "ResourceApi"
  },
  "MaskedName": "TenantB-DS",
  "MaxStorageGB": 0,
  "MaxVms": 0,
  "ResourceName": "Cluster:TenantB",
  "SiteIdentifier": "fceaad70-78a1-40f7-8a01-419fc4766f8c",
  "Type": "BackupRepositor",
  "VirtualizationSite": "Hypervisor"
}]

The following is an example response Json body for a vCD resource.

[{
  "CloudSiteName": "CloudServiceProvider-1-VC",
  "Identifier": "datastore-11.ab3816ea-7b54-4868-aa66-00840968ff2b",
  "Link": {
    "href": "https://172.20.999.99:9989/v1/resources/datastore-11.ab3816ea-7b54-4868-aa66-0084",
    "Identifier": "datastore-11.ab3816ea-7b54-4868-aa66-00840968ff2b",
    "rel":null,
    "type": "ResourceApi"
  },
  "MaskedName": "TenantB-DS",
  "MaxStorageGB": 0,
  "MaxVms": 0,
  "OwnerVCDOrgName": null
  "ResourceName": "BK3BL2-07_COMP_DS",
  "SiteIdentifier": "fceaad70-78a1-40f7-8a01-419fc4766f8c",
  "Type": "VCenterDatastore",
  "VirtualizationSite": "Vcd"
}]

The following are response values for both types of resource origin: hypervisor and vCD.

PARAMETER TYPE DESCRIPTION
CloudSiteName String

Name of the Zerto Virtual Manager site connected to the Zerto Cloud Manager.

Identifier String The unique internal identifier of the available resource.
Link   The details of the link to a specific resource.

href

String URL for API call(s) to the resource.

identifier

String The unique internal identifier of the resource.

rel

String The next path level for the API relative to the current path.

type

String The API interface service.
MaskedName String Alternative name for the resource.
MaxStorageGB Number Limit of the specific storage in GB.
MaxVms Number Max number of virtual machines allowed in the resource pool.
OwnerVCDOrgName String

vCD resource name. Appears only if the origin of the source is vCD.

ResourceName String Name of resource that can be attached to the ZORG.
SiteIdentifier String Identifies site to be queried for configured ZORGs. Optional.
Type String The type of resource.
VirtualizationSite String

The type of the resource origin. Possible values are:

Hypervisor

vCD

Back to List of APIs

Back to ZORG APIs

See also Starting and Ending a Session

On This Page
TitleResults for “How to create a CRG?”Also Available inAlert
Feedback Feedback