ZORGs API

Important:  This document is being phased out and does not contain up-to-date information. For updated API documentation for Zerto versions 9.5 and later, see ZVM REST API - Swagger.

You can also access Swagger from the ZVM: click the menu button () on the top right and select APIs or navigate to https://<ZVM IP>:9669/swagger/index.html in a Windows ZVM or https://<ZVM IP>/management/api/swagger/index.html in ZVM Appliance.

/v1/vzorgs returns information about Zerto organizations, ZORGs, defined in the Zerto Cloud Manager that is connected to the site where the API runs.

URL

HTTP Method

Security

See Also

Format

URL

All ZORGs

https://zvm_ip:port/v1/zorgs

Single ZORG

https://zvm_ip:port/v1/zorgs/{zorgIdentifier}

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.

zorgIdentifier

The identifier of the ZORG for which information is returned.

HTTP Method

GET

Security

The API is exposed over HTTPS. Client code must use the x-zerto-session HTTP authorization header.

See Also

Starting a session: Session: POST

Format

Json, XML

Request Body Using Json Format

The request body is empty.

Response In Json Format

The following is an example response Json body for https://zvm_ip:port/v1/zorgs and for https://zvm_ip:port/v1/zorgs/{zorgIdentifier}.

[{
  "Link": {
    "href": "String content",
    "identifier": "String content",
    "rel": "String content",
    "type": "String content"
  },
  "ZorgIdentifier": "String content"
  "ZorgName": "String content"
}]

XML Response Format

For the XML response format, see ZORG API XML Response Format.

Response Values

Response values for https://zvm_ip:port/v1/zorgs and for https://zvm_ip:port/v1/zorgs/{zorgIdentifier}.

Parameter

Description

Link

The link details.

href

The URL used.

identifier

The internal ZORG identifier.

rel

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

type

The API interface service.

ZorgIdentifier

The identifier of the ZORG, Zerto organization, defined in the Zerto Cloud Manager.

ZorgName

The name of the organization set up in Zerto Cloud Manager that uses a Managed Service Provider for recovery.
PowerShell Scripts

For complete PowerShell Scripts, see Examples.