Get Information About a Specific ZORG / List All ZORGs

The response for both APIs is identical.

Request

Response

To get information about a specific ZORG, run the following API.

METHOD

URL

GET

https://zcm_ip:port/v1/zorgs/{zorgidentifier}

To retrieve a list of all ZORGs run the following API.

METHOD URL
GET https://zcm_ip:port/v1/zorgs

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 to be deleted.

Request

The request body is empty.

Response

The following is an example response Json body of a list of all ZORGs and, without the array statement, of a single ZORG.

[{
  "CloudSitesCount": 0,
  "CrmIdentifier": "221"
  "CustomerSitesCount": 0,
  "EditEnabled": true,
  "IsHypervisorResourcesAvaliable": false,
  "IsVCDResourcesAvaliable": false,
  "Link": {
    "href": "https://172.33.84.14:9989/v1/zorgs/190982c0-7f09-4f6a-a04e-faab92b87411",
    "identifier": "190982c0-7f09-4f6a-a04e-faab92b87411",
    "rel": "null",
    "type": "ZorgApi"
  },
  "Name": "guy",
  "Permissions": {
    "CreateOrRemoveProtectionGroup": true,
    "EnableCustomProfile": true,
    "Failover": true,
    "FailoverTest": true,
    "Move": true,
    "VcdVappMaintenanceMode": false
  },
  "PreseedFolderName": "zerto-preseed-guy",
  "RemoveEnabled": true,
  "Resources": {
    "href": "https://172.33.84.14:9989/v1/zorgs/190982c0-7f09-4f6a-a04e-faab92b87411/resources",
    "identifier": "190982c0-7f09-4f6a-a04e-faab92b87411",
    "rel": "null",
    "type": "ResourceApi"
  "ZorgIdentifier": "190982c0-7f09-4f6a-a04e-faab92b87411"
}]

Parameter

TYPE

Description

CloudSitesCount Number The total number of sites related to this ZORG.
CrmIdentifier String An identifier used to identify the organization in a CRM.
CustomerSitesCount Number The number of customer sites.
EditEnabled Boolean Indicates whether the ZORG can be edited or not.
IsHypervisorResourcesAvaliable Boolean

Indicates whether Hypervisor resources can be used be the ZORG.

IsVCDResourcesAvaliable   Indicates whether Vcd resources can be used be the ZORG.
Link   The link details.

href

String

The URL used to retrieve ZORG information for the ZORG affected by the event.

identifier

String The unique internal identifier of the ZORG.

rel

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

type

String The API interface service.
Name String ZORG name.
Permissions   The ZORG permissions.

CreateOrRemoveProtectionGroup

Boolean Indicates if ZORG has permission to create or remove a VPG.

EnableCustomProfile

Boolean

Indicates if ZORG has permission to use the custom service profile.

Failover

Boolean Indicates if ZORG has permission to perform failover.

Fail2overTest

Boolean Indicates if ZORG has permission to perform failover test.

Move

Boolean

Indicates if ZORG has permission to perform move operation on VPG.

VcdVappMaintenanceMode

Boolean

Indicates if ZORG has permission to block vApp operations during VPG test.

PreseedFolderName String Preseed folder name.
RemoveEnabled Boolean Indicates whether a user can remove ZORG.
Resources   Information about links to resources?

href

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

identifier

String The unique internal identifier of the ZORG.

rel

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

type

String The API interface service.
ZorgIdentifier String identifier of the ZORG defined in Zerto Cloud Manager.

Back to List of APIs

Back to ZORG APIs

See also Starting and Ending a Session