/v1/ 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/ returns the list of all Zerto RESTful v1 APIs.

URL

/v1/ APIs https://zvm_ip:port/v1/

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.

HTTP Method

GET

Security

The API is exposed over HTTPS. This API does not require logging in with authentication to run the API.

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/

[
{
  "href": "String content",
  "rel": "String content",
  "type": "String content"
}
{
  "href": "String content",
  "rel": "String content",
  "type": "String content"
}
]

XML Response Format

For the XML response format, see V1/ API XML Response Format.

Response Values

Response values for https://zvm_ip:port/v1/

Parameter	Description
href	The URL used.
rel	The next path level for the API relative to the current path.
type	The API interface service.

PowerShell Scripts

For complete PowerShell Scripts, see Examples.