ZVM REST API

Alerts

getAlert

Get information about the specific Zerto alert. (Auth)


/v1/alerts/{alertIdentifier}

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/alerts/{alertIdentifier}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AlertsApi;

import java.io.File;
import java.util.*;

public class AlertsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        AlertsApi apiInstance = new AlertsApi();
        String alertIdentifier = alertIdentifier_example; // String | Alert identifier. Related endpoint: `/v1/alerts`
        try {
            AlertApi result = apiInstance.getAlert(alertIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertsApi#getAlert");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AlertsApi;

public class AlertsApiExample {

    public static void main(String[] args) {
        AlertsApi apiInstance = new AlertsApi();
        String alertIdentifier = alertIdentifier_example; // String | Alert identifier. Related endpoint: `/v1/alerts`
        try {
            AlertApi result = apiInstance.getAlert(alertIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertsApi#getAlert");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *alertIdentifier = alertIdentifier_example; // Alert identifier. Related endpoint: `/v1/alerts`

AlertsApi *apiInstance = [[AlertsApi alloc] init];

// Get information about the specific Zerto alert. (Auth)
[apiInstance getAlertWith:alertIdentifier
              completionHandler: ^(AlertApi output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.AlertsApi()
var alertIdentifier = alertIdentifier_example; // {{String}} Alert identifier. Related endpoint: `/v1/alerts`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAlert(alertIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAlertExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new AlertsApi();
            var alertIdentifier = alertIdentifier_example;  // String | Alert identifier. Related endpoint: `/v1/alerts`

            try
            {
                // Get information about the specific Zerto alert. (Auth)
                AlertApi result = apiInstance.getAlert(alertIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AlertsApi.getAlert: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiAlertsApi();
$alertIdentifier = alertIdentifier_example; // String | Alert identifier. Related endpoint: `/v1/alerts`

try {
    $result = $api_instance->getAlert($alertIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AlertsApi->getAlert: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AlertsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AlertsApi->new();
my $alertIdentifier = alertIdentifier_example; # String | Alert identifier. Related endpoint: `/v1/alerts`

eval { 
    my $result = $api_instance->getAlert(alertIdentifier => $alertIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AlertsApi->getAlert: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AlertsApi()
alertIdentifier = alertIdentifier_example # String | Alert identifier. Related endpoint: `/v1/alerts`

try: 
    # Get information about the specific Zerto alert. (Auth)
    api_response = api_instance.get_alert(alertIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AlertsApi->getAlert: %s\n" % e)

Parameters

Path parameters
Name Description
alertIdentifier*
String
Alert identifier. Related endpoint: `/v1/alerts`
Required

Responses

Status: 200 - Success

{
link:
{
rel:
string
href:
string
type:
string
identifier:
string
}
level:
string
entity:
string
isDismissed:
boolean
helpIdentifier:
string
site:
{
rel:
string
href:
string
type:
string
identifier:
string
}
description:
string
turnedOn:
string (date-time)
affectedVpgs:
[
{
rel:
string
href:
string
type:
string
identifier:
string
}
]
affectedZorgs:
[
{
rel:
string
href:
string
type:
string
identifier:
string
}
]
}

getAlertAll

Get a list of latest Zerto alerts. You can filter the results with additional parameters. (Auth)


/v1/alerts

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/alerts?startDate=&endDate=&vpgIdentifier=&zorgIdentifier=&siteIdentifier=&level=&entity=&helpIdentifier=&isDismissed="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AlertsApi;

import java.io.File;
import java.util.*;

public class AlertsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        AlertsApi apiInstance = new AlertsApi();
        Date startDate = 2013-10-20T19:20:30+01:00; // Date | The filter interval start date-time. Related endpoint: `v1/serverDateTime` for date-time format details
        Date endDate = 2013-10-20T19:20:30+01:00; // Date | The filter interval end date-time. Related endpoint: `v1/serverDateTime` for date-time format details
        String vpgIdentifier = vpgIdentifier_example; // String | The identifier of the VPG. Related endpoint: `v1/vpgs`
        String zorgIdentifier = zorgIdentifier_example; // String | The identifier of the ZORG. Related endpoint: `v1/zorgs`
        String siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
        String level = level_example; // String | The alert level. Related endpoint: `/v1/alerts/levels`
        String entity = entity_example; // String | The alert entity type. Related endpoint: `/v1/alerts/entity`
        String helpIdentifier = helpIdentifier_example; // String | The alert help identifier associated with the alert. Related endpoint: `/v1/alerts/helpidentifiers`
        Boolean isDismissed = true; // Boolean | True if alert was dismissed
        try {
            array[AlertApi] result = apiInstance.getAlertAll(startDate, endDate, vpgIdentifier, zorgIdentifier, siteIdentifier, level, entity, helpIdentifier, isDismissed);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertsApi#getAlertAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AlertsApi;

public class AlertsApiExample {

    public static void main(String[] args) {
        AlertsApi apiInstance = new AlertsApi();
        Date startDate = 2013-10-20T19:20:30+01:00; // Date | The filter interval start date-time. Related endpoint: `v1/serverDateTime` for date-time format details
        Date endDate = 2013-10-20T19:20:30+01:00; // Date | The filter interval end date-time. Related endpoint: `v1/serverDateTime` for date-time format details
        String vpgIdentifier = vpgIdentifier_example; // String | The identifier of the VPG. Related endpoint: `v1/vpgs`
        String zorgIdentifier = zorgIdentifier_example; // String | The identifier of the ZORG. Related endpoint: `v1/zorgs`
        String siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
        String level = level_example; // String | The alert level. Related endpoint: `/v1/alerts/levels`
        String entity = entity_example; // String | The alert entity type. Related endpoint: `/v1/alerts/entity`
        String helpIdentifier = helpIdentifier_example; // String | The alert help identifier associated with the alert. Related endpoint: `/v1/alerts/helpidentifiers`
        Boolean isDismissed = true; // Boolean | True if alert was dismissed
        try {
            array[AlertApi] result = apiInstance.getAlertAll(startDate, endDate, vpgIdentifier, zorgIdentifier, siteIdentifier, level, entity, helpIdentifier, isDismissed);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertsApi#getAlertAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
Date *startDate = 2013-10-20T19:20:30+01:00; // The filter interval start date-time. Related endpoint: `v1/serverDateTime` for date-time format details (optional)
Date *endDate = 2013-10-20T19:20:30+01:00; // The filter interval end date-time. Related endpoint: `v1/serverDateTime` for date-time format details (optional)
String *vpgIdentifier = vpgIdentifier_example; // The identifier of the VPG. Related endpoint: `v1/vpgs` (optional)
String *zorgIdentifier = zorgIdentifier_example; // The identifier of the ZORG. Related endpoint: `v1/zorgs` (optional)
String *siteIdentifier = siteIdentifier_example; // The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites` (optional)
String *level = level_example; // The alert level. Related endpoint: `/v1/alerts/levels` (optional)
String *entity = entity_example; // The alert entity type. Related endpoint: `/v1/alerts/entity` (optional)
String *helpIdentifier = helpIdentifier_example; // The alert help identifier associated with the alert. Related endpoint: `/v1/alerts/helpidentifiers` (optional)
Boolean *isDismissed = true; // True if alert was dismissed (optional)

AlertsApi *apiInstance = [[AlertsApi alloc] init];

// Get a list of latest Zerto alerts. You can filter the results with additional parameters. (Auth)
[apiInstance getAlertAllWith:startDate
    endDate:endDate
    vpgIdentifier:vpgIdentifier
    zorgIdentifier:zorgIdentifier
    siteIdentifier:siteIdentifier
    level:level
    entity:entity
    helpIdentifier:helpIdentifier
    isDismissed:isDismissed
              completionHandler: ^(array[AlertApi] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.AlertsApi()
var opts = { 
  'startDate': 2013-10-20T19:20:30+01:00, // {{Date}} The filter interval start date-time. Related endpoint: `v1/serverDateTime` for date-time format details
  'endDate': 2013-10-20T19:20:30+01:00, // {{Date}} The filter interval end date-time. Related endpoint: `v1/serverDateTime` for date-time format details
  'vpgIdentifier': vpgIdentifier_example, // {{String}} The identifier of the VPG. Related endpoint: `v1/vpgs`
  'zorgIdentifier': zorgIdentifier_example, // {{String}} The identifier of the ZORG. Related endpoint: `v1/zorgs`
  'siteIdentifier': siteIdentifier_example, // {{String}} The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
  'level': level_example, // {{String}} The alert level. Related endpoint: `/v1/alerts/levels`
  'entity': entity_example, // {{String}} The alert entity type. Related endpoint: `/v1/alerts/entity`
  'helpIdentifier': helpIdentifier_example, // {{String}} The alert help identifier associated with the alert. Related endpoint: `/v1/alerts/helpidentifiers`
  'isDismissed': true // {{Boolean}} True if alert was dismissed
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAlertAll(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAlertAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new AlertsApi();
            var startDate = 2013-10-20T19:20:30+01:00;  // Date | The filter interval start date-time. Related endpoint: `v1/serverDateTime` for date-time format details (optional) 
            var endDate = 2013-10-20T19:20:30+01:00;  // Date | The filter interval end date-time. Related endpoint: `v1/serverDateTime` for date-time format details (optional) 
            var vpgIdentifier = vpgIdentifier_example;  // String | The identifier of the VPG. Related endpoint: `v1/vpgs` (optional) 
            var zorgIdentifier = zorgIdentifier_example;  // String | The identifier of the ZORG. Related endpoint: `v1/zorgs` (optional) 
            var siteIdentifier = siteIdentifier_example;  // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites` (optional) 
            var level = level_example;  // String | The alert level. Related endpoint: `/v1/alerts/levels` (optional) 
            var entity = entity_example;  // String | The alert entity type. Related endpoint: `/v1/alerts/entity` (optional) 
            var helpIdentifier = helpIdentifier_example;  // String | The alert help identifier associated with the alert. Related endpoint: `/v1/alerts/helpidentifiers` (optional) 
            var isDismissed = true;  // Boolean | True if alert was dismissed (optional) 

            try
            {
                // Get a list of latest Zerto alerts. You can filter the results with additional parameters. (Auth)
                array[AlertApi] result = apiInstance.getAlertAll(startDate, endDate, vpgIdentifier, zorgIdentifier, siteIdentifier, level, entity, helpIdentifier, isDismissed);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AlertsApi.getAlertAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiAlertsApi();
$startDate = 2013-10-20T19:20:30+01:00; // Date | The filter interval start date-time. Related endpoint: `v1/serverDateTime` for date-time format details
$endDate = 2013-10-20T19:20:30+01:00; // Date | The filter interval end date-time. Related endpoint: `v1/serverDateTime` for date-time format details
$vpgIdentifier = vpgIdentifier_example; // String | The identifier of the VPG. Related endpoint: `v1/vpgs`
$zorgIdentifier = zorgIdentifier_example; // String | The identifier of the ZORG. Related endpoint: `v1/zorgs`
$siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
$level = level_example; // String | The alert level. Related endpoint: `/v1/alerts/levels`
$entity = entity_example; // String | The alert entity type. Related endpoint: `/v1/alerts/entity`
$helpIdentifier = helpIdentifier_example; // String | The alert help identifier associated with the alert. Related endpoint: `/v1/alerts/helpidentifiers`
$isDismissed = true; // Boolean | True if alert was dismissed

try {
    $result = $api_instance->getAlertAll($startDate, $endDate, $vpgIdentifier, $zorgIdentifier, $siteIdentifier, $level, $entity, $helpIdentifier, $isDismissed);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AlertsApi->getAlertAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AlertsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AlertsApi->new();
my $startDate = 2013-10-20T19:20:30+01:00; # Date | The filter interval start date-time. Related endpoint: `v1/serverDateTime` for date-time format details
my $endDate = 2013-10-20T19:20:30+01:00; # Date | The filter interval end date-time. Related endpoint: `v1/serverDateTime` for date-time format details
my $vpgIdentifier = vpgIdentifier_example; # String | The identifier of the VPG. Related endpoint: `v1/vpgs`
my $zorgIdentifier = zorgIdentifier_example; # String | The identifier of the ZORG. Related endpoint: `v1/zorgs`
my $siteIdentifier = siteIdentifier_example; # String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
my $level = level_example; # String | The alert level. Related endpoint: `/v1/alerts/levels`
my $entity = entity_example; # String | The alert entity type. Related endpoint: `/v1/alerts/entity`
my $helpIdentifier = helpIdentifier_example; # String | The alert help identifier associated with the alert. Related endpoint: `/v1/alerts/helpidentifiers`
my $isDismissed = true; # Boolean | True if alert was dismissed

eval { 
    my $result = $api_instance->getAlertAll(startDate => $startDate, endDate => $endDate, vpgIdentifier => $vpgIdentifier, zorgIdentifier => $zorgIdentifier, siteIdentifier => $siteIdentifier, level => $level, entity => $entity, helpIdentifier => $helpIdentifier, isDismissed => $isDismissed);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AlertsApi->getAlertAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AlertsApi()
startDate = 2013-10-20T19:20:30+01:00 # Date | The filter interval start date-time. Related endpoint: `v1/serverDateTime` for date-time format details (optional)
endDate = 2013-10-20T19:20:30+01:00 # Date | The filter interval end date-time. Related endpoint: `v1/serverDateTime` for date-time format details (optional)
vpgIdentifier = vpgIdentifier_example # String | The identifier of the VPG. Related endpoint: `v1/vpgs` (optional)
zorgIdentifier = zorgIdentifier_example # String | The identifier of the ZORG. Related endpoint: `v1/zorgs` (optional)
siteIdentifier = siteIdentifier_example # String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites` (optional)
level = level_example # String | The alert level. Related endpoint: `/v1/alerts/levels` (optional)
entity = entity_example # String | The alert entity type. Related endpoint: `/v1/alerts/entity` (optional)
helpIdentifier = helpIdentifier_example # String | The alert help identifier associated with the alert. Related endpoint: `/v1/alerts/helpidentifiers` (optional)
isDismissed = true # Boolean | True if alert was dismissed (optional)

try: 
    # Get a list of latest Zerto alerts. You can filter the results with additional parameters. (Auth)
    api_response = api_instance.get_alert_all(startDate=startDate, endDate=endDate, vpgIdentifier=vpgIdentifier, zorgIdentifier=zorgIdentifier, siteIdentifier=siteIdentifier, level=level, entity=entity, helpIdentifier=helpIdentifier, isDismissed=isDismissed)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AlertsApi->getAlertAll: %s\n" % e)

Parameters

Query parameters
Name Description
startDate
Date (date-time)
The filter interval start date-time. Related endpoint: `v1/serverDateTime` for date-time format details
endDate
Date (date-time)
The filter interval end date-time. Related endpoint: `v1/serverDateTime` for date-time format details
vpgIdentifier
String
The identifier of the VPG. Related endpoint: `v1/vpgs`
zorgIdentifier
String
The identifier of the ZORG. Related endpoint: `v1/zorgs`
siteIdentifier
String
The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
level
String
The alert level. Related endpoint: `/v1/alerts/levels`
entity
String
The alert entity type. Related endpoint: `/v1/alerts/entity`
helpIdentifier
String
The alert help identifier associated with the alert. Related endpoint: `/v1/alerts/helpidentifiers`
isDismissed
Boolean
True if alert was dismissed

Responses

Status: 200 - Success

[
{
link:
{
rel:
string
href:
string
type:
string
identifier:
string
}
level:
string
entity:
string
isDismissed:
boolean
helpIdentifier:
string
site:
{
rel:
string
href:
string
type:
string
identifier:
string
}
description:
string
turnedOn:
string (date-time)
affectedVpgs:
[
{
rel:
string
href:
string
type:
string
identifier:
string
}
]
affectedZorgs:
[
{
rel:
string
href:
string
type:
string
identifier:
string
}
]
}
]

getAlertEntityAll

Get a list of all available alert entities. (Auth)


/v1/alerts/entities

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/alerts/entities"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AlertsApi;

import java.io.File;
import java.util.*;

public class AlertsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        AlertsApi apiInstance = new AlertsApi();
        try {
            array['String'] result = apiInstance.getAlertEntityAll();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertsApi#getAlertEntityAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AlertsApi;

public class AlertsApiExample {

    public static void main(String[] args) {
        AlertsApi apiInstance = new AlertsApi();
        try {
            array['String'] result = apiInstance.getAlertEntityAll();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertsApi#getAlertEntityAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];

AlertsApi *apiInstance = [[AlertsApi alloc] init];

// Get a list of all available alert entities. (Auth)
[apiInstance getAlertEntityAllWithCompletionHandler: 
              ^(array['String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.AlertsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAlertEntityAll(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAlertEntityAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new AlertsApi();

            try
            {
                // Get a list of all available alert entities. (Auth)
                array['String'] result = apiInstance.getAlertEntityAll();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AlertsApi.getAlertEntityAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiAlertsApi();

try {
    $result = $api_instance->getAlertEntityAll();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AlertsApi->getAlertEntityAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AlertsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AlertsApi->new();

eval { 
    my $result = $api_instance->getAlertEntityAll();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AlertsApi->getAlertEntityAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AlertsApi()

try: 
    # Get a list of all available alert entities. (Auth)
    api_response = api_instance.get_alert_entity_all()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AlertsApi->getAlertEntityAll: %s\n" % e)

Parameters

Responses

Status: 200 - Success

[
string
]

getAlertHelpIdAll

Get a list of all available alert help identifiers. (Auth)


/v1/alerts/helpidentifiers

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/alerts/helpidentifiers"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AlertsApi;

import java.io.File;
import java.util.*;

public class AlertsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        AlertsApi apiInstance = new AlertsApi();
        try {
            array['String'] result = apiInstance.getAlertHelpIdAll();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertsApi#getAlertHelpIdAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AlertsApi;

public class AlertsApiExample {

    public static void main(String[] args) {
        AlertsApi apiInstance = new AlertsApi();
        try {
            array['String'] result = apiInstance.getAlertHelpIdAll();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertsApi#getAlertHelpIdAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];

AlertsApi *apiInstance = [[AlertsApi alloc] init];

// Get a list of all available alert help identifiers. (Auth)
[apiInstance getAlertHelpIdAllWithCompletionHandler: 
              ^(array['String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.AlertsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAlertHelpIdAll(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAlertHelpIdAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new AlertsApi();

            try
            {
                // Get a list of all available alert help identifiers. (Auth)
                array['String'] result = apiInstance.getAlertHelpIdAll();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AlertsApi.getAlertHelpIdAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiAlertsApi();

try {
    $result = $api_instance->getAlertHelpIdAll();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AlertsApi->getAlertHelpIdAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AlertsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AlertsApi->new();

eval { 
    my $result = $api_instance->getAlertHelpIdAll();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AlertsApi->getAlertHelpIdAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AlertsApi()

try: 
    # Get a list of all available alert help identifiers. (Auth)
    api_response = api_instance.get_alert_help_id_all()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AlertsApi->getAlertHelpIdAll: %s\n" % e)

Parameters

Responses

Status: 200 - Success

[
string
]

getAlertLevelAll

Get a list of all available alert levels. (Auth)


/v1/alerts/levels

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/alerts/levels"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AlertsApi;

import java.io.File;
import java.util.*;

public class AlertsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        AlertsApi apiInstance = new AlertsApi();
        try {
            array['String'] result = apiInstance.getAlertLevelAll();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertsApi#getAlertLevelAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AlertsApi;

public class AlertsApiExample {

    public static void main(String[] args) {
        AlertsApi apiInstance = new AlertsApi();
        try {
            array['String'] result = apiInstance.getAlertLevelAll();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertsApi#getAlertLevelAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];

AlertsApi *apiInstance = [[AlertsApi alloc] init];

// Get a list of all available alert levels. (Auth)
[apiInstance getAlertLevelAllWithCompletionHandler: 
              ^(array['String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.AlertsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAlertLevelAll(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAlertLevelAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new AlertsApi();

            try
            {
                // Get a list of all available alert levels. (Auth)
                array['String'] result = apiInstance.getAlertLevelAll();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AlertsApi.getAlertLevelAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiAlertsApi();

try {
    $result = $api_instance->getAlertLevelAll();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AlertsApi->getAlertLevelAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AlertsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AlertsApi->new();

eval { 
    my $result = $api_instance->getAlertLevelAll();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AlertsApi->getAlertLevelAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AlertsApi()

try: 
    # Get a list of all available alert levels. (Auth)
    api_response = api_instance.get_alert_level_all()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AlertsApi->getAlertLevelAll: %s\n" % e)

Parameters

Responses

Status: 200 - Success

[
string
]

removeAlert

Dismiss a specific alert. (Auth)


/v1/alerts/{alertIdentifier}/dismiss

Usage and SDK Samples

curl -X POST\
-H "x-zerto-session: [[apiKey]]"\
"https://localhost:9669//v1/alerts/{alertIdentifier}/dismiss"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AlertsApi;

import java.io.File;
import java.util.*;

public class AlertsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        AlertsApi apiInstance = new AlertsApi();
        String alertIdentifier = alertIdentifier_example; // String | Alert identifier. Related endpoint: `v1/alerts`
        try {
            apiInstance.removeAlert(alertIdentifier);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertsApi#removeAlert");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AlertsApi;

public class AlertsApiExample {

    public static void main(String[] args) {
        AlertsApi apiInstance = new AlertsApi();
        String alertIdentifier = alertIdentifier_example; // String | Alert identifier. Related endpoint: `v1/alerts`
        try {
            apiInstance.removeAlert(alertIdentifier);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertsApi#removeAlert");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *alertIdentifier = alertIdentifier_example; // Alert identifier. Related endpoint: `v1/alerts`

AlertsApi *apiInstance = [[AlertsApi alloc] init];

// Dismiss a specific alert. (Auth)
[apiInstance removeAlertWith:alertIdentifier
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.AlertsApi()
var alertIdentifier = alertIdentifier_example; // {{String}} Alert identifier. Related endpoint: `v1/alerts`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.removeAlert(alertIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class removeAlertExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new AlertsApi();
            var alertIdentifier = alertIdentifier_example;  // String | Alert identifier. Related endpoint: `v1/alerts`

            try
            {
                // Dismiss a specific alert. (Auth)
                apiInstance.removeAlert(alertIdentifier);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AlertsApi.removeAlert: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiAlertsApi();
$alertIdentifier = alertIdentifier_example; // String | Alert identifier. Related endpoint: `v1/alerts`

try {
    $api_instance->removeAlert($alertIdentifier);
} catch (Exception $e) {
    echo 'Exception when calling AlertsApi->removeAlert: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AlertsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AlertsApi->new();
my $alertIdentifier = alertIdentifier_example; # String | Alert identifier. Related endpoint: `v1/alerts`

eval { 
    $api_instance->removeAlert(alertIdentifier => $alertIdentifier);
};
if ($@) {
    warn "Exception when calling AlertsApi->removeAlert: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AlertsApi()
alertIdentifier = alertIdentifier_example # String | Alert identifier. Related endpoint: `v1/alerts`

try: 
    # Dismiss a specific alert. (Auth)
    api_instance.remove_alert(alertIdentifier)
except ApiException as e:
    print("Exception when calling AlertsApi->removeAlert: %s\n" % e)

Parameters

Path parameters
Name Description
alertIdentifier*
String
Alert identifier. Related endpoint: `v1/alerts`
Required

Responses

Status: 200 - Success


resetAlert

Undismiss a specific alert. (Auth)


/v1/alerts/{alertIdentifier}/undismiss

Usage and SDK Samples

curl -X POST\
-H "x-zerto-session: [[apiKey]]"\
"https://localhost:9669//v1/alerts/{alertIdentifier}/undismiss"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AlertsApi;

import java.io.File;
import java.util.*;

public class AlertsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        AlertsApi apiInstance = new AlertsApi();
        String alertIdentifier = alertIdentifier_example; // String | Alert identifier. Related endpoint: `v1/alerts`
        try {
            apiInstance.resetAlert(alertIdentifier);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertsApi#resetAlert");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AlertsApi;

public class AlertsApiExample {

    public static void main(String[] args) {
        AlertsApi apiInstance = new AlertsApi();
        String alertIdentifier = alertIdentifier_example; // String | Alert identifier. Related endpoint: `v1/alerts`
        try {
            apiInstance.resetAlert(alertIdentifier);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertsApi#resetAlert");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *alertIdentifier = alertIdentifier_example; // Alert identifier. Related endpoint: `v1/alerts`

AlertsApi *apiInstance = [[AlertsApi alloc] init];

// Undismiss a specific alert. (Auth)
[apiInstance resetAlertWith:alertIdentifier
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.AlertsApi()
var alertIdentifier = alertIdentifier_example; // {{String}} Alert identifier. Related endpoint: `v1/alerts`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.resetAlert(alertIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class resetAlertExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new AlertsApi();
            var alertIdentifier = alertIdentifier_example;  // String | Alert identifier. Related endpoint: `v1/alerts`

            try
            {
                // Undismiss a specific alert. (Auth)
                apiInstance.resetAlert(alertIdentifier);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AlertsApi.resetAlert: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiAlertsApi();
$alertIdentifier = alertIdentifier_example; // String | Alert identifier. Related endpoint: `v1/alerts`

try {
    $api_instance->resetAlert($alertIdentifier);
} catch (Exception $e) {
    echo 'Exception when calling AlertsApi->resetAlert: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AlertsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AlertsApi->new();
my $alertIdentifier = alertIdentifier_example; # String | Alert identifier. Related endpoint: `v1/alerts`

eval { 
    $api_instance->resetAlert(alertIdentifier => $alertIdentifier);
};
if ($@) {
    warn "Exception when calling AlertsApi->resetAlert: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AlertsApi()
alertIdentifier = alertIdentifier_example # String | Alert identifier. Related endpoint: `v1/alerts`

try: 
    # Undismiss a specific alert. (Auth)
    api_instance.reset_alert(alertIdentifier)
except ApiException as e:
    print("Exception when calling AlertsApi->resetAlert: %s\n" % e)

Parameters

Path parameters
Name Description
alertIdentifier*
String
Alert identifier. Related endpoint: `v1/alerts`
Required

Responses

Status: 200 - Success


Datastores

getDatastore

Get information about a specific datastore (Auth)


/v1/datastores/{datastoreIdentifier}

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/datastores/{datastoreIdentifier}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DatastoresApi;

import java.io.File;
import java.util.*;

public class DatastoresApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        DatastoresApi apiInstance = new DatastoresApi();
        String datastoreIdentifier = datastoreIdentifier_example; // String | Datastore identifier. Related endpoint: `v1/datastores`
        try {
            DatastoreApi result = apiInstance.getDatastore(datastoreIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatastoresApi#getDatastore");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DatastoresApi;

public class DatastoresApiExample {

    public static void main(String[] args) {
        DatastoresApi apiInstance = new DatastoresApi();
        String datastoreIdentifier = datastoreIdentifier_example; // String | Datastore identifier. Related endpoint: `v1/datastores`
        try {
            DatastoreApi result = apiInstance.getDatastore(datastoreIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatastoresApi#getDatastore");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *datastoreIdentifier = datastoreIdentifier_example; // Datastore identifier. Related endpoint: `v1/datastores`

DatastoresApi *apiInstance = [[DatastoresApi alloc] init];

// Get information about a specific datastore (Auth)
[apiInstance getDatastoreWith:datastoreIdentifier
              completionHandler: ^(DatastoreApi output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.DatastoresApi()
var datastoreIdentifier = datastoreIdentifier_example; // {{String}} Datastore identifier. Related endpoint: `v1/datastores`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDatastore(datastoreIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDatastoreExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new DatastoresApi();
            var datastoreIdentifier = datastoreIdentifier_example;  // String | Datastore identifier. Related endpoint: `v1/datastores`

            try
            {
                // Get information about a specific datastore (Auth)
                DatastoreApi result = apiInstance.getDatastore(datastoreIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DatastoresApi.getDatastore: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiDatastoresApi();
$datastoreIdentifier = datastoreIdentifier_example; // String | Datastore identifier. Related endpoint: `v1/datastores`

try {
    $result = $api_instance->getDatastore($datastoreIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DatastoresApi->getDatastore: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DatastoresApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DatastoresApi->new();
my $datastoreIdentifier = datastoreIdentifier_example; # String | Datastore identifier. Related endpoint: `v1/datastores`

eval { 
    my $result = $api_instance->getDatastore(datastoreIdentifier => $datastoreIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DatastoresApi->getDatastore: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DatastoresApi()
datastoreIdentifier = datastoreIdentifier_example # String | Datastore identifier. Related endpoint: `v1/datastores`

try: 
    # Get information about a specific datastore (Auth)
    api_response = api_instance.get_datastore(datastoreIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatastoresApi->getDatastore: %s\n" % e)

Parameters

Path parameters
Name Description
datastoreIdentifier*
String
Datastore identifier. Related endpoint: `v1/datastores`
Required

Responses

Status: 200 - Success

{
datastoreIdentifier:
string
datastoreName:
string
config:
{
devices:
[
string
]
type:
string
owningDatastoreCluster:
{
datastoreClusterIdentifier:
datastoreClusterName:
}
}
stats:
{
numVRAs:
integer (int32)
numIncomingVMs:
integer (int32)
numOutgoingVMs:
integer (int32)
availabilityStatus:
string
usage:
{
datastore:
zerto:
}
}
health:
{
status:
string
alerts:
[
{
description:
string
level:
string
link:
{
rel:
string
href:
string
type:
string
identifier:
string
}
}
]
}
}

getDatastoreAll

Get a list of datastore info available on the current site (Auth)


/v1/datastores

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/datastores"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DatastoresApi;

import java.io.File;
import java.util.*;

public class DatastoresApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        DatastoresApi apiInstance = new DatastoresApi();
        try {
            array[DatastoreApi] result = apiInstance.getDatastoreAll();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatastoresApi#getDatastoreAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DatastoresApi;

public class DatastoresApiExample {

    public static void main(String[] args) {
        DatastoresApi apiInstance = new DatastoresApi();
        try {
            array[DatastoreApi] result = apiInstance.getDatastoreAll();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatastoresApi#getDatastoreAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];

DatastoresApi *apiInstance = [[DatastoresApi alloc] init];

// Get a list of datastore info available on the current site (Auth)
[apiInstance getDatastoreAllWithCompletionHandler: 
              ^(array[DatastoreApi] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.DatastoresApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDatastoreAll(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDatastoreAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new DatastoresApi();

            try
            {
                // Get a list of datastore info available on the current site (Auth)
                array[DatastoreApi] result = apiInstance.getDatastoreAll();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DatastoresApi.getDatastoreAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiDatastoresApi();

try {
    $result = $api_instance->getDatastoreAll();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DatastoresApi->getDatastoreAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DatastoresApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DatastoresApi->new();

eval { 
    my $result = $api_instance->getDatastoreAll();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DatastoresApi->getDatastoreAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DatastoresApi()

try: 
    # Get a list of datastore info available on the current site (Auth)
    api_response = api_instance.get_datastore_all()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatastoresApi->getDatastoreAll: %s\n" % e)

Parameters

Responses

Status: 200 - Success

[
{
datastoreIdentifier:
string
datastoreName:
string
config:
{
devices:
[
string
]
type:
string
owningDatastoreCluster:
{
datastoreClusterIdentifier:
string
datastoreClusterName:
string
}
}
stats:
{
numVRAs:
integer (int32)
numIncomingVMs:
integer (int32)
numOutgoingVMs:
integer (int32)
availabilityStatus:
string
usage:
{
datastore:
{
capacityInBytes:
integer (int64)
freeInBytes:
integer (int64)
usedInBytes:
integer (int64)
provisionedInBytes:
integer (int64)
}
zerto:
{
protected:
{
usedInBytes:
integer (int64)
provisionedInBytes:
integer (int64)
}
recovery:
{
usedInBytes:
integer (int64)
provisionedInBytes:
integer (int64)
}
journal:
{
usedInBytes:
integer (int64)
provisionedInBytes:
integer (int64)
}
scratch:
{
usedInBytes:
integer (int64)
provisionedInBytes:
integer (int64)
}
appliances:
{
usedInBytes:
integer (int64)
provisionedInBytes:
integer (int64)
}
unknown:
{
usedInBytes:
integer (int64)
provisionedInBytes:
integer (int64)
}
}
}
}
health:
{
status:
string
alerts:
[
{
description:
string
level:
string
link:
{
rel:
string
href:
string
type:
string
identifier:
string
}
}
]
}
}
]

Events

getEvent

Get data for a single event on the site processing the API. (Auth)


/v1/events/{eventIdentifier}

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/events/{eventIdentifier}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EventsApi;

import java.io.File;
import java.util.*;

public class EventsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        EventsApi apiInstance = new EventsApi();
        String eventIdentifier = eventIdentifier_example; // String | Event identifier. Related endpoint: `/v1/events`
        try {
            EventApi result = apiInstance.getEvent(eventIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventsApi#getEvent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EventsApi;

public class EventsApiExample {

    public static void main(String[] args) {
        EventsApi apiInstance = new EventsApi();
        String eventIdentifier = eventIdentifier_example; // String | Event identifier. Related endpoint: `/v1/events`
        try {
            EventApi result = apiInstance.getEvent(eventIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventsApi#getEvent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *eventIdentifier = eventIdentifier_example; // Event identifier. Related endpoint: `/v1/events`

EventsApi *apiInstance = [[EventsApi alloc] init];

// Get data for a single event on the site processing the API. (Auth)
[apiInstance getEventWith:eventIdentifier
              completionHandler: ^(EventApi output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.EventsApi()
var eventIdentifier = eventIdentifier_example; // {{String}} Event identifier. Related endpoint: `/v1/events`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getEvent(eventIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getEventExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new EventsApi();
            var eventIdentifier = eventIdentifier_example;  // String | Event identifier. Related endpoint: `/v1/events`

            try
            {
                // Get data for a single event on the site processing the API. (Auth)
                EventApi result = apiInstance.getEvent(eventIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EventsApi.getEvent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiEventsApi();
$eventIdentifier = eventIdentifier_example; // String | Event identifier. Related endpoint: `/v1/events`

try {
    $result = $api_instance->getEvent($eventIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EventsApi->getEvent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EventsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::EventsApi->new();
my $eventIdentifier = eventIdentifier_example; # String | Event identifier. Related endpoint: `/v1/events`

eval { 
    my $result = $api_instance->getEvent(eventIdentifier => $eventIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EventsApi->getEvent: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.EventsApi()
eventIdentifier = eventIdentifier_example # String | Event identifier. Related endpoint: `/v1/events`

try: 
    # Get data for a single event on the site processing the API. (Auth)
    api_response = api_instance.get_event(eventIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EventsApi->getEvent: %s\n" % e)

Parameters

Path parameters
Name Description
eventIdentifier*
String
Event identifier. Related endpoint: `/v1/events`
Required

Responses

Status: 200 - Success

{
link:
{
rel:
string
href:
string
type:
string
identifier:
string
}
eventIdentifier:
string
description:
string
occurredOn:
string (date-time)
Link_{0}:
{
rel:
string
href:
string
type:
string
}
eventType:
integer (int32)
Enum: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106
vpgs:
[
{
vpgIdentifier:
string
vpgName:
string
Link_{0}:
{
rel:
string
href:
string
type:
string
}
}
]
helpLink:
string
siteName:
string
siteIdentifier:
string
zorgName:
string
zorgIdentifier:
string
eventCompletedSuccessfully:
boolean
entityType:
integer (int32)
Enum: 0, 1, 2, 3
eventCategory:
string
userName:
string
relatedEntities:
{
vpgs:
[
{
rel:
string
href:
string
type:
string
identifier:
string
}
]
sites:
[
{
rel:
string
href:
string
type:
string
identifier:
string
}
]
hosts:
[
{
rel:
string
href:
string
type:
string
identifier:
string
}
]
zorgs:
[
{
rel:
string
href:
string
type:
string
identifier:
string
}
]
alerts:
[
{
rel:
string
href:
string
type:
string
identifier:
string
}
]
flrSessions:
[
{
rel:
string
href:
string
type:
string
identifier:
string
}
]
repositories:
[
{
rel:
string
href:
string
type:
string
identifier:
string
}
]
}
}

getEventAll

Get a list of latest Zerto events. You can filter the results with additional parameters. (Auth)


/v1/events

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/events?startDate=&endDate=&vpg=&vpgIdentifier=&siteName=&siteIdentifier=&zorgIdentifier=&eventType=&entityType=&category=&eventCategory=&userName=&alertIdentifier="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EventsApi;

import java.io.File;
import java.util.*;

public class EventsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        EventsApi apiInstance = new EventsApi();
        Date startDate = 2013-10-20T19:20:30+01:00; // Date | The filter interval start date-time. Related endpoint: `v1/serverDateTime` for date-time format details
        Date endDate = 2013-10-20T19:20:30+01:00; // Date | The filter interval end date-time. Related endpoint: `v1/serverDateTime` for date-time format details
        String vpg = vpg_example; // String | [Obsolete] The identifier of the VPG. Related endpoint: `v1/vpgs`
        String vpgIdentifier = vpgIdentifier_example; // String | The identifier of the VPG. Related endpoint: `v1/vpgs`
        String siteName = siteName_example; // String | The name of the site
        String siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
        String zorgIdentifier = zorgIdentifier_example; // String | The identifier of the ZORG. Related endpoint: `v1/zorgs`
        String eventType = eventType_example; // String | The event type. Related endpoint: `/v1/events/types`
        String entityType = entityType_example; // String | The entity type to return. Related endpoint: `/v1/events/entities`
        String category = category_example; // String | The event category to return. Related endpoint: `/v1/events/categories`
        String eventCategory = eventCategory_example; // String | [Obsolete] The event category to return. Related endpoint: `/v1/events/categories`
        String userName = userName_example; // String | The username for which the event occurred. Tasks run by ZVM have the username `System`
        String alertIdentifier = alertIdentifier_example; // String | Alert identifier. Related endpoint: `/v1/alerts`
        try {
            array[EventApi] result = apiInstance.getEventAll(startDate, endDate, vpg, vpgIdentifier, siteName, siteIdentifier, zorgIdentifier, eventType, entityType, category, eventCategory, userName, alertIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventsApi#getEventAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EventsApi;

public class EventsApiExample {

    public static void main(String[] args) {
        EventsApi apiInstance = new EventsApi();
        Date startDate = 2013-10-20T19:20:30+01:00; // Date | The filter interval start date-time. Related endpoint: `v1/serverDateTime` for date-time format details
        Date endDate = 2013-10-20T19:20:30+01:00; // Date | The filter interval end date-time. Related endpoint: `v1/serverDateTime` for date-time format details
        String vpg = vpg_example; // String | [Obsolete] The identifier of the VPG. Related endpoint: `v1/vpgs`
        String vpgIdentifier = vpgIdentifier_example; // String | The identifier of the VPG. Related endpoint: `v1/vpgs`
        String siteName = siteName_example; // String | The name of the site
        String siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
        String zorgIdentifier = zorgIdentifier_example; // String | The identifier of the ZORG. Related endpoint: `v1/zorgs`
        String eventType = eventType_example; // String | The event type. Related endpoint: `/v1/events/types`
        String entityType = entityType_example; // String | The entity type to return. Related endpoint: `/v1/events/entities`
        String category = category_example; // String | The event category to return. Related endpoint: `/v1/events/categories`
        String eventCategory = eventCategory_example; // String | [Obsolete] The event category to return. Related endpoint: `/v1/events/categories`
        String userName = userName_example; // String | The username for which the event occurred. Tasks run by ZVM have the username `System`
        String alertIdentifier = alertIdentifier_example; // String | Alert identifier. Related endpoint: `/v1/alerts`
        try {
            array[EventApi] result = apiInstance.getEventAll(startDate, endDate, vpg, vpgIdentifier, siteName, siteIdentifier, zorgIdentifier, eventType, entityType, category, eventCategory, userName, alertIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventsApi#getEventAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
Date *startDate = 2013-10-20T19:20:30+01:00; // The filter interval start date-time. Related endpoint: `v1/serverDateTime` for date-time format details (optional)
Date *endDate = 2013-10-20T19:20:30+01:00; // The filter interval end date-time. Related endpoint: `v1/serverDateTime` for date-time format details (optional)
String *vpg = vpg_example; // [Obsolete] The identifier of the VPG. Related endpoint: `v1/vpgs` (optional)
String *vpgIdentifier = vpgIdentifier_example; // The identifier of the VPG. Related endpoint: `v1/vpgs` (optional)
String *siteName = siteName_example; // The name of the site (optional)
String *siteIdentifier = siteIdentifier_example; // The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites` (optional)
String *zorgIdentifier = zorgIdentifier_example; // The identifier of the ZORG. Related endpoint: `v1/zorgs` (optional)
String *eventType = eventType_example; // The event type. Related endpoint: `/v1/events/types` (optional)
String *entityType = entityType_example; // The entity type to return. Related endpoint: `/v1/events/entities` (optional)
String *category = category_example; // The event category to return. Related endpoint: `/v1/events/categories` (optional)
String *eventCategory = eventCategory_example; // [Obsolete] The event category to return. Related endpoint: `/v1/events/categories` (optional)
String *userName = userName_example; // The username for which the event occurred. Tasks run by ZVM have the username `System` (optional)
String *alertIdentifier = alertIdentifier_example; // Alert identifier. Related endpoint: `/v1/alerts` (optional)

EventsApi *apiInstance = [[EventsApi alloc] init];

// Get a list of latest Zerto events. You can filter the results with additional parameters. (Auth)
[apiInstance getEventAllWith:startDate
    endDate:endDate
    vpg:vpg
    vpgIdentifier:vpgIdentifier
    siteName:siteName
    siteIdentifier:siteIdentifier
    zorgIdentifier:zorgIdentifier
    eventType:eventType
    entityType:entityType
    category:category
    eventCategory:eventCategory
    userName:userName
    alertIdentifier:alertIdentifier
              completionHandler: ^(array[EventApi] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.EventsApi()
var opts = { 
  'startDate': 2013-10-20T19:20:30+01:00, // {{Date}} The filter interval start date-time. Related endpoint: `v1/serverDateTime` for date-time format details
  'endDate': 2013-10-20T19:20:30+01:00, // {{Date}} The filter interval end date-time. Related endpoint: `v1/serverDateTime` for date-time format details
  'vpg': vpg_example, // {{String}} [Obsolete] The identifier of the VPG. Related endpoint: `v1/vpgs`
  'vpgIdentifier': vpgIdentifier_example, // {{String}} The identifier of the VPG. Related endpoint: `v1/vpgs`
  'siteName': siteName_example, // {{String}} The name of the site
  'siteIdentifier': siteIdentifier_example, // {{String}} The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
  'zorgIdentifier': zorgIdentifier_example, // {{String}} The identifier of the ZORG. Related endpoint: `v1/zorgs`
  'eventType': eventType_example, // {{String}} The event type. Related endpoint: `/v1/events/types`
  'entityType': entityType_example, // {{String}} The entity type to return. Related endpoint: `/v1/events/entities`
  'category': category_example, // {{String}} The event category to return. Related endpoint: `/v1/events/categories`
  'eventCategory': eventCategory_example, // {{String}} [Obsolete] The event category to return. Related endpoint: `/v1/events/categories`
  'userName': userName_example, // {{String}} The username for which the event occurred. Tasks run by ZVM have the username `System`
  'alertIdentifier': alertIdentifier_example // {{String}} Alert identifier. Related endpoint: `/v1/alerts`
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getEventAll(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getEventAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new EventsApi();
            var startDate = 2013-10-20T19:20:30+01:00;  // Date | The filter interval start date-time. Related endpoint: `v1/serverDateTime` for date-time format details (optional) 
            var endDate = 2013-10-20T19:20:30+01:00;  // Date | The filter interval end date-time. Related endpoint: `v1/serverDateTime` for date-time format details (optional) 
            var vpg = vpg_example;  // String | [Obsolete] The identifier of the VPG. Related endpoint: `v1/vpgs` (optional) 
            var vpgIdentifier = vpgIdentifier_example;  // String | The identifier of the VPG. Related endpoint: `v1/vpgs` (optional) 
            var siteName = siteName_example;  // String | The name of the site (optional) 
            var siteIdentifier = siteIdentifier_example;  // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites` (optional) 
            var zorgIdentifier = zorgIdentifier_example;  // String | The identifier of the ZORG. Related endpoint: `v1/zorgs` (optional) 
            var eventType = eventType_example;  // String | The event type. Related endpoint: `/v1/events/types` (optional) 
            var entityType = entityType_example;  // String | The entity type to return. Related endpoint: `/v1/events/entities` (optional) 
            var category = category_example;  // String | The event category to return. Related endpoint: `/v1/events/categories` (optional) 
            var eventCategory = eventCategory_example;  // String | [Obsolete] The event category to return. Related endpoint: `/v1/events/categories` (optional) 
            var userName = userName_example;  // String | The username for which the event occurred. Tasks run by ZVM have the username `System` (optional) 
            var alertIdentifier = alertIdentifier_example;  // String | Alert identifier. Related endpoint: `/v1/alerts` (optional) 

            try
            {
                // Get a list of latest Zerto events. You can filter the results with additional parameters. (Auth)
                array[EventApi] result = apiInstance.getEventAll(startDate, endDate, vpg, vpgIdentifier, siteName, siteIdentifier, zorgIdentifier, eventType, entityType, category, eventCategory, userName, alertIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EventsApi.getEventAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiEventsApi();
$startDate = 2013-10-20T19:20:30+01:00; // Date | The filter interval start date-time. Related endpoint: `v1/serverDateTime` for date-time format details
$endDate = 2013-10-20T19:20:30+01:00; // Date | The filter interval end date-time. Related endpoint: `v1/serverDateTime` for date-time format details
$vpg = vpg_example; // String | [Obsolete] The identifier of the VPG. Related endpoint: `v1/vpgs`
$vpgIdentifier = vpgIdentifier_example; // String | The identifier of the VPG. Related endpoint: `v1/vpgs`
$siteName = siteName_example; // String | The name of the site
$siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
$zorgIdentifier = zorgIdentifier_example; // String | The identifier of the ZORG. Related endpoint: `v1/zorgs`
$eventType = eventType_example; // String | The event type. Related endpoint: `/v1/events/types`
$entityType = entityType_example; // String | The entity type to return. Related endpoint: `/v1/events/entities`
$category = category_example; // String | The event category to return. Related endpoint: `/v1/events/categories`
$eventCategory = eventCategory_example; // String | [Obsolete] The event category to return. Related endpoint: `/v1/events/categories`
$userName = userName_example; // String | The username for which the event occurred. Tasks run by ZVM have the username `System`
$alertIdentifier = alertIdentifier_example; // String | Alert identifier. Related endpoint: `/v1/alerts`

try {
    $result = $api_instance->getEventAll($startDate, $endDate, $vpg, $vpgIdentifier, $siteName, $siteIdentifier, $zorgIdentifier, $eventType, $entityType, $category, $eventCategory, $userName, $alertIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EventsApi->getEventAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EventsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::EventsApi->new();
my $startDate = 2013-10-20T19:20:30+01:00; # Date | The filter interval start date-time. Related endpoint: `v1/serverDateTime` for date-time format details
my $endDate = 2013-10-20T19:20:30+01:00; # Date | The filter interval end date-time. Related endpoint: `v1/serverDateTime` for date-time format details
my $vpg = vpg_example; # String | [Obsolete] The identifier of the VPG. Related endpoint: `v1/vpgs`
my $vpgIdentifier = vpgIdentifier_example; # String | The identifier of the VPG. Related endpoint: `v1/vpgs`
my $siteName = siteName_example; # String | The name of the site
my $siteIdentifier = siteIdentifier_example; # String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
my $zorgIdentifier = zorgIdentifier_example; # String | The identifier of the ZORG. Related endpoint: `v1/zorgs`
my $eventType = eventType_example; # String | The event type. Related endpoint: `/v1/events/types`
my $entityType = entityType_example; # String | The entity type to return. Related endpoint: `/v1/events/entities`
my $category = category_example; # String | The event category to return. Related endpoint: `/v1/events/categories`
my $eventCategory = eventCategory_example; # String | [Obsolete] The event category to return. Related endpoint: `/v1/events/categories`
my $userName = userName_example; # String | The username for which the event occurred. Tasks run by ZVM have the username `System`
my $alertIdentifier = alertIdentifier_example; # String | Alert identifier. Related endpoint: `/v1/alerts`

eval { 
    my $result = $api_instance->getEventAll(startDate => $startDate, endDate => $endDate, vpg => $vpg, vpgIdentifier => $vpgIdentifier, siteName => $siteName, siteIdentifier => $siteIdentifier, zorgIdentifier => $zorgIdentifier, eventType => $eventType, entityType => $entityType, category => $category, eventCategory => $eventCategory, userName => $userName, alertIdentifier => $alertIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EventsApi->getEventAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.EventsApi()
startDate = 2013-10-20T19:20:30+01:00 # Date | The filter interval start date-time. Related endpoint: `v1/serverDateTime` for date-time format details (optional)
endDate = 2013-10-20T19:20:30+01:00 # Date | The filter interval end date-time. Related endpoint: `v1/serverDateTime` for date-time format details (optional)
vpg = vpg_example # String | [Obsolete] The identifier of the VPG. Related endpoint: `v1/vpgs` (optional)
vpgIdentifier = vpgIdentifier_example # String | The identifier of the VPG. Related endpoint: `v1/vpgs` (optional)
siteName = siteName_example # String | The name of the site (optional)
siteIdentifier = siteIdentifier_example # String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites` (optional)
zorgIdentifier = zorgIdentifier_example # String | The identifier of the ZORG. Related endpoint: `v1/zorgs` (optional)
eventType = eventType_example # String | The event type. Related endpoint: `/v1/events/types` (optional)
entityType = entityType_example # String | The entity type to return. Related endpoint: `/v1/events/entities` (optional)
category = category_example # String | The event category to return. Related endpoint: `/v1/events/categories` (optional)
eventCategory = eventCategory_example # String | [Obsolete] The event category to return. Related endpoint: `/v1/events/categories` (optional)
userName = userName_example # String | The username for which the event occurred. Tasks run by ZVM have the username `System` (optional)
alertIdentifier = alertIdentifier_example # String | Alert identifier. Related endpoint: `/v1/alerts` (optional)

try: 
    # Get a list of latest Zerto events. You can filter the results with additional parameters. (Auth)
    api_response = api_instance.get_event_all(startDate=startDate, endDate=endDate, vpg=vpg, vpgIdentifier=vpgIdentifier, siteName=siteName, siteIdentifier=siteIdentifier, zorgIdentifier=zorgIdentifier, eventType=eventType, entityType=entityType, category=category, eventCategory=eventCategory, userName=userName, alertIdentifier=alertIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EventsApi->getEventAll: %s\n" % e)

Parameters

Query parameters
Name Description
startDate
Date (date-time)
The filter interval start date-time. Related endpoint: `v1/serverDateTime` for date-time format details
endDate
Date (date-time)
The filter interval end date-time. Related endpoint: `v1/serverDateTime` for date-time format details
vpg
String
[Obsolete] The identifier of the VPG. Related endpoint: `v1/vpgs`
vpgIdentifier
String
The identifier of the VPG. Related endpoint: `v1/vpgs`
siteName
String
The name of the site
siteIdentifier
String
The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
zorgIdentifier
String
The identifier of the ZORG. Related endpoint: `v1/zorgs`
eventType
String
The event type. Related endpoint: `/v1/events/types`
entityType
String
The entity type to return. Related endpoint: `/v1/events/entities`
category
String
The event category to return. Related endpoint: `/v1/events/categories`
eventCategory
String
[Obsolete] The event category to return. Related endpoint: `/v1/events/categories`
userName
String
The username for which the event occurred. Tasks run by ZVM have the username `System`
alertIdentifier
String
Alert identifier. Related endpoint: `/v1/alerts`

Responses

Status: 200 - Success

[
{
link:
{
rel:
string
href:
string
type:
string
identifier:
string
}
eventIdentifier:
string
description:
string
occurredOn:
string (date-time)
Link_{0}:
{
rel:
string
href:
string
type:
string
}
eventType:
integer (int32)
Enum: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106
vpgs:
[
{
vpgIdentifier:
string
vpgName:
string
Link_{0}:
{
rel:
string
href:
string
type:
string
}
}
]
helpLink:
string
siteName:
string
siteIdentifier:
string
zorgName:
string
zorgIdentifier:
string
eventCompletedSuccessfully:
boolean
entityType:
integer (int32)
Enum: 0, 1, 2, 3
eventCategory:
string
userName:
string
relatedEntities:
{
vpgs:
[
{
rel:
string
href:
string
type:
string
identifier:
string
}
]
sites:
[
{
rel:
string
href:
string
type:
string
identifier:
string
}
]
hosts:
[
{
rel:
string
href:
string
type:
string
identifier:
string
}
]
zorgs:
[
{
rel:
string
href:
string
type:
string
identifier:
string
}
]
alerts:
[
{
rel:
string
href:
string
type:
string
identifier:
string
}
]
flrSessions:
[
{
rel:
string
href:
string
type:
string
identifier:
string
}
]
repositories:
[
{
rel:
string
href:
string
type:
string
identifier:
string
}
]
}
}
]

getEventCategoryAll

Get a list of all available event categories. (Auth)


/v1/events/categories

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/events/categories"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EventsApi;

import java.io.File;
import java.util.*;

public class EventsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        EventsApi apiInstance = new EventsApi();
        try {
            array['String'] result = apiInstance.getEventCategoryAll();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventsApi#getEventCategoryAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EventsApi;

public class EventsApiExample {

    public static void main(String[] args) {
        EventsApi apiInstance = new EventsApi();
        try {
            array['String'] result = apiInstance.getEventCategoryAll();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventsApi#getEventCategoryAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];

EventsApi *apiInstance = [[EventsApi alloc] init];

// Get a list of all available event categories. (Auth)
[apiInstance getEventCategoryAllWithCompletionHandler: 
              ^(array['String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.EventsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getEventCategoryAll(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getEventCategoryAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new EventsApi();

            try
            {
                // Get a list of all available event categories. (Auth)
                array['String'] result = apiInstance.getEventCategoryAll();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EventsApi.getEventCategoryAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiEventsApi();

try {
    $result = $api_instance->getEventCategoryAll();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EventsApi->getEventCategoryAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EventsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::EventsApi->new();

eval { 
    my $result = $api_instance->getEventCategoryAll();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EventsApi->getEventCategoryAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.EventsApi()

try: 
    # Get a list of all available event categories. (Auth)
    api_response = api_instance.get_event_category_all()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EventsApi->getEventCategoryAll: %s\n" % e)

Parameters

Responses

Status: 200 - Success

[
string
]

getEventEntityAll

Get a list of all available event entities. (Auth)


/v1/events/entities

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/events/entities"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EventsApi;

import java.io.File;
import java.util.*;

public class EventsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        EventsApi apiInstance = new EventsApi();
        try {
            array['String'] result = apiInstance.getEventEntityAll();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventsApi#getEventEntityAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EventsApi;

public class EventsApiExample {

    public static void main(String[] args) {
        EventsApi apiInstance = new EventsApi();
        try {
            array['String'] result = apiInstance.getEventEntityAll();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventsApi#getEventEntityAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];

EventsApi *apiInstance = [[EventsApi alloc] init];

// Get a list of all available event entities. (Auth)
[apiInstance getEventEntityAllWithCompletionHandler: 
              ^(array['String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.EventsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getEventEntityAll(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getEventEntityAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new EventsApi();

            try
            {
                // Get a list of all available event entities. (Auth)
                array['String'] result = apiInstance.getEventEntityAll();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EventsApi.getEventEntityAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiEventsApi();

try {
    $result = $api_instance->getEventEntityAll();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EventsApi->getEventEntityAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EventsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::EventsApi->new();

eval { 
    my $result = $api_instance->getEventEntityAll();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EventsApi->getEventEntityAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.EventsApi()

try: 
    # Get a list of all available event entities. (Auth)
    api_response = api_instance.get_event_entity_all()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EventsApi->getEventEntityAll: %s\n" % e)

Parameters

Responses

Status: 200 - Success

[
string
]

getEventTypeAll

Get a list of all available event types (Auth)


/v1/events/types

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/events/types"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EventsApi;

import java.io.File;
import java.util.*;

public class EventsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        EventsApi apiInstance = new EventsApi();
        try {
            array['String'] result = apiInstance.getEventTypeAll();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventsApi#getEventTypeAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EventsApi;

public class EventsApiExample {

    public static void main(String[] args) {
        EventsApi apiInstance = new EventsApi();
        try {
            array['String'] result = apiInstance.getEventTypeAll();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventsApi#getEventTypeAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];

EventsApi *apiInstance = [[EventsApi alloc] init];

// Get a list of all available event types (Auth)
[apiInstance getEventTypeAllWithCompletionHandler: 
              ^(array['String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.EventsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getEventTypeAll(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getEventTypeAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new EventsApi();

            try
            {
                // Get a list of all available event types (Auth)
                array['String'] result = apiInstance.getEventTypeAll();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EventsApi.getEventTypeAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiEventsApi();

try {
    $result = $api_instance->getEventTypeAll();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EventsApi->getEventTypeAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EventsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::EventsApi->new();

eval { 
    my $result = $api_instance->getEventTypeAll();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EventsApi->getEventTypeAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.EventsApi()

try: 
    # Get a list of all available event types (Auth)
    api_response = api_instance.get_event_type_all()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EventsApi->getEventTypeAll: %s\n" % e)

Parameters

Responses

Status: 200 - Success

[
string
]

FileLevelRestore

dismountFlr

Unmount a previously mounted disk. (Auth)


/v1/flrs/{flrSessionIdentifier}

Usage and SDK Samples

curl -X DELETE\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/flrs/{flrSessionIdentifier}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FileLevelRestoreApi;

import java.io.File;
import java.util.*;

public class FileLevelRestoreApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        FileLevelRestoreApi apiInstance = new FileLevelRestoreApi();
        String flrSessionIdentifier = flrSessionIdentifier_example; // String | The File-level Restore session identifier. Related endpoint: `v1/flrs`
        try {
            'String' result = apiInstance.dismountFlr(flrSessionIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FileLevelRestoreApi#dismountFlr");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FileLevelRestoreApi;

public class FileLevelRestoreApiExample {

    public static void main(String[] args) {
        FileLevelRestoreApi apiInstance = new FileLevelRestoreApi();
        String flrSessionIdentifier = flrSessionIdentifier_example; // String | The File-level Restore session identifier. Related endpoint: `v1/flrs`
        try {
            'String' result = apiInstance.dismountFlr(flrSessionIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FileLevelRestoreApi#dismountFlr");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *flrSessionIdentifier = flrSessionIdentifier_example; // The File-level Restore session identifier. Related endpoint: `v1/flrs`

FileLevelRestoreApi *apiInstance = [[FileLevelRestoreApi alloc] init];

// Unmount a previously mounted disk. (Auth)
[apiInstance dismountFlrWith:flrSessionIdentifier
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.FileLevelRestoreApi()
var flrSessionIdentifier = flrSessionIdentifier_example; // {{String}} The File-level Restore session identifier. Related endpoint: `v1/flrs`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.dismountFlr(flrSessionIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class dismountFlrExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new FileLevelRestoreApi();
            var flrSessionIdentifier = flrSessionIdentifier_example;  // String | The File-level Restore session identifier. Related endpoint: `v1/flrs`

            try
            {
                // Unmount a previously mounted disk. (Auth)
                'String' result = apiInstance.dismountFlr(flrSessionIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FileLevelRestoreApi.dismountFlr: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiFileLevelRestoreApi();
$flrSessionIdentifier = flrSessionIdentifier_example; // String | The File-level Restore session identifier. Related endpoint: `v1/flrs`

try {
    $result = $api_instance->dismountFlr($flrSessionIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FileLevelRestoreApi->dismountFlr: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FileLevelRestoreApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::FileLevelRestoreApi->new();
my $flrSessionIdentifier = flrSessionIdentifier_example; # String | The File-level Restore session identifier. Related endpoint: `v1/flrs`

eval { 
    my $result = $api_instance->dismountFlr(flrSessionIdentifier => $flrSessionIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FileLevelRestoreApi->dismountFlr: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.FileLevelRestoreApi()
flrSessionIdentifier = flrSessionIdentifier_example # String | The File-level Restore session identifier. Related endpoint: `v1/flrs`

try: 
    # Unmount a previously mounted disk. (Auth)
    api_response = api_instance.dismount_flr(flrSessionIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FileLevelRestoreApi->dismountFlr: %s\n" % e)

Parameters

Path parameters
Name Description
flrSessionIdentifier*
String
The File-level Restore session identifier. Related endpoint: `v1/flrs`
Required

Responses

Status: 200 - Success

string

getFlr

Get information about a single mounted disk. (Auth)


/v1/flrs/{flrSessionIdentifier}

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/flrs/{flrSessionIdentifier}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FileLevelRestoreApi;

import java.io.File;
import java.util.*;

public class FileLevelRestoreApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        FileLevelRestoreApi apiInstance = new FileLevelRestoreApi();
        String flrSessionIdentifier = flrSessionIdentifier_example; // String | The File-level Restore session identifier. Related endpoint: `v1/flrs`
        try {
            array[FlrSessionInformationApi] result = apiInstance.getFlr(flrSessionIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FileLevelRestoreApi#getFlr");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FileLevelRestoreApi;

public class FileLevelRestoreApiExample {

    public static void main(String[] args) {
        FileLevelRestoreApi apiInstance = new FileLevelRestoreApi();
        String flrSessionIdentifier = flrSessionIdentifier_example; // String | The File-level Restore session identifier. Related endpoint: `v1/flrs`
        try {
            array[FlrSessionInformationApi] result = apiInstance.getFlr(flrSessionIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FileLevelRestoreApi#getFlr");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *flrSessionIdentifier = flrSessionIdentifier_example; // The File-level Restore session identifier. Related endpoint: `v1/flrs`

FileLevelRestoreApi *apiInstance = [[FileLevelRestoreApi alloc] init];

// Get information about a single mounted disk. (Auth)
[apiInstance getFlrWith:flrSessionIdentifier
              completionHandler: ^(array[FlrSessionInformationApi] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.FileLevelRestoreApi()
var flrSessionIdentifier = flrSessionIdentifier_example; // {{String}} The File-level Restore session identifier. Related endpoint: `v1/flrs`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFlr(flrSessionIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getFlrExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new FileLevelRestoreApi();
            var flrSessionIdentifier = flrSessionIdentifier_example;  // String | The File-level Restore session identifier. Related endpoint: `v1/flrs`

            try
            {
                // Get information about a single mounted disk. (Auth)
                array[FlrSessionInformationApi] result = apiInstance.getFlr(flrSessionIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FileLevelRestoreApi.getFlr: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiFileLevelRestoreApi();
$flrSessionIdentifier = flrSessionIdentifier_example; // String | The File-level Restore session identifier. Related endpoint: `v1/flrs`

try {
    $result = $api_instance->getFlr($flrSessionIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FileLevelRestoreApi->getFlr: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FileLevelRestoreApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::FileLevelRestoreApi->new();
my $flrSessionIdentifier = flrSessionIdentifier_example; # String | The File-level Restore session identifier. Related endpoint: `v1/flrs`

eval { 
    my $result = $api_instance->getFlr(flrSessionIdentifier => $flrSessionIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FileLevelRestoreApi->getFlr: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.FileLevelRestoreApi()
flrSessionIdentifier = flrSessionIdentifier_example # String | The File-level Restore session identifier. Related endpoint: `v1/flrs`

try: 
    # Get information about a single mounted disk. (Auth)
    api_response = api_instance.get_flr(flrSessionIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FileLevelRestoreApi->getFlr: %s\n" % e)

Parameters

Path parameters
Name Description
flrSessionIdentifier*
String
The File-level Restore session identifier. Related endpoint: `v1/flrs`
Required

Responses

Status: 200 - Success

[
{
flrSessionStatus:
string
flrSessionIdentifier:
string
flrSessionType:
string
vmIdentifier:
string
vmVolumeIdentifier:
string
vpgIdentifier:
string
checkpointIdentifier:
string
mountTime:
string
selectedPath:
string
numberOfRelatedRunningTasks:
integer (int32)
repositoryIdentifier:
string
retentionSetIdentifier:
string
siteIdentifier:
string
}
]

getFlrAll

Get all mounted volumes. Results can be filtered by a VM identifier. (Auth)


/v1/flrs

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/flrs?vmIdentifier="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FileLevelRestoreApi;

import java.io.File;
import java.util.*;

public class FileLevelRestoreApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        FileLevelRestoreApi apiInstance = new FileLevelRestoreApi();
        String vmIdentifier = vmIdentifier_example; // String | The idenfier of the VM. Related endpoint: `v1/vms`
        try {
            array[FlrSessionInformationApi] result = apiInstance.getFlrAll(vmIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FileLevelRestoreApi#getFlrAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FileLevelRestoreApi;

public class FileLevelRestoreApiExample {

    public static void main(String[] args) {
        FileLevelRestoreApi apiInstance = new FileLevelRestoreApi();
        String vmIdentifier = vmIdentifier_example; // String | The idenfier of the VM. Related endpoint: `v1/vms`
        try {
            array[FlrSessionInformationApi] result = apiInstance.getFlrAll(vmIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FileLevelRestoreApi#getFlrAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vmIdentifier = vmIdentifier_example; // The idenfier of the VM. Related endpoint: `v1/vms` (optional)

FileLevelRestoreApi *apiInstance = [[FileLevelRestoreApi alloc] init];

// Get all mounted volumes. Results can be filtered by a VM identifier. (Auth)
[apiInstance getFlrAllWith:vmIdentifier
              completionHandler: ^(array[FlrSessionInformationApi] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.FileLevelRestoreApi()
var opts = { 
  'vmIdentifier': vmIdentifier_example // {{String}} The idenfier of the VM. Related endpoint: `v1/vms`
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFlrAll(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getFlrAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new FileLevelRestoreApi();
            var vmIdentifier = vmIdentifier_example;  // String | The idenfier of the VM. Related endpoint: `v1/vms` (optional) 

            try
            {
                // Get all mounted volumes. Results can be filtered by a VM identifier. (Auth)
                array[FlrSessionInformationApi] result = apiInstance.getFlrAll(vmIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FileLevelRestoreApi.getFlrAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiFileLevelRestoreApi();
$vmIdentifier = vmIdentifier_example; // String | The idenfier of the VM. Related endpoint: `v1/vms`

try {
    $result = $api_instance->getFlrAll($vmIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FileLevelRestoreApi->getFlrAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FileLevelRestoreApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::FileLevelRestoreApi->new();
my $vmIdentifier = vmIdentifier_example; # String | The idenfier of the VM. Related endpoint: `v1/vms`

eval { 
    my $result = $api_instance->getFlrAll(vmIdentifier => $vmIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FileLevelRestoreApi->getFlrAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.FileLevelRestoreApi()
vmIdentifier = vmIdentifier_example # String | The idenfier of the VM. Related endpoint: `v1/vms` (optional)

try: 
    # Get all mounted volumes. Results can be filtered by a VM identifier. (Auth)
    api_response = api_instance.get_flr_all(vmIdentifier=vmIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FileLevelRestoreApi->getFlrAll: %s\n" % e)

Parameters

Query parameters
Name Description
vmIdentifier
String
The idenfier of the VM. Related endpoint: `v1/vms`

Responses

Status: 200 - Success

[
{
flrSessionStatus:
string
flrSessionIdentifier:
string
flrSessionType:
string
vmIdentifier:
string
vmVolumeIdentifier:
string
vpgIdentifier:
string
checkpointIdentifier:
string
mountTime:
string
selectedPath:
string
numberOfRelatedRunningTasks:
integer (int32)
repositoryIdentifier:
string
retentionSetIdentifier:
string
siteIdentifier:
string
}
]

getFlrDownload

Get URL link to download all the files from the specified paths. (Auth)


/v1/flrs/{flrSessionIdentifier}/download

Usage and SDK Samples

curl -X POST\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
-H "Content-Type: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/flrs/{flrSessionIdentifier}/download"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FileLevelRestoreApi;

import java.io.File;
import java.util.*;

public class FileLevelRestoreApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        FileLevelRestoreApi apiInstance = new FileLevelRestoreApi();
        String flrSessionIdentifier = flrSessionIdentifier_example; // String | The File-level Restore session identifier. Related endpoint: `v1/flrs`
        FlrDownloadDataApi body = ; // FlrDownloadDataApi | 
        try {
            'String' result = apiInstance.getFlrDownload(flrSessionIdentifier, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FileLevelRestoreApi#getFlrDownload");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FileLevelRestoreApi;

public class FileLevelRestoreApiExample {

    public static void main(String[] args) {
        FileLevelRestoreApi apiInstance = new FileLevelRestoreApi();
        String flrSessionIdentifier = flrSessionIdentifier_example; // String | The File-level Restore session identifier. Related endpoint: `v1/flrs`
        FlrDownloadDataApi body = ; // FlrDownloadDataApi | 
        try {
            'String' result = apiInstance.getFlrDownload(flrSessionIdentifier, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FileLevelRestoreApi#getFlrDownload");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *flrSessionIdentifier = flrSessionIdentifier_example; // The File-level Restore session identifier. Related endpoint: `v1/flrs`
FlrDownloadDataApi *body = ; //  (optional)

FileLevelRestoreApi *apiInstance = [[FileLevelRestoreApi alloc] init];

// Get URL link to download all the files from the specified paths. (Auth)
[apiInstance getFlrDownloadWith:flrSessionIdentifier
    body:body
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.FileLevelRestoreApi()
var flrSessionIdentifier = flrSessionIdentifier_example; // {{String}} The File-level Restore session identifier. Related endpoint: `v1/flrs`
var opts = { 
  'body':  // {{FlrDownloadDataApi}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFlrDownload(flrSessionIdentifier, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getFlrDownloadExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new FileLevelRestoreApi();
            var flrSessionIdentifier = flrSessionIdentifier_example;  // String | The File-level Restore session identifier. Related endpoint: `v1/flrs`
            var body = new FlrDownloadDataApi(); // FlrDownloadDataApi |  (optional) 

            try
            {
                // Get URL link to download all the files from the specified paths. (Auth)
                'String' result = apiInstance.getFlrDownload(flrSessionIdentifier, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FileLevelRestoreApi.getFlrDownload: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiFileLevelRestoreApi();
$flrSessionIdentifier = flrSessionIdentifier_example; // String | The File-level Restore session identifier. Related endpoint: `v1/flrs`
$body = ; // FlrDownloadDataApi | 

try {
    $result = $api_instance->getFlrDownload($flrSessionIdentifier, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FileLevelRestoreApi->getFlrDownload: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FileLevelRestoreApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::FileLevelRestoreApi->new();
my $flrSessionIdentifier = flrSessionIdentifier_example; # String | The File-level Restore session identifier. Related endpoint: `v1/flrs`
my $body = WWW::SwaggerClient::Object::FlrDownloadDataApi->new(); # FlrDownloadDataApi | 

eval { 
    my $result = $api_instance->getFlrDownload(flrSessionIdentifier => $flrSessionIdentifier, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FileLevelRestoreApi->getFlrDownload: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.FileLevelRestoreApi()
flrSessionIdentifier = flrSessionIdentifier_example # String | The File-level Restore session identifier. Related endpoint: `v1/flrs`
body =  # FlrDownloadDataApi |  (optional)

try: 
    # Get URL link to download all the files from the specified paths. (Auth)
    api_response = api_instance.get_flr_download(flrSessionIdentifier, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FileLevelRestoreApi->getFlrDownload: %s\n" % e)

Parameters

Path parameters
Name Description
flrSessionIdentifier*
String
The File-level Restore session identifier. Related endpoint: `v1/flrs`
Required
Body parameters
Name Description
body
{
pathList:
[
string
]
}

Responses

Status: 200 - Success

string

getFlrPathInfo

Browse a list of files and folders in a specific path in the mounted disk. (Auth)


/v1/flrs/{flrSessionIdentifier}/browse

Usage and SDK Samples

curl -X POST\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
-H "Content-Type: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/flrs/{flrSessionIdentifier}/browse"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FileLevelRestoreApi;

import java.io.File;
import java.util.*;

public class FileLevelRestoreApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        FileLevelRestoreApi apiInstance = new FileLevelRestoreApi();
        String flrSessionIdentifier = flrSessionIdentifier_example; // String | The File-level Restore session identifier. Related endpoint: `v1/flrs`
        BrowseDataApi body = ; // BrowseDataApi | 
        try {
            PathInformationApi result = apiInstance.getFlrPathInfo(flrSessionIdentifier, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FileLevelRestoreApi#getFlrPathInfo");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FileLevelRestoreApi;

public class FileLevelRestoreApiExample {

    public static void main(String[] args) {
        FileLevelRestoreApi apiInstance = new FileLevelRestoreApi();
        String flrSessionIdentifier = flrSessionIdentifier_example; // String | The File-level Restore session identifier. Related endpoint: `v1/flrs`
        BrowseDataApi body = ; // BrowseDataApi | 
        try {
            PathInformationApi result = apiInstance.getFlrPathInfo(flrSessionIdentifier, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FileLevelRestoreApi#getFlrPathInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *flrSessionIdentifier = flrSessionIdentifier_example; // The File-level Restore session identifier. Related endpoint: `v1/flrs`
BrowseDataApi *body = ; //  (optional)

FileLevelRestoreApi *apiInstance = [[FileLevelRestoreApi alloc] init];

// Browse a list of files and folders in a specific path in the mounted disk. (Auth)
[apiInstance getFlrPathInfoWith:flrSessionIdentifier
    body:body
              completionHandler: ^(PathInformationApi output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.FileLevelRestoreApi()
var flrSessionIdentifier = flrSessionIdentifier_example; // {{String}} The File-level Restore session identifier. Related endpoint: `v1/flrs`
var opts = { 
  'body':  // {{BrowseDataApi}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFlrPathInfo(flrSessionIdentifier, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getFlrPathInfoExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new FileLevelRestoreApi();
            var flrSessionIdentifier = flrSessionIdentifier_example;  // String | The File-level Restore session identifier. Related endpoint: `v1/flrs`
            var body = new BrowseDataApi(); // BrowseDataApi |  (optional) 

            try
            {
                // Browse a list of files and folders in a specific path in the mounted disk. (Auth)
                PathInformationApi result = apiInstance.getFlrPathInfo(flrSessionIdentifier, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FileLevelRestoreApi.getFlrPathInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiFileLevelRestoreApi();
$flrSessionIdentifier = flrSessionIdentifier_example; // String | The File-level Restore session identifier. Related endpoint: `v1/flrs`
$body = ; // BrowseDataApi | 

try {
    $result = $api_instance->getFlrPathInfo($flrSessionIdentifier, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FileLevelRestoreApi->getFlrPathInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FileLevelRestoreApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::FileLevelRestoreApi->new();
my $flrSessionIdentifier = flrSessionIdentifier_example; # String | The File-level Restore session identifier. Related endpoint: `v1/flrs`
my $body = WWW::SwaggerClient::Object::BrowseDataApi->new(); # BrowseDataApi | 

eval { 
    my $result = $api_instance->getFlrPathInfo(flrSessionIdentifier => $flrSessionIdentifier, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FileLevelRestoreApi->getFlrPathInfo: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.FileLevelRestoreApi()
flrSessionIdentifier = flrSessionIdentifier_example # String | The File-level Restore session identifier. Related endpoint: `v1/flrs`
body =  # BrowseDataApi |  (optional)

try: 
    # Browse a list of files and folders in a specific path in the mounted disk. (Auth)
    api_response = api_instance.get_flr_path_info(flrSessionIdentifier, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FileLevelRestoreApi->getFlrPathInfo: %s\n" % e)

Parameters

Path parameters
Name Description
flrSessionIdentifier*
String
The File-level Restore session identifier. Related endpoint: `v1/flrs`
Required
Body parameters
Name Description
body
{
path:
string
pageNumber:
integer (int32)
pageSize:
integer (int32)
}

Responses

Status: 200 - Success

{
mainPathItem:
{
path:
string
type:
string
isBrowsable:
boolean
downloadInformation:
{
isDownloadable:
additionalInformation:
}
sizeInBytes:
integer (int64)
creationTime:
string
lastAccessTime:
string
lastWriteTime:
string
}
pathItems:
[
{
path:
string
type:
string
isBrowsable:
boolean
downloadInformation:
{
isDownloadable:
boolean
additionalInformation:
string
}
sizeInBytes:
integer (int64)
creationTime:
string
lastAccessTime:
string
lastWriteTime:
string
}
]
}

mountFlr

Create a new Mount Session. Mount a disk with specified parameters. Get the FLR session identifier. (Auth)


/v1/flrs

Usage and SDK Samples

curl -X POST\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
-H "Content-Type: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/flrs"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FileLevelRestoreApi;

import java.io.File;
import java.util.*;

public class FileLevelRestoreApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        FileLevelRestoreApi apiInstance = new FileLevelRestoreApi();
        FlrMountDataApi body = ; // FlrMountDataApi | 
        try {
            'String' result = apiInstance.mountFlr(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FileLevelRestoreApi#mountFlr");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FileLevelRestoreApi;

public class FileLevelRestoreApiExample {

    public static void main(String[] args) {
        FileLevelRestoreApi apiInstance = new FileLevelRestoreApi();
        FlrMountDataApi body = ; // FlrMountDataApi | 
        try {
            'String' result = apiInstance.mountFlr(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FileLevelRestoreApi#mountFlr");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
FlrMountDataApi *body = ; //  (optional)

FileLevelRestoreApi *apiInstance = [[FileLevelRestoreApi alloc] init];

// Create a new Mount Session. Mount a disk with specified parameters. Get the FLR session identifier. (Auth)
[apiInstance mountFlrWith:body
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.FileLevelRestoreApi()
var opts = { 
  'body':  // {{FlrMountDataApi}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.mountFlr(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class mountFlrExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new FileLevelRestoreApi();
            var body = new FlrMountDataApi(); // FlrMountDataApi |  (optional) 

            try
            {
                // Create a new Mount Session. Mount a disk with specified parameters. Get the FLR session identifier. (Auth)
                'String' result = apiInstance.mountFlr(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FileLevelRestoreApi.mountFlr: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiFileLevelRestoreApi();
$body = ; // FlrMountDataApi | 

try {
    $result = $api_instance->mountFlr($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FileLevelRestoreApi->mountFlr: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FileLevelRestoreApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::FileLevelRestoreApi->new();
my $body = WWW::SwaggerClient::Object::FlrMountDataApi->new(); # FlrMountDataApi | 

eval { 
    my $result = $api_instance->mountFlr(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FileLevelRestoreApi->mountFlr: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.FileLevelRestoreApi()
body =  # FlrMountDataApi |  (optional)

try: 
    # Create a new Mount Session. Mount a disk with specified parameters. Get the FLR session identifier. (Auth)
    api_response = api_instance.mount_flr(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FileLevelRestoreApi->mountFlr: %s\n" % e)

Parameters

Body parameters
Name Description
body
{
jflr:
{
vpgIdentifier:
vmIdentifier:
checkpointIdentifier:
vmVolumeIdentifier:
initialDownloadPath:
}
bflr:
{
vpgIdentifier:
vmIdentifier:
retentionSetIdentifier:
repositoryIdentifier:
repositorySiteIdentifier:
initialDownloadPath:
}
}

Responses

Status: 200 - Success

string

Licensing

getLicense

Get license details of the ZVM (Auth)


/v1/license

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/license"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LicensingApi;

import java.io.File;
import java.util.*;

public class LicensingApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        LicensingApi apiInstance = new LicensingApi();
        try {
            LicenseApi result = apiInstance.getLicense();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LicensingApi#getLicense");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LicensingApi;

public class LicensingApiExample {

    public static void main(String[] args) {
        LicensingApi apiInstance = new LicensingApi();
        try {
            LicenseApi result = apiInstance.getLicense();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LicensingApi#getLicense");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];

LicensingApi *apiInstance = [[LicensingApi alloc] init];

// Get license details of the ZVM (Auth)
[apiInstance getLicenseWithCompletionHandler: 
              ^(LicenseApi output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.LicensingApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getLicense(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getLicenseExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new LicensingApi();

            try
            {
                // Get license details of the ZVM (Auth)
                LicenseApi result = apiInstance.getLicense();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LicensingApi.getLicense: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiLicensingApi();

try {
    $result = $api_instance->getLicense();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LicensingApi->getLicense: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LicensingApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::LicensingApi->new();

eval { 
    my $result = $api_instance->getLicense();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LicensingApi->getLicense: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.LicensingApi()

try: 
    # Get license details of the ZVM (Auth)
    api_response = api_instance.get_license()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LicensingApi->getLicense: %s\n" % e)

Parameters

Responses

Status: 200 - Success

{
details:
{
licenseKey:
string
licenseType:
string
expiryTime:
string
maxVms:
integer (int32)
}
usage:
{
sitesUsage:
[
{
siteIdentifier:
string
siteName:
string
protectedVmsCount:
integer (int32)
}
]
totalVmsCount:
integer (int32)
}
}

removeLicense

Delete the license from the ZVM (Auth)


/v1/license

Usage and SDK Samples

curl -X DELETE\
-H "x-zerto-session: [[apiKey]]"\
"https://localhost:9669//v1/license"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LicensingApi;

import java.io.File;
import java.util.*;

public class LicensingApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        LicensingApi apiInstance = new LicensingApi();
        try {
            apiInstance.removeLicense();
        } catch (ApiException e) {
            System.err.println("Exception when calling LicensingApi#removeLicense");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LicensingApi;

public class LicensingApiExample {

    public static void main(String[] args) {
        LicensingApi apiInstance = new LicensingApi();
        try {
            apiInstance.removeLicense();
        } catch (ApiException e) {
            System.err.println("Exception when calling LicensingApi#removeLicense");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];

LicensingApi *apiInstance = [[LicensingApi alloc] init];

// Delete the license from the ZVM (Auth)
[apiInstance removeLicenseWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.LicensingApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.removeLicense(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class removeLicenseExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new LicensingApi();

            try
            {
                // Delete the license from the ZVM (Auth)
                apiInstance.removeLicense();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LicensingApi.removeLicense: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiLicensingApi();

try {
    $api_instance->removeLicense();
} catch (Exception $e) {
    echo 'Exception when calling LicensingApi->removeLicense: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LicensingApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::LicensingApi->new();

eval { 
    $api_instance->removeLicense();
};
if ($@) {
    warn "Exception when calling LicensingApi->removeLicense: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.LicensingApi()

try: 
    # Delete the license from the ZVM (Auth)
    api_instance.remove_license()
except ApiException as e:
    print("Exception when calling LicensingApi->removeLicense: %s\n" % e)

Parameters

Responses

Status: 200 - Success


setLicense

Add a new license or update an existing one. (Auth)


/v1/license

Usage and SDK Samples

curl -X PUT\
-H "x-zerto-session: [[apiKey]]"\
-H "Content-Type: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/license"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LicensingApi;

import java.io.File;
import java.util.*;

public class LicensingApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        LicensingApi apiInstance = new LicensingApi();
        LicenseKeyApi body = ; // LicenseKeyApi | 
        try {
            apiInstance.setLicense(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling LicensingApi#setLicense");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LicensingApi;

public class LicensingApiExample {

    public static void main(String[] args) {
        LicensingApi apiInstance = new LicensingApi();
        LicenseKeyApi body = ; // LicenseKeyApi | 
        try {
            apiInstance.setLicense(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling LicensingApi#setLicense");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
LicenseKeyApi *body = ; //  (optional)

LicensingApi *apiInstance = [[LicensingApi alloc] init];

// Add a new license or update an existing one. (Auth)
[apiInstance setLicenseWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.LicensingApi()
var opts = { 
  'body':  // {{LicenseKeyApi}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.setLicense(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class setLicenseExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new LicensingApi();
            var body = new LicenseKeyApi(); // LicenseKeyApi |  (optional) 

            try
            {
                // Add a new license or update an existing one. (Auth)
                apiInstance.setLicense(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LicensingApi.setLicense: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiLicensingApi();
$body = ; // LicenseKeyApi | 

try {
    $api_instance->setLicense($body);
} catch (Exception $e) {
    echo 'Exception when calling LicensingApi->setLicense: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LicensingApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::LicensingApi->new();
my $body = WWW::SwaggerClient::Object::LicenseKeyApi->new(); # LicenseKeyApi | 

eval { 
    $api_instance->setLicense(body => $body);
};
if ($@) {
    warn "Exception when calling LicensingApi->setLicense: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.LicensingApi()
body =  # LicenseKeyApi |  (optional)

try: 
    # Add a new license or update an existing one. (Auth)
    api_instance.set_license(body=body)
except ApiException as e:
    print("Exception when calling LicensingApi->setLicense: %s\n" % e)

Parameters

Body parameters
Name Description
body
{
licenseKey:
string
}

Responses

Status: 200 - Success


LocalSite

getLocalSiteAll

Get information about the local site (Auth)


/v1/localsite

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/localsite"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LocalSiteApi;

import java.io.File;
import java.util.*;

public class LocalSiteApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        LocalSiteApi apiInstance = new LocalSiteApi();
        try {
            LocalSiteApi result = apiInstance.getLocalSiteAll();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LocalSiteApi#getLocalSiteAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LocalSiteApi;

public class LocalSiteApiExample {

    public static void main(String[] args) {
        LocalSiteApi apiInstance = new LocalSiteApi();
        try {
            LocalSiteApi result = apiInstance.getLocalSiteAll();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LocalSiteApi#getLocalSiteAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];

LocalSiteApi *apiInstance = [[LocalSiteApi alloc] init];

// Get information about the local site (Auth)
[apiInstance getLocalSiteAllWithCompletionHandler: 
              ^(LocalSiteApi output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.LocalSiteApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getLocalSiteAll(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getLocalSiteAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new LocalSiteApi();

            try
            {
                // Get information about the local site (Auth)
                LocalSiteApi result = apiInstance.getLocalSiteAll();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LocalSiteApi.getLocalSiteAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiLocalSiteApi();

try {
    $result = $api_instance->getLocalSiteAll();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LocalSiteApi->getLocalSiteAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LocalSiteApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::LocalSiteApi->new();

eval { 
    my $result = $api_instance->getLocalSiteAll();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LocalSiteApi->getLocalSiteAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.LocalSiteApi()

try: 
    # Get information about the local site (Auth)
    api_response = api_instance.get_local_site_all()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LocalSiteApi->getLocalSiteAll: %s\n" % e)

Parameters

Responses

Status: 200 - Success

{
link:
{
rel:
string
href:
string
type:
string
identifier:
string
}
siteIdentifier:
string
siteName:
string
location:
string
version:
string
zvmApiVersion:
string
contactEmail:
string
contactName:
string
contactPhone:
string
isReplicationToSelfEnabled:
boolean
utcOffsetInMinutes:
integer (int32)
siteType:
string
ipAddress:
string
bandwidthThrottlingInMBs:
number (double)
siteTypeVersion:
string
}

getLocalSitePairingStatusAll

Get the list of acceptable values for site pairing status (Auth)


/v1/localsite/pairingstatuses

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/localsite/pairingstatuses"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LocalSiteApi;

import java.io.File;
import java.util.*;

public class LocalSiteApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        LocalSiteApi apiInstance = new LocalSiteApi();
        try {
            array['String'] result = apiInstance.getLocalSitePairingStatusAll();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LocalSiteApi#getLocalSitePairingStatusAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LocalSiteApi;

public class LocalSiteApiExample {

    public static void main(String[] args) {
        LocalSiteApi apiInstance = new LocalSiteApi();
        try {
            array['String'] result = apiInstance.getLocalSitePairingStatusAll();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LocalSiteApi#getLocalSitePairingStatusAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];

LocalSiteApi *apiInstance = [[LocalSiteApi alloc] init];

// Get the list of acceptable values for site pairing status (Auth)
[apiInstance getLocalSitePairingStatusAllWithCompletionHandler: 
              ^(array['String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.LocalSiteApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getLocalSitePairingStatusAll(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getLocalSitePairingStatusAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new LocalSiteApi();

            try
            {
                // Get the list of acceptable values for site pairing status (Auth)
                array['String'] result = apiInstance.getLocalSitePairingStatusAll();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LocalSiteApi.getLocalSitePairingStatusAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiLocalSiteApi();

try {
    $result = $api_instance->getLocalSitePairingStatusAll();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LocalSiteApi->getLocalSitePairingStatusAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LocalSiteApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::LocalSiteApi->new();

eval { 
    my $result = $api_instance->getLocalSitePairingStatusAll();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LocalSiteApi->getLocalSitePairingStatusAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.LocalSiteApi()

try: 
    # Get the list of acceptable values for site pairing status (Auth)
    api_response = api_instance.get_local_site_pairing_status_all()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LocalSiteApi->getLocalSitePairingStatusAll: %s\n" % e)

Parameters

Responses

Status: 200 - Success

[
string
]

sendLocalSiteBillingUsageData

Send billing data to the billing server (Auth)


/v1/localsite/billing/sendUsage

Usage and SDK Samples

curl -X POST\
-H "x-zerto-session: [[apiKey]]"\
"https://localhost:9669//v1/localsite/billing/sendUsage"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LocalSiteApi;

import java.io.File;
import java.util.*;

public class LocalSiteApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        LocalSiteApi apiInstance = new LocalSiteApi();
        try {
            apiInstance.sendLocalSiteBillingUsageData();
        } catch (ApiException e) {
            System.err.println("Exception when calling LocalSiteApi#sendLocalSiteBillingUsageData");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LocalSiteApi;

public class LocalSiteApiExample {

    public static void main(String[] args) {
        LocalSiteApi apiInstance = new LocalSiteApi();
        try {
            apiInstance.sendLocalSiteBillingUsageData();
        } catch (ApiException e) {
            System.err.println("Exception when calling LocalSiteApi#sendLocalSiteBillingUsageData");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];

LocalSiteApi *apiInstance = [[LocalSiteApi alloc] init];

// Send billing data to the billing server (Auth)
[apiInstance sendLocalSiteBillingUsageDataWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.LocalSiteApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.sendLocalSiteBillingUsageData(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class sendLocalSiteBillingUsageDataExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new LocalSiteApi();

            try
            {
                // Send billing data to the billing server (Auth)
                apiInstance.sendLocalSiteBillingUsageData();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LocalSiteApi.sendLocalSiteBillingUsageData: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiLocalSiteApi();

try {
    $api_instance->sendLocalSiteBillingUsageData();
} catch (Exception $e) {
    echo 'Exception when calling LocalSiteApi->sendLocalSiteBillingUsageData: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LocalSiteApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::LocalSiteApi->new();

eval { 
    $api_instance->sendLocalSiteBillingUsageData();
};
if ($@) {
    warn "Exception when calling LocalSiteApi->sendLocalSiteBillingUsageData: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.LocalSiteApi()

try: 
    # Send billing data to the billing server (Auth)
    api_instance.send_local_site_billing_usage_data()
except ApiException as e:
    print("Exception when calling LocalSiteApi->sendLocalSiteBillingUsageData: %s\n" % e)

Parameters

Responses

Status: 200 - Success


LongTermRetention

deleteLtrCatalogRetentionSets

Delete Retention sets (Auth)


/v1/ltr/catalog/deleteretentionsets

Usage and SDK Samples

curl -X POST\
-H "x-zerto-session: [[apiKey]]"\
-H "Content-Type: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/ltr/catalog/deleteretentionsets"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LongTermRetentionApi;

import java.io.File;
import java.util.*;

public class LongTermRetentionApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        LongTermRetentionApi apiInstance = new LongTermRetentionApi();
        DeleteRetentionSetsApi body = ; // DeleteRetentionSetsApi | 
        try {
            apiInstance.deleteLtrCatalogRetentionSets(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling LongTermRetentionApi#deleteLtrCatalogRetentionSets");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LongTermRetentionApi;

public class LongTermRetentionApiExample {

    public static void main(String[] args) {
        LongTermRetentionApi apiInstance = new LongTermRetentionApi();
        DeleteRetentionSetsApi body = ; // DeleteRetentionSetsApi | 
        try {
            apiInstance.deleteLtrCatalogRetentionSets(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling LongTermRetentionApi#deleteLtrCatalogRetentionSets");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
DeleteRetentionSetsApi *body = ; //  (optional)

LongTermRetentionApi *apiInstance = [[LongTermRetentionApi alloc] init];

// Delete Retention sets (Auth)
[apiInstance deleteLtrCatalogRetentionSetsWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.LongTermRetentionApi()
var opts = { 
  'body':  // {{DeleteRetentionSetsApi}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteLtrCatalogRetentionSets(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteLtrCatalogRetentionSetsExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new LongTermRetentionApi();
            var body = new DeleteRetentionSetsApi(); // DeleteRetentionSetsApi |  (optional) 

            try
            {
                // Delete Retention sets (Auth)
                apiInstance.deleteLtrCatalogRetentionSets(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LongTermRetentionApi.deleteLtrCatalogRetentionSets: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiLongTermRetentionApi();
$body = ; // DeleteRetentionSetsApi | 

try {
    $api_instance->deleteLtrCatalogRetentionSets($body);
} catch (Exception $e) {
    echo 'Exception when calling LongTermRetentionApi->deleteLtrCatalogRetentionSets: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LongTermRetentionApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::LongTermRetentionApi->new();
my $body = WWW::SwaggerClient::Object::DeleteRetentionSetsApi->new(); # DeleteRetentionSetsApi | 

eval { 
    $api_instance->deleteLtrCatalogRetentionSets(body => $body);
};
if ($@) {
    warn "Exception when calling LongTermRetentionApi->deleteLtrCatalogRetentionSets: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.LongTermRetentionApi()
body =  # DeleteRetentionSetsApi |  (optional)

try: 
    # Delete Retention sets (Auth)
    api_instance.delete_ltr_catalog_retention_sets(body=body)
except ApiException as e:
    print("Exception when calling LongTermRetentionApi->deleteLtrCatalogRetentionSets: %s\n" % e)

Parameters

Body parameters
Name Description
body
{
retentionSetsToDelete:
[
{
fullRetentionSetIdentifier:
string
incrementalRetentionSetsIdentifiers:
[
string
]
}
]
}

Responses

Status: 200 - Success


getLtrCatalogFullRetentionSets

Get a list of full Retention sets (Auth)


/v1/ltr/catalog/fullretentionsets

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/ltr/catalog/fullretentionsets?repositoryIdentifier=&vpgIdentifier=&zorgIdentifier="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LongTermRetentionApi;

import java.io.File;
import java.util.*;

public class LongTermRetentionApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        LongTermRetentionApi apiInstance = new LongTermRetentionApi();
        String repositoryIdentifier = repositoryIdentifier_example; // String | The identifier of the repository where the Retention Set is stored. Relatd endpoint: `/v1/virtualizationsites/{siteIdentifier}/repositories`
        String vpgIdentifier = vpgIdentifier_example; // String | The identifier of the VPG. Related endpoint: `v1/vpgs`
        String zorgIdentifier = zorgIdentifier_example; // String | The identifier of the ZORG. Related endpoint: `v1/zorgs`
        try {
            RetentionSetsInfoApi result = apiInstance.getLtrCatalogFullRetentionSets(repositoryIdentifier, vpgIdentifier, zorgIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LongTermRetentionApi#getLtrCatalogFullRetentionSets");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LongTermRetentionApi;

public class LongTermRetentionApiExample {

    public static void main(String[] args) {
        LongTermRetentionApi apiInstance = new LongTermRetentionApi();
        String repositoryIdentifier = repositoryIdentifier_example; // String | The identifier of the repository where the Retention Set is stored. Relatd endpoint: `/v1/virtualizationsites/{siteIdentifier}/repositories`
        String vpgIdentifier = vpgIdentifier_example; // String | The identifier of the VPG. Related endpoint: `v1/vpgs`
        String zorgIdentifier = zorgIdentifier_example; // String | The identifier of the ZORG. Related endpoint: `v1/zorgs`
        try {
            RetentionSetsInfoApi result = apiInstance.getLtrCatalogFullRetentionSets(repositoryIdentifier, vpgIdentifier, zorgIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LongTermRetentionApi#getLtrCatalogFullRetentionSets");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *repositoryIdentifier = repositoryIdentifier_example; // The identifier of the repository where the Retention Set is stored. Relatd endpoint: `/v1/virtualizationsites/{siteIdentifier}/repositories` (optional)
String *vpgIdentifier = vpgIdentifier_example; // The identifier of the VPG. Related endpoint: `v1/vpgs` (optional)
String *zorgIdentifier = zorgIdentifier_example; // The identifier of the ZORG. Related endpoint: `v1/zorgs` (optional)

LongTermRetentionApi *apiInstance = [[LongTermRetentionApi alloc] init];

// Get a list of full Retention sets (Auth)
[apiInstance getLtrCatalogFullRetentionSetsWith:repositoryIdentifier
    vpgIdentifier:vpgIdentifier
    zorgIdentifier:zorgIdentifier
              completionHandler: ^(RetentionSetsInfoApi output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.LongTermRetentionApi()
var opts = { 
  'repositoryIdentifier': repositoryIdentifier_example, // {{String}} The identifier of the repository where the Retention Set is stored. Relatd endpoint: `/v1/virtualizationsites/{siteIdentifier}/repositories`
  'vpgIdentifier': vpgIdentifier_example, // {{String}} The identifier of the VPG. Related endpoint: `v1/vpgs`
  'zorgIdentifier': zorgIdentifier_example // {{String}} The identifier of the ZORG. Related endpoint: `v1/zorgs`
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getLtrCatalogFullRetentionSets(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getLtrCatalogFullRetentionSetsExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new LongTermRetentionApi();
            var repositoryIdentifier = repositoryIdentifier_example;  // String | The identifier of the repository where the Retention Set is stored. Relatd endpoint: `/v1/virtualizationsites/{siteIdentifier}/repositories` (optional) 
            var vpgIdentifier = vpgIdentifier_example;  // String | The identifier of the VPG. Related endpoint: `v1/vpgs` (optional) 
            var zorgIdentifier = zorgIdentifier_example;  // String | The identifier of the ZORG. Related endpoint: `v1/zorgs` (optional) 

            try
            {
                // Get a list of full Retention sets (Auth)
                RetentionSetsInfoApi result = apiInstance.getLtrCatalogFullRetentionSets(repositoryIdentifier, vpgIdentifier, zorgIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LongTermRetentionApi.getLtrCatalogFullRetentionSets: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiLongTermRetentionApi();
$repositoryIdentifier = repositoryIdentifier_example; // String | The identifier of the repository where the Retention Set is stored. Relatd endpoint: `/v1/virtualizationsites/{siteIdentifier}/repositories`
$vpgIdentifier = vpgIdentifier_example; // String | The identifier of the VPG. Related endpoint: `v1/vpgs`
$zorgIdentifier = zorgIdentifier_example; // String | The identifier of the ZORG. Related endpoint: `v1/zorgs`

try {
    $result = $api_instance->getLtrCatalogFullRetentionSets($repositoryIdentifier, $vpgIdentifier, $zorgIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LongTermRetentionApi->getLtrCatalogFullRetentionSets: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LongTermRetentionApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::LongTermRetentionApi->new();
my $repositoryIdentifier = repositoryIdentifier_example; # String | The identifier of the repository where the Retention Set is stored. Relatd endpoint: `/v1/virtualizationsites/{siteIdentifier}/repositories`
my $vpgIdentifier = vpgIdentifier_example; # String | The identifier of the VPG. Related endpoint: `v1/vpgs`
my $zorgIdentifier = zorgIdentifier_example; # String | The identifier of the ZORG. Related endpoint: `v1/zorgs`

eval { 
    my $result = $api_instance->getLtrCatalogFullRetentionSets(repositoryIdentifier => $repositoryIdentifier, vpgIdentifier => $vpgIdentifier, zorgIdentifier => $zorgIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LongTermRetentionApi->getLtrCatalogFullRetentionSets: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.LongTermRetentionApi()
repositoryIdentifier = repositoryIdentifier_example # String | The identifier of the repository where the Retention Set is stored. Relatd endpoint: `/v1/virtualizationsites/{siteIdentifier}/repositories` (optional)
vpgIdentifier = vpgIdentifier_example # String | The identifier of the VPG. Related endpoint: `v1/vpgs` (optional)
zorgIdentifier = zorgIdentifier_example # String | The identifier of the ZORG. Related endpoint: `v1/zorgs` (optional)

try: 
    # Get a list of full Retention sets (Auth)
    api_response = api_instance.get_ltr_catalog_full_retention_sets(repositoryIdentifier=repositoryIdentifier, vpgIdentifier=vpgIdentifier, zorgIdentifier=zorgIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LongTermRetentionApi->getLtrCatalogFullRetentionSets: %s\n" % e)

Parameters

Query parameters
Name Description
repositoryIdentifier
String
The identifier of the repository where the Retention Set is stored. Relatd endpoint: `/v1/virtualizationsites/{siteIdentifier}/repositories`
vpgIdentifier
String
The identifier of the VPG. Related endpoint: `v1/vpgs`
zorgIdentifier
String
The identifier of the ZORG. Related endpoint: `v1/zorgs`

Responses

Status: 200 - Success

{
retentionSets:
[
{
retentionSetIdentifier:
string
backupMethod:
string
vpg:
{
name:
string
identifier:
string
}
repository:
{
name:
string
identifier:
string
}
zorg:
{
name:
string
identifier:
string
}
pointInTime:
string (date-time)
expiryDate:
string (date-time)
actionType:
string
statusType:
string
isAppAware:
boolean
sizeInKB:
integer (int64)
aggregatedSizeInKB:
integer (int64)
numberOfIncrementals:
integer (int32)
isVpgExists:
boolean
retentionSetImmutability:
{
immutabilityState:
string
immutabilityExpiryTime:
string (date-time)
}
retentionSetActionsInformation:
{
deleteAction:
{
isEnabled:
boolean
disableReasonText:
string
}
}
}
]
}

getLtrCatalogIncrementalsOfRetentionSet

Get a list of incremental Retention sets (Auth)


/v1/ltr/catalog/fullretentionsets/{retentionSetIdentifier}/incrementals

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/ltr/catalog/fullretentionsets/{retentionSetIdentifier}/incrementals"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LongTermRetentionApi;

import java.io.File;
import java.util.*;

public class LongTermRetentionApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        LongTermRetentionApi apiInstance = new LongTermRetentionApi();
        String retentionSetIdentifier = retentionSetIdentifier_example; // String | The unique identifier of the Retention Set. Related endpoint: `v1/ltr/catalog/fullretentionsets`
        try {
            RetentionSetsInfoApi result = apiInstance.getLtrCatalogIncrementalsOfRetentionSet(retentionSetIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LongTermRetentionApi#getLtrCatalogIncrementalsOfRetentionSet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LongTermRetentionApi;

public class LongTermRetentionApiExample {

    public static void main(String[] args) {
        LongTermRetentionApi apiInstance = new LongTermRetentionApi();
        String retentionSetIdentifier = retentionSetIdentifier_example; // String | The unique identifier of the Retention Set. Related endpoint: `v1/ltr/catalog/fullretentionsets`
        try {
            RetentionSetsInfoApi result = apiInstance.getLtrCatalogIncrementalsOfRetentionSet(retentionSetIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LongTermRetentionApi#getLtrCatalogIncrementalsOfRetentionSet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *retentionSetIdentifier = retentionSetIdentifier_example; // The unique identifier of the Retention Set. Related endpoint: `v1/ltr/catalog/fullretentionsets`

LongTermRetentionApi *apiInstance = [[LongTermRetentionApi alloc] init];

// Get a list of incremental Retention sets (Auth)
[apiInstance getLtrCatalogIncrementalsOfRetentionSetWith:retentionSetIdentifier
              completionHandler: ^(RetentionSetsInfoApi output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.LongTermRetentionApi()
var retentionSetIdentifier = retentionSetIdentifier_example; // {{String}} The unique identifier of the Retention Set. Related endpoint: `v1/ltr/catalog/fullretentionsets`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getLtrCatalogIncrementalsOfRetentionSet(retentionSetIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getLtrCatalogIncrementalsOfRetentionSetExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new LongTermRetentionApi();
            var retentionSetIdentifier = retentionSetIdentifier_example;  // String | The unique identifier of the Retention Set. Related endpoint: `v1/ltr/catalog/fullretentionsets`

            try
            {
                // Get a list of incremental Retention sets (Auth)
                RetentionSetsInfoApi result = apiInstance.getLtrCatalogIncrementalsOfRetentionSet(retentionSetIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LongTermRetentionApi.getLtrCatalogIncrementalsOfRetentionSet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiLongTermRetentionApi();
$retentionSetIdentifier = retentionSetIdentifier_example; // String | The unique identifier of the Retention Set. Related endpoint: `v1/ltr/catalog/fullretentionsets`

try {
    $result = $api_instance->getLtrCatalogIncrementalsOfRetentionSet($retentionSetIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LongTermRetentionApi->getLtrCatalogIncrementalsOfRetentionSet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LongTermRetentionApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::LongTermRetentionApi->new();
my $retentionSetIdentifier = retentionSetIdentifier_example; # String | The unique identifier of the Retention Set. Related endpoint: `v1/ltr/catalog/fullretentionsets`

eval { 
    my $result = $api_instance->getLtrCatalogIncrementalsOfRetentionSet(retentionSetIdentifier => $retentionSetIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LongTermRetentionApi->getLtrCatalogIncrementalsOfRetentionSet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.LongTermRetentionApi()
retentionSetIdentifier = retentionSetIdentifier_example # String | The unique identifier of the Retention Set. Related endpoint: `v1/ltr/catalog/fullretentionsets`

try: 
    # Get a list of incremental Retention sets (Auth)
    api_response = api_instance.get_ltr_catalog_incrementals_of_retention_set(retentionSetIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LongTermRetentionApi->getLtrCatalogIncrementalsOfRetentionSet: %s\n" % e)

Parameters

Path parameters
Name Description
retentionSetIdentifier*
String
The unique identifier of the Retention Set. Related endpoint: `v1/ltr/catalog/fullretentionsets`
Required

Responses

Status: 200 - Success

{
retentionSets:
[
{
retentionSetIdentifier:
string
backupMethod:
string
vpg:
{
name:
string
identifier:
string
}
repository:
{
name:
string
identifier:
string
}
zorg:
{
name:
string
identifier:
string
}
pointInTime:
string (date-time)
expiryDate:
string (date-time)
actionType:
string
statusType:
string
isAppAware:
boolean
sizeInKB:
integer (int64)
aggregatedSizeInKB:
integer (int64)
numberOfIncrementals:
integer (int32)
isVpgExists:
boolean
retentionSetImmutability:
{
immutabilityState:
string
immutabilityExpiryTime:
string (date-time)
}
retentionSetActionsInformation:
{
deleteAction:
{
isEnabled:
boolean
disableReasonText:
string
}
}
}
]
}

getLtrCatalogVmAll

Get a list of available VMs in a Retention set (Auth)


/v1/ltr/catalog/vms

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/ltr/catalog/vms"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LongTermRetentionApi;

import java.io.File;
import java.util.*;

public class LongTermRetentionApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        LongTermRetentionApi apiInstance = new LongTermRetentionApi();
        try {
            RecoverableVmsApi result = apiInstance.getLtrCatalogVmAll();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LongTermRetentionApi#getLtrCatalogVmAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LongTermRetentionApi;

public class LongTermRetentionApiExample {

    public static void main(String[] args) {
        LongTermRetentionApi apiInstance = new LongTermRetentionApi();
        try {
            RecoverableVmsApi result = apiInstance.getLtrCatalogVmAll();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LongTermRetentionApi#getLtrCatalogVmAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];

LongTermRetentionApi *apiInstance = [[LongTermRetentionApi alloc] init];

// Get a list of available VMs in a Retention set (Auth)
[apiInstance getLtrCatalogVmAllWithCompletionHandler: 
              ^(RecoverableVmsApi output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.LongTermRetentionApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getLtrCatalogVmAll(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getLtrCatalogVmAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new LongTermRetentionApi();

            try
            {
                // Get a list of available VMs in a Retention set (Auth)
                RecoverableVmsApi result = apiInstance.getLtrCatalogVmAll();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LongTermRetentionApi.getLtrCatalogVmAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiLongTermRetentionApi();

try {
    $result = $api_instance->getLtrCatalogVmAll();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LongTermRetentionApi->getLtrCatalogVmAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LongTermRetentionApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::LongTermRetentionApi->new();

eval { 
    my $result = $api_instance->getLtrCatalogVmAll();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LongTermRetentionApi->getLtrCatalogVmAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.LongTermRetentionApi()

try: 
    # Get a list of available VMs in a Retention set (Auth)
    api_response = api_instance.get_ltr_catalog_vm_all()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LongTermRetentionApi->getLtrCatalogVmAll: %s\n" % e)

Parameters

Responses

Status: 200 - Success

{
vms:
[
{
vm:
{
name:
string
identifier:
string
}
vpg:
{
name:
string
identifier:
string
}
isSearchable:
boolean
isVmExist:
boolean
}
]
}

getLtrCatalogVmOriginalSettingsForRetentionSet

Get the original settings for a VM in a Retention set (Auth)


/v1/ltr/catalog/vms/{vmIdentifier}/retentionsets/{retentionSetIdentifier}/settings

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/ltr/catalog/vms/{vmIdentifier}/retentionsets/{retentionSetIdentifier}/settings"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LongTermRetentionApi;

import java.io.File;
import java.util.*;

public class LongTermRetentionApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        LongTermRetentionApi apiInstance = new LongTermRetentionApi();
        String vmIdentifier = vmIdentifier_example; // String | The idenfier of the VM. Related endpoint: `v1/vms`
        String retentionSetIdentifier = retentionSetIdentifier_example; // String | The unique identifier of the Retention Set. Related endpoint: `v1/ltr/catalog/fullretentionsets`
        try {
            RetentionSetVmSettingsApi result = apiInstance.getLtrCatalogVmOriginalSettingsForRetentionSet(vmIdentifier, retentionSetIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LongTermRetentionApi#getLtrCatalogVmOriginalSettingsForRetentionSet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LongTermRetentionApi;

public class LongTermRetentionApiExample {

    public static void main(String[] args) {
        LongTermRetentionApi apiInstance = new LongTermRetentionApi();
        String vmIdentifier = vmIdentifier_example; // String | The idenfier of the VM. Related endpoint: `v1/vms`
        String retentionSetIdentifier = retentionSetIdentifier_example; // String | The unique identifier of the Retention Set. Related endpoint: `v1/ltr/catalog/fullretentionsets`
        try {
            RetentionSetVmSettingsApi result = apiInstance.getLtrCatalogVmOriginalSettingsForRetentionSet(vmIdentifier, retentionSetIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LongTermRetentionApi#getLtrCatalogVmOriginalSettingsForRetentionSet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vmIdentifier = vmIdentifier_example; // The idenfier of the VM. Related endpoint: `v1/vms`
String *retentionSetIdentifier = retentionSetIdentifier_example; // The unique identifier of the Retention Set. Related endpoint: `v1/ltr/catalog/fullretentionsets`

LongTermRetentionApi *apiInstance = [[LongTermRetentionApi alloc] init];

// Get the original settings for a VM in a Retention set (Auth)
[apiInstance getLtrCatalogVmOriginalSettingsForRetentionSetWith:vmIdentifier
    retentionSetIdentifier:retentionSetIdentifier
              completionHandler: ^(RetentionSetVmSettingsApi output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.LongTermRetentionApi()
var vmIdentifier = vmIdentifier_example; // {{String}} The idenfier of the VM. Related endpoint: `v1/vms`
var retentionSetIdentifier = retentionSetIdentifier_example; // {{String}} The unique identifier of the Retention Set. Related endpoint: `v1/ltr/catalog/fullretentionsets`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getLtrCatalogVmOriginalSettingsForRetentionSet(vmIdentifier, retentionSetIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getLtrCatalogVmOriginalSettingsForRetentionSetExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new LongTermRetentionApi();
            var vmIdentifier = vmIdentifier_example;  // String | The idenfier of the VM. Related endpoint: `v1/vms`
            var retentionSetIdentifier = retentionSetIdentifier_example;  // String | The unique identifier of the Retention Set. Related endpoint: `v1/ltr/catalog/fullretentionsets`

            try
            {
                // Get the original settings for a VM in a Retention set (Auth)
                RetentionSetVmSettingsApi result = apiInstance.getLtrCatalogVmOriginalSettingsForRetentionSet(vmIdentifier, retentionSetIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LongTermRetentionApi.getLtrCatalogVmOriginalSettingsForRetentionSet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiLongTermRetentionApi();
$vmIdentifier = vmIdentifier_example; // String | The idenfier of the VM. Related endpoint: `v1/vms`
$retentionSetIdentifier = retentionSetIdentifier_example; // String | The unique identifier of the Retention Set. Related endpoint: `v1/ltr/catalog/fullretentionsets`

try {
    $result = $api_instance->getLtrCatalogVmOriginalSettingsForRetentionSet($vmIdentifier, $retentionSetIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LongTermRetentionApi->getLtrCatalogVmOriginalSettingsForRetentionSet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LongTermRetentionApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::LongTermRetentionApi->new();
my $vmIdentifier = vmIdentifier_example; # String | The idenfier of the VM. Related endpoint: `v1/vms`
my $retentionSetIdentifier = retentionSetIdentifier_example; # String | The unique identifier of the Retention Set. Related endpoint: `v1/ltr/catalog/fullretentionsets`

eval { 
    my $result = $api_instance->getLtrCatalogVmOriginalSettingsForRetentionSet(vmIdentifier => $vmIdentifier, retentionSetIdentifier => $retentionSetIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LongTermRetentionApi->getLtrCatalogVmOriginalSettingsForRetentionSet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.LongTermRetentionApi()
vmIdentifier = vmIdentifier_example # String | The idenfier of the VM. Related endpoint: `v1/vms`
retentionSetIdentifier = retentionSetIdentifier_example # String | The unique identifier of the Retention Set. Related endpoint: `v1/ltr/catalog/fullretentionsets`

try: 
    # Get the original settings for a VM in a Retention set (Auth)
    api_response = api_instance.get_ltr_catalog_vm_original_settings_for_retention_set(vmIdentifier, retentionSetIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LongTermRetentionApi->getLtrCatalogVmOriginalSettingsForRetentionSet: %s\n" % e)

Parameters

Path parameters
Name Description
vmIdentifier*
String
The idenfier of the VM. Related endpoint: `v1/vms`
Required
retentionSetIdentifier*
String
The unique identifier of the Retention Set. Related endpoint: `v1/ltr/catalog/fullretentionsets`
Required

Responses

Status: 200 - Success

{
ltrVmIdentifier:
string
repositoryIdentifier:
string
retentionSetIdentifier:
string
hostIdentifier:
string
volumes:
[
{
datastoreIdentifier:
string
isThin:
boolean
volumeIdentifier:
string
}
]
nics:
[
{
networkIdentifier:
string
dnsSuffix:
string
gateway:
string
isDhcp:
boolean
primaryDns:
string
secondaryDns:
string
staticIp:
string
subnetMask:
string
shouldReplaceMacAddress:
boolean
}
]
}

getLtrCatalogVmRetentionSets

Get a list of the available Retention sets for a VM in all Repositories in the site (Auth)


/v1/ltr/catalog/vms/{vmIdentifier}/retentionsets

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/ltr/catalog/vms/{vmIdentifier}/retentionsets"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LongTermRetentionApi;

import java.io.File;
import java.util.*;

public class LongTermRetentionApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        LongTermRetentionApi apiInstance = new LongTermRetentionApi();
        String vmIdentifier = vmIdentifier_example; // String | The idenfier of the VM. Related endpoint: `v1/vms`
        try {
            RetentionSetsApi result = apiInstance.getLtrCatalogVmRetentionSets(vmIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LongTermRetentionApi#getLtrCatalogVmRetentionSets");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LongTermRetentionApi;

public class LongTermRetentionApiExample {

    public static void main(String[] args) {
        LongTermRetentionApi apiInstance = new LongTermRetentionApi();
        String vmIdentifier = vmIdentifier_example; // String | The idenfier of the VM. Related endpoint: `v1/vms`
        try {
            RetentionSetsApi result = apiInstance.getLtrCatalogVmRetentionSets(vmIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LongTermRetentionApi#getLtrCatalogVmRetentionSets");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vmIdentifier = vmIdentifier_example; // The idenfier of the VM. Related endpoint: `v1/vms`

LongTermRetentionApi *apiInstance = [[LongTermRetentionApi alloc] init];

// Get a list of the available Retention sets for a VM in all Repositories in the site (Auth)
[apiInstance getLtrCatalogVmRetentionSetsWith:vmIdentifier
              completionHandler: ^(RetentionSetsApi output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.LongTermRetentionApi()
var vmIdentifier = vmIdentifier_example; // {{String}} The idenfier of the VM. Related endpoint: `v1/vms`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getLtrCatalogVmRetentionSets(vmIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getLtrCatalogVmRetentionSetsExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new LongTermRetentionApi();
            var vmIdentifier = vmIdentifier_example;  // String | The idenfier of the VM. Related endpoint: `v1/vms`

            try
            {
                // Get a list of the available Retention sets for a VM in all Repositories in the site (Auth)
                RetentionSetsApi result = apiInstance.getLtrCatalogVmRetentionSets(vmIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LongTermRetentionApi.getLtrCatalogVmRetentionSets: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiLongTermRetentionApi();
$vmIdentifier = vmIdentifier_example; // String | The idenfier of the VM. Related endpoint: `v1/vms`

try {
    $result = $api_instance->getLtrCatalogVmRetentionSets($vmIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LongTermRetentionApi->getLtrCatalogVmRetentionSets: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LongTermRetentionApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::LongTermRetentionApi->new();
my $vmIdentifier = vmIdentifier_example; # String | The idenfier of the VM. Related endpoint: `v1/vms`

eval { 
    my $result = $api_instance->getLtrCatalogVmRetentionSets(vmIdentifier => $vmIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LongTermRetentionApi->getLtrCatalogVmRetentionSets: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.LongTermRetentionApi()
vmIdentifier = vmIdentifier_example # String | The idenfier of the VM. Related endpoint: `v1/vms`

try: 
    # Get a list of the available Retention sets for a VM in all Repositories in the site (Auth)
    api_response = api_instance.get_ltr_catalog_vm_retention_sets(vmIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LongTermRetentionApi->getLtrCatalogVmRetentionSets: %s\n" % e)

Parameters

Path parameters
Name Description
vmIdentifier*
String
The idenfier of the VM. Related endpoint: `v1/vms`
Required

Responses

Status: 200 - Success

{
retentionSets:
[
{
repositoryIdentifier:
string
retentionSetIdentifier:
string
timeStamp:
string
isApplicationAware:
boolean
zorgIdentifier:
string
numberOfVolumes:
integer (int32)
repositorySiteIdentifier:
string
tier:
integer (int32)
Enum: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10
}
]
ltrVmIdentifier:
string
}

retentionAbort

End the Manual Retention process (Auth)


/v1/ltr/vpgs/{vpgIdentifier}/retentionabort

Usage and SDK Samples

curl -X POST\
-H "x-zerto-session: [[apiKey]]"\
"https://localhost:9669//v1/ltr/vpgs/{vpgIdentifier}/retentionabort"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LongTermRetentionApi;

import java.io.File;
import java.util.*;

public class LongTermRetentionApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        LongTermRetentionApi apiInstance = new LongTermRetentionApi();
        String vpgIdentifier = vpgIdentifier_example; // String | The identifier of the VPG. Related endpoint: `v1/vpgs`
        try {
            apiInstance.retentionAbort(vpgIdentifier);
        } catch (ApiException e) {
            System.err.println("Exception when calling LongTermRetentionApi#retentionAbort");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LongTermRetentionApi;

public class LongTermRetentionApiExample {

    public static void main(String[] args) {
        LongTermRetentionApi apiInstance = new LongTermRetentionApi();
        String vpgIdentifier = vpgIdentifier_example; // String | The identifier of the VPG. Related endpoint: `v1/vpgs`
        try {
            apiInstance.retentionAbort(vpgIdentifier);
        } catch (ApiException e) {
            System.err.println("Exception when calling LongTermRetentionApi#retentionAbort");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgIdentifier = vpgIdentifier_example; // The identifier of the VPG. Related endpoint: `v1/vpgs`

LongTermRetentionApi *apiInstance = [[LongTermRetentionApi alloc] init];

// End the Manual Retention process (Auth)
[apiInstance retentionAbortWith:vpgIdentifier
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.LongTermRetentionApi()
var vpgIdentifier = vpgIdentifier_example; // {{String}} The identifier of the VPG. Related endpoint: `v1/vpgs`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.retentionAbort(vpgIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class retentionAbortExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new LongTermRetentionApi();
            var vpgIdentifier = vpgIdentifier_example;  // String | The identifier of the VPG. Related endpoint: `v1/vpgs`

            try
            {
                // End the Manual Retention process (Auth)
                apiInstance.retentionAbort(vpgIdentifier);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LongTermRetentionApi.retentionAbort: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiLongTermRetentionApi();
$vpgIdentifier = vpgIdentifier_example; // String | The identifier of the VPG. Related endpoint: `v1/vpgs`

try {
    $api_instance->retentionAbort($vpgIdentifier);
} catch (Exception $e) {
    echo 'Exception when calling LongTermRetentionApi->retentionAbort: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LongTermRetentionApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::LongTermRetentionApi->new();
my $vpgIdentifier = vpgIdentifier_example; # String | The identifier of the VPG. Related endpoint: `v1/vpgs`

eval { 
    $api_instance->retentionAbort(vpgIdentifier => $vpgIdentifier);
};
if ($@) {
    warn "Exception when calling LongTermRetentionApi->retentionAbort: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.LongTermRetentionApi()
vpgIdentifier = vpgIdentifier_example # String | The identifier of the VPG. Related endpoint: `v1/vpgs`

try: 
    # End the Manual Retention process (Auth)
    api_instance.retention_abort(vpgIdentifier)
except ApiException as e:
    print("Exception when calling LongTermRetentionApi->retentionAbort: %s\n" % e)

Parameters

Path parameters
Name Description
vpgIdentifier*
String
The identifier of the VPG. Related endpoint: `v1/vpgs`
Required

Responses

Status: 200 - Success


retentionStart

Start the Manual Retention process (Auth)


/v1/ltr/vpgs/{vpgIdentifier}/retentionstart

Usage and SDK Samples

curl -X POST\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
-H "Content-Type: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/ltr/vpgs/{vpgIdentifier}/retentionstart"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LongTermRetentionApi;

import java.io.File;
import java.util.*;

public class LongTermRetentionApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        LongTermRetentionApi apiInstance = new LongTermRetentionApi();
        String vpgIdentifier = vpgIdentifier_example; // String | The identifier of the VPG. Related endpoint: `v1/vpgs`
        RetentionStartInfoApi body = ; // RetentionStartInfoApi | 
        try {
            'String' result = apiInstance.retentionStart(vpgIdentifier, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LongTermRetentionApi#retentionStart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LongTermRetentionApi;

public class LongTermRetentionApiExample {

    public static void main(String[] args) {
        LongTermRetentionApi apiInstance = new LongTermRetentionApi();
        String vpgIdentifier = vpgIdentifier_example; // String | The identifier of the VPG. Related endpoint: `v1/vpgs`
        RetentionStartInfoApi body = ; // RetentionStartInfoApi | 
        try {
            'String' result = apiInstance.retentionStart(vpgIdentifier, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LongTermRetentionApi#retentionStart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgIdentifier = vpgIdentifier_example; // The identifier of the VPG. Related endpoint: `v1/vpgs`
RetentionStartInfoApi *body = ; //  (optional)

LongTermRetentionApi *apiInstance = [[LongTermRetentionApi alloc] init];

// Start the Manual Retention process (Auth)
[apiInstance retentionStartWith:vpgIdentifier
    body:body
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.LongTermRetentionApi()
var vpgIdentifier = vpgIdentifier_example; // {{String}} The identifier of the VPG. Related endpoint: `v1/vpgs`
var opts = { 
  'body':  // {{RetentionStartInfoApi}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.retentionStart(vpgIdentifier, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class retentionStartExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new LongTermRetentionApi();
            var vpgIdentifier = vpgIdentifier_example;  // String | The identifier of the VPG. Related endpoint: `v1/vpgs`
            var body = new RetentionStartInfoApi(); // RetentionStartInfoApi |  (optional) 

            try
            {
                // Start the Manual Retention process (Auth)
                'String' result = apiInstance.retentionStart(vpgIdentifier, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LongTermRetentionApi.retentionStart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiLongTermRetentionApi();
$vpgIdentifier = vpgIdentifier_example; // String | The identifier of the VPG. Related endpoint: `v1/vpgs`
$body = ; // RetentionStartInfoApi | 

try {
    $result = $api_instance->retentionStart($vpgIdentifier, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LongTermRetentionApi->retentionStart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LongTermRetentionApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::LongTermRetentionApi->new();
my $vpgIdentifier = vpgIdentifier_example; # String | The identifier of the VPG. Related endpoint: `v1/vpgs`
my $body = WWW::SwaggerClient::Object::RetentionStartInfoApi->new(); # RetentionStartInfoApi | 

eval { 
    my $result = $api_instance->retentionStart(vpgIdentifier => $vpgIdentifier, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LongTermRetentionApi->retentionStart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.LongTermRetentionApi()
vpgIdentifier = vpgIdentifier_example # String | The identifier of the VPG. Related endpoint: `v1/vpgs`
body =  # RetentionStartInfoApi |  (optional)

try: 
    # Start the Manual Retention process (Auth)
    api_response = api_instance.retention_start(vpgIdentifier, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LongTermRetentionApi->retentionStart: %s\n" % e)

Parameters

Path parameters
Name Description
vpgIdentifier*
String
The identifier of the VPG. Related endpoint: `v1/vpgs`
Required
Body parameters
Name Description
body
{
checkpointId:
string
}

Responses

Status: 200 - Success

string

startLtrRestoreVm

Restore the VM from the Repository at the recovery site. Returns a token. (Auth)


/v1/ltr/restore/vm

Usage and SDK Samples

curl -X POST\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
-H "Content-Type: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/ltr/restore/vm"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LongTermRetentionApi;

import java.io.File;
import java.util.*;

public class LongTermRetentionApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        LongTermRetentionApi apiInstance = new LongTermRetentionApi();
        RestoreVmApi body = ; // RestoreVmApi | 
        try {
            'String' result = apiInstance.startLtrRestoreVm(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LongTermRetentionApi#startLtrRestoreVm");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LongTermRetentionApi;

public class LongTermRetentionApiExample {

    public static void main(String[] args) {
        LongTermRetentionApi apiInstance = new LongTermRetentionApi();
        RestoreVmApi body = ; // RestoreVmApi | 
        try {
            'String' result = apiInstance.startLtrRestoreVm(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LongTermRetentionApi#startLtrRestoreVm");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
RestoreVmApi *body = ; //  (optional)

LongTermRetentionApi *apiInstance = [[LongTermRetentionApi alloc] init];

// Restore the VM from the Repository at the recovery site. Returns a token. (Auth)
[apiInstance startLtrRestoreVmWith:body
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.LongTermRetentionApi()
var opts = { 
  'body':  // {{RestoreVmApi}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.startLtrRestoreVm(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class startLtrRestoreVmExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new LongTermRetentionApi();
            var body = new RestoreVmApi(); // RestoreVmApi |  (optional) 

            try
            {
                // Restore the VM from the Repository at the recovery site. Returns a token. (Auth)
                'String' result = apiInstance.startLtrRestoreVm(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LongTermRetentionApi.startLtrRestoreVm: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiLongTermRetentionApi();
$body = ; // RestoreVmApi | 

try {
    $result = $api_instance->startLtrRestoreVm($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LongTermRetentionApi->startLtrRestoreVm: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LongTermRetentionApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::LongTermRetentionApi->new();
my $body = WWW::SwaggerClient::Object::RestoreVmApi->new(); # RestoreVmApi | 

eval { 
    my $result = $api_instance->startLtrRestoreVm(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LongTermRetentionApi->startLtrRestoreVm: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.LongTermRetentionApi()
body =  # RestoreVmApi |  (optional)

try: 
    # Restore the VM from the Repository at the recovery site. Returns a token. (Auth)
    api_response = api_instance.start_ltr_restore_vm(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LongTermRetentionApi->startLtrRestoreVm: %s\n" % e)

Parameters

Body parameters
Name Description
body
{
ltrVmIdentifier:
string
retentionSetIdentifier:
string
hostIdentifier:
string
datastoreIdentifier:
string
}

Responses

Status: 200 - Success

string

PeerSites

getPairingToken

Generate a token for pairing (Auth)


/v1/peersites/generatetoken

Usage and SDK Samples

curl -X POST\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/peersites/generatetoken"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PeerSitesApi;

import java.io.File;
import java.util.*;

public class PeerSitesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        PeerSitesApi apiInstance = new PeerSitesApi();
        try {
            PairingTokenResult result = apiInstance.getPairingToken();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PeerSitesApi#getPairingToken");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PeerSitesApi;

public class PeerSitesApiExample {

    public static void main(String[] args) {
        PeerSitesApi apiInstance = new PeerSitesApi();
        try {
            PairingTokenResult result = apiInstance.getPairingToken();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PeerSitesApi#getPairingToken");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];

PeerSitesApi *apiInstance = [[PeerSitesApi alloc] init];

// Generate a token for pairing (Auth)
[apiInstance getPairingTokenWithCompletionHandler: 
              ^(PairingTokenResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.PeerSitesApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPairingToken(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPairingTokenExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new PeerSitesApi();

            try
            {
                // Generate a token for pairing (Auth)
                PairingTokenResult result = apiInstance.getPairingToken();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PeerSitesApi.getPairingToken: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiPeerSitesApi();

try {
    $result = $api_instance->getPairingToken();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PeerSitesApi->getPairingToken: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PeerSitesApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::PeerSitesApi->new();

eval { 
    my $result = $api_instance->getPairingToken();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PeerSitesApi->getPairingToken: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.PeerSitesApi()

try: 
    # Generate a token for pairing (Auth)
    api_response = api_instance.get_pairing_token()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PeerSitesApi->getPairingToken: %s\n" % e)

Parameters

Responses

Status: 200 - Success

{
token:
string
utcExpirationDate:
string
}

getPeer

Get information about the specified peer site (Auth)


/v1/peersites/{siteIdentifier}

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/peersites/{siteIdentifier}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PeerSitesApi;

import java.io.File;
import java.util.*;

public class PeerSitesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        PeerSitesApi apiInstance = new PeerSitesApi();
        String siteIdentifier = siteIdentifier_example; // String | The identifier of the peer site. Related endpoints: `v1/peersites`
        try {
            PeerSiteApi result = apiInstance.getPeer(siteIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PeerSitesApi#getPeer");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PeerSitesApi;

public class PeerSitesApiExample {

    public static void main(String[] args) {
        PeerSitesApi apiInstance = new PeerSitesApi();
        String siteIdentifier = siteIdentifier_example; // String | The identifier of the peer site. Related endpoints: `v1/peersites`
        try {
            PeerSiteApi result = apiInstance.getPeer(siteIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PeerSitesApi#getPeer");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *siteIdentifier = siteIdentifier_example; // The identifier of the peer site. Related endpoints: `v1/peersites`

PeerSitesApi *apiInstance = [[PeerSitesApi alloc] init];

// Get information about the specified peer site (Auth)
[apiInstance getPeerWith:siteIdentifier
              completionHandler: ^(PeerSiteApi output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.PeerSitesApi()
var siteIdentifier = siteIdentifier_example; // {{String}} The identifier of the peer site. Related endpoints: `v1/peersites`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPeer(siteIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPeerExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new PeerSitesApi();
            var siteIdentifier = siteIdentifier_example;  // String | The identifier of the peer site. Related endpoints: `v1/peersites`

            try
            {
                // Get information about the specified peer site (Auth)
                PeerSiteApi result = apiInstance.getPeer(siteIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PeerSitesApi.getPeer: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiPeerSitesApi();
$siteIdentifier = siteIdentifier_example; // String | The identifier of the peer site. Related endpoints: `v1/peersites`

try {
    $result = $api_instance->getPeer($siteIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PeerSitesApi->getPeer: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PeerSitesApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::PeerSitesApi->new();
my $siteIdentifier = siteIdentifier_example; # String | The identifier of the peer site. Related endpoints: `v1/peersites`

eval { 
    my $result = $api_instance->getPeer(siteIdentifier => $siteIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PeerSitesApi->getPeer: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.PeerSitesApi()
siteIdentifier = siteIdentifier_example # String | The identifier of the peer site. Related endpoints: `v1/peersites`

try: 
    # Get information about the specified peer site (Auth)
    api_response = api_instance.get_peer(siteIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PeerSitesApi->getPeer: %s\n" % e)

Parameters

Path parameters
Name Description
siteIdentifier*
String
The identifier of the peer site. Related endpoints: `v1/peersites`
Required

Responses

Status: 200 - Success

{
link:
{
rel:
string
href:
string
type:
string
identifier:
string
}
siteIdentifier:
string
peerSiteName:
string
pairingStatus:
integer (int32)
Enum: 0, 1, 2
location:
string
hostName:
string
port:
integer (int32)
provisionedStorage:
integer (int64)
usedStorage:
integer (int64)
incomingThroughputInMb:
number (double)
outgoingBandWidth:
number (double)
Link_{0}:
{
rel:
string
href:
string
type:
string
}
version:
string
siteType:
string
}

getPeerAll

Get a list of all peer sites (Auth)


/v1/peersites

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/peersites?peerName=&pairingStatus=&location=&hostName=&port="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PeerSitesApi;

import java.io.File;
import java.util.*;

public class PeerSitesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        PeerSitesApi apiInstance = new PeerSitesApi();
        String peerName = peerName_example; // String | The name of a peer site. The name is case-sensitive
        String pairingStatus = pairingStatus_example; // String | The pairing status. Related endpoint: `/v1/peersites/pairingstatuses`
        String location = location_example; // String | The site location, as specified in the site information
        String hostName = hostName_example; // String | The IP address of a ZVM, paired with this site
        Integer port = 56; // Integer | The port used to access peer sites. The default port is 9081
        try {
            array[PeerSiteApi] result = apiInstance.getPeerAll(peerName, pairingStatus, location, hostName, port);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PeerSitesApi#getPeerAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PeerSitesApi;

public class PeerSitesApiExample {

    public static void main(String[] args) {
        PeerSitesApi apiInstance = new PeerSitesApi();
        String peerName = peerName_example; // String | The name of a peer site. The name is case-sensitive
        String pairingStatus = pairingStatus_example; // String | The pairing status. Related endpoint: `/v1/peersites/pairingstatuses`
        String location = location_example; // String | The site location, as specified in the site information
        String hostName = hostName_example; // String | The IP address of a ZVM, paired with this site
        Integer port = 56; // Integer | The port used to access peer sites. The default port is 9081
        try {
            array[PeerSiteApi] result = apiInstance.getPeerAll(peerName, pairingStatus, location, hostName, port);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PeerSitesApi#getPeerAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *peerName = peerName_example; // The name of a peer site. The name is case-sensitive (optional)
String *pairingStatus = pairingStatus_example; // The pairing status. Related endpoint: `/v1/peersites/pairingstatuses` (optional)
String *location = location_example; // The site location, as specified in the site information (optional)
String *hostName = hostName_example; // The IP address of a ZVM, paired with this site (optional)
Integer *port = 56; // The port used to access peer sites. The default port is 9081 (optional)

PeerSitesApi *apiInstance = [[PeerSitesApi alloc] init];

// Get a list of all peer sites (Auth)
[apiInstance getPeerAllWith:peerName
    pairingStatus:pairingStatus
    location:location
    hostName:hostName
    port:port
              completionHandler: ^(array[PeerSiteApi] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.PeerSitesApi()
var opts = { 
  'peerName': peerName_example, // {{String}} The name of a peer site. The name is case-sensitive
  'pairingStatus': pairingStatus_example, // {{String}} The pairing status. Related endpoint: `/v1/peersites/pairingstatuses`
  'location': location_example, // {{String}} The site location, as specified in the site information
  'hostName': hostName_example, // {{String}} The IP address of a ZVM, paired with this site
  'port': 56 // {{Integer}} The port used to access peer sites. The default port is 9081
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPeerAll(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPeerAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new PeerSitesApi();
            var peerName = peerName_example;  // String | The name of a peer site. The name is case-sensitive (optional) 
            var pairingStatus = pairingStatus_example;  // String | The pairing status. Related endpoint: `/v1/peersites/pairingstatuses` (optional) 
            var location = location_example;  // String | The site location, as specified in the site information (optional) 
            var hostName = hostName_example;  // String | The IP address of a ZVM, paired with this site (optional) 
            var port = 56;  // Integer | The port used to access peer sites. The default port is 9081 (optional) 

            try
            {
                // Get a list of all peer sites (Auth)
                array[PeerSiteApi] result = apiInstance.getPeerAll(peerName, pairingStatus, location, hostName, port);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PeerSitesApi.getPeerAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiPeerSitesApi();
$peerName = peerName_example; // String | The name of a peer site. The name is case-sensitive
$pairingStatus = pairingStatus_example; // String | The pairing status. Related endpoint: `/v1/peersites/pairingstatuses`
$location = location_example; // String | The site location, as specified in the site information
$hostName = hostName_example; // String | The IP address of a ZVM, paired with this site
$port = 56; // Integer | The port used to access peer sites. The default port is 9081

try {
    $result = $api_instance->getPeerAll($peerName, $pairingStatus, $location, $hostName, $port);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PeerSitesApi->getPeerAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PeerSitesApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::PeerSitesApi->new();
my $peerName = peerName_example; # String | The name of a peer site. The name is case-sensitive
my $pairingStatus = pairingStatus_example; # String | The pairing status. Related endpoint: `/v1/peersites/pairingstatuses`
my $location = location_example; # String | The site location, as specified in the site information
my $hostName = hostName_example; # String | The IP address of a ZVM, paired with this site
my $port = 56; # Integer | The port used to access peer sites. The default port is 9081

eval { 
    my $result = $api_instance->getPeerAll(peerName => $peerName, pairingStatus => $pairingStatus, location => $location, hostName => $hostName, port => $port);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PeerSitesApi->getPeerAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.PeerSitesApi()
peerName = peerName_example # String | The name of a peer site. The name is case-sensitive (optional)
pairingStatus = pairingStatus_example # String | The pairing status. Related endpoint: `/v1/peersites/pairingstatuses` (optional)
location = location_example # String | The site location, as specified in the site information (optional)
hostName = hostName_example # String | The IP address of a ZVM, paired with this site (optional)
port = 56 # Integer | The port used to access peer sites. The default port is 9081 (optional)

try: 
    # Get a list of all peer sites (Auth)
    api_response = api_instance.get_peer_all(peerName=peerName, pairingStatus=pairingStatus, location=location, hostName=hostName, port=port)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PeerSitesApi->getPeerAll: %s\n" % e)

Parameters

Query parameters
Name Description
peerName
String
The name of a peer site. The name is case-sensitive
pairingStatus
String
The pairing status. Related endpoint: `/v1/peersites/pairingstatuses`
location
String
The site location, as specified in the site information
hostName
String
The IP address of a ZVM, paired with this site
port
Integer (int32)
The port used to access peer sites. The default port is 9081

Responses

Status: 200 - Success

[
{
link:
{
rel:
string
href:
string
type:
string
identifier:
string
}
siteIdentifier:
string
peerSiteName:
string
pairingStatus:
integer (int32)
Enum: 0, 1, 2
location:
string
hostName:
string
port:
integer (int32)
provisionedStorage:
integer (int64)
usedStorage:
integer (int64)
incomingThroughputInMb:
number (double)
outgoingBandWidth:
number (double)
Link_{0}:
{
rel:
string
href:
string
type:
string
}
version:
string
siteType:
string
}
]

getPeerStatusAll

Get the list of acceptable values for site pairing status (Auth)


/v1/peersites/pairingstatuses

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/peersites/pairingstatuses"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PeerSitesApi;

import java.io.File;
import java.util.*;

public class PeerSitesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        PeerSitesApi apiInstance = new PeerSitesApi();
        try {
            array['String'] result = apiInstance.getPeerStatusAll();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PeerSitesApi#getPeerStatusAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PeerSitesApi;

public class PeerSitesApiExample {

    public static void main(String[] args) {
        PeerSitesApi apiInstance = new PeerSitesApi();
        try {
            array['String'] result = apiInstance.getPeerStatusAll();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PeerSitesApi#getPeerStatusAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];

PeerSitesApi *apiInstance = [[PeerSitesApi alloc] init];

// Get the list of acceptable values for site pairing status (Auth)
[apiInstance getPeerStatusAllWithCompletionHandler: 
              ^(array['String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.PeerSitesApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPeerStatusAll(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPeerStatusAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new PeerSitesApi();

            try
            {
                // Get the list of acceptable values for site pairing status (Auth)
                array['String'] result = apiInstance.getPeerStatusAll();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PeerSitesApi.getPeerStatusAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiPeerSitesApi();

try {
    $result = $api_instance->getPeerStatusAll();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PeerSitesApi->getPeerStatusAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PeerSitesApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::PeerSitesApi->new();

eval { 
    my $result = $api_instance->getPeerStatusAll();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PeerSitesApi->getPeerStatusAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.PeerSitesApi()

try: 
    # Get the list of acceptable values for site pairing status (Auth)
    api_response = api_instance.get_peer_status_all()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PeerSitesApi->getPeerStatusAll: %s\n" % e)

Parameters

Responses

Status: 200 - Success

[
string
]

startPair

Add a peer site (start pairing). (Auth)


/v1/peersites

Usage and SDK Samples

curl -X POST\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
-H "Content-Type: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/peersites"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PeerSitesApi;

import java.io.File;
import java.util.*;

public class PeerSitesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        PeerSitesApi apiInstance = new PeerSitesApi();
        PairDataApi body = ; // PairDataApi | 
        try {
            'String' result = apiInstance.startPair(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PeerSitesApi#startPair");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PeerSitesApi;

public class PeerSitesApiExample {

    public static void main(String[] args) {
        PeerSitesApi apiInstance = new PeerSitesApi();
        PairDataApi body = ; // PairDataApi | 
        try {
            'String' result = apiInstance.startPair(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PeerSitesApi#startPair");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
PairDataApi *body = ; //  (optional)

PeerSitesApi *apiInstance = [[PeerSitesApi alloc] init];

// Add a peer site (start pairing). (Auth)
[apiInstance startPairWith:body
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.PeerSitesApi()
var opts = { 
  'body':  // {{PairDataApi}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.startPair(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class startPairExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new PeerSitesApi();
            var body = new PairDataApi(); // PairDataApi |  (optional) 

            try
            {
                // Add a peer site (start pairing). (Auth)
                'String' result = apiInstance.startPair(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PeerSitesApi.startPair: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiPeerSitesApi();
$body = ; // PairDataApi | 

try {
    $result = $api_instance->startPair($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PeerSitesApi->startPair: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PeerSitesApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::PeerSitesApi->new();
my $body = WWW::SwaggerClient::Object::PairDataApi->new(); # PairDataApi | 

eval { 
    my $result = $api_instance->startPair(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PeerSitesApi->startPair: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.PeerSitesApi()
body =  # PairDataApi |  (optional)

try: 
    # Add a peer site (start pairing). (Auth)
    api_response = api_instance.start_pair(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PeerSitesApi->startPair: %s\n" % e)

Parameters

Body parameters
Name Description
body
{
hostName:
string
port:
integer (int32)
token:
string
}

Responses

Status: 200 - Success

string

startUnpair

Unpair a peer site (Auth)


/v1/peersites/{siteIdentifier}

Usage and SDK Samples

curl -X DELETE\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
-H "Content-Type: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/peersites/{siteIdentifier}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PeerSitesApi;

import java.io.File;
import java.util.*;

public class PeerSitesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        PeerSitesApi apiInstance = new PeerSitesApi();
        String siteIdentifier = siteIdentifier_example; // String | The identifier of the peer site. Related endpoints: `v1/peersites`
        UnPairDataApi body = ; // UnPairDataApi | 
        try {
            'String' result = apiInstance.startUnpair(siteIdentifier, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PeerSitesApi#startUnpair");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PeerSitesApi;

public class PeerSitesApiExample {

    public static void main(String[] args) {
        PeerSitesApi apiInstance = new PeerSitesApi();
        String siteIdentifier = siteIdentifier_example; // String | The identifier of the peer site. Related endpoints: `v1/peersites`
        UnPairDataApi body = ; // UnPairDataApi | 
        try {
            'String' result = apiInstance.startUnpair(siteIdentifier, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PeerSitesApi#startUnpair");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *siteIdentifier = siteIdentifier_example; // The identifier of the peer site. Related endpoints: `v1/peersites`
UnPairDataApi *body = ; //  (optional)

PeerSitesApi *apiInstance = [[PeerSitesApi alloc] init];

// Unpair a peer site (Auth)
[apiInstance startUnpairWith:siteIdentifier
    body:body
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.PeerSitesApi()
var siteIdentifier = siteIdentifier_example; // {{String}} The identifier of the peer site. Related endpoints: `v1/peersites`
var opts = { 
  'body':  // {{UnPairDataApi}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.startUnpair(siteIdentifier, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class startUnpairExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new PeerSitesApi();
            var siteIdentifier = siteIdentifier_example;  // String | The identifier of the peer site. Related endpoints: `v1/peersites`
            var body = new UnPairDataApi(); // UnPairDataApi |  (optional) 

            try
            {
                // Unpair a peer site (Auth)
                'String' result = apiInstance.startUnpair(siteIdentifier, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PeerSitesApi.startUnpair: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiPeerSitesApi();
$siteIdentifier = siteIdentifier_example; // String | The identifier of the peer site. Related endpoints: `v1/peersites`
$body = ; // UnPairDataApi | 

try {
    $result = $api_instance->startUnpair($siteIdentifier, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PeerSitesApi->startUnpair: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PeerSitesApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::PeerSitesApi->new();
my $siteIdentifier = siteIdentifier_example; # String | The identifier of the peer site. Related endpoints: `v1/peersites`
my $body = WWW::SwaggerClient::Object::UnPairDataApi->new(); # UnPairDataApi | 

eval { 
    my $result = $api_instance->startUnpair(siteIdentifier => $siteIdentifier, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PeerSitesApi->startUnpair: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.PeerSitesApi()
siteIdentifier = siteIdentifier_example # String | The identifier of the peer site. Related endpoints: `v1/peersites`
body =  # UnPairDataApi |  (optional)

try: 
    # Unpair a peer site (Auth)
    api_response = api_instance.start_unpair(siteIdentifier, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PeerSitesApi->startUnpair: %s\n" % e)

Parameters

Path parameters
Name Description
siteIdentifier*
String
The identifier of the peer site. Related endpoints: `v1/peersites`
Required
Body parameters
Name Description
body
{
isKeepTargetDisks:
boolean
}

Responses

Status: 200 - Success

string

RecoveryResourcesReports

getRecoveryReport

Get a specific recovery report. (Auth)


/v1/reports/recovery/{recoveryOperationIdentifier}

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/reports/recovery/{recoveryOperationIdentifier}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RecoveryResourcesReportsApi;

import java.io.File;
import java.util.*;

public class RecoveryResourcesReportsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        RecoveryResourcesReportsApi apiInstance = new RecoveryResourcesReportsApi();
        String recoveryOperationIdentifier = recoveryOperationIdentifier_example; // String | Recovery report identifier. Related endpoint: `v1/reports/recovery`
        try {
            RecoveryReportApi result = apiInstance.getRecoveryReport(recoveryOperationIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecoveryResourcesReportsApi#getRecoveryReport");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.RecoveryResourcesReportsApi;

public class RecoveryResourcesReportsApiExample {

    public static void main(String[] args) {
        RecoveryResourcesReportsApi apiInstance = new RecoveryResourcesReportsApi();
        String recoveryOperationIdentifier = recoveryOperationIdentifier_example; // String | Recovery report identifier. Related endpoint: `v1/reports/recovery`
        try {
            RecoveryReportApi result = apiInstance.getRecoveryReport(recoveryOperationIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecoveryResourcesReportsApi#getRecoveryReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *recoveryOperationIdentifier = recoveryOperationIdentifier_example; // Recovery report identifier. Related endpoint: `v1/reports/recovery`

RecoveryResourcesReportsApi *apiInstance = [[RecoveryResourcesReportsApi alloc] init];

// Get a specific recovery report. (Auth)
[apiInstance getRecoveryReportWith:recoveryOperationIdentifier
              completionHandler: ^(RecoveryReportApi output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.RecoveryResourcesReportsApi()
var recoveryOperationIdentifier = recoveryOperationIdentifier_example; // {{String}} Recovery report identifier. Related endpoint: `v1/reports/recovery`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getRecoveryReport(recoveryOperationIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getRecoveryReportExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new RecoveryResourcesReportsApi();
            var recoveryOperationIdentifier = recoveryOperationIdentifier_example;  // String | Recovery report identifier. Related endpoint: `v1/reports/recovery`

            try
            {
                // Get a specific recovery report. (Auth)
                RecoveryReportApi result = apiInstance.getRecoveryReport(recoveryOperationIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RecoveryResourcesReportsApi.getRecoveryReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiRecoveryResourcesReportsApi();
$recoveryOperationIdentifier = recoveryOperationIdentifier_example; // String | Recovery report identifier. Related endpoint: `v1/reports/recovery`

try {
    $result = $api_instance->getRecoveryReport($recoveryOperationIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RecoveryResourcesReportsApi->getRecoveryReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::RecoveryResourcesReportsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::RecoveryResourcesReportsApi->new();
my $recoveryOperationIdentifier = recoveryOperationIdentifier_example; # String | Recovery report identifier. Related endpoint: `v1/reports/recovery`

eval { 
    my $result = $api_instance->getRecoveryReport(recoveryOperationIdentifier => $recoveryOperationIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RecoveryResourcesReportsApi->getRecoveryReport: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.RecoveryResourcesReportsApi()
recoveryOperationIdentifier = recoveryOperationIdentifier_example # String | Recovery report identifier. Related endpoint: `v1/reports/recovery`

try: 
    # Get a specific recovery report. (Auth)
    api_response = api_instance.get_recovery_report(recoveryOperationIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RecoveryResourcesReportsApi->getRecoveryReport: %s\n" % e)

Parameters

Path parameters
Name Description
recoveryOperationIdentifier*
String
Recovery report identifier. Related endpoint: `v1/reports/recovery`
Required

Responses

Status: 200 - Success

{
recoveryOperationIdentifier:
string
general:
{
vpgIdentifier:
string
vpgName:
string
recoveryType:
string
protectedSiteName:
string
recoverySiteName:
string
startTime:
string
endTime:
string
pointInTime:
string
rtoInSeconds:
string
status:
string
initiatedBy:
string
notes:
string
}
recoverySettings:
{
vpg:
{
defaultHostName:
defaultDatastoreName:
defaultNetworkName:
}
vms:
[
{
vmName:
string
hostName:
string
datastoreName:
string
folderName:
string
networkNames:
[
string
]
volumes:
[
{
volumeName:
string
datastoreName:
string
}
]
}
]
steps:
[
{
description:
string
result:
string
startTime:
string
endTime:
string
executionTime:
string
}
]
}
}

getRecoveryReportAll

Generate a recovery report and view information about recovery operations (Auth)


/v1/reports/recovery

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/reports/recovery?startTime=&endTime=&pageNumber=&pageSize=&vpgName=&recoveryType=&state="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RecoveryResourcesReportsApi;

import java.io.File;
import java.util.*;

public class RecoveryResourcesReportsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        RecoveryResourcesReportsApi apiInstance = new RecoveryResourcesReportsApi();
        String startTime = startTime_example; // String | The filterining interval start date-time. Related endpoint: `v1/serverDateTime` for date time format details
        String endTime = endTime_example; // String | The filterining interval end date-time. Related endpoint: `v1/serverDateTime` for date time format details
        Integer pageNumber = 56; // Integer | The page number to retrieve
        Integer pageSize = 56; // Integer | The number of reports to display in a single page. The maximum number of reports per page is 1000
        String vpgName = vpgName_example; // String | The name of the VPG. You can specify more than one VPG, separated by commas. Related endpoint: `v1/vpgs`
        String recoveryType = recoveryType_example; // String | The type of recovery operation. Possible values are: `Failover`, `Failover Test`, `Move`
        String state = state_example; // String | Whether the recovery operation has completed
        try {
            array[RecoveryReportApi] result = apiInstance.getRecoveryReportAll(startTime, endTime, pageNumber, pageSize, vpgName, recoveryType, state);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecoveryResourcesReportsApi#getRecoveryReportAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.RecoveryResourcesReportsApi;

public class RecoveryResourcesReportsApiExample {

    public static void main(String[] args) {
        RecoveryResourcesReportsApi apiInstance = new RecoveryResourcesReportsApi();
        String startTime = startTime_example; // String | The filterining interval start date-time. Related endpoint: `v1/serverDateTime` for date time format details
        String endTime = endTime_example; // String | The filterining interval end date-time. Related endpoint: `v1/serverDateTime` for date time format details
        Integer pageNumber = 56; // Integer | The page number to retrieve
        Integer pageSize = 56; // Integer | The number of reports to display in a single page. The maximum number of reports per page is 1000
        String vpgName = vpgName_example; // String | The name of the VPG. You can specify more than one VPG, separated by commas. Related endpoint: `v1/vpgs`
        String recoveryType = recoveryType_example; // String | The type of recovery operation. Possible values are: `Failover`, `Failover Test`, `Move`
        String state = state_example; // String | Whether the recovery operation has completed
        try {
            array[RecoveryReportApi] result = apiInstance.getRecoveryReportAll(startTime, endTime, pageNumber, pageSize, vpgName, recoveryType, state);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecoveryResourcesReportsApi#getRecoveryReportAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *startTime = startTime_example; // The filterining interval start date-time. Related endpoint: `v1/serverDateTime` for date time format details (optional)
String *endTime = endTime_example; // The filterining interval end date-time. Related endpoint: `v1/serverDateTime` for date time format details (optional)
Integer *pageNumber = 56; // The page number to retrieve (optional)
Integer *pageSize = 56; // The number of reports to display in a single page. The maximum number of reports per page is 1000 (optional)
String *vpgName = vpgName_example; // The name of the VPG. You can specify more than one VPG, separated by commas. Related endpoint: `v1/vpgs` (optional)
String *recoveryType = recoveryType_example; // The type of recovery operation. Possible values are: `Failover`, `Failover Test`, `Move` (optional)
String *state = state_example; // Whether the recovery operation has completed (optional)

RecoveryResourcesReportsApi *apiInstance = [[RecoveryResourcesReportsApi alloc] init];

// Generate a recovery report and view information about recovery operations (Auth)
[apiInstance getRecoveryReportAllWith:startTime
    endTime:endTime
    pageNumber:pageNumber
    pageSize:pageSize
    vpgName:vpgName
    recoveryType:recoveryType
    state:state
              completionHandler: ^(array[RecoveryReportApi] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.RecoveryResourcesReportsApi()
var opts = { 
  'startTime': startTime_example, // {{String}} The filterining interval start date-time. Related endpoint: `v1/serverDateTime` for date time format details
  'endTime': endTime_example, // {{String}} The filterining interval end date-time. Related endpoint: `v1/serverDateTime` for date time format details
  'pageNumber': 56, // {{Integer}} The page number to retrieve
  'pageSize': 56, // {{Integer}} The number of reports to display in a single page. The maximum number of reports per page is 1000
  'vpgName': vpgName_example, // {{String}} The name of the VPG. You can specify more than one VPG, separated by commas. Related endpoint: `v1/vpgs`
  'recoveryType': recoveryType_example, // {{String}} The type of recovery operation. Possible values are: `Failover`, `Failover Test`, `Move`
  'state': state_example // {{String}} Whether the recovery operation has completed
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getRecoveryReportAll(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getRecoveryReportAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new RecoveryResourcesReportsApi();
            var startTime = startTime_example;  // String | The filterining interval start date-time. Related endpoint: `v1/serverDateTime` for date time format details (optional) 
            var endTime = endTime_example;  // String | The filterining interval end date-time. Related endpoint: `v1/serverDateTime` for date time format details (optional) 
            var pageNumber = 56;  // Integer | The page number to retrieve (optional) 
            var pageSize = 56;  // Integer | The number of reports to display in a single page. The maximum number of reports per page is 1000 (optional) 
            var vpgName = vpgName_example;  // String | The name of the VPG. You can specify more than one VPG, separated by commas. Related endpoint: `v1/vpgs` (optional) 
            var recoveryType = recoveryType_example;  // String | The type of recovery operation. Possible values are: `Failover`, `Failover Test`, `Move` (optional) 
            var state = state_example;  // String | Whether the recovery operation has completed (optional) 

            try
            {
                // Generate a recovery report and view information about recovery operations (Auth)
                array[RecoveryReportApi] result = apiInstance.getRecoveryReportAll(startTime, endTime, pageNumber, pageSize, vpgName, recoveryType, state);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RecoveryResourcesReportsApi.getRecoveryReportAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiRecoveryResourcesReportsApi();
$startTime = startTime_example; // String | The filterining interval start date-time. Related endpoint: `v1/serverDateTime` for date time format details
$endTime = endTime_example; // String | The filterining interval end date-time. Related endpoint: `v1/serverDateTime` for date time format details
$pageNumber = 56; // Integer | The page number to retrieve
$pageSize = 56; // Integer | The number of reports to display in a single page. The maximum number of reports per page is 1000
$vpgName = vpgName_example; // String | The name of the VPG. You can specify more than one VPG, separated by commas. Related endpoint: `v1/vpgs`
$recoveryType = recoveryType_example; // String | The type of recovery operation. Possible values are: `Failover`, `Failover Test`, `Move`
$state = state_example; // String | Whether the recovery operation has completed

try {
    $result = $api_instance->getRecoveryReportAll($startTime, $endTime, $pageNumber, $pageSize, $vpgName, $recoveryType, $state);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RecoveryResourcesReportsApi->getRecoveryReportAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::RecoveryResourcesReportsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::RecoveryResourcesReportsApi->new();
my $startTime = startTime_example; # String | The filterining interval start date-time. Related endpoint: `v1/serverDateTime` for date time format details
my $endTime = endTime_example; # String | The filterining interval end date-time. Related endpoint: `v1/serverDateTime` for date time format details
my $pageNumber = 56; # Integer | The page number to retrieve
my $pageSize = 56; # Integer | The number of reports to display in a single page. The maximum number of reports per page is 1000
my $vpgName = vpgName_example; # String | The name of the VPG. You can specify more than one VPG, separated by commas. Related endpoint: `v1/vpgs`
my $recoveryType = recoveryType_example; # String | The type of recovery operation. Possible values are: `Failover`, `Failover Test`, `Move`
my $state = state_example; # String | Whether the recovery operation has completed

eval { 
    my $result = $api_instance->getRecoveryReportAll(startTime => $startTime, endTime => $endTime, pageNumber => $pageNumber, pageSize => $pageSize, vpgName => $vpgName, recoveryType => $recoveryType, state => $state);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RecoveryResourcesReportsApi->getRecoveryReportAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.RecoveryResourcesReportsApi()
startTime = startTime_example # String | The filterining interval start date-time. Related endpoint: `v1/serverDateTime` for date time format details (optional)
endTime = endTime_example # String | The filterining interval end date-time. Related endpoint: `v1/serverDateTime` for date time format details (optional)
pageNumber = 56 # Integer | The page number to retrieve (optional)
pageSize = 56 # Integer | The number of reports to display in a single page. The maximum number of reports per page is 1000 (optional)
vpgName = vpgName_example # String | The name of the VPG. You can specify more than one VPG, separated by commas. Related endpoint: `v1/vpgs` (optional)
recoveryType = recoveryType_example # String | The type of recovery operation. Possible values are: `Failover`, `Failover Test`, `Move` (optional)
state = state_example # String | Whether the recovery operation has completed (optional)

try: 
    # Generate a recovery report and view information about recovery operations (Auth)
    api_response = api_instance.get_recovery_report_all(startTime=startTime, endTime=endTime, pageNumber=pageNumber, pageSize=pageSize, vpgName=vpgName, recoveryType=recoveryType, state=state)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RecoveryResourcesReportsApi->getRecoveryReportAll: %s\n" % e)

Parameters

Query parameters
Name Description
startTime
String
The filterining interval start date-time. Related endpoint: `v1/serverDateTime` for date time format details
endTime
String
The filterining interval end date-time. Related endpoint: `v1/serverDateTime` for date time format details
pageNumber
Integer (int32)
The page number to retrieve
pageSize
Integer (int32)
The number of reports to display in a single page. The maximum number of reports per page is 1000
vpgName
String
The name of the VPG. You can specify more than one VPG, separated by commas. Related endpoint: `v1/vpgs`
recoveryType
String
The type of recovery operation. Possible values are: `Failover`, `Failover Test`, `Move`
state
String
Whether the recovery operation has completed

Responses

Status: 200 - Success

[
{
recoveryOperationIdentifier:
string
general:
{
vpgIdentifier:
string
vpgName:
string
recoveryType:
string
protectedSiteName:
string
recoverySiteName:
string
startTime:
string
endTime:
string
pointInTime:
string
rtoInSeconds:
string
status:
string
initiatedBy:
string
notes:
string
}
recoverySettings:
{
vpg:
{
defaultHostName:
string
defaultDatastoreName:
string
defaultNetworkName:
string
}
vms:
[
{
vmName:
string
hostName:
string
datastoreName:
string
folderName:
string
networkNames:
[
string
]
volumes:
[
{
volumeName:
string
datastoreName:
string
}
]
}
]
steps:
[
{
description:
string
result:
string
startTime:
string
endTime:
string
executionTime:
string
}
]
}
}
]

getResourceReportAll

Get VM resource reports. (Auth)


/v1/reports/resources

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/reports/resources?startTime=&endTime=&pageNumber=&pageSize=&zorgName=&vpgName=&vmName=&protectedSiteName=&protectedClusterName=&protectedHostName=&protectedOrgVdc=&protectedVcdOrg=&recoverySiteName=&recoveryClusterName=&recoveryHostName=&recoveryOrgVdc=&recoveryVcdOrg="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RecoveryResourcesReportsApi;

import java.io.File;
import java.util.*;

public class RecoveryResourcesReportsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        RecoveryResourcesReportsApi apiInstance = new RecoveryResourcesReportsApi();
        String startTime = startTime_example; // String | The filterining interval start date-time. Related endpoint: `v1/serverDateTime` for date time format details
        String endTime = endTime_example; // String | The filterining interval end date-time. Related endpoint: `v1/serverDateTime` for date time format details
        Integer pageNumber = 56; // Integer | The page number to retrieve
        Integer pageSize = 56; // Integer | The number of reports to display in a single page. The maximum number of reports per page is 1000
        String zorgName = zorgName_example; // String | The name of the ZORG in the Zerto Cloud Manager
        String vpgName = vpgName_example; // String | The name of the VPG
        String vmName = vmName_example; // String | The name of the virtual machine
        String protectedSiteName = protectedSiteName_example; // String | The name of the protected site
        String protectedClusterName = protectedClusterName_example; // String | The name of the cluster containing the host where the virtual machine in the protected site is
        String protectedHostName = protectedHostName_example; // String | The address or DNS name of the host where the virtual machine in the protected site is
        String protectedOrgVdc = protectedOrgVdc_example; // String | The name of the VDC organization in the protected site
        String protectedVcdOrg = protectedVcdOrg_example; // String | The name of the VCD organization in the protected site
        String recoverySiteName = recoverySiteName_example; // String | The name of the recovery site
        String recoveryClusterName = recoveryClusterName_example; // String | The name of the cluster containing the host where the virtual machine in the recovery site is
        String recoveryHostName = recoveryHostName_example; // String | The address or DNS name of the host where the virtual machine in the recovery site is
        String recoveryOrgVdc = recoveryOrgVdc_example; // String | The name of the VDC organization in the recovery site
        String recoveryVcdOrg = recoveryVcdOrg_example; // String | The name of the recovery VCD organization
        try {
            array[VmResourcesReportApi] result = apiInstance.getResourceReportAll(startTime, endTime, pageNumber, pageSize, zorgName, vpgName, vmName, protectedSiteName, protectedClusterName, protectedHostName, protectedOrgVdc, protectedVcdOrg, recoverySiteName, recoveryClusterName, recoveryHostName, recoveryOrgVdc, recoveryVcdOrg);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecoveryResourcesReportsApi#getResourceReportAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.RecoveryResourcesReportsApi;

public class RecoveryResourcesReportsApiExample {

    public static void main(String[] args) {
        RecoveryResourcesReportsApi apiInstance = new RecoveryResourcesReportsApi();
        String startTime = startTime_example; // String | The filterining interval start date-time. Related endpoint: `v1/serverDateTime` for date time format details
        String endTime = endTime_example; // String | The filterining interval end date-time. Related endpoint: `v1/serverDateTime` for date time format details
        Integer pageNumber = 56; // Integer | The page number to retrieve
        Integer pageSize = 56; // Integer | The number of reports to display in a single page. The maximum number of reports per page is 1000
        String zorgName = zorgName_example; // String | The name of the ZORG in the Zerto Cloud Manager
        String vpgName = vpgName_example; // String | The name of the VPG
        String vmName = vmName_example; // String | The name of the virtual machine
        String protectedSiteName = protectedSiteName_example; // String | The name of the protected site
        String protectedClusterName = protectedClusterName_example; // String | The name of the cluster containing the host where the virtual machine in the protected site is
        String protectedHostName = protectedHostName_example; // String | The address or DNS name of the host where the virtual machine in the protected site is
        String protectedOrgVdc = protectedOrgVdc_example; // String | The name of the VDC organization in the protected site
        String protectedVcdOrg = protectedVcdOrg_example; // String | The name of the VCD organization in the protected site
        String recoverySiteName = recoverySiteName_example; // String | The name of the recovery site
        String recoveryClusterName = recoveryClusterName_example; // String | The name of the cluster containing the host where the virtual machine in the recovery site is
        String recoveryHostName = recoveryHostName_example; // String | The address or DNS name of the host where the virtual machine in the recovery site is
        String recoveryOrgVdc = recoveryOrgVdc_example; // String | The name of the VDC organization in the recovery site
        String recoveryVcdOrg = recoveryVcdOrg_example; // String | The name of the recovery VCD organization
        try {
            array[VmResourcesReportApi] result = apiInstance.getResourceReportAll(startTime, endTime, pageNumber, pageSize, zorgName, vpgName, vmName, protectedSiteName, protectedClusterName, protectedHostName, protectedOrgVdc, protectedVcdOrg, recoverySiteName, recoveryClusterName, recoveryHostName, recoveryOrgVdc, recoveryVcdOrg);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecoveryResourcesReportsApi#getResourceReportAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *startTime = startTime_example; // The filterining interval start date-time. Related endpoint: `v1/serverDateTime` for date time format details (optional)
String *endTime = endTime_example; // The filterining interval end date-time. Related endpoint: `v1/serverDateTime` for date time format details (optional)
Integer *pageNumber = 56; // The page number to retrieve (optional)
Integer *pageSize = 56; // The number of reports to display in a single page. The maximum number of reports per page is 1000 (optional)
String *zorgName = zorgName_example; // The name of the ZORG in the Zerto Cloud Manager (optional)
String *vpgName = vpgName_example; // The name of the VPG (optional)
String *vmName = vmName_example; // The name of the virtual machine (optional)
String *protectedSiteName = protectedSiteName_example; // The name of the protected site (optional)
String *protectedClusterName = protectedClusterName_example; // The name of the cluster containing the host where the virtual machine in the protected site is (optional)
String *protectedHostName = protectedHostName_example; // The address or DNS name of the host where the virtual machine in the protected site is (optional)
String *protectedOrgVdc = protectedOrgVdc_example; // The name of the VDC organization in the protected site (optional)
String *protectedVcdOrg = protectedVcdOrg_example; // The name of the VCD organization in the protected site (optional)
String *recoverySiteName = recoverySiteName_example; // The name of the recovery site (optional)
String *recoveryClusterName = recoveryClusterName_example; // The name of the cluster containing the host where the virtual machine in the recovery site is (optional)
String *recoveryHostName = recoveryHostName_example; // The address or DNS name of the host where the virtual machine in the recovery site is (optional)
String *recoveryOrgVdc = recoveryOrgVdc_example; // The name of the VDC organization in the recovery site (optional)
String *recoveryVcdOrg = recoveryVcdOrg_example; // The name of the recovery VCD organization (optional)

RecoveryResourcesReportsApi *apiInstance = [[RecoveryResourcesReportsApi alloc] init];

// Get VM resource reports. (Auth)
[apiInstance getResourceReportAllWith:startTime
    endTime:endTime
    pageNumber:pageNumber
    pageSize:pageSize
    zorgName:zorgName
    vpgName:vpgName
    vmName:vmName
    protectedSiteName:protectedSiteName
    protectedClusterName:protectedClusterName
    protectedHostName:protectedHostName
    protectedOrgVdc:protectedOrgVdc
    protectedVcdOrg:protectedVcdOrg
    recoverySiteName:recoverySiteName
    recoveryClusterName:recoveryClusterName
    recoveryHostName:recoveryHostName
    recoveryOrgVdc:recoveryOrgVdc
    recoveryVcdOrg:recoveryVcdOrg
              completionHandler: ^(array[VmResourcesReportApi] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.RecoveryResourcesReportsApi()
var opts = { 
  'startTime': startTime_example, // {{String}} The filterining interval start date-time. Related endpoint: `v1/serverDateTime` for date time format details
  'endTime': endTime_example, // {{String}} The filterining interval end date-time. Related endpoint: `v1/serverDateTime` for date time format details
  'pageNumber': 56, // {{Integer}} The page number to retrieve
  'pageSize': 56, // {{Integer}} The number of reports to display in a single page. The maximum number of reports per page is 1000
  'zorgName': zorgName_example, // {{String}} The name of the ZORG in the Zerto Cloud Manager
  'vpgName': vpgName_example, // {{String}} The name of the VPG
  'vmName': vmName_example, // {{String}} The name of the virtual machine
  'protectedSiteName': protectedSiteName_example, // {{String}} The name of the protected site
  'protectedClusterName': protectedClusterName_example, // {{String}} The name of the cluster containing the host where the virtual machine in the protected site is
  'protectedHostName': protectedHostName_example, // {{String}} The address or DNS name of the host where the virtual machine in the protected site is
  'protectedOrgVdc': protectedOrgVdc_example, // {{String}} The name of the VDC organization in the protected site
  'protectedVcdOrg': protectedVcdOrg_example, // {{String}} The name of the VCD organization in the protected site
  'recoverySiteName': recoverySiteName_example, // {{String}} The name of the recovery site
  'recoveryClusterName': recoveryClusterName_example, // {{String}} The name of the cluster containing the host where the virtual machine in the recovery site is
  'recoveryHostName': recoveryHostName_example, // {{String}} The address or DNS name of the host where the virtual machine in the recovery site is
  'recoveryOrgVdc': recoveryOrgVdc_example, // {{String}} The name of the VDC organization in the recovery site
  'recoveryVcdOrg': recoveryVcdOrg_example // {{String}} The name of the recovery VCD organization
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getResourceReportAll(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getResourceReportAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new RecoveryResourcesReportsApi();
            var startTime = startTime_example;  // String | The filterining interval start date-time. Related endpoint: `v1/serverDateTime` for date time format details (optional) 
            var endTime = endTime_example;  // String | The filterining interval end date-time. Related endpoint: `v1/serverDateTime` for date time format details (optional) 
            var pageNumber = 56;  // Integer | The page number to retrieve (optional) 
            var pageSize = 56;  // Integer | The number of reports to display in a single page. The maximum number of reports per page is 1000 (optional) 
            var zorgName = zorgName_example;  // String | The name of the ZORG in the Zerto Cloud Manager (optional) 
            var vpgName = vpgName_example;  // String | The name of the VPG (optional) 
            var vmName = vmName_example;  // String | The name of the virtual machine (optional) 
            var protectedSiteName = protectedSiteName_example;  // String | The name of the protected site (optional) 
            var protectedClusterName = protectedClusterName_example;  // String | The name of the cluster containing the host where the virtual machine in the protected site is (optional) 
            var protectedHostName = protectedHostName_example;  // String | The address or DNS name of the host where the virtual machine in the protected site is (optional) 
            var protectedOrgVdc = protectedOrgVdc_example;  // String | The name of the VDC organization in the protected site (optional) 
            var protectedVcdOrg = protectedVcdOrg_example;  // String | The name of the VCD organization in the protected site (optional) 
            var recoverySiteName = recoverySiteName_example;  // String | The name of the recovery site (optional) 
            var recoveryClusterName = recoveryClusterName_example;  // String | The name of the cluster containing the host where the virtual machine in the recovery site is (optional) 
            var recoveryHostName = recoveryHostName_example;  // String | The address or DNS name of the host where the virtual machine in the recovery site is (optional) 
            var recoveryOrgVdc = recoveryOrgVdc_example;  // String | The name of the VDC organization in the recovery site (optional) 
            var recoveryVcdOrg = recoveryVcdOrg_example;  // String | The name of the recovery VCD organization (optional) 

            try
            {
                // Get VM resource reports. (Auth)
                array[VmResourcesReportApi] result = apiInstance.getResourceReportAll(startTime, endTime, pageNumber, pageSize, zorgName, vpgName, vmName, protectedSiteName, protectedClusterName, protectedHostName, protectedOrgVdc, protectedVcdOrg, recoverySiteName, recoveryClusterName, recoveryHostName, recoveryOrgVdc, recoveryVcdOrg);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RecoveryResourcesReportsApi.getResourceReportAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiRecoveryResourcesReportsApi();
$startTime = startTime_example; // String | The filterining interval start date-time. Related endpoint: `v1/serverDateTime` for date time format details
$endTime = endTime_example; // String | The filterining interval end date-time. Related endpoint: `v1/serverDateTime` for date time format details
$pageNumber = 56; // Integer | The page number to retrieve
$pageSize = 56; // Integer | The number of reports to display in a single page. The maximum number of reports per page is 1000
$zorgName = zorgName_example; // String | The name of the ZORG in the Zerto Cloud Manager
$vpgName = vpgName_example; // String | The name of the VPG
$vmName = vmName_example; // String | The name of the virtual machine
$protectedSiteName = protectedSiteName_example; // String | The name of the protected site
$protectedClusterName = protectedClusterName_example; // String | The name of the cluster containing the host where the virtual machine in the protected site is
$protectedHostName = protectedHostName_example; // String | The address or DNS name of the host where the virtual machine in the protected site is
$protectedOrgVdc = protectedOrgVdc_example; // String | The name of the VDC organization in the protected site
$protectedVcdOrg = protectedVcdOrg_example; // String | The name of the VCD organization in the protected site
$recoverySiteName = recoverySiteName_example; // String | The name of the recovery site
$recoveryClusterName = recoveryClusterName_example; // String | The name of the cluster containing the host where the virtual machine in the recovery site is
$recoveryHostName = recoveryHostName_example; // String | The address or DNS name of the host where the virtual machine in the recovery site is
$recoveryOrgVdc = recoveryOrgVdc_example; // String | The name of the VDC organization in the recovery site
$recoveryVcdOrg = recoveryVcdOrg_example; // String | The name of the recovery VCD organization

try {
    $result = $api_instance->getResourceReportAll($startTime, $endTime, $pageNumber, $pageSize, $zorgName, $vpgName, $vmName, $protectedSiteName, $protectedClusterName, $protectedHostName, $protectedOrgVdc, $protectedVcdOrg, $recoverySiteName, $recoveryClusterName, $recoveryHostName, $recoveryOrgVdc, $recoveryVcdOrg);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RecoveryResourcesReportsApi->getResourceReportAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::RecoveryResourcesReportsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::RecoveryResourcesReportsApi->new();
my $startTime = startTime_example; # String | The filterining interval start date-time. Related endpoint: `v1/serverDateTime` for date time format details
my $endTime = endTime_example; # String | The filterining interval end date-time. Related endpoint: `v1/serverDateTime` for date time format details
my $pageNumber = 56; # Integer | The page number to retrieve
my $pageSize = 56; # Integer | The number of reports to display in a single page. The maximum number of reports per page is 1000
my $zorgName = zorgName_example; # String | The name of the ZORG in the Zerto Cloud Manager
my $vpgName = vpgName_example; # String | The name of the VPG
my $vmName = vmName_example; # String | The name of the virtual machine
my $protectedSiteName = protectedSiteName_example; # String | The name of the protected site
my $protectedClusterName = protectedClusterName_example; # String | The name of the cluster containing the host where the virtual machine in the protected site is
my $protectedHostName = protectedHostName_example; # String | The address or DNS name of the host where the virtual machine in the protected site is
my $protectedOrgVdc = protectedOrgVdc_example; # String | The name of the VDC organization in the protected site
my $protectedVcdOrg = protectedVcdOrg_example; # String | The name of the VCD organization in the protected site
my $recoverySiteName = recoverySiteName_example; # String | The name of the recovery site
my $recoveryClusterName = recoveryClusterName_example; # String | The name of the cluster containing the host where the virtual machine in the recovery site is
my $recoveryHostName = recoveryHostName_example; # String | The address or DNS name of the host where the virtual machine in the recovery site is
my $recoveryOrgVdc = recoveryOrgVdc_example; # String | The name of the VDC organization in the recovery site
my $recoveryVcdOrg = recoveryVcdOrg_example; # String | The name of the recovery VCD organization

eval { 
    my $result = $api_instance->getResourceReportAll(startTime => $startTime, endTime => $endTime, pageNumber => $pageNumber, pageSize => $pageSize, zorgName => $zorgName, vpgName => $vpgName, vmName => $vmName, protectedSiteName => $protectedSiteName, protectedClusterName => $protectedClusterName, protectedHostName => $protectedHostName, protectedOrgVdc => $protectedOrgVdc, protectedVcdOrg => $protectedVcdOrg, recoverySiteName => $recoverySiteName, recoveryClusterName => $recoveryClusterName, recoveryHostName => $recoveryHostName, recoveryOrgVdc => $recoveryOrgVdc, recoveryVcdOrg => $recoveryVcdOrg);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RecoveryResourcesReportsApi->getResourceReportAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.RecoveryResourcesReportsApi()
startTime = startTime_example # String | The filterining interval start date-time. Related endpoint: `v1/serverDateTime` for date time format details (optional)
endTime = endTime_example # String | The filterining interval end date-time. Related endpoint: `v1/serverDateTime` for date time format details (optional)
pageNumber = 56 # Integer | The page number to retrieve (optional)
pageSize = 56 # Integer | The number of reports to display in a single page. The maximum number of reports per page is 1000 (optional)
zorgName = zorgName_example # String | The name of the ZORG in the Zerto Cloud Manager (optional)
vpgName = vpgName_example # String | The name of the VPG (optional)
vmName = vmName_example # String | The name of the virtual machine (optional)
protectedSiteName = protectedSiteName_example # String | The name of the protected site (optional)
protectedClusterName = protectedClusterName_example # String | The name of the cluster containing the host where the virtual machine in the protected site is (optional)
protectedHostName = protectedHostName_example # String | The address or DNS name of the host where the virtual machine in the protected site is (optional)
protectedOrgVdc = protectedOrgVdc_example # String | The name of the VDC organization in the protected site (optional)
protectedVcdOrg = protectedVcdOrg_example # String | The name of the VCD organization in the protected site (optional)
recoverySiteName = recoverySiteName_example # String | The name of the recovery site (optional)
recoveryClusterName = recoveryClusterName_example # String | The name of the cluster containing the host where the virtual machine in the recovery site is (optional)
recoveryHostName = recoveryHostName_example # String | The address or DNS name of the host where the virtual machine in the recovery site is (optional)
recoveryOrgVdc = recoveryOrgVdc_example # String | The name of the VDC organization in the recovery site (optional)
recoveryVcdOrg = recoveryVcdOrg_example # String | The name of the recovery VCD organization (optional)

try: 
    # Get VM resource reports. (Auth)
    api_response = api_instance.get_resource_report_all(startTime=startTime, endTime=endTime, pageNumber=pageNumber, pageSize=pageSize, zorgName=zorgName, vpgName=vpgName, vmName=vmName, protectedSiteName=protectedSiteName, protectedClusterName=protectedClusterName, protectedHostName=protectedHostName, protectedOrgVdc=protectedOrgVdc, protectedVcdOrg=protectedVcdOrg, recoverySiteName=recoverySiteName, recoveryClusterName=recoveryClusterName, recoveryHostName=recoveryHostName, recoveryOrgVdc=recoveryOrgVdc, recoveryVcdOrg=recoveryVcdOrg)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RecoveryResourcesReportsApi->getResourceReportAll: %s\n" % e)

Parameters

Query parameters
Name Description
startTime
String
The filterining interval start date-time. Related endpoint: `v1/serverDateTime` for date time format details
endTime
String
The filterining interval end date-time. Related endpoint: `v1/serverDateTime` for date time format details
pageNumber
Integer (int32)
The page number to retrieve
pageSize
Integer (int32)
The number of reports to display in a single page. The maximum number of reports per page is 1000
zorgName
String
The name of the ZORG in the Zerto Cloud Manager
vpgName
String
The name of the VPG
vmName
String
The name of the virtual machine
protectedSiteName
String
The name of the protected site
protectedClusterName
String
The name of the cluster containing the host where the virtual machine in the protected site is
protectedHostName
String
The address or DNS name of the host where the virtual machine in the protected site is
protectedOrgVdc
String
The name of the VDC organization in the protected site
protectedVcdOrg
String
The name of the VCD organization in the protected site
recoverySiteName
String
The name of the recovery site
recoveryClusterName
String
The name of the cluster containing the host where the virtual machine in the recovery site is
recoveryHostName
String
The address or DNS name of the host where the virtual machine in the recovery site is
recoveryOrgVdc
String
The name of the VDC organization in the recovery site
recoveryVcdOrg
String
The name of the recovery VCD organization

Responses

Status: 200 - Success

[
{
sampleTime:
string
performance:
{
bandwidthInBps:
number (double)
throughputInBps:
number (double)
}
vpg:
{
crmIdentifier:
string
serviceProfileName:
string
vpgName:
string
protectedAndRecoveryType:
string
zorgName:
string
}
protectedSite:
{
compute:
{
clusterName:
string
hostName:
string
vraName:
string
orgVdcName:
string
resourcePoolName:
string
}
storage:
{
numberOfVolumes:
integer (int32)
volumesProvisionedStorageInGB:
number (double)
volumesUsedStorageInGB:
number (double)
}
vmInfo:
{
hardwareVersion:
string
vmIdentifier:
string
vmName:
string
cpu:
{
cpuLimitationInMhz:
integer (int32)
cpuReservedInMhz:
integer (int32)
numberOfvCpus:
integer (int32)
cpuUsedInMhz:
integer (int32)
}
memory:
{
activeGuestMemoryInMB:
integer (int64)
consumedHostMemoryInMB:
integer (int64)
memoryInMB:
integer (int32)
memoryLimitationInMB:
integer (int32)
memoryReservedInMB:
integer (int32)
}
}
siteName:
string
vcdOrgName:
string
}
recoverySite:
{
compute:
{
failoverOrMoveInstanceType:
string
failoverOrMoveInstanceFamily:
string
failoverTestInstanceType:
string
failoverTestInstanceFamily:
string
clusterName:
string
hostName:
string
vraName:
string
orgVdcName:
string
resourcePoolName:
string
}
storage:
{
journalProvisionedStorageInGB:
number (double)
journalUsedStorageInGB:
number (double)
datastoreName:
string
storagePolicyName:
string
volumesProvisionedStorageInGB:
number (double)
volumesUsedStorageInGB:
number (double)
}
siteName:
string
vcdOrgName:
string
}
}
]

ServerDateTime

systemDateTimeServiceGetDateTimeLocal

Get current system date-time in a Local time zone (Auth)


/v1/serverDateTime/serverDateTimeLocal

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/serverDateTime/serverDateTimeLocal"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ServerDateTimeApi;

import java.io.File;
import java.util.*;

public class ServerDateTimeApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        ServerDateTimeApi apiInstance = new ServerDateTimeApi();
        try {
            'Date' result = apiInstance.systemDateTimeServiceGetDateTimeLocal();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServerDateTimeApi#systemDateTimeServiceGetDateTimeLocal");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ServerDateTimeApi;

public class ServerDateTimeApiExample {

    public static void main(String[] args) {
        ServerDateTimeApi apiInstance = new ServerDateTimeApi();
        try {
            'Date' result = apiInstance.systemDateTimeServiceGetDateTimeLocal();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServerDateTimeApi#systemDateTimeServiceGetDateTimeLocal");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];

ServerDateTimeApi *apiInstance = [[ServerDateTimeApi alloc] init];

// Get current system date-time in a Local time zone (Auth)
[apiInstance systemDateTimeServiceGetDateTimeLocalWithCompletionHandler: 
              ^('Date' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.ServerDateTimeApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.systemDateTimeServiceGetDateTimeLocal(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class systemDateTimeServiceGetDateTimeLocalExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new ServerDateTimeApi();

            try
            {
                // Get current system date-time in a Local time zone (Auth)
                'Date' result = apiInstance.systemDateTimeServiceGetDateTimeLocal();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ServerDateTimeApi.systemDateTimeServiceGetDateTimeLocal: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiServerDateTimeApi();

try {
    $result = $api_instance->systemDateTimeServiceGetDateTimeLocal();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ServerDateTimeApi->systemDateTimeServiceGetDateTimeLocal: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ServerDateTimeApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ServerDateTimeApi->new();

eval { 
    my $result = $api_instance->systemDateTimeServiceGetDateTimeLocal();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ServerDateTimeApi->systemDateTimeServiceGetDateTimeLocal: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ServerDateTimeApi()

try: 
    # Get current system date-time in a Local time zone (Auth)
    api_response = api_instance.system_date_time_service_get_date_time_local()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServerDateTimeApi->systemDateTimeServiceGetDateTimeLocal: %s\n" % e)

Parameters

Responses

Status: 200 - Success

string (date-time)

systemDateTimeServiceGetDateTimeUtc

Get current system date-time in UTC format (Auth)


/v1/serverDateTime/serverDateTimeUtc

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/serverDateTime/serverDateTimeUtc"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ServerDateTimeApi;

import java.io.File;
import java.util.*;

public class ServerDateTimeApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        ServerDateTimeApi apiInstance = new ServerDateTimeApi();
        try {
            'Date' result = apiInstance.systemDateTimeServiceGetDateTimeUtc();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServerDateTimeApi#systemDateTimeServiceGetDateTimeUtc");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ServerDateTimeApi;

public class ServerDateTimeApiExample {

    public static void main(String[] args) {
        ServerDateTimeApi apiInstance = new ServerDateTimeApi();
        try {
            'Date' result = apiInstance.systemDateTimeServiceGetDateTimeUtc();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServerDateTimeApi#systemDateTimeServiceGetDateTimeUtc");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];

ServerDateTimeApi *apiInstance = [[ServerDateTimeApi alloc] init];

// Get current system date-time in UTC format (Auth)
[apiInstance systemDateTimeServiceGetDateTimeUtcWithCompletionHandler: 
              ^('Date' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.ServerDateTimeApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.systemDateTimeServiceGetDateTimeUtc(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class systemDateTimeServiceGetDateTimeUtcExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new ServerDateTimeApi();

            try
            {
                // Get current system date-time in UTC format (Auth)
                'Date' result = apiInstance.systemDateTimeServiceGetDateTimeUtc();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ServerDateTimeApi.systemDateTimeServiceGetDateTimeUtc: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiServerDateTimeApi();

try {
    $result = $api_instance->systemDateTimeServiceGetDateTimeUtc();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ServerDateTimeApi->systemDateTimeServiceGetDateTimeUtc: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ServerDateTimeApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ServerDateTimeApi->new();

eval { 
    my $result = $api_instance->systemDateTimeServiceGetDateTimeUtc();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ServerDateTimeApi->systemDateTimeServiceGetDateTimeUtc: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ServerDateTimeApi()

try: 
    # Get current system date-time in UTC format (Auth)
    api_response = api_instance.system_date_time_service_get_date_time_utc()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServerDateTimeApi->systemDateTimeServiceGetDateTimeUtc: %s\n" % e)

Parameters

Responses

Status: 200 - Success

string (date-time)

systemDateTimeServicePost

Check system date time casting from parameters. Specify the date and check the return value to prove your expectations. (Auth)


/v1/serverDateTime/dateTimeArgument

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/serverDateTime/dateTimeArgument?dateTime="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ServerDateTimeApi;

import java.io.File;
import java.util.*;

public class ServerDateTimeApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        ServerDateTimeApi apiInstance = new ServerDateTimeApi();
        Date dateTime = 2013-10-20T19:20:30+01:00; // Date | There are three main ways to specify the date time:
In milliseconds | In UTC format | In any other general format (Local time)
        try {
            'Date' result = apiInstance.systemDateTimeServicePost(dateTime);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServerDateTimeApi#systemDateTimeServicePost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ServerDateTimeApi;

public class ServerDateTimeApiExample {

    public static void main(String[] args) {
        ServerDateTimeApi apiInstance = new ServerDateTimeApi();
        Date dateTime = 2013-10-20T19:20:30+01:00; // Date | There are three main ways to specify the date time:
In milliseconds | In UTC format | In any other general format (Local time)
        try {
            'Date' result = apiInstance.systemDateTimeServicePost(dateTime);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServerDateTimeApi#systemDateTimeServicePost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
Date *dateTime = 2013-10-20T19:20:30+01:00; // There are three main ways to specify the date time:
In milliseconds | In UTC format | In any other general format (Local time) (optional)

ServerDateTimeApi *apiInstance = [[ServerDateTimeApi alloc] init];

// Check system date time casting from parameters. Specify the date and check the return value to prove your expectations. (Auth)
[apiInstance systemDateTimeServicePostWith:dateTime
              completionHandler: ^('Date' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.ServerDateTimeApi()
var opts = { 
  'dateTime': 2013-10-20T19:20:30+01:00 // {{Date}} There are three main ways to specify the date time:
In milliseconds | In UTC format | In any other general format (Local time)
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.systemDateTimeServicePost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class systemDateTimeServicePostExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new ServerDateTimeApi();
            var dateTime = 2013-10-20T19:20:30+01:00;  // Date | There are three main ways to specify the date time:
In milliseconds | In UTC format | In any other general format (Local time) (optional) 

            try
            {
                // Check system date time casting from parameters. Specify the date and check the return value to prove your expectations. (Auth)
                'Date' result = apiInstance.systemDateTimeServicePost(dateTime);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ServerDateTimeApi.systemDateTimeServicePost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiServerDateTimeApi();
$dateTime = 2013-10-20T19:20:30+01:00; // Date | There are three main ways to specify the date time:
In milliseconds | In UTC format | In any other general format (Local time)

try {
    $result = $api_instance->systemDateTimeServicePost($dateTime);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ServerDateTimeApi->systemDateTimeServicePost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ServerDateTimeApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ServerDateTimeApi->new();
my $dateTime = 2013-10-20T19:20:30+01:00; # Date | There are three main ways to specify the date time:
In milliseconds | In UTC format | In any other general format (Local time)

eval { 
    my $result = $api_instance->systemDateTimeServicePost(dateTime => $dateTime);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ServerDateTimeApi->systemDateTimeServicePost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ServerDateTimeApi()
dateTime = 2013-10-20T19:20:30+01:00 # Date | There are three main ways to specify the date time:
In milliseconds | In UTC format | In any other general format (Local time) (optional)

try: 
    # Check system date time casting from parameters. Specify the date and check the return value to prove your expectations. (Auth)
    api_response = api_instance.system_date_time_service_post(dateTime=dateTime)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServerDateTimeApi->systemDateTimeServicePost: %s\n" % e)

Parameters

Query parameters
Name Description
dateTime
Date (date-time)
There are three main ways to specify the date time: In milliseconds | In UTC format | In any other general format (Local time)

Responses

Status: 200 - Success

string (date-time)

ServiceProfiles

getServiceProfile

Get details of a specified service profile at the site processing the API. (Auth)


/v1/serviceprofiles/{serviceProfileIdentifier}

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/serviceprofiles/{serviceProfileIdentifier}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ServiceProfilesApi;

import java.io.File;
import java.util.*;

public class ServiceProfilesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        ServiceProfilesApi apiInstance = new ServiceProfilesApi();
        String serviceProfileIdentifier = serviceProfileIdentifier_example; // String | The service profile ID for which information should be returned. Related endpoint: `v1/serviceprofiles`
        try {
            ServiceProfileApi result = apiInstance.getServiceProfile(serviceProfileIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceProfilesApi#getServiceProfile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ServiceProfilesApi;

public class ServiceProfilesApiExample {

    public static void main(String[] args) {
        ServiceProfilesApi apiInstance = new ServiceProfilesApi();
        String serviceProfileIdentifier = serviceProfileIdentifier_example; // String | The service profile ID for which information should be returned. Related endpoint: `v1/serviceprofiles`
        try {
            ServiceProfileApi result = apiInstance.getServiceProfile(serviceProfileIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceProfilesApi#getServiceProfile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *serviceProfileIdentifier = serviceProfileIdentifier_example; // The service profile ID for which information should be returned. Related endpoint: `v1/serviceprofiles`

ServiceProfilesApi *apiInstance = [[ServiceProfilesApi alloc] init];

// Get details of a specified service profile at the site processing the API. (Auth)
[apiInstance getServiceProfileWith:serviceProfileIdentifier
              completionHandler: ^(ServiceProfileApi output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.ServiceProfilesApi()
var serviceProfileIdentifier = serviceProfileIdentifier_example; // {{String}} The service profile ID for which information should be returned. Related endpoint: `v1/serviceprofiles`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getServiceProfile(serviceProfileIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getServiceProfileExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new ServiceProfilesApi();
            var serviceProfileIdentifier = serviceProfileIdentifier_example;  // String | The service profile ID for which information should be returned. Related endpoint: `v1/serviceprofiles`

            try
            {
                // Get details of a specified service profile at the site processing the API. (Auth)
                ServiceProfileApi result = apiInstance.getServiceProfile(serviceProfileIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ServiceProfilesApi.getServiceProfile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiServiceProfilesApi();
$serviceProfileIdentifier = serviceProfileIdentifier_example; // String | The service profile ID for which information should be returned. Related endpoint: `v1/serviceprofiles`

try {
    $result = $api_instance->getServiceProfile($serviceProfileIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ServiceProfilesApi->getServiceProfile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ServiceProfilesApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ServiceProfilesApi->new();
my $serviceProfileIdentifier = serviceProfileIdentifier_example; # String | The service profile ID for which information should be returned. Related endpoint: `v1/serviceprofiles`

eval { 
    my $result = $api_instance->getServiceProfile(serviceProfileIdentifier => $serviceProfileIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ServiceProfilesApi->getServiceProfile: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ServiceProfilesApi()
serviceProfileIdentifier = serviceProfileIdentifier_example # String | The service profile ID for which information should be returned. Related endpoint: `v1/serviceprofiles`

try: 
    # Get details of a specified service profile at the site processing the API. (Auth)
    api_response = api_instance.get_service_profile(serviceProfileIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServiceProfilesApi->getServiceProfile: %s\n" % e)

Parameters

Path parameters
Name Description
serviceProfileIdentifier*
String
The service profile ID for which information should be returned. Related endpoint: `v1/serviceprofiles`
Required

Responses

Status: 200 - Success

{
link:
{
rel:
string
href:
string
type:
string
identifier:
string
}
serviceProfileIdentifier:
string
serviceProfileName:
string
rpo:
string (date-span)
history:
string (date-span)
maxJournalSizeInPercent:
integer (int32)
testInterval:
string (date-span)
description:
string
journalWarningThresholdInPercent:
integer (int32)
}

getServiceProfileAll

Get the list of all service profiles for the site processing the API. (Auth)


/v1/serviceprofiles

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/serviceprofiles?siteIdentifier="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ServiceProfilesApi;

import java.io.File;
import java.util.*;

public class ServiceProfilesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        ServiceProfilesApi apiInstance = new ServiceProfilesApi();
        String siteIdentifier = siteIdentifier_example; // String | The identifier of the site for which service profiles should be returned. Related endpoints: `v1/localsite`, `v1/peersites`
        try {
            array[ServiceProfileApi] result = apiInstance.getServiceProfileAll(siteIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceProfilesApi#getServiceProfileAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ServiceProfilesApi;

public class ServiceProfilesApiExample {

    public static void main(String[] args) {
        ServiceProfilesApi apiInstance = new ServiceProfilesApi();
        String siteIdentifier = siteIdentifier_example; // String | The identifier of the site for which service profiles should be returned. Related endpoints: `v1/localsite`, `v1/peersites`
        try {
            array[ServiceProfileApi] result = apiInstance.getServiceProfileAll(siteIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceProfilesApi#getServiceProfileAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *siteIdentifier = siteIdentifier_example; // The identifier of the site for which service profiles should be returned. Related endpoints: `v1/localsite`, `v1/peersites` (optional)

ServiceProfilesApi *apiInstance = [[ServiceProfilesApi alloc] init];

// Get the list of all service profiles for the site processing the API. (Auth)
[apiInstance getServiceProfileAllWith:siteIdentifier
              completionHandler: ^(array[ServiceProfileApi] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.ServiceProfilesApi()
var opts = { 
  'siteIdentifier': siteIdentifier_example // {{String}} The identifier of the site for which service profiles should be returned. Related endpoints: `v1/localsite`, `v1/peersites`
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getServiceProfileAll(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getServiceProfileAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new ServiceProfilesApi();
            var siteIdentifier = siteIdentifier_example;  // String | The identifier of the site for which service profiles should be returned. Related endpoints: `v1/localsite`, `v1/peersites` (optional) 

            try
            {
                // Get the list of all service profiles for the site processing the API. (Auth)
                array[ServiceProfileApi] result = apiInstance.getServiceProfileAll(siteIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ServiceProfilesApi.getServiceProfileAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiServiceProfilesApi();
$siteIdentifier = siteIdentifier_example; // String | The identifier of the site for which service profiles should be returned. Related endpoints: `v1/localsite`, `v1/peersites`

try {
    $result = $api_instance->getServiceProfileAll($siteIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ServiceProfilesApi->getServiceProfileAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ServiceProfilesApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ServiceProfilesApi->new();
my $siteIdentifier = siteIdentifier_example; # String | The identifier of the site for which service profiles should be returned. Related endpoints: `v1/localsite`, `v1/peersites`

eval { 
    my $result = $api_instance->getServiceProfileAll(siteIdentifier => $siteIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ServiceProfilesApi->getServiceProfileAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ServiceProfilesApi()
siteIdentifier = siteIdentifier_example # String | The identifier of the site for which service profiles should be returned. Related endpoints: `v1/localsite`, `v1/peersites` (optional)

try: 
    # Get the list of all service profiles for the site processing the API. (Auth)
    api_response = api_instance.get_service_profile_all(siteIdentifier=siteIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServiceProfilesApi->getServiceProfileAll: %s\n" % e)

Parameters

Query parameters
Name Description
siteIdentifier
String
The identifier of the site for which service profiles should be returned. Related endpoints: `v1/localsite`, `v1/peersites`

Responses

Status: 200 - Success

[
{
link:
{
rel:
string
href:
string
type:
string
identifier:
string
}
serviceProfileIdentifier:
string
serviceProfileName:
string
rpo:
string (date-span)
history:
string (date-span)
maxJournalSizeInPercent:
integer (int32)
testInterval:
string (date-span)
description:
string
journalWarningThresholdInPercent:
integer (int32)
}
]

Sessions

connect

Add session. Authorization header or login password from AddSessionDataApi is required. Header has higher priority.


/v1/session/add

Usage and SDK Samples

curl -X POST\
-H "Content-Type: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/session/add"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SessionsApi;

import java.io.File;
import java.util.*;

public class SessionsApiExample {

    public static void main(String[] args) {
        
        SessionsApi apiInstance = new SessionsApi();
        AddSessionDataApi body = ; // AddSessionDataApi | 
        String authorization = authorization_example; // String | Basic authorization
        try {
            apiInstance.connect(body, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling SessionsApi#connect");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SessionsApi;

public class SessionsApiExample {

    public static void main(String[] args) {
        SessionsApi apiInstance = new SessionsApi();
        AddSessionDataApi body = ; // AddSessionDataApi | 
        String authorization = authorization_example; // String | Basic authorization
        try {
            apiInstance.connect(body, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling SessionsApi#connect");
            e.printStackTrace();
        }
    }
}
AddSessionDataApi *body = ; //  (optional)
String *authorization = authorization_example; // Basic authorization (optional)

SessionsApi *apiInstance = [[SessionsApi alloc] init];

// Add session. Authorization header or login password from AddSessionDataApi is required. Header has higher priority.
[apiInstance connectWith:body
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');

var api = new ZvmRestApi.SessionsApi()
var opts = { 
  'body':  // {{AddSessionDataApi}} 
  'authorization': authorization_example // {{String}} Basic authorization
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.connect(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class connectExample
    {
        public void main()
        {

            var apiInstance = new SessionsApi();
            var body = new AddSessionDataApi(); // AddSessionDataApi |  (optional) 
            var authorization = authorization_example;  // String | Basic authorization (optional) 

            try
            {
                // Add session. Authorization header or login password from AddSessionDataApi is required. Header has higher priority.
                apiInstance.connect(body, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SessionsApi.connect: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSessionsApi();
$body = ; // AddSessionDataApi | 
$authorization = authorization_example; // String | Basic authorization

try {
    $api_instance->connect($body, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling SessionsApi->connect: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SessionsApi;

my $api_instance = WWW::SwaggerClient::SessionsApi->new();
my $body = WWW::SwaggerClient::Object::AddSessionDataApi->new(); # AddSessionDataApi | 
my $authorization = authorization_example; # String | Basic authorization

eval { 
    $api_instance->connect(body => $body, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling SessionsApi->connect: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SessionsApi()
body =  # AddSessionDataApi |  (optional)
authorization = authorization_example # String | Basic authorization (optional)

try: 
    # Add session. Authorization header or login password from AddSessionDataApi is required. Header has higher priority.
    api_instance.connect(body=body, authorization=authorization)
except ApiException as e:
    print("Exception when calling SessionsApi->connect: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String
Basic authorization
Body parameters
Name Description
body
{
authenticationMethod:
integer (int32)
Enum: 0, 1, 2
login:
string
password:
string
}

Responses

Status: 200 - Success

Name Type Format Description
x-zerto-session String Session token

disconnect

Close current session (Auth)


/v1/session

Usage and SDK Samples

curl -X DELETE\
-H "x-zerto-session: [[apiKey]]"\
"https://localhost:9669//v1/session"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SessionsApi;

import java.io.File;
import java.util.*;

public class SessionsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        SessionsApi apiInstance = new SessionsApi();
        try {
            apiInstance.disconnect();
        } catch (ApiException e) {
            System.err.println("Exception when calling SessionsApi#disconnect");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SessionsApi;

public class SessionsApiExample {

    public static void main(String[] args) {
        SessionsApi apiInstance = new SessionsApi();
        try {
            apiInstance.disconnect();
        } catch (ApiException e) {
            System.err.println("Exception when calling SessionsApi#disconnect");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];

SessionsApi *apiInstance = [[SessionsApi alloc] init];

// Close current session (Auth)
[apiInstance disconnectWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.SessionsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.disconnect(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class disconnectExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new SessionsApi();

            try
            {
                // Close current session (Auth)
                apiInstance.disconnect();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SessionsApi.disconnect: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiSessionsApi();

try {
    $api_instance->disconnect();
} catch (Exception $e) {
    echo 'Exception when calling SessionsApi->disconnect: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SessionsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::SessionsApi->new();

eval { 
    $api_instance->disconnect();
};
if ($@) {
    warn "Exception when calling SessionsApi->disconnect: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.SessionsApi()

try: 
    # Close current session (Auth)
    api_instance.disconnect()
except ApiException as e:
    print("Exception when calling SessionsApi->disconnect: %s\n" % e)

Parameters

Responses

Status: 200 - Success


Tasks

getTask

Get details of a specific task running on the site processing the API. (Auth)


/v1/tasks/{taskIdentifier}

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/tasks/{taskIdentifier}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TasksApi;

import java.io.File;
import java.util.*;

public class TasksApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        TasksApi apiInstance = new TasksApi();
        String taskIdentifier = taskIdentifier_example; // String | The identifier of the task. Related endpoints: `v1/tasks`
        try {
            TaskApi result = apiInstance.getTask(taskIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TasksApi#getTask");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TasksApi;

public class TasksApiExample {

    public static void main(String[] args) {
        TasksApi apiInstance = new TasksApi();
        String taskIdentifier = taskIdentifier_example; // String | The identifier of the task. Related endpoints: `v1/tasks`
        try {
            TaskApi result = apiInstance.getTask(taskIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TasksApi#getTask");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *taskIdentifier = taskIdentifier_example; // The identifier of the task. Related endpoints: `v1/tasks`

TasksApi *apiInstance = [[TasksApi alloc] init];

// Get details of a specific task running on the site processing the API. (Auth)
[apiInstance getTaskWith:taskIdentifier
              completionHandler: ^(TaskApi output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.TasksApi()
var taskIdentifier = taskIdentifier_example; // {{String}} The identifier of the task. Related endpoints: `v1/tasks`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTask(taskIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getTaskExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new TasksApi();
            var taskIdentifier = taskIdentifier_example;  // String | The identifier of the task. Related endpoints: `v1/tasks`

            try
            {
                // Get details of a specific task running on the site processing the API. (Auth)
                TaskApi result = apiInstance.getTask(taskIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TasksApi.getTask: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiTasksApi();
$taskIdentifier = taskIdentifier_example; // String | The identifier of the task. Related endpoints: `v1/tasks`

try {
    $result = $api_instance->getTask($taskIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TasksApi->getTask: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TasksApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TasksApi->new();
my $taskIdentifier = taskIdentifier_example; # String | The identifier of the task. Related endpoints: `v1/tasks`

eval { 
    my $result = $api_instance->getTask(taskIdentifier => $taskIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TasksApi->getTask: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.TasksApi()
taskIdentifier = taskIdentifier_example # String | The identifier of the task. Related endpoints: `v1/tasks`

try: 
    # Get details of a specific task running on the site processing the API. (Auth)
    api_response = api_instance.get_task(taskIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TasksApi->getTask: %s\n" % e)

Parameters

Path parameters
Name Description
taskIdentifier*
String
The identifier of the task. Related endpoints: `v1/tasks`
Required

Responses

Status: 200 - Success

{
link:
{
rel:
string
href:
string
type:
string
identifier:
string
}
type:
string
status:
{
state:
integer (int32)
Enum: 0, 1, 2, 3, 4, 5, 6, 7
progress:
integer (int32)
}
initiatedBy:
string
started:
string (date-time)
completed:
string (date-time)
taskIdentifier:
string
completeReason:
string
isCancellable:
boolean
relatedEntities:
{
vpgs:
[
{
rel:
string
href:
string
type:
string
identifier:
string
}
]
sites:
[
{
rel:
string
href:
string
type:
string
identifier:
string
}
]
hosts:
[
{
rel:
string
href:
string
type:
string
identifier:
string
}
]
flrSessions:
[
{
rel:
string
href:
string
type:
string
identifier:
string
}
]
}
}

getTaskAll

Get information about tasks run on this site. (Auth)


/v1/tasks

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/tasks?startedBeforeDate=&startedAfterDate=&completedBeforeDate=&completedAfterDate=&type=&status="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TasksApi;

import java.io.File;
import java.util.*;

public class TasksApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        TasksApi apiInstance = new TasksApi();
        Date startedBeforeDate = 2013-10-20T19:20:30+01:00; // Date | The date-time before the tasks started. Related endpoint: `v1/serverDateTime` for date time format details
        Date startedAfterDate = 2013-10-20T19:20:30+01:00; // Date | The date-time after the tasks started. Related endpoint: `v1/serverDateTime` for date time format details
        Date completedBeforeDate = 2013-10-20T19:20:30+01:00; // Date | The date-time before the tasks ended. Related endpoint: `v1/serverDateTime` for date time format details
        Date completedAfterDate = 2013-10-20T19:20:30+01:00; // Date | The date-time after the tasks ended. Related endpoint: `v1/serverDateTime` for date time format details
        String type = type_example; // String | The task type. Related endpoint `/v1/tasks/types`
        String status = status_example; // String | The status of the task. Possible values are: `1 or InProgress` | `3 or Paused` | `4 or Failed` | `6 or Completed` | `7 or Cancelling`
        try {
            array[TaskApi] result = apiInstance.getTaskAll(startedBeforeDate, startedAfterDate, completedBeforeDate, completedAfterDate, type, status);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TasksApi#getTaskAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TasksApi;

public class TasksApiExample {

    public static void main(String[] args) {
        TasksApi apiInstance = new TasksApi();
        Date startedBeforeDate = 2013-10-20T19:20:30+01:00; // Date | The date-time before the tasks started. Related endpoint: `v1/serverDateTime` for date time format details
        Date startedAfterDate = 2013-10-20T19:20:30+01:00; // Date | The date-time after the tasks started. Related endpoint: `v1/serverDateTime` for date time format details
        Date completedBeforeDate = 2013-10-20T19:20:30+01:00; // Date | The date-time before the tasks ended. Related endpoint: `v1/serverDateTime` for date time format details
        Date completedAfterDate = 2013-10-20T19:20:30+01:00; // Date | The date-time after the tasks ended. Related endpoint: `v1/serverDateTime` for date time format details
        String type = type_example; // String | The task type. Related endpoint `/v1/tasks/types`
        String status = status_example; // String | The status of the task. Possible values are: `1 or InProgress` | `3 or Paused` | `4 or Failed` | `6 or Completed` | `7 or Cancelling`
        try {
            array[TaskApi] result = apiInstance.getTaskAll(startedBeforeDate, startedAfterDate, completedBeforeDate, completedAfterDate, type, status);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TasksApi#getTaskAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
Date *startedBeforeDate = 2013-10-20T19:20:30+01:00; // The date-time before the tasks started. Related endpoint: `v1/serverDateTime` for date time format details (optional)
Date *startedAfterDate = 2013-10-20T19:20:30+01:00; // The date-time after the tasks started. Related endpoint: `v1/serverDateTime` for date time format details (optional)
Date *completedBeforeDate = 2013-10-20T19:20:30+01:00; // The date-time before the tasks ended. Related endpoint: `v1/serverDateTime` for date time format details (optional)
Date *completedAfterDate = 2013-10-20T19:20:30+01:00; // The date-time after the tasks ended. Related endpoint: `v1/serverDateTime` for date time format details (optional)
String *type = type_example; // The task type. Related endpoint `/v1/tasks/types` (optional)
String *status = status_example; // The status of the task. Possible values are: `1 or InProgress` | `3 or Paused` | `4 or Failed` | `6 or Completed` | `7 or Cancelling` (optional)

TasksApi *apiInstance = [[TasksApi alloc] init];

// Get information about tasks run on this site. (Auth)
[apiInstance getTaskAllWith:startedBeforeDate
    startedAfterDate:startedAfterDate
    completedBeforeDate:completedBeforeDate
    completedAfterDate:completedAfterDate
    type:type
    status:status
              completionHandler: ^(array[TaskApi] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.TasksApi()
var opts = { 
  'startedBeforeDate': 2013-10-20T19:20:30+01:00, // {{Date}} The date-time before the tasks started. Related endpoint: `v1/serverDateTime` for date time format details
  'startedAfterDate': 2013-10-20T19:20:30+01:00, // {{Date}} The date-time after the tasks started. Related endpoint: `v1/serverDateTime` for date time format details
  'completedBeforeDate': 2013-10-20T19:20:30+01:00, // {{Date}} The date-time before the tasks ended. Related endpoint: `v1/serverDateTime` for date time format details
  'completedAfterDate': 2013-10-20T19:20:30+01:00, // {{Date}} The date-time after the tasks ended. Related endpoint: `v1/serverDateTime` for date time format details
  'type': type_example, // {{String}} The task type. Related endpoint `/v1/tasks/types`
  'status': status_example // {{String}} The status of the task. Possible values are: `1 or InProgress` | `3 or Paused` | `4 or Failed` | `6 or Completed` | `7 or Cancelling`
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTaskAll(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getTaskAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new TasksApi();
            var startedBeforeDate = 2013-10-20T19:20:30+01:00;  // Date | The date-time before the tasks started. Related endpoint: `v1/serverDateTime` for date time format details (optional) 
            var startedAfterDate = 2013-10-20T19:20:30+01:00;  // Date | The date-time after the tasks started. Related endpoint: `v1/serverDateTime` for date time format details (optional) 
            var completedBeforeDate = 2013-10-20T19:20:30+01:00;  // Date | The date-time before the tasks ended. Related endpoint: `v1/serverDateTime` for date time format details (optional) 
            var completedAfterDate = 2013-10-20T19:20:30+01:00;  // Date | The date-time after the tasks ended. Related endpoint: `v1/serverDateTime` for date time format details (optional) 
            var type = type_example;  // String | The task type. Related endpoint `/v1/tasks/types` (optional) 
            var status = status_example;  // String | The status of the task. Possible values are: `1 or InProgress` | `3 or Paused` | `4 or Failed` | `6 or Completed` | `7 or Cancelling` (optional) 

            try
            {
                // Get information about tasks run on this site. (Auth)
                array[TaskApi] result = apiInstance.getTaskAll(startedBeforeDate, startedAfterDate, completedBeforeDate, completedAfterDate, type, status);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TasksApi.getTaskAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiTasksApi();
$startedBeforeDate = 2013-10-20T19:20:30+01:00; // Date | The date-time before the tasks started. Related endpoint: `v1/serverDateTime` for date time format details
$startedAfterDate = 2013-10-20T19:20:30+01:00; // Date | The date-time after the tasks started. Related endpoint: `v1/serverDateTime` for date time format details
$completedBeforeDate = 2013-10-20T19:20:30+01:00; // Date | The date-time before the tasks ended. Related endpoint: `v1/serverDateTime` for date time format details
$completedAfterDate = 2013-10-20T19:20:30+01:00; // Date | The date-time after the tasks ended. Related endpoint: `v1/serverDateTime` for date time format details
$type = type_example; // String | The task type. Related endpoint `/v1/tasks/types`
$status = status_example; // String | The status of the task. Possible values are: `1 or InProgress` | `3 or Paused` | `4 or Failed` | `6 or Completed` | `7 or Cancelling`

try {
    $result = $api_instance->getTaskAll($startedBeforeDate, $startedAfterDate, $completedBeforeDate, $completedAfterDate, $type, $status);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TasksApi->getTaskAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TasksApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TasksApi->new();
my $startedBeforeDate = 2013-10-20T19:20:30+01:00; # Date | The date-time before the tasks started. Related endpoint: `v1/serverDateTime` for date time format details
my $startedAfterDate = 2013-10-20T19:20:30+01:00; # Date | The date-time after the tasks started. Related endpoint: `v1/serverDateTime` for date time format details
my $completedBeforeDate = 2013-10-20T19:20:30+01:00; # Date | The date-time before the tasks ended. Related endpoint: `v1/serverDateTime` for date time format details
my $completedAfterDate = 2013-10-20T19:20:30+01:00; # Date | The date-time after the tasks ended. Related endpoint: `v1/serverDateTime` for date time format details
my $type = type_example; # String | The task type. Related endpoint `/v1/tasks/types`
my $status = status_example; # String | The status of the task. Possible values are: `1 or InProgress` | `3 or Paused` | `4 or Failed` | `6 or Completed` | `7 or Cancelling`

eval { 
    my $result = $api_instance->getTaskAll(startedBeforeDate => $startedBeforeDate, startedAfterDate => $startedAfterDate, completedBeforeDate => $completedBeforeDate, completedAfterDate => $completedAfterDate, type => $type, status => $status);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TasksApi->getTaskAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.TasksApi()
startedBeforeDate = 2013-10-20T19:20:30+01:00 # Date | The date-time before the tasks started. Related endpoint: `v1/serverDateTime` for date time format details (optional)
startedAfterDate = 2013-10-20T19:20:30+01:00 # Date | The date-time after the tasks started. Related endpoint: `v1/serverDateTime` for date time format details (optional)
completedBeforeDate = 2013-10-20T19:20:30+01:00 # Date | The date-time before the tasks ended. Related endpoint: `v1/serverDateTime` for date time format details (optional)
completedAfterDate = 2013-10-20T19:20:30+01:00 # Date | The date-time after the tasks ended. Related endpoint: `v1/serverDateTime` for date time format details (optional)
type = type_example # String | The task type. Related endpoint `/v1/tasks/types` (optional)
status = status_example # String | The status of the task. Possible values are: `1 or InProgress` | `3 or Paused` | `4 or Failed` | `6 or Completed` | `7 or Cancelling` (optional)

try: 
    # Get information about tasks run on this site. (Auth)
    api_response = api_instance.get_task_all(startedBeforeDate=startedBeforeDate, startedAfterDate=startedAfterDate, completedBeforeDate=completedBeforeDate, completedAfterDate=completedAfterDate, type=type, status=status)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TasksApi->getTaskAll: %s\n" % e)

Parameters

Query parameters
Name Description
startedBeforeDate
Date (date-time)
The date-time before the tasks started. Related endpoint: `v1/serverDateTime` for date time format details
startedAfterDate
Date (date-time)
The date-time after the tasks started. Related endpoint: `v1/serverDateTime` for date time format details
completedBeforeDate
Date (date-time)
The date-time before the tasks ended. Related endpoint: `v1/serverDateTime` for date time format details
completedAfterDate
Date (date-time)
The date-time after the tasks ended. Related endpoint: `v1/serverDateTime` for date time format details
type
String
The task type. Related endpoint `/v1/tasks/types`
status
String
The status of the task. Possible values are: `1 or InProgress` | `3 or Paused` | `4 or Failed` | `6 or Completed` | `7 or Cancelling`

Responses

Status: 200 - Success

[
{
link:
{
rel:
string
href:
string
type:
string
identifier:
string
}
type:
string
status:
{
state:
integer (int32)
Enum: 0, 1, 2, 3, 4, 5, 6, 7
progress:
integer (int32)
}
initiatedBy:
string
started:
string (date-time)
completed:
string (date-time)
taskIdentifier:
string
completeReason:
string
isCancellable:
boolean
relatedEntities:
{
vpgs:
[
{
rel:
string
href:
string
type:
string
identifier:
string
}
]
sites:
[
{
rel:
string
href:
string
type:
string
identifier:
string
}
]
hosts:
[
{
rel:
string
href:
string
type:
string
identifier:
string
}
]
flrSessions:
[
{
rel:
string
href:
string
type:
string
identifier:
string
}
]
}
}
]

getTaskTypeAll

Get the list of acceptable values for task types. (Auth)


/v1/tasks/types

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/tasks/types"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TasksApi;

import java.io.File;
import java.util.*;

public class TasksApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        TasksApi apiInstance = new TasksApi();
        try {
            array['String'] result = apiInstance.getTaskTypeAll();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TasksApi#getTaskTypeAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TasksApi;

public class TasksApiExample {

    public static void main(String[] args) {
        TasksApi apiInstance = new TasksApi();
        try {
            array['String'] result = apiInstance.getTaskTypeAll();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TasksApi#getTaskTypeAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];

TasksApi *apiInstance = [[TasksApi alloc] init];

// Get the list of acceptable values for task types. (Auth)
[apiInstance getTaskTypeAllWithCompletionHandler: 
              ^(array['String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.TasksApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTaskTypeAll(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getTaskTypeAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new TasksApi();

            try
            {
                // Get the list of acceptable values for task types. (Auth)
                array['String'] result = apiInstance.getTaskTypeAll();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TasksApi.getTaskTypeAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiTasksApi();

try {
    $result = $api_instance->getTaskTypeAll();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TasksApi->getTaskTypeAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TasksApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TasksApi->new();

eval { 
    my $result = $api_instance->getTaskTypeAll();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TasksApi->getTaskTypeAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.TasksApi()

try: 
    # Get the list of acceptable values for task types. (Auth)
    api_response = api_instance.get_task_type_all()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TasksApi->getTaskTypeAll: %s\n" % e)

Parameters

Responses

Status: 200 - Success

[
string
]

VPGVirtualProtectionGroupSettings

copyVpgSetting

Create a new VPG settings object from an existing VPG, returns the settings object identifier (Auth)


/v1/vpgSettings/copyVpgSettings

Usage and SDK Samples

curl -X POST\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
-H "Content-Type: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgSettings/copyVpgSettings"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

import java.io.File;
import java.util.*;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        CopyVpgSettingsApi body = ; // CopyVpgSettingsApi | 
        try {
            'String' result = apiInstance.copyVpgSetting(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#copyVpgSetting");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        CopyVpgSettingsApi body = ; // CopyVpgSettingsApi | 
        try {
            'String' result = apiInstance.copyVpgSetting(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#copyVpgSetting");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
CopyVpgSettingsApi *body = ; //  (optional)

VPGVirtualProtectionGroupSettingsApi *apiInstance = [[VPGVirtualProtectionGroupSettingsApi alloc] init];

// Create a new VPG settings object from an existing VPG, returns the settings object identifier (Auth)
[apiInstance copyVpgSettingWith:body
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGVirtualProtectionGroupSettingsApi()
var opts = { 
  'body':  // {{CopyVpgSettingsApi}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.copyVpgSetting(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class copyVpgSettingExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGVirtualProtectionGroupSettingsApi();
            var body = new CopyVpgSettingsApi(); // CopyVpgSettingsApi |  (optional) 

            try
            {
                // Create a new VPG settings object from an existing VPG, returns the settings object identifier (Auth)
                'String' result = apiInstance.copyVpgSetting(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGVirtualProtectionGroupSettingsApi.copyVpgSetting: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGVirtualProtectionGroupSettingsApi();
$body = ; // CopyVpgSettingsApi | 

try {
    $result = $api_instance->copyVpgSetting($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VPGVirtualProtectionGroupSettingsApi->copyVpgSetting: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi->new();
my $body = WWW::SwaggerClient::Object::CopyVpgSettingsApi->new(); # CopyVpgSettingsApi | 

eval { 
    my $result = $api_instance->copyVpgSetting(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VPGVirtualProtectionGroupSettingsApi->copyVpgSetting: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGVirtualProtectionGroupSettingsApi()
body =  # CopyVpgSettingsApi |  (optional)

try: 
    # Create a new VPG settings object from an existing VPG, returns the settings object identifier (Auth)
    api_response = api_instance.copy_vpg_setting(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VPGVirtualProtectionGroupSettingsApi->copyVpgSetting: %s\n" % e)

Parameters

Body parameters
Name Description
body
{
vpgIdentifier:
string
}

Responses

Status: 200 - Success

string

deleteVpgSettingBootGroup

Delete Bootgroups VPG settings (Auth)


/v1/vpgSettings/{vpgSettingsIdentifier}/bootgroup

Usage and SDK Samples

curl -X DELETE\
-H "x-zerto-session: [[apiKey]]"\
"https://localhost:9669//v1/vpgSettings/{vpgSettingsIdentifier}/bootgroup"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

import java.io.File;
import java.util.*;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        try {
            apiInstance.deleteVpgSettingBootGroup(vpgSettingsIdentifier);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#deleteVpgSettingBootGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        try {
            apiInstance.deleteVpgSettingBootGroup(vpgSettingsIdentifier);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#deleteVpgSettingBootGroup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgSettingsIdentifier = vpgSettingsIdentifier_example; // Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

VPGVirtualProtectionGroupSettingsApi *apiInstance = [[VPGVirtualProtectionGroupSettingsApi alloc] init];

// Delete Bootgroups VPG settings (Auth)
[apiInstance deleteVpgSettingBootGroupWith:vpgSettingsIdentifier
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGVirtualProtectionGroupSettingsApi()
var vpgSettingsIdentifier = vpgSettingsIdentifier_example; // {{String}} Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteVpgSettingBootGroup(vpgSettingsIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteVpgSettingBootGroupExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGVirtualProtectionGroupSettingsApi();
            var vpgSettingsIdentifier = vpgSettingsIdentifier_example;  // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

            try
            {
                // Delete Bootgroups VPG settings (Auth)
                apiInstance.deleteVpgSettingBootGroup(vpgSettingsIdentifier);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGVirtualProtectionGroupSettingsApi.deleteVpgSettingBootGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGVirtualProtectionGroupSettingsApi();
$vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

try {
    $api_instance->deleteVpgSettingBootGroup($vpgSettingsIdentifier);
} catch (Exception $e) {
    echo 'Exception when calling VPGVirtualProtectionGroupSettingsApi->deleteVpgSettingBootGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi->new();
my $vpgSettingsIdentifier = vpgSettingsIdentifier_example; # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

eval { 
    $api_instance->deleteVpgSettingBootGroup(vpgSettingsIdentifier => $vpgSettingsIdentifier);
};
if ($@) {
    warn "Exception when calling VPGVirtualProtectionGroupSettingsApi->deleteVpgSettingBootGroup: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGVirtualProtectionGroupSettingsApi()
vpgSettingsIdentifier = vpgSettingsIdentifier_example # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

try: 
    # Delete Bootgroups VPG settings (Auth)
    api_instance.delete_vpg_setting_boot_group(vpgSettingsIdentifier)
except ApiException as e:
    print("Exception when calling VPGVirtualProtectionGroupSettingsApi->deleteVpgSettingBootGroup: %s\n" % e)

Parameters

Path parameters
Name Description
vpgSettingsIdentifier*
String
Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
Required

Responses

Status: 200 - Success


deleteVpgSettingScript

Delete Scripting VPG settings (Auth)


/v1/vpgSettings/{vpgSettingsIdentifier}/scripting

Usage and SDK Samples

curl -X DELETE\
-H "x-zerto-session: [[apiKey]]"\
"https://localhost:9669//v1/vpgSettings/{vpgSettingsIdentifier}/scripting"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

import java.io.File;
import java.util.*;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        try {
            apiInstance.deleteVpgSettingScript(vpgSettingsIdentifier);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#deleteVpgSettingScript");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        try {
            apiInstance.deleteVpgSettingScript(vpgSettingsIdentifier);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#deleteVpgSettingScript");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgSettingsIdentifier = vpgSettingsIdentifier_example; // Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

VPGVirtualProtectionGroupSettingsApi *apiInstance = [[VPGVirtualProtectionGroupSettingsApi alloc] init];

// Delete Scripting VPG settings (Auth)
[apiInstance deleteVpgSettingScriptWith:vpgSettingsIdentifier
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGVirtualProtectionGroupSettingsApi()
var vpgSettingsIdentifier = vpgSettingsIdentifier_example; // {{String}} Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteVpgSettingScript(vpgSettingsIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteVpgSettingScriptExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGVirtualProtectionGroupSettingsApi();
            var vpgSettingsIdentifier = vpgSettingsIdentifier_example;  // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

            try
            {
                // Delete Scripting VPG settings (Auth)
                apiInstance.deleteVpgSettingScript(vpgSettingsIdentifier);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGVirtualProtectionGroupSettingsApi.deleteVpgSettingScript: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGVirtualProtectionGroupSettingsApi();
$vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

try {
    $api_instance->deleteVpgSettingScript($vpgSettingsIdentifier);
} catch (Exception $e) {
    echo 'Exception when calling VPGVirtualProtectionGroupSettingsApi->deleteVpgSettingScript: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi->new();
my $vpgSettingsIdentifier = vpgSettingsIdentifier_example; # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

eval { 
    $api_instance->deleteVpgSettingScript(vpgSettingsIdentifier => $vpgSettingsIdentifier);
};
if ($@) {
    warn "Exception when calling VPGVirtualProtectionGroupSettingsApi->deleteVpgSettingScript: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGVirtualProtectionGroupSettingsApi()
vpgSettingsIdentifier = vpgSettingsIdentifier_example # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

try: 
    # Delete Scripting VPG settings (Auth)
    api_instance.delete_vpg_setting_script(vpgSettingsIdentifier)
except ApiException as e:
    print("Exception when calling VPGVirtualProtectionGroupSettingsApi->deleteVpgSettingScript: %s\n" % e)

Parameters

Path parameters
Name Description
vpgSettingsIdentifier*
String
Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
Required

Responses

Status: 200 - Success


editVpgSetting

Edit the VPG settings. (Auth)


/v1/vpgSettings/{vpgSettingsIdentifier}

Usage and SDK Samples

curl -X PUT\
-H "x-zerto-session: [[apiKey]]"\
-H "Content-Type: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgSettings/{vpgSettingsIdentifier}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

import java.io.File;
import java.util.*;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        VpgSettingsApi body = ; // VpgSettingsApi | 
        try {
            apiInstance.editVpgSetting(vpgSettingsIdentifier, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#editVpgSetting");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        VpgSettingsApi body = ; // VpgSettingsApi | 
        try {
            apiInstance.editVpgSetting(vpgSettingsIdentifier, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#editVpgSetting");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgSettingsIdentifier = vpgSettingsIdentifier_example; // Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
VpgSettingsApi *body = ; //  (optional)

VPGVirtualProtectionGroupSettingsApi *apiInstance = [[VPGVirtualProtectionGroupSettingsApi alloc] init];

// Edit the VPG settings. (Auth)
[apiInstance editVpgSettingWith:vpgSettingsIdentifier
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGVirtualProtectionGroupSettingsApi()
var vpgSettingsIdentifier = vpgSettingsIdentifier_example; // {{String}} Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
var opts = { 
  'body':  // {{VpgSettingsApi}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.editVpgSetting(vpgSettingsIdentifier, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editVpgSettingExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGVirtualProtectionGroupSettingsApi();
            var vpgSettingsIdentifier = vpgSettingsIdentifier_example;  // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
            var body = new VpgSettingsApi(); // VpgSettingsApi |  (optional) 

            try
            {
                // Edit the VPG settings. (Auth)
                apiInstance.editVpgSetting(vpgSettingsIdentifier, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGVirtualProtectionGroupSettingsApi.editVpgSetting: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGVirtualProtectionGroupSettingsApi();
$vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
$body = ; // VpgSettingsApi | 

try {
    $api_instance->editVpgSetting($vpgSettingsIdentifier, $body);
} catch (Exception $e) {
    echo 'Exception when calling VPGVirtualProtectionGroupSettingsApi->editVpgSetting: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi->new();
my $vpgSettingsIdentifier = vpgSettingsIdentifier_example; # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
my $body = WWW::SwaggerClient::Object::VpgSettingsApi->new(); # VpgSettingsApi | 

eval { 
    $api_instance->editVpgSetting(vpgSettingsIdentifier => $vpgSettingsIdentifier, body => $body);
};
if ($@) {
    warn "Exception when calling VPGVirtualProtectionGroupSettingsApi->editVpgSetting: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGVirtualProtectionGroupSettingsApi()
vpgSettingsIdentifier = vpgSettingsIdentifier_example # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
body =  # VpgSettingsApi |  (optional)

try: 
    # Edit the VPG settings. (Auth)
    api_instance.edit_vpg_setting(vpgSettingsIdentifier, body=body)
except ApiException as e:
    print("Exception when calling VPGVirtualProtectionGroupSettingsApi->editVpgSetting: %s\n" % e)

Parameters

Path parameters
Name Description
vpgSettingsIdentifier*
String
Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
Required
Body parameters
Name Description
body
{
vpgIdentifier:
string
vpgSettingsIdentifier:
string
basic:
{
zorgIdentifier:
name:
vpgType:
rpoInSeconds:
testIntervalInMinutes:
journalHistoryInHours:
priority:
useWanCompression:
serviceProfileIdentifier:
protectedSiteIdentifier:
recoverySiteIdentifier:
}
scripting:
{
preRecovery:
postRecovery:
postBackup:
}
bootGroups:
{
bootGroups:
}
journal:
{
limitation:
datastoreIdentifier:
}
longTermRetention:
{
enabled:
repositoryIdentifier:
retentionRunTime:
schedulerPolicy:
retry:
indexing:
compression:
}
recovery:
{
defaultHostIdentifier:
defaultHostClusterIdentifier:
defaultDatastoreIdentifier:
defaultDatastoreClusterIdentifier:
defaultFolderIdentifier:
resourcePoolIdentifier:
vcd:
publicCloud:
}
networks:
{
failover:
failoverTest:
}
vms:
[
{
vmIdentifier:
string
recovery:
{
hostIdentifier:
string
hostClusterIdentifier:
string
datastoreIdentifier:
string
datastoreClusterIdentifier:
string
folderIdentifier:
string
resourcePoolIdentifier:
string
vcd:
{
storagePolicyIdentifier:
string
}
publicCloud:
{
failover:
{
vmInstanceType:
string
azure:
{
recoveryDiskType:
string
}
virtualNetworkIdentifier:
string
}
failoverTest:
{
vmInstanceType:
string
azure:
{
recoveryDiskType:
string
}
virtualNetworkIdentifier:
string
}
}
useVmEncryption:
boolean
}
bootGroupIdentifier:
string
journal:
{
limitation:
{
hardLimitInMB:
integer (int32)
hardLimitInPercent:
integer (int32)
warningThresholdInMB:
integer (int32)
warningThresholdInPercent:
integer (int32)
}
datastoreIdentifier:
string
}
volumes:
[
{
volumeIdentifier:
string
vcd:
{
isThin:
boolean
}
preseed:
{
datastoreIdentifier:
string
path:
string
}
rdm:
{
deviceIdentifier:
string
isPhysical:
boolean
}
datastore:
{
datastoreClusterIdentifier:
string
datastoreIdentifier:
string
isThin:
boolean
}
isSwap:
boolean
}
]
nics:
[
{
nicIdentifier:
string
failoverTest:
{
hypervisor:
{
networkIdentifier:
string
shouldReplaceMacAddress:
boolean
dnsSuffix:
string
ipConfig:
{
staticIp:
string
subnetMask:
string
gateway:
string
primaryDns:
string
secondaryDns:
string
isDhcp:
boolean
}
}
vcd:
{
isResetMacAddress:
boolean
isPrimary:
boolean
isConnected:
boolean
ipMode:
string
ipAddress:
string
recoveryOrgVdcNetworkIdentifier:
string
}
publicCloud:
{
subnetIdentifier:
string
securityGroupIdentifier:
string
privateIP:
string
isPrimary:
boolean
}
}
failover:
{
hypervisor:
{
networkIdentifier:
string
shouldReplaceMacAddress:
boolean
dnsSuffix:
string
ipConfig:
{
staticIp:
string
subnetMask:
string
gateway:
string
primaryDns:
string
secondaryDns:
string
isDhcp:
boolean
}
}
vcd:
{
isResetMacAddress:
boolean
isPrimary:
boolean
isConnected:
boolean
ipMode:
string
ipAddress:
string
recoveryOrgVdcNetworkIdentifier:
string
}
publicCloud:
{
subnetIdentifier:
string
securityGroupIdentifier:
string
privateIP:
string
isPrimary:
boolean
}
}
}
]
}
]
protected:
{
vcd:
}
}

Responses

Status: 200 - Success


editVpgSettingBasic

Edit VPG settings with basic settings (Auth)


/v1/vpgSettings/{vpgSettingsIdentifier}/basic

Usage and SDK Samples

curl -X PUT\
-H "x-zerto-session: [[apiKey]]"\
-H "Content-Type: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgSettings/{vpgSettingsIdentifier}/basic"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

import java.io.File;
import java.util.*;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        VpgSettingsBasicApi body = ; // VpgSettingsBasicApi | 
        try {
            apiInstance.editVpgSettingBasic(vpgSettingsIdentifier, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#editVpgSettingBasic");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        VpgSettingsBasicApi body = ; // VpgSettingsBasicApi | 
        try {
            apiInstance.editVpgSettingBasic(vpgSettingsIdentifier, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#editVpgSettingBasic");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgSettingsIdentifier = vpgSettingsIdentifier_example; // Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
VpgSettingsBasicApi *body = ; //  (optional)

VPGVirtualProtectionGroupSettingsApi *apiInstance = [[VPGVirtualProtectionGroupSettingsApi alloc] init];

// Edit VPG settings with basic settings (Auth)
[apiInstance editVpgSettingBasicWith:vpgSettingsIdentifier
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGVirtualProtectionGroupSettingsApi()
var vpgSettingsIdentifier = vpgSettingsIdentifier_example; // {{String}} Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
var opts = { 
  'body':  // {{VpgSettingsBasicApi}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.editVpgSettingBasic(vpgSettingsIdentifier, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editVpgSettingBasicExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGVirtualProtectionGroupSettingsApi();
            var vpgSettingsIdentifier = vpgSettingsIdentifier_example;  // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
            var body = new VpgSettingsBasicApi(); // VpgSettingsBasicApi |  (optional) 

            try
            {
                // Edit VPG settings with basic settings (Auth)
                apiInstance.editVpgSettingBasic(vpgSettingsIdentifier, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGVirtualProtectionGroupSettingsApi.editVpgSettingBasic: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGVirtualProtectionGroupSettingsApi();
$vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
$body = ; // VpgSettingsBasicApi | 

try {
    $api_instance->editVpgSettingBasic($vpgSettingsIdentifier, $body);
} catch (Exception $e) {
    echo 'Exception when calling VPGVirtualProtectionGroupSettingsApi->editVpgSettingBasic: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi->new();
my $vpgSettingsIdentifier = vpgSettingsIdentifier_example; # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
my $body = WWW::SwaggerClient::Object::VpgSettingsBasicApi->new(); # VpgSettingsBasicApi | 

eval { 
    $api_instance->editVpgSettingBasic(vpgSettingsIdentifier => $vpgSettingsIdentifier, body => $body);
};
if ($@) {
    warn "Exception when calling VPGVirtualProtectionGroupSettingsApi->editVpgSettingBasic: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGVirtualProtectionGroupSettingsApi()
vpgSettingsIdentifier = vpgSettingsIdentifier_example # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
body =  # VpgSettingsBasicApi |  (optional)

try: 
    # Edit VPG settings with basic settings (Auth)
    api_instance.edit_vpg_setting_basic(vpgSettingsIdentifier, body=body)
except ApiException as e:
    print("Exception when calling VPGVirtualProtectionGroupSettingsApi->editVpgSettingBasic: %s\n" % e)

Parameters

Path parameters
Name Description
vpgSettingsIdentifier*
String
Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
Required
Body parameters
Name Description
body
{
zorgIdentifier:
string
name:
string
vpgType:
string
rpoInSeconds:
integer (int32)
testIntervalInMinutes:
integer (int32)
journalHistoryInHours:
integer (int32)
priority:
string
useWanCompression:
boolean
serviceProfileIdentifier:
string
protectedSiteIdentifier:
string
recoverySiteIdentifier:
string
}

Responses

Status: 200 - Success


editVpgSettingBasicBootGroup

Edit VPG settings with Bootgroups settings (Auth)


/v1/vpgSettings/{vpgSettingsIdentifier}/bootgroup

Usage and SDK Samples

curl -X PUT\
-H "x-zerto-session: [[apiKey]]"\
-H "Content-Type: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgSettings/{vpgSettingsIdentifier}/bootgroup"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

import java.io.File;
import java.util.*;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        VpgSettingsBootGroupsApi body = ; // VpgSettingsBootGroupsApi | 
        try {
            apiInstance.editVpgSettingBasicBootGroup(vpgSettingsIdentifier, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#editVpgSettingBasicBootGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        VpgSettingsBootGroupsApi body = ; // VpgSettingsBootGroupsApi | 
        try {
            apiInstance.editVpgSettingBasicBootGroup(vpgSettingsIdentifier, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#editVpgSettingBasicBootGroup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgSettingsIdentifier = vpgSettingsIdentifier_example; // Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
VpgSettingsBootGroupsApi *body = ; //  (optional)

VPGVirtualProtectionGroupSettingsApi *apiInstance = [[VPGVirtualProtectionGroupSettingsApi alloc] init];

// Edit VPG settings with Bootgroups settings (Auth)
[apiInstance editVpgSettingBasicBootGroupWith:vpgSettingsIdentifier
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGVirtualProtectionGroupSettingsApi()
var vpgSettingsIdentifier = vpgSettingsIdentifier_example; // {{String}} Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
var opts = { 
  'body':  // {{VpgSettingsBootGroupsApi}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.editVpgSettingBasicBootGroup(vpgSettingsIdentifier, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editVpgSettingBasicBootGroupExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGVirtualProtectionGroupSettingsApi();
            var vpgSettingsIdentifier = vpgSettingsIdentifier_example;  // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
            var body = new VpgSettingsBootGroupsApi(); // VpgSettingsBootGroupsApi |  (optional) 

            try
            {
                // Edit VPG settings with Bootgroups settings (Auth)
                apiInstance.editVpgSettingBasicBootGroup(vpgSettingsIdentifier, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGVirtualProtectionGroupSettingsApi.editVpgSettingBasicBootGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGVirtualProtectionGroupSettingsApi();
$vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
$body = ; // VpgSettingsBootGroupsApi | 

try {
    $api_instance->editVpgSettingBasicBootGroup($vpgSettingsIdentifier, $body);
} catch (Exception $e) {
    echo 'Exception when calling VPGVirtualProtectionGroupSettingsApi->editVpgSettingBasicBootGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi->new();
my $vpgSettingsIdentifier = vpgSettingsIdentifier_example; # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
my $body = WWW::SwaggerClient::Object::VpgSettingsBootGroupsApi->new(); # VpgSettingsBootGroupsApi | 

eval { 
    $api_instance->editVpgSettingBasicBootGroup(vpgSettingsIdentifier => $vpgSettingsIdentifier, body => $body);
};
if ($@) {
    warn "Exception when calling VPGVirtualProtectionGroupSettingsApi->editVpgSettingBasicBootGroup: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGVirtualProtectionGroupSettingsApi()
vpgSettingsIdentifier = vpgSettingsIdentifier_example # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
body =  # VpgSettingsBootGroupsApi |  (optional)

try: 
    # Edit VPG settings with Bootgroups settings (Auth)
    api_instance.edit_vpg_setting_basic_boot_group(vpgSettingsIdentifier, body=body)
except ApiException as e:
    print("Exception when calling VPGVirtualProtectionGroupSettingsApi->editVpgSettingBasicBootGroup: %s\n" % e)

Parameters

Path parameters
Name Description
vpgSettingsIdentifier*
String
Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
Required
Body parameters
Name Description
body
{
bootGroups:
[
{
bootGroupIdentifier:
string
name:
string
bootDelayInSeconds:
integer (int32)
}
]
}

Responses

Status: 200 - Success


editVpgSettingJournal

Update Journal VPG settings (Auth)


/v1/vpgSettings/{vpgSettingsIdentifier}/journal

Usage and SDK Samples

curl -X PUT\
-H "x-zerto-session: [[apiKey]]"\
-H "Content-Type: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgSettings/{vpgSettingsIdentifier}/journal"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

import java.io.File;
import java.util.*;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        VpgSettingsJournalApi body = ; // VpgSettingsJournalApi | 
        try {
            apiInstance.editVpgSettingJournal(vpgSettingsIdentifier, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#editVpgSettingJournal");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        VpgSettingsJournalApi body = ; // VpgSettingsJournalApi | 
        try {
            apiInstance.editVpgSettingJournal(vpgSettingsIdentifier, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#editVpgSettingJournal");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgSettingsIdentifier = vpgSettingsIdentifier_example; // Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
VpgSettingsJournalApi *body = ; //  (optional)

VPGVirtualProtectionGroupSettingsApi *apiInstance = [[VPGVirtualProtectionGroupSettingsApi alloc] init];

// Update Journal VPG settings (Auth)
[apiInstance editVpgSettingJournalWith:vpgSettingsIdentifier
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGVirtualProtectionGroupSettingsApi()
var vpgSettingsIdentifier = vpgSettingsIdentifier_example; // {{String}} Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
var opts = { 
  'body':  // {{VpgSettingsJournalApi}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.editVpgSettingJournal(vpgSettingsIdentifier, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editVpgSettingJournalExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGVirtualProtectionGroupSettingsApi();
            var vpgSettingsIdentifier = vpgSettingsIdentifier_example;  // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
            var body = new VpgSettingsJournalApi(); // VpgSettingsJournalApi |  (optional) 

            try
            {
                // Update Journal VPG settings (Auth)
                apiInstance.editVpgSettingJournal(vpgSettingsIdentifier, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGVirtualProtectionGroupSettingsApi.editVpgSettingJournal: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGVirtualProtectionGroupSettingsApi();
$vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
$body = ; // VpgSettingsJournalApi | 

try {
    $api_instance->editVpgSettingJournal($vpgSettingsIdentifier, $body);
} catch (Exception $e) {
    echo 'Exception when calling VPGVirtualProtectionGroupSettingsApi->editVpgSettingJournal: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi->new();
my $vpgSettingsIdentifier = vpgSettingsIdentifier_example; # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
my $body = WWW::SwaggerClient::Object::VpgSettingsJournalApi->new(); # VpgSettingsJournalApi | 

eval { 
    $api_instance->editVpgSettingJournal(vpgSettingsIdentifier => $vpgSettingsIdentifier, body => $body);
};
if ($@) {
    warn "Exception when calling VPGVirtualProtectionGroupSettingsApi->editVpgSettingJournal: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGVirtualProtectionGroupSettingsApi()
vpgSettingsIdentifier = vpgSettingsIdentifier_example # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
body =  # VpgSettingsJournalApi |  (optional)

try: 
    # Update Journal VPG settings (Auth)
    api_instance.edit_vpg_setting_journal(vpgSettingsIdentifier, body=body)
except ApiException as e:
    print("Exception when calling VPGVirtualProtectionGroupSettingsApi->editVpgSettingJournal: %s\n" % e)

Parameters

Path parameters
Name Description
vpgSettingsIdentifier*
String
Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
Required
Body parameters
Name Description
body
{
limitation:
{
hardLimitInMB:
hardLimitInPercent:
warningThresholdInMB:
warningThresholdInPercent:
}
datastoreIdentifier:
string
}

Responses

Status: 200 - Success


editVpgSettingLtr

Edit Long-term Retention VPG settings (Auth)


/v1/vpgSettings/{vpgSettingsIdentifier}/ltr

Usage and SDK Samples

curl -X PUT\
-H "x-zerto-session: [[apiKey]]"\
-H "Content-Type: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgSettings/{vpgSettingsIdentifier}/ltr"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

import java.io.File;
import java.util.*;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        VpgSettingsLtrApi body = ; // VpgSettingsLtrApi | 
        try {
            apiInstance.editVpgSettingLtr(vpgSettingsIdentifier, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#editVpgSettingLtr");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        VpgSettingsLtrApi body = ; // VpgSettingsLtrApi | 
        try {
            apiInstance.editVpgSettingLtr(vpgSettingsIdentifier, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#editVpgSettingLtr");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgSettingsIdentifier = vpgSettingsIdentifier_example; // Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
VpgSettingsLtrApi *body = ; //  (optional)

VPGVirtualProtectionGroupSettingsApi *apiInstance = [[VPGVirtualProtectionGroupSettingsApi alloc] init];

// Edit Long-term Retention VPG settings (Auth)
[apiInstance editVpgSettingLtrWith:vpgSettingsIdentifier
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGVirtualProtectionGroupSettingsApi()
var vpgSettingsIdentifier = vpgSettingsIdentifier_example; // {{String}} Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
var opts = { 
  'body':  // {{VpgSettingsLtrApi}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.editVpgSettingLtr(vpgSettingsIdentifier, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editVpgSettingLtrExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGVirtualProtectionGroupSettingsApi();
            var vpgSettingsIdentifier = vpgSettingsIdentifier_example;  // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
            var body = new VpgSettingsLtrApi(); // VpgSettingsLtrApi |  (optional) 

            try
            {
                // Edit Long-term Retention VPG settings (Auth)
                apiInstance.editVpgSettingLtr(vpgSettingsIdentifier, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGVirtualProtectionGroupSettingsApi.editVpgSettingLtr: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGVirtualProtectionGroupSettingsApi();
$vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
$body = ; // VpgSettingsLtrApi | 

try {
    $api_instance->editVpgSettingLtr($vpgSettingsIdentifier, $body);
} catch (Exception $e) {
    echo 'Exception when calling VPGVirtualProtectionGroupSettingsApi->editVpgSettingLtr: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi->new();
my $vpgSettingsIdentifier = vpgSettingsIdentifier_example; # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
my $body = WWW::SwaggerClient::Object::VpgSettingsLtrApi->new(); # VpgSettingsLtrApi | 

eval { 
    $api_instance->editVpgSettingLtr(vpgSettingsIdentifier => $vpgSettingsIdentifier, body => $body);
};
if ($@) {
    warn "Exception when calling VPGVirtualProtectionGroupSettingsApi->editVpgSettingLtr: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGVirtualProtectionGroupSettingsApi()
vpgSettingsIdentifier = vpgSettingsIdentifier_example # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
body =  # VpgSettingsLtrApi |  (optional)

try: 
    # Edit Long-term Retention VPG settings (Auth)
    api_instance.edit_vpg_setting_ltr(vpgSettingsIdentifier, body=body)
except ApiException as e:
    print("Exception when calling VPGVirtualProtectionGroupSettingsApi->editVpgSettingLtr: %s\n" % e)

Parameters

Path parameters
Name Description
vpgSettingsIdentifier*
String
Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
Required
Body parameters
Name Description
body
{
enabled:
boolean
repositoryIdentifier:
string
retentionRunTime:
string
schedulerPolicy:
{
daily:
weekly:
monthly:
yearly:
}
retry:
{
enabled:
number:
intervalInMinutes:
}
indexing:
{
vms:
}
compression:
string
}

Responses

Status: 200 - Success


editVpgSettingLtrNetwork

Update Network VPG settings (Auth)


/v1/vpgSettings/{vpgSettingsIdentifier}/networks

Usage and SDK Samples

curl -X PUT\
-H "x-zerto-session: [[apiKey]]"\
-H "Content-Type: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgSettings/{vpgSettingsIdentifier}/networks"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

import java.io.File;
import java.util.*;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        VpgSettingsNetworksApi body = ; // VpgSettingsNetworksApi | 
        try {
            apiInstance.editVpgSettingLtrNetwork(vpgSettingsIdentifier, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#editVpgSettingLtrNetwork");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        VpgSettingsNetworksApi body = ; // VpgSettingsNetworksApi | 
        try {
            apiInstance.editVpgSettingLtrNetwork(vpgSettingsIdentifier, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#editVpgSettingLtrNetwork");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgSettingsIdentifier = vpgSettingsIdentifier_example; // Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
VpgSettingsNetworksApi *body = ; //  (optional)

VPGVirtualProtectionGroupSettingsApi *apiInstance = [[VPGVirtualProtectionGroupSettingsApi alloc] init];

// Update Network VPG settings (Auth)
[apiInstance editVpgSettingLtrNetworkWith:vpgSettingsIdentifier
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGVirtualProtectionGroupSettingsApi()
var vpgSettingsIdentifier = vpgSettingsIdentifier_example; // {{String}} Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
var opts = { 
  'body':  // {{VpgSettingsNetworksApi}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.editVpgSettingLtrNetwork(vpgSettingsIdentifier, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editVpgSettingLtrNetworkExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGVirtualProtectionGroupSettingsApi();
            var vpgSettingsIdentifier = vpgSettingsIdentifier_example;  // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
            var body = new VpgSettingsNetworksApi(); // VpgSettingsNetworksApi |  (optional) 

            try
            {
                // Update Network VPG settings (Auth)
                apiInstance.editVpgSettingLtrNetwork(vpgSettingsIdentifier, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGVirtualProtectionGroupSettingsApi.editVpgSettingLtrNetwork: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGVirtualProtectionGroupSettingsApi();
$vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
$body = ; // VpgSettingsNetworksApi | 

try {
    $api_instance->editVpgSettingLtrNetwork($vpgSettingsIdentifier, $body);
} catch (Exception $e) {
    echo 'Exception when calling VPGVirtualProtectionGroupSettingsApi->editVpgSettingLtrNetwork: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi->new();
my $vpgSettingsIdentifier = vpgSettingsIdentifier_example; # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
my $body = WWW::SwaggerClient::Object::VpgSettingsNetworksApi->new(); # VpgSettingsNetworksApi | 

eval { 
    $api_instance->editVpgSettingLtrNetwork(vpgSettingsIdentifier => $vpgSettingsIdentifier, body => $body);
};
if ($@) {
    warn "Exception when calling VPGVirtualProtectionGroupSettingsApi->editVpgSettingLtrNetwork: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGVirtualProtectionGroupSettingsApi()
vpgSettingsIdentifier = vpgSettingsIdentifier_example # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
body =  # VpgSettingsNetworksApi |  (optional)

try: 
    # Update Network VPG settings (Auth)
    api_instance.edit_vpg_setting_ltr_network(vpgSettingsIdentifier, body=body)
except ApiException as e:
    print("Exception when calling VPGVirtualProtectionGroupSettingsApi->editVpgSettingLtrNetwork: %s\n" % e)

Parameters

Path parameters
Name Description
vpgSettingsIdentifier*
String
Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
Required
Body parameters
Name Description
body
{
failover:
{
vcd:
hypervisor:
publicCloud:
}
failoverTest:
{
vcd:
hypervisor:
publicCloud:
}
}

Responses

Status: 200 - Success


editVpgSettingRecovery

Update Recovery VPG settings (Auth)


/v1/vpgSettings/{vpgSettingsIdentifier}/recovery

Usage and SDK Samples

curl -X PUT\
-H "x-zerto-session: [[apiKey]]"\
-H "Content-Type: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgSettings/{vpgSettingsIdentifier}/recovery"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

import java.io.File;
import java.util.*;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        VpgSettingsRecoveryApi body = ; // VpgSettingsRecoveryApi | 
        try {
            apiInstance.editVpgSettingRecovery(vpgSettingsIdentifier, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#editVpgSettingRecovery");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        VpgSettingsRecoveryApi body = ; // VpgSettingsRecoveryApi | 
        try {
            apiInstance.editVpgSettingRecovery(vpgSettingsIdentifier, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#editVpgSettingRecovery");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgSettingsIdentifier = vpgSettingsIdentifier_example; // Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
VpgSettingsRecoveryApi *body = ; //  (optional)

VPGVirtualProtectionGroupSettingsApi *apiInstance = [[VPGVirtualProtectionGroupSettingsApi alloc] init];

// Update Recovery VPG settings (Auth)
[apiInstance editVpgSettingRecoveryWith:vpgSettingsIdentifier
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGVirtualProtectionGroupSettingsApi()
var vpgSettingsIdentifier = vpgSettingsIdentifier_example; // {{String}} Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
var opts = { 
  'body':  // {{VpgSettingsRecoveryApi}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.editVpgSettingRecovery(vpgSettingsIdentifier, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editVpgSettingRecoveryExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGVirtualProtectionGroupSettingsApi();
            var vpgSettingsIdentifier = vpgSettingsIdentifier_example;  // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
            var body = new VpgSettingsRecoveryApi(); // VpgSettingsRecoveryApi |  (optional) 

            try
            {
                // Update Recovery VPG settings (Auth)
                apiInstance.editVpgSettingRecovery(vpgSettingsIdentifier, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGVirtualProtectionGroupSettingsApi.editVpgSettingRecovery: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGVirtualProtectionGroupSettingsApi();
$vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
$body = ; // VpgSettingsRecoveryApi | 

try {
    $api_instance->editVpgSettingRecovery($vpgSettingsIdentifier, $body);
} catch (Exception $e) {
    echo 'Exception when calling VPGVirtualProtectionGroupSettingsApi->editVpgSettingRecovery: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi->new();
my $vpgSettingsIdentifier = vpgSettingsIdentifier_example; # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
my $body = WWW::SwaggerClient::Object::VpgSettingsRecoveryApi->new(); # VpgSettingsRecoveryApi | 

eval { 
    $api_instance->editVpgSettingRecovery(vpgSettingsIdentifier => $vpgSettingsIdentifier, body => $body);
};
if ($@) {
    warn "Exception when calling VPGVirtualProtectionGroupSettingsApi->editVpgSettingRecovery: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGVirtualProtectionGroupSettingsApi()
vpgSettingsIdentifier = vpgSettingsIdentifier_example # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
body =  # VpgSettingsRecoveryApi |  (optional)

try: 
    # Update Recovery VPG settings (Auth)
    api_instance.edit_vpg_setting_recovery(vpgSettingsIdentifier, body=body)
except ApiException as e:
    print("Exception when calling VPGVirtualProtectionGroupSettingsApi->editVpgSettingRecovery: %s\n" % e)

Parameters

Path parameters
Name Description
vpgSettingsIdentifier*
String
Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
Required
Body parameters
Name Description
body
{
defaultHostIdentifier:
string
defaultHostClusterIdentifier:
string
defaultDatastoreIdentifier:
string
defaultDatastoreClusterIdentifier:
string
defaultFolderIdentifier:
string
resourcePoolIdentifier:
string
vcd:
{
orgVdcIdentifier:
}
publicCloud:
{
failover:
failoverTest:
}
}

Responses

Status: 200 - Success


editVpgSettingScript

Update Scripting VPG settings (Auth)


/v1/vpgSettings/{vpgSettingsIdentifier}/scripting

Usage and SDK Samples

curl -X PUT\
-H "x-zerto-session: [[apiKey]]"\
-H "Content-Type: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgSettings/{vpgSettingsIdentifier}/scripting"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

import java.io.File;
import java.util.*;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        VpgSettingsScriptsApi body = ; // VpgSettingsScriptsApi | 
        try {
            apiInstance.editVpgSettingScript(vpgSettingsIdentifier, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#editVpgSettingScript");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        VpgSettingsScriptsApi body = ; // VpgSettingsScriptsApi | 
        try {
            apiInstance.editVpgSettingScript(vpgSettingsIdentifier, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#editVpgSettingScript");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgSettingsIdentifier = vpgSettingsIdentifier_example; // Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
VpgSettingsScriptsApi *body = ; //  (optional)

VPGVirtualProtectionGroupSettingsApi *apiInstance = [[VPGVirtualProtectionGroupSettingsApi alloc] init];

// Update Scripting VPG settings (Auth)
[apiInstance editVpgSettingScriptWith:vpgSettingsIdentifier
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGVirtualProtectionGroupSettingsApi()
var vpgSettingsIdentifier = vpgSettingsIdentifier_example; // {{String}} Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
var opts = { 
  'body':  // {{VpgSettingsScriptsApi}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.editVpgSettingScript(vpgSettingsIdentifier, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editVpgSettingScriptExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGVirtualProtectionGroupSettingsApi();
            var vpgSettingsIdentifier = vpgSettingsIdentifier_example;  // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
            var body = new VpgSettingsScriptsApi(); // VpgSettingsScriptsApi |  (optional) 

            try
            {
                // Update Scripting VPG settings (Auth)
                apiInstance.editVpgSettingScript(vpgSettingsIdentifier, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGVirtualProtectionGroupSettingsApi.editVpgSettingScript: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGVirtualProtectionGroupSettingsApi();
$vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
$body = ; // VpgSettingsScriptsApi | 

try {
    $api_instance->editVpgSettingScript($vpgSettingsIdentifier, $body);
} catch (Exception $e) {
    echo 'Exception when calling VPGVirtualProtectionGroupSettingsApi->editVpgSettingScript: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi->new();
my $vpgSettingsIdentifier = vpgSettingsIdentifier_example; # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
my $body = WWW::SwaggerClient::Object::VpgSettingsScriptsApi->new(); # VpgSettingsScriptsApi | 

eval { 
    $api_instance->editVpgSettingScript(vpgSettingsIdentifier => $vpgSettingsIdentifier, body => $body);
};
if ($@) {
    warn "Exception when calling VPGVirtualProtectionGroupSettingsApi->editVpgSettingScript: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGVirtualProtectionGroupSettingsApi()
vpgSettingsIdentifier = vpgSettingsIdentifier_example # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
body =  # VpgSettingsScriptsApi |  (optional)

try: 
    # Update Scripting VPG settings (Auth)
    api_instance.edit_vpg_setting_script(vpgSettingsIdentifier, body=body)
except ApiException as e:
    print("Exception when calling VPGVirtualProtectionGroupSettingsApi->editVpgSettingScript: %s\n" % e)

Parameters

Path parameters
Name Description
vpgSettingsIdentifier*
String
Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
Required
Body parameters
Name Description
body
{
preRecovery:
{
command:
parameters:
timeoutInSeconds:
}
postRecovery:
{
command:
parameters:
timeoutInSeconds:
}
postBackup:
{
command:
parameters:
timeoutInSeconds:
}
}

Responses

Status: 200 - Success


editVpgSettingVm

Edit the VPG settings of a single VM (Auth)


/v1/vpgSettings/{vpgSettingsIdentifier}/vms/{vmIdentifier}

Usage and SDK Samples

curl -X PUT\
-H "x-zerto-session: [[apiKey]]"\
-H "Content-Type: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgSettings/{vpgSettingsIdentifier}/vms/{vmIdentifier}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

import java.io.File;
import java.util.*;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        String vmIdentifier = vmIdentifier_example; // String | Vm Identifier.Related endpoint: `v1/vms`
        VpgSettingsVmApi body = ; // VpgSettingsVmApi | 
        try {
            apiInstance.editVpgSettingVm(vpgSettingsIdentifier, vmIdentifier, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#editVpgSettingVm");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        String vmIdentifier = vmIdentifier_example; // String | Vm Identifier.Related endpoint: `v1/vms`
        VpgSettingsVmApi body = ; // VpgSettingsVmApi | 
        try {
            apiInstance.editVpgSettingVm(vpgSettingsIdentifier, vmIdentifier, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#editVpgSettingVm");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgSettingsIdentifier = vpgSettingsIdentifier_example; // Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
String *vmIdentifier = vmIdentifier_example; // Vm Identifier.Related endpoint: `v1/vms`
VpgSettingsVmApi *body = ; //  (optional)

VPGVirtualProtectionGroupSettingsApi *apiInstance = [[VPGVirtualProtectionGroupSettingsApi alloc] init];

// Edit the VPG settings of a single VM (Auth)
[apiInstance editVpgSettingVmWith:vpgSettingsIdentifier
    vmIdentifier:vmIdentifier
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGVirtualProtectionGroupSettingsApi()
var vpgSettingsIdentifier = vpgSettingsIdentifier_example; // {{String}} Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
var vmIdentifier = vmIdentifier_example; // {{String}} Vm Identifier.Related endpoint: `v1/vms`
var opts = { 
  'body':  // {{VpgSettingsVmApi}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.editVpgSettingVm(vpgSettingsIdentifiervmIdentifier, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editVpgSettingVmExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGVirtualProtectionGroupSettingsApi();
            var vpgSettingsIdentifier = vpgSettingsIdentifier_example;  // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
            var vmIdentifier = vmIdentifier_example;  // String | Vm Identifier.Related endpoint: `v1/vms`
            var body = new VpgSettingsVmApi(); // VpgSettingsVmApi |  (optional) 

            try
            {
                // Edit the VPG settings of a single VM (Auth)
                apiInstance.editVpgSettingVm(vpgSettingsIdentifier, vmIdentifier, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGVirtualProtectionGroupSettingsApi.editVpgSettingVm: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGVirtualProtectionGroupSettingsApi();
$vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
$vmIdentifier = vmIdentifier_example; // String | Vm Identifier.Related endpoint: `v1/vms`
$body = ; // VpgSettingsVmApi | 

try {
    $api_instance->editVpgSettingVm($vpgSettingsIdentifier, $vmIdentifier, $body);
} catch (Exception $e) {
    echo 'Exception when calling VPGVirtualProtectionGroupSettingsApi->editVpgSettingVm: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi->new();
my $vpgSettingsIdentifier = vpgSettingsIdentifier_example; # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
my $vmIdentifier = vmIdentifier_example; # String | Vm Identifier.Related endpoint: `v1/vms`
my $body = WWW::SwaggerClient::Object::VpgSettingsVmApi->new(); # VpgSettingsVmApi | 

eval { 
    $api_instance->editVpgSettingVm(vpgSettingsIdentifier => $vpgSettingsIdentifier, vmIdentifier => $vmIdentifier, body => $body);
};
if ($@) {
    warn "Exception when calling VPGVirtualProtectionGroupSettingsApi->editVpgSettingVm: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGVirtualProtectionGroupSettingsApi()
vpgSettingsIdentifier = vpgSettingsIdentifier_example # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
vmIdentifier = vmIdentifier_example # String | Vm Identifier.Related endpoint: `v1/vms`
body =  # VpgSettingsVmApi |  (optional)

try: 
    # Edit the VPG settings of a single VM (Auth)
    api_instance.edit_vpg_setting_vm(vpgSettingsIdentifier, vmIdentifier, body=body)
except ApiException as e:
    print("Exception when calling VPGVirtualProtectionGroupSettingsApi->editVpgSettingVm: %s\n" % e)

Parameters

Path parameters
Name Description
vpgSettingsIdentifier*
String
Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
Required
vmIdentifier*
String
Vm Identifier.Related endpoint: `v1/vms`
Required
Body parameters
Name Description
body
{
vmIdentifier:
string
recovery:
{
hostIdentifier:
hostClusterIdentifier:
datastoreIdentifier:
datastoreClusterIdentifier:
folderIdentifier:
resourcePoolIdentifier:
vcd:
publicCloud:
useVmEncryption:
}
bootGroupIdentifier:
string
journal:
{
limitation:
datastoreIdentifier:
}
volumes:
[
{
volumeIdentifier:
string
vcd:
{
isThin:
boolean
}
preseed:
{
datastoreIdentifier:
string
path:
string
}
rdm:
{
deviceIdentifier:
string
isPhysical:
boolean
}
datastore:
{
datastoreClusterIdentifier:
string
datastoreIdentifier:
string
isThin:
boolean
}
isSwap:
boolean
}
]
nics:
[
{
nicIdentifier:
string
failoverTest:
{
hypervisor:
{
networkIdentifier:
string
shouldReplaceMacAddress:
boolean
dnsSuffix:
string
ipConfig:
{
staticIp:
string
subnetMask:
string
gateway:
string
primaryDns:
string
secondaryDns:
string
isDhcp:
boolean
}
}
vcd:
{
isResetMacAddress:
boolean
isPrimary:
boolean
isConnected:
boolean
ipMode:
string
ipAddress:
string
recoveryOrgVdcNetworkIdentifier:
string
}
publicCloud:
{
subnetIdentifier:
string
securityGroupIdentifier:
string
privateIP:
string
isPrimary:
boolean
}
}
failover:
{
hypervisor:
{
networkIdentifier:
string
shouldReplaceMacAddress:
boolean
dnsSuffix:
string
ipConfig:
{
staticIp:
string
subnetMask:
string
gateway:
string
primaryDns:
string
secondaryDns:
string
isDhcp:
boolean
}
}
vcd:
{
isResetMacAddress:
boolean
isPrimary:
boolean
isConnected:
boolean
ipMode:
string
ipAddress:
string
recoveryOrgVdcNetworkIdentifier:
string
}
publicCloud:
{
subnetIdentifier:
string
securityGroupIdentifier:
string
privateIP:
string
isPrimary:
boolean
}
}
}
]
}

Responses

Status: 200 - Success


editVpgSettingVmNic

Edit NICs details of specific VM in VPG settings (Auth)


/v1/vpgSettings/{vpgSettingsIdentifier}/vms/{vmIdentifier}/nics/{nicIdentifier}

Usage and SDK Samples

curl -X PUT\
-H "x-zerto-session: [[apiKey]]"\
-H "Content-Type: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgSettings/{vpgSettingsIdentifier}/vms/{vmIdentifier}/nics/{nicIdentifier}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

import java.io.File;
import java.util.*;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        String vmIdentifier = vmIdentifier_example; // String | Vm Identifier.Related endpoint: `v1/vms`
        String nicIdentifier = nicIdentifier_example; // String | 
        VpgSettingsVmNicApi body = ; // VpgSettingsVmNicApi | 
        try {
            apiInstance.editVpgSettingVmNic(vpgSettingsIdentifier, vmIdentifier, nicIdentifier, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#editVpgSettingVmNic");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        String vmIdentifier = vmIdentifier_example; // String | Vm Identifier.Related endpoint: `v1/vms`
        String nicIdentifier = nicIdentifier_example; // String | 
        VpgSettingsVmNicApi body = ; // VpgSettingsVmNicApi | 
        try {
            apiInstance.editVpgSettingVmNic(vpgSettingsIdentifier, vmIdentifier, nicIdentifier, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#editVpgSettingVmNic");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgSettingsIdentifier = vpgSettingsIdentifier_example; // Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
String *vmIdentifier = vmIdentifier_example; // Vm Identifier.Related endpoint: `v1/vms`
String *nicIdentifier = nicIdentifier_example; // 
VpgSettingsVmNicApi *body = ; //  (optional)

VPGVirtualProtectionGroupSettingsApi *apiInstance = [[VPGVirtualProtectionGroupSettingsApi alloc] init];

// Edit NICs details of specific VM in VPG settings (Auth)
[apiInstance editVpgSettingVmNicWith:vpgSettingsIdentifier
    vmIdentifier:vmIdentifier
    nicIdentifier:nicIdentifier
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGVirtualProtectionGroupSettingsApi()
var vpgSettingsIdentifier = vpgSettingsIdentifier_example; // {{String}} Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
var vmIdentifier = vmIdentifier_example; // {{String}} Vm Identifier.Related endpoint: `v1/vms`
var nicIdentifier = nicIdentifier_example; // {{String}} 
var opts = { 
  'body':  // {{VpgSettingsVmNicApi}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.editVpgSettingVmNic(vpgSettingsIdentifiervmIdentifiernicIdentifier, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editVpgSettingVmNicExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGVirtualProtectionGroupSettingsApi();
            var vpgSettingsIdentifier = vpgSettingsIdentifier_example;  // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
            var vmIdentifier = vmIdentifier_example;  // String | Vm Identifier.Related endpoint: `v1/vms`
            var nicIdentifier = nicIdentifier_example;  // String | 
            var body = new VpgSettingsVmNicApi(); // VpgSettingsVmNicApi |  (optional) 

            try
            {
                // Edit NICs details of specific VM in VPG settings (Auth)
                apiInstance.editVpgSettingVmNic(vpgSettingsIdentifier, vmIdentifier, nicIdentifier, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGVirtualProtectionGroupSettingsApi.editVpgSettingVmNic: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGVirtualProtectionGroupSettingsApi();
$vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
$vmIdentifier = vmIdentifier_example; // String | Vm Identifier.Related endpoint: `v1/vms`
$nicIdentifier = nicIdentifier_example; // String | 
$body = ; // VpgSettingsVmNicApi | 

try {
    $api_instance->editVpgSettingVmNic($vpgSettingsIdentifier, $vmIdentifier, $nicIdentifier, $body);
} catch (Exception $e) {
    echo 'Exception when calling VPGVirtualProtectionGroupSettingsApi->editVpgSettingVmNic: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi->new();
my $vpgSettingsIdentifier = vpgSettingsIdentifier_example; # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
my $vmIdentifier = vmIdentifier_example; # String | Vm Identifier.Related endpoint: `v1/vms`
my $nicIdentifier = nicIdentifier_example; # String | 
my $body = WWW::SwaggerClient::Object::VpgSettingsVmNicApi->new(); # VpgSettingsVmNicApi | 

eval { 
    $api_instance->editVpgSettingVmNic(vpgSettingsIdentifier => $vpgSettingsIdentifier, vmIdentifier => $vmIdentifier, nicIdentifier => $nicIdentifier, body => $body);
};
if ($@) {
    warn "Exception when calling VPGVirtualProtectionGroupSettingsApi->editVpgSettingVmNic: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGVirtualProtectionGroupSettingsApi()
vpgSettingsIdentifier = vpgSettingsIdentifier_example # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
vmIdentifier = vmIdentifier_example # String | Vm Identifier.Related endpoint: `v1/vms`
nicIdentifier = nicIdentifier_example # String | 
body =  # VpgSettingsVmNicApi |  (optional)

try: 
    # Edit NICs details of specific VM in VPG settings (Auth)
    api_instance.edit_vpg_setting_vm_nic(vpgSettingsIdentifier, vmIdentifier, nicIdentifier, body=body)
except ApiException as e:
    print("Exception when calling VPGVirtualProtectionGroupSettingsApi->editVpgSettingVmNic: %s\n" % e)

Parameters

Path parameters
Name Description
vpgSettingsIdentifier*
String
Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
Required
vmIdentifier*
String
Vm Identifier.Related endpoint: `v1/vms`
Required
nicIdentifier*
String
Required
Body parameters
Name Description
body
{
nicIdentifier:
string
failoverTest:
{
hypervisor:
vcd:
publicCloud:
}
failover:
{
hypervisor:
vcd:
publicCloud:
}
}

Responses

Status: 200 - Success


editVpgSettingVmVolume

Update Volume details of specific VM in VPG settings (Auth)


/v1/vpgSettings/{vpgSettingsIdentifier}/vms/{vmIdentifier}/volumes/{volumeIdentifier}

Usage and SDK Samples

curl -X PUT\
-H "x-zerto-session: [[apiKey]]"\
-H "Content-Type: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgSettings/{vpgSettingsIdentifier}/vms/{vmIdentifier}/volumes/{volumeIdentifier}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

import java.io.File;
import java.util.*;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        String vmIdentifier = vmIdentifier_example; // String | Vm Identifier.Related endpoint: `v1/vms`
        String volumeIdentifier = volumeIdentifier_example; // String | Volume Identifier. Related endpoint: `Get: v1/volumes`
        VpgSettingsVmVolumeApi body = ; // VpgSettingsVmVolumeApi | 
        try {
            apiInstance.editVpgSettingVmVolume(vpgSettingsIdentifier, vmIdentifier, volumeIdentifier, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#editVpgSettingVmVolume");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        String vmIdentifier = vmIdentifier_example; // String | Vm Identifier.Related endpoint: `v1/vms`
        String volumeIdentifier = volumeIdentifier_example; // String | Volume Identifier. Related endpoint: `Get: v1/volumes`
        VpgSettingsVmVolumeApi body = ; // VpgSettingsVmVolumeApi | 
        try {
            apiInstance.editVpgSettingVmVolume(vpgSettingsIdentifier, vmIdentifier, volumeIdentifier, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#editVpgSettingVmVolume");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgSettingsIdentifier = vpgSettingsIdentifier_example; // Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
String *vmIdentifier = vmIdentifier_example; // Vm Identifier.Related endpoint: `v1/vms`
String *volumeIdentifier = volumeIdentifier_example; // Volume Identifier. Related endpoint: `Get: v1/volumes`
VpgSettingsVmVolumeApi *body = ; //  (optional)

VPGVirtualProtectionGroupSettingsApi *apiInstance = [[VPGVirtualProtectionGroupSettingsApi alloc] init];

// Update Volume details of specific VM in VPG settings (Auth)
[apiInstance editVpgSettingVmVolumeWith:vpgSettingsIdentifier
    vmIdentifier:vmIdentifier
    volumeIdentifier:volumeIdentifier
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGVirtualProtectionGroupSettingsApi()
var vpgSettingsIdentifier = vpgSettingsIdentifier_example; // {{String}} Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
var vmIdentifier = vmIdentifier_example; // {{String}} Vm Identifier.Related endpoint: `v1/vms`
var volumeIdentifier = volumeIdentifier_example; // {{String}} Volume Identifier. Related endpoint: `Get: v1/volumes`
var opts = { 
  'body':  // {{VpgSettingsVmVolumeApi}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.editVpgSettingVmVolume(vpgSettingsIdentifiervmIdentifiervolumeIdentifier, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editVpgSettingVmVolumeExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGVirtualProtectionGroupSettingsApi();
            var vpgSettingsIdentifier = vpgSettingsIdentifier_example;  // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
            var vmIdentifier = vmIdentifier_example;  // String | Vm Identifier.Related endpoint: `v1/vms`
            var volumeIdentifier = volumeIdentifier_example;  // String | Volume Identifier. Related endpoint: `Get: v1/volumes`
            var body = new VpgSettingsVmVolumeApi(); // VpgSettingsVmVolumeApi |  (optional) 

            try
            {
                // Update Volume details of specific VM in VPG settings (Auth)
                apiInstance.editVpgSettingVmVolume(vpgSettingsIdentifier, vmIdentifier, volumeIdentifier, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGVirtualProtectionGroupSettingsApi.editVpgSettingVmVolume: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGVirtualProtectionGroupSettingsApi();
$vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
$vmIdentifier = vmIdentifier_example; // String | Vm Identifier.Related endpoint: `v1/vms`
$volumeIdentifier = volumeIdentifier_example; // String | Volume Identifier. Related endpoint: `Get: v1/volumes`
$body = ; // VpgSettingsVmVolumeApi | 

try {
    $api_instance->editVpgSettingVmVolume($vpgSettingsIdentifier, $vmIdentifier, $volumeIdentifier, $body);
} catch (Exception $e) {
    echo 'Exception when calling VPGVirtualProtectionGroupSettingsApi->editVpgSettingVmVolume: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi->new();
my $vpgSettingsIdentifier = vpgSettingsIdentifier_example; # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
my $vmIdentifier = vmIdentifier_example; # String | Vm Identifier.Related endpoint: `v1/vms`
my $volumeIdentifier = volumeIdentifier_example; # String | Volume Identifier. Related endpoint: `Get: v1/volumes`
my $body = WWW::SwaggerClient::Object::VpgSettingsVmVolumeApi->new(); # VpgSettingsVmVolumeApi | 

eval { 
    $api_instance->editVpgSettingVmVolume(vpgSettingsIdentifier => $vpgSettingsIdentifier, vmIdentifier => $vmIdentifier, volumeIdentifier => $volumeIdentifier, body => $body);
};
if ($@) {
    warn "Exception when calling VPGVirtualProtectionGroupSettingsApi->editVpgSettingVmVolume: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGVirtualProtectionGroupSettingsApi()
vpgSettingsIdentifier = vpgSettingsIdentifier_example # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
vmIdentifier = vmIdentifier_example # String | Vm Identifier.Related endpoint: `v1/vms`
volumeIdentifier = volumeIdentifier_example # String | Volume Identifier. Related endpoint: `Get: v1/volumes`
body =  # VpgSettingsVmVolumeApi |  (optional)

try: 
    # Update Volume details of specific VM in VPG settings (Auth)
    api_instance.edit_vpg_setting_vm_volume(vpgSettingsIdentifier, vmIdentifier, volumeIdentifier, body=body)
except ApiException as e:
    print("Exception when calling VPGVirtualProtectionGroupSettingsApi->editVpgSettingVmVolume: %s\n" % e)

Parameters

Path parameters
Name Description
vpgSettingsIdentifier*
String
Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
Required
vmIdentifier*
String
Vm Identifier.Related endpoint: `v1/vms`
Required
volumeIdentifier*
String
Volume Identifier. Related endpoint: `Get: v1/volumes`
Required
Body parameters
Name Description
body
{
volumeIdentifier:
string
vcd:
{
isThin:
}
preseed:
{
datastoreIdentifier:
path:
}
rdm:
{
deviceIdentifier:
isPhysical:
}
datastore:
{
datastoreClusterIdentifier:
datastoreIdentifier:
isThin:
}
isSwap:
boolean
}

Responses

Status: 200 - Success


getVpgSetting

Get VPG settings (Auth)


/v1/vpgSettings/{vpgSettingsIdentifier}

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgSettings/{vpgSettingsIdentifier}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

import java.io.File;
import java.util.*;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        try {
            VpgSettingsApi result = apiInstance.getVpgSetting(vpgSettingsIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#getVpgSetting");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        try {
            VpgSettingsApi result = apiInstance.getVpgSetting(vpgSettingsIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#getVpgSetting");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgSettingsIdentifier = vpgSettingsIdentifier_example; // Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

VPGVirtualProtectionGroupSettingsApi *apiInstance = [[VPGVirtualProtectionGroupSettingsApi alloc] init];

// Get VPG settings (Auth)
[apiInstance getVpgSettingWith:vpgSettingsIdentifier
              completionHandler: ^(VpgSettingsApi output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGVirtualProtectionGroupSettingsApi()
var vpgSettingsIdentifier = vpgSettingsIdentifier_example; // {{String}} Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVpgSetting(vpgSettingsIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVpgSettingExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGVirtualProtectionGroupSettingsApi();
            var vpgSettingsIdentifier = vpgSettingsIdentifier_example;  // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

            try
            {
                // Get VPG settings (Auth)
                VpgSettingsApi result = apiInstance.getVpgSetting(vpgSettingsIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGVirtualProtectionGroupSettingsApi.getVpgSetting: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGVirtualProtectionGroupSettingsApi();
$vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

try {
    $result = $api_instance->getVpgSetting($vpgSettingsIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VPGVirtualProtectionGroupSettingsApi->getVpgSetting: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi->new();
my $vpgSettingsIdentifier = vpgSettingsIdentifier_example; # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

eval { 
    my $result = $api_instance->getVpgSetting(vpgSettingsIdentifier => $vpgSettingsIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VPGVirtualProtectionGroupSettingsApi->getVpgSetting: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGVirtualProtectionGroupSettingsApi()
vpgSettingsIdentifier = vpgSettingsIdentifier_example # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

try: 
    # Get VPG settings (Auth)
    api_response = api_instance.get_vpg_setting(vpgSettingsIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VPGVirtualProtectionGroupSettingsApi->getVpgSetting: %s\n" % e)

Parameters

Path parameters
Name Description
vpgSettingsIdentifier*
String
Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
Required

Responses

Status: 200 - Success

{
vpgIdentifier:
string
vpgSettingsIdentifier:
string
basic:
{
zorgIdentifier:
string
name:
string
vpgType:
string
rpoInSeconds:
integer (int32)
testIntervalInMinutes:
integer (int32)
journalHistoryInHours:
integer (int32)
priority:
string
useWanCompression:
boolean
serviceProfileIdentifier:
string
protectedSiteIdentifier:
string
recoverySiteIdentifier:
string
}
scripting:
{
preRecovery:
{
command:
parameters:
timeoutInSeconds:
}
postRecovery:
{
command:
parameters:
timeoutInSeconds:
}
postBackup:
{
command:
parameters:
timeoutInSeconds:
}
}
bootGroups:
{
bootGroups:
[
{
bootGroupIdentifier:
string
name:
string
bootDelayInSeconds:
integer (int32)
}
]
}
journal:
{
limitation:
{
hardLimitInMB:
hardLimitInPercent:
warningThresholdInMB:
warningThresholdInPercent:
}
datastoreIdentifier:
string
}
longTermRetention:
{
enabled:
boolean
repositoryIdentifier:
string
retentionRunTime:
string
schedulerPolicy:
{
daily:
weekly:
monthly:
yearly:
}
retry:
{
enabled:
number:
intervalInMinutes:
}
indexing:
{
vms:
}
compression:
string
}
recovery:
{
defaultHostIdentifier:
string
defaultHostClusterIdentifier:
string
defaultDatastoreIdentifier:
string
defaultDatastoreClusterIdentifier:
string
defaultFolderIdentifier:
string
resourcePoolIdentifier:
string
vcd:
{
orgVdcIdentifier:
}
publicCloud:
{
failover:
failoverTest:
}
}
networks:
{
failover:
{
vcd:
hypervisor:
publicCloud:
}
failoverTest:
{
vcd:
hypervisor:
publicCloud:
}
}
vms:
[
{
vmIdentifier:
string
recovery:
{
hostIdentifier:
string
hostClusterIdentifier:
string
datastoreIdentifier:
string
datastoreClusterIdentifier:
string
folderIdentifier:
string
resourcePoolIdentifier:
string
vcd:
{
storagePolicyIdentifier:
string
}
publicCloud:
{
failover:
{
vmInstanceType:
string
azure:
{
recoveryDiskType:
string
}
virtualNetworkIdentifier:
string
}
failoverTest:
{
vmInstanceType:
string
azure:
{
recoveryDiskType:
string
}
virtualNetworkIdentifier:
string
}
}
useVmEncryption:
boolean
}
bootGroupIdentifier:
string
journal:
{
limitation:
{
hardLimitInMB:
integer (int32)
hardLimitInPercent:
integer (int32)
warningThresholdInMB:
integer (int32)
warningThresholdInPercent:
integer (int32)
}
datastoreIdentifier:
string
}
volumes:
[
{
volumeIdentifier:
string
vcd:
{
isThin:
boolean
}
preseed:
{
datastoreIdentifier:
string
path:
string
}
rdm:
{
deviceIdentifier:
string
isPhysical:
boolean
}
datastore:
{
datastoreClusterIdentifier:
string
datastoreIdentifier:
string
isThin:
boolean
}
isSwap:
boolean
}
]
nics:
[
{
nicIdentifier:
string
failoverTest:
{
hypervisor:
{
networkIdentifier:
string
shouldReplaceMacAddress:
boolean
dnsSuffix:
string
ipConfig:
{
staticIp:
string
subnetMask:
string
gateway:
string
primaryDns:
string
secondaryDns:
string
isDhcp:
boolean
}
}
vcd:
{
isResetMacAddress:
boolean
isPrimary:
boolean
isConnected:
boolean
ipMode:
string
ipAddress:
string
recoveryOrgVdcNetworkIdentifier:
string
}
publicCloud:
{
subnetIdentifier:
string
securityGroupIdentifier:
string
privateIP:
string
isPrimary:
boolean
}
}
failover:
{
hypervisor:
{
networkIdentifier:
string
shouldReplaceMacAddress:
boolean
dnsSuffix:
string
ipConfig:
{
staticIp:
string
subnetMask:
string
gateway:
string
primaryDns:
string
secondaryDns:
string
isDhcp:
boolean
}
}
vcd:
{
isResetMacAddress:
boolean
isPrimary:
boolean
isConnected:
boolean
ipMode:
string
ipAddress:
string
recoveryOrgVdcNetworkIdentifier:
string
}
publicCloud:
{
subnetIdentifier:
string
securityGroupIdentifier:
string
privateIP:
string
isPrimary:
boolean
}
}
}
]
}
]
protected:
{
vcd:
{
vcdVappIdentifier:
}
}
}

getVpgSettingAll

Get all VPG settings. (Auth)


/v1/vpgSettings

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgSettings"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

import java.io.File;
import java.util.*;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        try {
            array[VpgSettingsApi] result = apiInstance.getVpgSettingAll();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#getVpgSettingAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        try {
            array[VpgSettingsApi] result = apiInstance.getVpgSettingAll();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#getVpgSettingAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];

VPGVirtualProtectionGroupSettingsApi *apiInstance = [[VPGVirtualProtectionGroupSettingsApi alloc] init];

// Get all VPG settings. (Auth)
[apiInstance getVpgSettingAllWithCompletionHandler: 
              ^(array[VpgSettingsApi] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGVirtualProtectionGroupSettingsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVpgSettingAll(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVpgSettingAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGVirtualProtectionGroupSettingsApi();

            try
            {
                // Get all VPG settings. (Auth)
                array[VpgSettingsApi] result = apiInstance.getVpgSettingAll();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGVirtualProtectionGroupSettingsApi.getVpgSettingAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGVirtualProtectionGroupSettingsApi();

try {
    $result = $api_instance->getVpgSettingAll();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VPGVirtualProtectionGroupSettingsApi->getVpgSettingAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi->new();

eval { 
    my $result = $api_instance->getVpgSettingAll();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VPGVirtualProtectionGroupSettingsApi->getVpgSettingAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGVirtualProtectionGroupSettingsApi()

try: 
    # Get all VPG settings. (Auth)
    api_response = api_instance.get_vpg_setting_all()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VPGVirtualProtectionGroupSettingsApi->getVpgSettingAll: %s\n" % e)

Parameters

Responses

Status: 200 - Success

[
{
vpgIdentifier:
string
vpgSettingsIdentifier:
string
basic:
{
zorgIdentifier:
string
name:
string
vpgType:
string
rpoInSeconds:
integer (int32)
testIntervalInMinutes:
integer (int32)
journalHistoryInHours:
integer (int32)
priority:
string
useWanCompression:
boolean
serviceProfileIdentifier:
string
protectedSiteIdentifier:
string
recoverySiteIdentifier:
string
}
scripting:
{
preRecovery:
{
command:
string
parameters:
string
timeoutInSeconds:
integer (int32)
}
postRecovery:
{
command:
string
parameters:
string
timeoutInSeconds:
integer (int32)
}
postBackup:
{
command:
string
parameters:
string
timeoutInSeconds:
integer (int32)
}
}
bootGroups:
{
bootGroups:
[
{
bootGroupIdentifier:
string
name:
string
bootDelayInSeconds:
integer (int32)
}
]
}
journal:
{
limitation:
{
hardLimitInMB:
integer (int32)
hardLimitInPercent:
integer (int32)
warningThresholdInMB:
integer (int32)
warningThresholdInPercent:
integer (int32)
}
datastoreIdentifier:
string
}
longTermRetention:
{
enabled:
boolean
repositoryIdentifier:
string
retentionRunTime:
string
schedulerPolicy:
{
daily:
{
enabled:
boolean
retentionDuration:
{
count:
integer (int32)
durationType:
string
}
}
weekly:
{
enabled:
boolean
dayOfWeek:
string
retentionType:
string
retentionDuration:
{
count:
integer (int32)
durationType:
string
}
}
monthly:
{
enabled:
boolean
dayOfWeek:
string
weekOfMonth:
string
dayOfMonth:
string
retentionType:
string
retentionDuration:
{
count:
integer (int32)
durationType:
string
}
}
yearly:
{
enabled:
boolean
dayOfWeek:
string
dayOfYear:
string
monthOfYear:
string
dayOfMonth:
integer (int32)
retentionDuration:
{
count:
integer (int32)
durationType:
string
}
}
}
retry:
{
enabled:
boolean
number:
integer (int32)
intervalInMinutes:
integer (int32)
}
indexing:
{
vms:
[
string
]
}
compression:
string
}
recovery:
{
defaultHostIdentifier:
string
defaultHostClusterIdentifier:
string
defaultDatastoreIdentifier:
string
defaultDatastoreClusterIdentifier:
string
defaultFolderIdentifier:
string
resourcePoolIdentifier:
string
vcd:
{
orgVdcIdentifier:
string
}
publicCloud:
{
failover:
{
vmInstanceType:
string
azure:
{
recoveryDiskType:
string
}
}
failoverTest:
{
vmInstanceType:
string
azure:
{
recoveryDiskType:
string
}
}
}
}
networks:
{
failover:
{
vcd:
{
copyNATRules:
string
isEnableGuestCustomization:
boolean
mapping:
[
{
protectedOrgVdcNetworkIdentifier:
string
recoveryOrgVdcNetworkIdentifier:
string
reverseTestOrgVdcNetworkIdentifier:
string
}
]
defaultRecoveryOrgVdcNetworkIdentifier:
string
}
hypervisor:
{
defaultNetworkIdentifier:
string
}
publicCloud:
{
virtualNetworkIdentifier:
string
subnetIdentifier:
string
securityGroupIdentifier:
string
}
}
failoverTest:
{
vcd:
{
copyNATRules:
string
isEnableGuestCustomization:
boolean
mapping:
[
{
protectedOrgVdcNetworkIdentifier:
string
recoveryOrgVdcNetworkIdentifier:
string
reverseTestOrgVdcNetworkIdentifier:
string
}
]
defaultRecoveryOrgVdcNetworkIdentifier:
string
}
hypervisor:
{
defaultNetworkIdentifier:
string
}
publicCloud:
{
virtualNetworkIdentifier:
string
subnetIdentifier:
string
securityGroupIdentifier:
string
}
}
}
vms:
[
{
vmIdentifier:
string
recovery:
{
hostIdentifier:
string
hostClusterIdentifier:
string
datastoreIdentifier:
string
datastoreClusterIdentifier:
string
folderIdentifier:
string
resourcePoolIdentifier:
string
vcd:
{
storagePolicyIdentifier:
string
}
publicCloud:
{
failover:
{
vmInstanceType:
string
azure:
{
recoveryDiskType:
string
}
virtualNetworkIdentifier:
string
}
failoverTest:
{
vmInstanceType:
string
azure:
{
recoveryDiskType:
string
}
virtualNetworkIdentifier:
string
}
}
useVmEncryption:
boolean
}
bootGroupIdentifier:
string
journal:
{
limitation:
{
hardLimitInMB:
integer (int32)
hardLimitInPercent:
integer (int32)
warningThresholdInMB:
integer (int32)
warningThresholdInPercent:
integer (int32)
}
datastoreIdentifier:
string
}
volumes:
[
{
volumeIdentifier:
string
vcd:
{
isThin:
boolean
}
preseed:
{
datastoreIdentifier:
string
path:
string
}
rdm:
{
deviceIdentifier:
string
isPhysical:
boolean
}
datastore:
{
datastoreClusterIdentifier:
string
datastoreIdentifier:
string
isThin:
boolean
}
isSwap:
boolean
}
]
nics:
[
{
nicIdentifier:
string
failoverTest:
{
hypervisor:
{
networkIdentifier:
string
shouldReplaceMacAddress:
boolean
dnsSuffix:
string
ipConfig:
{
staticIp:
string
subnetMask:
string
gateway:
string
primaryDns:
string
secondaryDns:
string
isDhcp:
boolean
}
}
vcd:
{
isResetMacAddress:
boolean
isPrimary:
boolean
isConnected:
boolean
ipMode:
string
ipAddress:
string
recoveryOrgVdcNetworkIdentifier:
string
}
publicCloud:
{
subnetIdentifier:
string
securityGroupIdentifier:
string
privateIP:
string
isPrimary:
boolean
}
}
failover:
{
hypervisor:
{
networkIdentifier:
string
shouldReplaceMacAddress:
boolean
dnsSuffix:
string
ipConfig:
{
staticIp:
string
subnetMask:
string
gateway:
string
primaryDns:
string
secondaryDns:
string
isDhcp:
boolean
}
}
vcd:
{
isResetMacAddress:
boolean
isPrimary:
boolean
isConnected:
boolean
ipMode:
string
ipAddress:
string
recoveryOrgVdcNetworkIdentifier:
string
}
publicCloud:
{
subnetIdentifier:
string
securityGroupIdentifier:
string
privateIP:
string
isPrimary:
boolean
}
}
}
]
}
]
protected:
{
vcd:
{
vcdVappIdentifier:
string
}
}
}
]

getVpgSettingBasic

Get Basic VPG settings (Auth)


/v1/vpgSettings/{vpgSettingsIdentifier}/basic

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgSettings/{vpgSettingsIdentifier}/basic"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

import java.io.File;
import java.util.*;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        try {
            VpgSettingsBasicApi result = apiInstance.getVpgSettingBasic(vpgSettingsIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#getVpgSettingBasic");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        try {
            VpgSettingsBasicApi result = apiInstance.getVpgSettingBasic(vpgSettingsIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#getVpgSettingBasic");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgSettingsIdentifier = vpgSettingsIdentifier_example; // Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

VPGVirtualProtectionGroupSettingsApi *apiInstance = [[VPGVirtualProtectionGroupSettingsApi alloc] init];

// Get Basic VPG settings (Auth)
[apiInstance getVpgSettingBasicWith:vpgSettingsIdentifier
              completionHandler: ^(VpgSettingsBasicApi output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGVirtualProtectionGroupSettingsApi()
var vpgSettingsIdentifier = vpgSettingsIdentifier_example; // {{String}} Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVpgSettingBasic(vpgSettingsIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVpgSettingBasicExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGVirtualProtectionGroupSettingsApi();
            var vpgSettingsIdentifier = vpgSettingsIdentifier_example;  // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

            try
            {
                // Get Basic VPG settings (Auth)
                VpgSettingsBasicApi result = apiInstance.getVpgSettingBasic(vpgSettingsIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGVirtualProtectionGroupSettingsApi.getVpgSettingBasic: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGVirtualProtectionGroupSettingsApi();
$vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

try {
    $result = $api_instance->getVpgSettingBasic($vpgSettingsIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VPGVirtualProtectionGroupSettingsApi->getVpgSettingBasic: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi->new();
my $vpgSettingsIdentifier = vpgSettingsIdentifier_example; # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

eval { 
    my $result = $api_instance->getVpgSettingBasic(vpgSettingsIdentifier => $vpgSettingsIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VPGVirtualProtectionGroupSettingsApi->getVpgSettingBasic: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGVirtualProtectionGroupSettingsApi()
vpgSettingsIdentifier = vpgSettingsIdentifier_example # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

try: 
    # Get Basic VPG settings (Auth)
    api_response = api_instance.get_vpg_setting_basic(vpgSettingsIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VPGVirtualProtectionGroupSettingsApi->getVpgSettingBasic: %s\n" % e)

Parameters

Path parameters
Name Description
vpgSettingsIdentifier*
String
Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
Required

Responses

Status: 200 - Success

{
zorgIdentifier:
string
name:
string
vpgType:
string
rpoInSeconds:
integer (int32)
testIntervalInMinutes:
integer (int32)
journalHistoryInHours:
integer (int32)
priority:
string
useWanCompression:
boolean
serviceProfileIdentifier:
string
protectedSiteIdentifier:
string
recoverySiteIdentifier:
string
}

getVpgSettingBootGroup

Get Bootgroups VPG settings (Auth)


/v1/vpgSettings/{vpgSettingsIdentifier}/bootgroup

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgSettings/{vpgSettingsIdentifier}/bootgroup"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

import java.io.File;
import java.util.*;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        try {
            VpgSettingsBootGroupsApi result = apiInstance.getVpgSettingBootGroup(vpgSettingsIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#getVpgSettingBootGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        try {
            VpgSettingsBootGroupsApi result = apiInstance.getVpgSettingBootGroup(vpgSettingsIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#getVpgSettingBootGroup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgSettingsIdentifier = vpgSettingsIdentifier_example; // Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

VPGVirtualProtectionGroupSettingsApi *apiInstance = [[VPGVirtualProtectionGroupSettingsApi alloc] init];

// Get Bootgroups VPG settings (Auth)
[apiInstance getVpgSettingBootGroupWith:vpgSettingsIdentifier
              completionHandler: ^(VpgSettingsBootGroupsApi output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGVirtualProtectionGroupSettingsApi()
var vpgSettingsIdentifier = vpgSettingsIdentifier_example; // {{String}} Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVpgSettingBootGroup(vpgSettingsIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVpgSettingBootGroupExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGVirtualProtectionGroupSettingsApi();
            var vpgSettingsIdentifier = vpgSettingsIdentifier_example;  // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

            try
            {
                // Get Bootgroups VPG settings (Auth)
                VpgSettingsBootGroupsApi result = apiInstance.getVpgSettingBootGroup(vpgSettingsIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGVirtualProtectionGroupSettingsApi.getVpgSettingBootGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGVirtualProtectionGroupSettingsApi();
$vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

try {
    $result = $api_instance->getVpgSettingBootGroup($vpgSettingsIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VPGVirtualProtectionGroupSettingsApi->getVpgSettingBootGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi->new();
my $vpgSettingsIdentifier = vpgSettingsIdentifier_example; # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

eval { 
    my $result = $api_instance->getVpgSettingBootGroup(vpgSettingsIdentifier => $vpgSettingsIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VPGVirtualProtectionGroupSettingsApi->getVpgSettingBootGroup: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGVirtualProtectionGroupSettingsApi()
vpgSettingsIdentifier = vpgSettingsIdentifier_example # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

try: 
    # Get Bootgroups VPG settings (Auth)
    api_response = api_instance.get_vpg_setting_boot_group(vpgSettingsIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VPGVirtualProtectionGroupSettingsApi->getVpgSettingBootGroup: %s\n" % e)

Parameters

Path parameters
Name Description
vpgSettingsIdentifier*
String
Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
Required

Responses

Status: 200 - Success

{
bootGroups:
[
{
bootGroupIdentifier:
string
name:
string
bootDelayInSeconds:
integer (int32)
}
]
}

getVpgSettingJournal

Get Journal VPG settings (Auth)


/v1/vpgSettings/{vpgSettingsIdentifier}/journal

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgSettings/{vpgSettingsIdentifier}/journal"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

import java.io.File;
import java.util.*;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        try {
            VpgSettingsJournalApi result = apiInstance.getVpgSettingJournal(vpgSettingsIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#getVpgSettingJournal");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        try {
            VpgSettingsJournalApi result = apiInstance.getVpgSettingJournal(vpgSettingsIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#getVpgSettingJournal");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgSettingsIdentifier = vpgSettingsIdentifier_example; // Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

VPGVirtualProtectionGroupSettingsApi *apiInstance = [[VPGVirtualProtectionGroupSettingsApi alloc] init];

// Get Journal VPG settings (Auth)
[apiInstance getVpgSettingJournalWith:vpgSettingsIdentifier
              completionHandler: ^(VpgSettingsJournalApi output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGVirtualProtectionGroupSettingsApi()
var vpgSettingsIdentifier = vpgSettingsIdentifier_example; // {{String}} Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVpgSettingJournal(vpgSettingsIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVpgSettingJournalExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGVirtualProtectionGroupSettingsApi();
            var vpgSettingsIdentifier = vpgSettingsIdentifier_example;  // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

            try
            {
                // Get Journal VPG settings (Auth)
                VpgSettingsJournalApi result = apiInstance.getVpgSettingJournal(vpgSettingsIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGVirtualProtectionGroupSettingsApi.getVpgSettingJournal: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGVirtualProtectionGroupSettingsApi();
$vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

try {
    $result = $api_instance->getVpgSettingJournal($vpgSettingsIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VPGVirtualProtectionGroupSettingsApi->getVpgSettingJournal: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi->new();
my $vpgSettingsIdentifier = vpgSettingsIdentifier_example; # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

eval { 
    my $result = $api_instance->getVpgSettingJournal(vpgSettingsIdentifier => $vpgSettingsIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VPGVirtualProtectionGroupSettingsApi->getVpgSettingJournal: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGVirtualProtectionGroupSettingsApi()
vpgSettingsIdentifier = vpgSettingsIdentifier_example # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

try: 
    # Get Journal VPG settings (Auth)
    api_response = api_instance.get_vpg_setting_journal(vpgSettingsIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VPGVirtualProtectionGroupSettingsApi->getVpgSettingJournal: %s\n" % e)

Parameters

Path parameters
Name Description
vpgSettingsIdentifier*
String
Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
Required

Responses

Status: 200 - Success

{
limitation:
{
hardLimitInMB:
integer (int32)
hardLimitInPercent:
integer (int32)
warningThresholdInMB:
integer (int32)
warningThresholdInPercent:
integer (int32)
}
datastoreIdentifier:
string
}

getVpgSettingLtr

Get Long-term Retention VPG settings (Auth)


/v1/vpgSettings/{vpgSettingsIdentifier}/ltr

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgSettings/{vpgSettingsIdentifier}/ltr"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

import java.io.File;
import java.util.*;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        try {
            VpgSettingsLtrApi result = apiInstance.getVpgSettingLtr(vpgSettingsIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#getVpgSettingLtr");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        try {
            VpgSettingsLtrApi result = apiInstance.getVpgSettingLtr(vpgSettingsIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#getVpgSettingLtr");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgSettingsIdentifier = vpgSettingsIdentifier_example; // Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

VPGVirtualProtectionGroupSettingsApi *apiInstance = [[VPGVirtualProtectionGroupSettingsApi alloc] init];

// Get Long-term Retention VPG settings (Auth)
[apiInstance getVpgSettingLtrWith:vpgSettingsIdentifier
              completionHandler: ^(VpgSettingsLtrApi output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGVirtualProtectionGroupSettingsApi()
var vpgSettingsIdentifier = vpgSettingsIdentifier_example; // {{String}} Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVpgSettingLtr(vpgSettingsIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVpgSettingLtrExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGVirtualProtectionGroupSettingsApi();
            var vpgSettingsIdentifier = vpgSettingsIdentifier_example;  // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

            try
            {
                // Get Long-term Retention VPG settings (Auth)
                VpgSettingsLtrApi result = apiInstance.getVpgSettingLtr(vpgSettingsIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGVirtualProtectionGroupSettingsApi.getVpgSettingLtr: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGVirtualProtectionGroupSettingsApi();
$vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

try {
    $result = $api_instance->getVpgSettingLtr($vpgSettingsIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VPGVirtualProtectionGroupSettingsApi->getVpgSettingLtr: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi->new();
my $vpgSettingsIdentifier = vpgSettingsIdentifier_example; # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

eval { 
    my $result = $api_instance->getVpgSettingLtr(vpgSettingsIdentifier => $vpgSettingsIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VPGVirtualProtectionGroupSettingsApi->getVpgSettingLtr: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGVirtualProtectionGroupSettingsApi()
vpgSettingsIdentifier = vpgSettingsIdentifier_example # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

try: 
    # Get Long-term Retention VPG settings (Auth)
    api_response = api_instance.get_vpg_setting_ltr(vpgSettingsIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VPGVirtualProtectionGroupSettingsApi->getVpgSettingLtr: %s\n" % e)

Parameters

Path parameters
Name Description
vpgSettingsIdentifier*
String
Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
Required

Responses

Status: 200 - Success

{
enabled:
boolean
repositoryIdentifier:
string
retentionRunTime:
string
schedulerPolicy:
{
daily:
{
enabled:
retentionDuration:
}
weekly:
{
enabled:
dayOfWeek:
retentionType:
retentionDuration:
}
monthly:
{
enabled:
dayOfWeek:
weekOfMonth:
dayOfMonth:
retentionType:
retentionDuration:
}
yearly:
{
enabled:
dayOfWeek:
dayOfYear:
monthOfYear:
dayOfMonth:
retentionDuration:
}
}
retry:
{
enabled:
boolean
number:
integer (int32)
intervalInMinutes:
integer (int32)
}
indexing:
{
vms:
[
string
]
}
compression:
string
}

getVpgSettingLtrNetworkAll

Get Network VPG settings (Auth)


/v1/vpgSettings/{vpgSettingsIdentifier}/networks

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgSettings/{vpgSettingsIdentifier}/networks"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

import java.io.File;
import java.util.*;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        try {
            VpgSettingsNetworksApi result = apiInstance.getVpgSettingLtrNetworkAll(vpgSettingsIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#getVpgSettingLtrNetworkAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        try {
            VpgSettingsNetworksApi result = apiInstance.getVpgSettingLtrNetworkAll(vpgSettingsIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#getVpgSettingLtrNetworkAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgSettingsIdentifier = vpgSettingsIdentifier_example; // Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

VPGVirtualProtectionGroupSettingsApi *apiInstance = [[VPGVirtualProtectionGroupSettingsApi alloc] init];

// Get Network VPG settings (Auth)
[apiInstance getVpgSettingLtrNetworkAllWith:vpgSettingsIdentifier
              completionHandler: ^(VpgSettingsNetworksApi output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGVirtualProtectionGroupSettingsApi()
var vpgSettingsIdentifier = vpgSettingsIdentifier_example; // {{String}} Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVpgSettingLtrNetworkAll(vpgSettingsIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVpgSettingLtrNetworkAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGVirtualProtectionGroupSettingsApi();
            var vpgSettingsIdentifier = vpgSettingsIdentifier_example;  // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

            try
            {
                // Get Network VPG settings (Auth)
                VpgSettingsNetworksApi result = apiInstance.getVpgSettingLtrNetworkAll(vpgSettingsIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGVirtualProtectionGroupSettingsApi.getVpgSettingLtrNetworkAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGVirtualProtectionGroupSettingsApi();
$vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

try {
    $result = $api_instance->getVpgSettingLtrNetworkAll($vpgSettingsIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VPGVirtualProtectionGroupSettingsApi->getVpgSettingLtrNetworkAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi->new();
my $vpgSettingsIdentifier = vpgSettingsIdentifier_example; # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

eval { 
    my $result = $api_instance->getVpgSettingLtrNetworkAll(vpgSettingsIdentifier => $vpgSettingsIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VPGVirtualProtectionGroupSettingsApi->getVpgSettingLtrNetworkAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGVirtualProtectionGroupSettingsApi()
vpgSettingsIdentifier = vpgSettingsIdentifier_example # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

try: 
    # Get Network VPG settings (Auth)
    api_response = api_instance.get_vpg_setting_ltr_network_all(vpgSettingsIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VPGVirtualProtectionGroupSettingsApi->getVpgSettingLtrNetworkAll: %s\n" % e)

Parameters

Path parameters
Name Description
vpgSettingsIdentifier*
String
Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
Required

Responses

Status: 200 - Success

{
failover:
{
vcd:
{
copyNATRules:
isEnableGuestCustomization:
mapping:
defaultRecoveryOrgVdcNetworkIdentifier:
}
hypervisor:
{
defaultNetworkIdentifier:
}
publicCloud:
{
virtualNetworkIdentifier:
subnetIdentifier:
securityGroupIdentifier:
}
}
failoverTest:
{
vcd:
{
copyNATRules:
isEnableGuestCustomization:
mapping:
defaultRecoveryOrgVdcNetworkIdentifier:
}
hypervisor:
{
defaultNetworkIdentifier:
}
publicCloud:
{
virtualNetworkIdentifier:
subnetIdentifier:
securityGroupIdentifier:
}
}
}

getVpgSettingPossiblePriorityAll

Get values for Priority. (Auth)


/v1/vpgSettings/{vpgSettingsIdentifier}/priority

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgSettings/{vpgSettingsIdentifier}/priority"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

import java.io.File;
import java.util.*;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        try {
            'String' result = apiInstance.getVpgSettingPossiblePriorityAll(vpgSettingsIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#getVpgSettingPossiblePriorityAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        try {
            'String' result = apiInstance.getVpgSettingPossiblePriorityAll(vpgSettingsIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#getVpgSettingPossiblePriorityAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgSettingsIdentifier = vpgSettingsIdentifier_example; // Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

VPGVirtualProtectionGroupSettingsApi *apiInstance = [[VPGVirtualProtectionGroupSettingsApi alloc] init];

// Get values for Priority. (Auth)
[apiInstance getVpgSettingPossiblePriorityAllWith:vpgSettingsIdentifier
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGVirtualProtectionGroupSettingsApi()
var vpgSettingsIdentifier = vpgSettingsIdentifier_example; // {{String}} Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVpgSettingPossiblePriorityAll(vpgSettingsIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVpgSettingPossiblePriorityAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGVirtualProtectionGroupSettingsApi();
            var vpgSettingsIdentifier = vpgSettingsIdentifier_example;  // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

            try
            {
                // Get values for Priority. (Auth)
                'String' result = apiInstance.getVpgSettingPossiblePriorityAll(vpgSettingsIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGVirtualProtectionGroupSettingsApi.getVpgSettingPossiblePriorityAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGVirtualProtectionGroupSettingsApi();
$vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

try {
    $result = $api_instance->getVpgSettingPossiblePriorityAll($vpgSettingsIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VPGVirtualProtectionGroupSettingsApi->getVpgSettingPossiblePriorityAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi->new();
my $vpgSettingsIdentifier = vpgSettingsIdentifier_example; # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

eval { 
    my $result = $api_instance->getVpgSettingPossiblePriorityAll(vpgSettingsIdentifier => $vpgSettingsIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VPGVirtualProtectionGroupSettingsApi->getVpgSettingPossiblePriorityAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGVirtualProtectionGroupSettingsApi()
vpgSettingsIdentifier = vpgSettingsIdentifier_example # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

try: 
    # Get values for Priority. (Auth)
    api_response = api_instance.get_vpg_setting_possible_priority_all(vpgSettingsIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VPGVirtualProtectionGroupSettingsApi->getVpgSettingPossiblePriorityAll: %s\n" % e)

Parameters

Path parameters
Name Description
vpgSettingsIdentifier*
String
Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
Required

Responses

Status: 200 - Success

string

getVpgSettingRecovery

Get Recovery VPG settings (Auth)


/v1/vpgSettings/{vpgSettingsIdentifier}/recovery

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgSettings/{vpgSettingsIdentifier}/recovery"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

import java.io.File;
import java.util.*;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        try {
            VpgSettingsRecoveryApi result = apiInstance.getVpgSettingRecovery(vpgSettingsIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#getVpgSettingRecovery");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        try {
            VpgSettingsRecoveryApi result = apiInstance.getVpgSettingRecovery(vpgSettingsIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#getVpgSettingRecovery");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgSettingsIdentifier = vpgSettingsIdentifier_example; // Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

VPGVirtualProtectionGroupSettingsApi *apiInstance = [[VPGVirtualProtectionGroupSettingsApi alloc] init];

// Get Recovery VPG settings (Auth)
[apiInstance getVpgSettingRecoveryWith:vpgSettingsIdentifier
              completionHandler: ^(VpgSettingsRecoveryApi output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGVirtualProtectionGroupSettingsApi()
var vpgSettingsIdentifier = vpgSettingsIdentifier_example; // {{String}} Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVpgSettingRecovery(vpgSettingsIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVpgSettingRecoveryExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGVirtualProtectionGroupSettingsApi();
            var vpgSettingsIdentifier = vpgSettingsIdentifier_example;  // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

            try
            {
                // Get Recovery VPG settings (Auth)
                VpgSettingsRecoveryApi result = apiInstance.getVpgSettingRecovery(vpgSettingsIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGVirtualProtectionGroupSettingsApi.getVpgSettingRecovery: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGVirtualProtectionGroupSettingsApi();
$vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

try {
    $result = $api_instance->getVpgSettingRecovery($vpgSettingsIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VPGVirtualProtectionGroupSettingsApi->getVpgSettingRecovery: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi->new();
my $vpgSettingsIdentifier = vpgSettingsIdentifier_example; # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

eval { 
    my $result = $api_instance->getVpgSettingRecovery(vpgSettingsIdentifier => $vpgSettingsIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VPGVirtualProtectionGroupSettingsApi->getVpgSettingRecovery: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGVirtualProtectionGroupSettingsApi()
vpgSettingsIdentifier = vpgSettingsIdentifier_example # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

try: 
    # Get Recovery VPG settings (Auth)
    api_response = api_instance.get_vpg_setting_recovery(vpgSettingsIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VPGVirtualProtectionGroupSettingsApi->getVpgSettingRecovery: %s\n" % e)

Parameters

Path parameters
Name Description
vpgSettingsIdentifier*
String
Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
Required

Responses

Status: 200 - Success

{
defaultHostIdentifier:
string
defaultHostClusterIdentifier:
string
defaultDatastoreIdentifier:
string
defaultDatastoreClusterIdentifier:
string
defaultFolderIdentifier:
string
resourcePoolIdentifier:
string
vcd:
{
orgVdcIdentifier:
string
}
publicCloud:
{
failover:
{
vmInstanceType:
azure:
}
failoverTest:
{
vmInstanceType:
azure:
}
}
}

getVpgSettingScript

Get Scripting VPG settings (Auth)


/v1/vpgSettings/{vpgSettingsIdentifier}/scripting

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgSettings/{vpgSettingsIdentifier}/scripting"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

import java.io.File;
import java.util.*;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        try {
            VpgSettingsScriptsApi result = apiInstance.getVpgSettingScript(vpgSettingsIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#getVpgSettingScript");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        try {
            VpgSettingsScriptsApi result = apiInstance.getVpgSettingScript(vpgSettingsIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#getVpgSettingScript");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgSettingsIdentifier = vpgSettingsIdentifier_example; // Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

VPGVirtualProtectionGroupSettingsApi *apiInstance = [[VPGVirtualProtectionGroupSettingsApi alloc] init];

// Get Scripting VPG settings (Auth)
[apiInstance getVpgSettingScriptWith:vpgSettingsIdentifier
              completionHandler: ^(VpgSettingsScriptsApi output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGVirtualProtectionGroupSettingsApi()
var vpgSettingsIdentifier = vpgSettingsIdentifier_example; // {{String}} Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVpgSettingScript(vpgSettingsIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVpgSettingScriptExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGVirtualProtectionGroupSettingsApi();
            var vpgSettingsIdentifier = vpgSettingsIdentifier_example;  // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

            try
            {
                // Get Scripting VPG settings (Auth)
                VpgSettingsScriptsApi result = apiInstance.getVpgSettingScript(vpgSettingsIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGVirtualProtectionGroupSettingsApi.getVpgSettingScript: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGVirtualProtectionGroupSettingsApi();
$vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

try {
    $result = $api_instance->getVpgSettingScript($vpgSettingsIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VPGVirtualProtectionGroupSettingsApi->getVpgSettingScript: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi->new();
my $vpgSettingsIdentifier = vpgSettingsIdentifier_example; # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

eval { 
    my $result = $api_instance->getVpgSettingScript(vpgSettingsIdentifier => $vpgSettingsIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VPGVirtualProtectionGroupSettingsApi->getVpgSettingScript: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGVirtualProtectionGroupSettingsApi()
vpgSettingsIdentifier = vpgSettingsIdentifier_example # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

try: 
    # Get Scripting VPG settings (Auth)
    api_response = api_instance.get_vpg_setting_script(vpgSettingsIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VPGVirtualProtectionGroupSettingsApi->getVpgSettingScript: %s\n" % e)

Parameters

Path parameters
Name Description
vpgSettingsIdentifier*
String
Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
Required

Responses

Status: 200 - Success

{
preRecovery:
{
command:
string
parameters:
string
timeoutInSeconds:
integer (int32)
}
postRecovery:
{
command:
string
parameters:
string
timeoutInSeconds:
integer (int32)
}
postBackup:
{
command:
string
parameters:
string
timeoutInSeconds:
integer (int32)
}
}

getVpgSettingVm

Get VPG settings of a single VM (Auth)


/v1/vpgSettings/{vpgSettingsIdentifier}/vms/{vmIdentifier}

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgSettings/{vpgSettingsIdentifier}/vms/{vmIdentifier}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

import java.io.File;
import java.util.*;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        String vmIdentifier = vmIdentifier_example; // String | Vm Identifier.Related endpoint: `v1/vms`
        try {
            VpgSettingsVmApi result = apiInstance.getVpgSettingVm(vpgSettingsIdentifier, vmIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#getVpgSettingVm");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        String vmIdentifier = vmIdentifier_example; // String | Vm Identifier.Related endpoint: `v1/vms`
        try {
            VpgSettingsVmApi result = apiInstance.getVpgSettingVm(vpgSettingsIdentifier, vmIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#getVpgSettingVm");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgSettingsIdentifier = vpgSettingsIdentifier_example; // Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
String *vmIdentifier = vmIdentifier_example; // Vm Identifier.Related endpoint: `v1/vms`

VPGVirtualProtectionGroupSettingsApi *apiInstance = [[VPGVirtualProtectionGroupSettingsApi alloc] init];

// Get VPG settings of a single VM (Auth)
[apiInstance getVpgSettingVmWith:vpgSettingsIdentifier
    vmIdentifier:vmIdentifier
              completionHandler: ^(VpgSettingsVmApi output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGVirtualProtectionGroupSettingsApi()
var vpgSettingsIdentifier = vpgSettingsIdentifier_example; // {{String}} Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
var vmIdentifier = vmIdentifier_example; // {{String}} Vm Identifier.Related endpoint: `v1/vms`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVpgSettingVm(vpgSettingsIdentifier, vmIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVpgSettingVmExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGVirtualProtectionGroupSettingsApi();
            var vpgSettingsIdentifier = vpgSettingsIdentifier_example;  // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
            var vmIdentifier = vmIdentifier_example;  // String | Vm Identifier.Related endpoint: `v1/vms`

            try
            {
                // Get VPG settings of a single VM (Auth)
                VpgSettingsVmApi result = apiInstance.getVpgSettingVm(vpgSettingsIdentifier, vmIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGVirtualProtectionGroupSettingsApi.getVpgSettingVm: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGVirtualProtectionGroupSettingsApi();
$vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
$vmIdentifier = vmIdentifier_example; // String | Vm Identifier.Related endpoint: `v1/vms`

try {
    $result = $api_instance->getVpgSettingVm($vpgSettingsIdentifier, $vmIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VPGVirtualProtectionGroupSettingsApi->getVpgSettingVm: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi->new();
my $vpgSettingsIdentifier = vpgSettingsIdentifier_example; # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
my $vmIdentifier = vmIdentifier_example; # String | Vm Identifier.Related endpoint: `v1/vms`

eval { 
    my $result = $api_instance->getVpgSettingVm(vpgSettingsIdentifier => $vpgSettingsIdentifier, vmIdentifier => $vmIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VPGVirtualProtectionGroupSettingsApi->getVpgSettingVm: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGVirtualProtectionGroupSettingsApi()
vpgSettingsIdentifier = vpgSettingsIdentifier_example # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
vmIdentifier = vmIdentifier_example # String | Vm Identifier.Related endpoint: `v1/vms`

try: 
    # Get VPG settings of a single VM (Auth)
    api_response = api_instance.get_vpg_setting_vm(vpgSettingsIdentifier, vmIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VPGVirtualProtectionGroupSettingsApi->getVpgSettingVm: %s\n" % e)

Parameters

Path parameters
Name Description
vpgSettingsIdentifier*
String
Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
Required
vmIdentifier*
String
Vm Identifier.Related endpoint: `v1/vms`
Required

Responses

Status: 200 - Success

{
vmIdentifier:
string
recovery:
{
hostIdentifier:
string
hostClusterIdentifier:
string
datastoreIdentifier:
string
datastoreClusterIdentifier:
string
folderIdentifier:
string
resourcePoolIdentifier:
string
vcd:
{
storagePolicyIdentifier:
}
publicCloud:
{
failover:
failoverTest:
}
useVmEncryption:
boolean
}
bootGroupIdentifier:
string
journal:
{
limitation:
{
hardLimitInMB:
hardLimitInPercent:
warningThresholdInMB:
warningThresholdInPercent:
}
datastoreIdentifier:
string
}
volumes:
[
{
volumeIdentifier:
string
vcd:
{
isThin:
boolean
}
preseed:
{
datastoreIdentifier:
string
path:
string
}
rdm:
{
deviceIdentifier:
string
isPhysical:
boolean
}
datastore:
{
datastoreClusterIdentifier:
string
datastoreIdentifier:
string
isThin:
boolean
}
isSwap:
boolean
}
]
nics:
[
{
nicIdentifier:
string
failoverTest:
{
hypervisor:
{
networkIdentifier:
string
shouldReplaceMacAddress:
boolean
dnsSuffix:
string
ipConfig:
{
staticIp:
string
subnetMask:
string
gateway:
string
primaryDns:
string
secondaryDns:
string
isDhcp:
boolean
}
}
vcd:
{
isResetMacAddress:
boolean
isPrimary:
boolean
isConnected:
boolean
ipMode:
string
ipAddress:
string
recoveryOrgVdcNetworkIdentifier:
string
}
publicCloud:
{
subnetIdentifier:
string
securityGroupIdentifier:
string
privateIP:
string
isPrimary:
boolean
}
}
failover:
{
hypervisor:
{
networkIdentifier:
string
shouldReplaceMacAddress:
boolean
dnsSuffix:
string
ipConfig:
{
staticIp:
string
subnetMask:
string
gateway:
string
primaryDns:
string
secondaryDns:
string
isDhcp:
boolean
}
}
vcd:
{
isResetMacAddress:
boolean
isPrimary:
boolean
isConnected:
boolean
ipMode:
string
ipAddress:
string
recoveryOrgVdcNetworkIdentifier:
string
}
publicCloud:
{
subnetIdentifier:
string
securityGroupIdentifier:
string
privateIP:
string
isPrimary:
boolean
}
}
}
]
}

getVpgSettingVmAll

Get VMs from VPG settings (Auth)


/v1/vpgSettings/{vpgSettingsIdentifier}/vms

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgSettings/{vpgSettingsIdentifier}/vms"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

import java.io.File;
import java.util.*;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        try {
            array[VpgSettingsVmApi] result = apiInstance.getVpgSettingVmAll(vpgSettingsIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#getVpgSettingVmAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        try {
            array[VpgSettingsVmApi] result = apiInstance.getVpgSettingVmAll(vpgSettingsIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#getVpgSettingVmAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgSettingsIdentifier = vpgSettingsIdentifier_example; // Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

VPGVirtualProtectionGroupSettingsApi *apiInstance = [[VPGVirtualProtectionGroupSettingsApi alloc] init];

// Get VMs from VPG settings (Auth)
[apiInstance getVpgSettingVmAllWith:vpgSettingsIdentifier
              completionHandler: ^(array[VpgSettingsVmApi] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGVirtualProtectionGroupSettingsApi()
var vpgSettingsIdentifier = vpgSettingsIdentifier_example; // {{String}} Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVpgSettingVmAll(vpgSettingsIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVpgSettingVmAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGVirtualProtectionGroupSettingsApi();
            var vpgSettingsIdentifier = vpgSettingsIdentifier_example;  // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

            try
            {
                // Get VMs from VPG settings (Auth)
                array[VpgSettingsVmApi] result = apiInstance.getVpgSettingVmAll(vpgSettingsIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGVirtualProtectionGroupSettingsApi.getVpgSettingVmAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGVirtualProtectionGroupSettingsApi();
$vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

try {
    $result = $api_instance->getVpgSettingVmAll($vpgSettingsIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VPGVirtualProtectionGroupSettingsApi->getVpgSettingVmAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi->new();
my $vpgSettingsIdentifier = vpgSettingsIdentifier_example; # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

eval { 
    my $result = $api_instance->getVpgSettingVmAll(vpgSettingsIdentifier => $vpgSettingsIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VPGVirtualProtectionGroupSettingsApi->getVpgSettingVmAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGVirtualProtectionGroupSettingsApi()
vpgSettingsIdentifier = vpgSettingsIdentifier_example # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

try: 
    # Get VMs from VPG settings (Auth)
    api_response = api_instance.get_vpg_setting_vm_all(vpgSettingsIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VPGVirtualProtectionGroupSettingsApi->getVpgSettingVmAll: %s\n" % e)

Parameters

Path parameters
Name Description
vpgSettingsIdentifier*
String
Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
Required

Responses

Status: 200 - Success

[
{
vmIdentifier:
string
recovery:
{
hostIdentifier:
string
hostClusterIdentifier:
string
datastoreIdentifier:
string
datastoreClusterIdentifier:
string
folderIdentifier:
string
resourcePoolIdentifier:
string
vcd:
{
storagePolicyIdentifier:
string
}
publicCloud:
{
failover:
{
vmInstanceType:
string
azure:
{
recoveryDiskType:
string
}
virtualNetworkIdentifier:
string
}
failoverTest:
{
vmInstanceType:
string
azure:
{
recoveryDiskType:
string
}
virtualNetworkIdentifier:
string
}
}
useVmEncryption:
boolean
}
bootGroupIdentifier:
string
journal:
{
limitation:
{
hardLimitInMB:
integer (int32)
hardLimitInPercent:
integer (int32)
warningThresholdInMB:
integer (int32)
warningThresholdInPercent:
integer (int32)
}
datastoreIdentifier:
string
}
volumes:
[
{
volumeIdentifier:
string
vcd:
{
isThin:
boolean
}
preseed:
{
datastoreIdentifier:
string
path:
string
}
rdm:
{
deviceIdentifier:
string
isPhysical:
boolean
}
datastore:
{
datastoreClusterIdentifier:
string
datastoreIdentifier:
string
isThin:
boolean
}
isSwap:
boolean
}
]
nics:
[
{
nicIdentifier:
string
failoverTest:
{
hypervisor:
{
networkIdentifier:
string
shouldReplaceMacAddress:
boolean
dnsSuffix:
string
ipConfig:
{
staticIp:
string
subnetMask:
string
gateway:
string
primaryDns:
string
secondaryDns:
string
isDhcp:
boolean
}
}
vcd:
{
isResetMacAddress:
boolean
isPrimary:
boolean
isConnected:
boolean
ipMode:
string
ipAddress:
string
recoveryOrgVdcNetworkIdentifier:
string
}
publicCloud:
{
subnetIdentifier:
string
securityGroupIdentifier:
string
privateIP:
string
isPrimary:
boolean
}
}
failover:
{
hypervisor:
{
networkIdentifier:
string
shouldReplaceMacAddress:
boolean
dnsSuffix:
string
ipConfig:
{
staticIp:
string
subnetMask:
string
gateway:
string
primaryDns:
string
secondaryDns:
string
isDhcp:
boolean
}
}
vcd:
{
isResetMacAddress:
boolean
isPrimary:
boolean
isConnected:
boolean
ipMode:
string
ipAddress:
string
recoveryOrgVdcNetworkIdentifier:
string
}
publicCloud:
{
subnetIdentifier:
string
securityGroupIdentifier:
string
privateIP:
string
isPrimary:
boolean
}
}
}
]
}
]

getVpgSettingVmNic

Get the NIC details of specific VM in VPG settings (Auth)


/v1/vpgSettings/{vpgSettingsIdentifier}/vms/{vmIdentifier}/nics/{nicIdentifier}

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgSettings/{vpgSettingsIdentifier}/vms/{vmIdentifier}/nics/{nicIdentifier}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

import java.io.File;
import java.util.*;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        String vmIdentifier = vmIdentifier_example; // String | Vm Identifier.Related endpoint: `v1/vms`
        String nicIdentifier = nicIdentifier_example; // String | 
        try {
            VpgSettingsVmNicApi result = apiInstance.getVpgSettingVmNic(vpgSettingsIdentifier, vmIdentifier, nicIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#getVpgSettingVmNic");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        String vmIdentifier = vmIdentifier_example; // String | Vm Identifier.Related endpoint: `v1/vms`
        String nicIdentifier = nicIdentifier_example; // String | 
        try {
            VpgSettingsVmNicApi result = apiInstance.getVpgSettingVmNic(vpgSettingsIdentifier, vmIdentifier, nicIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#getVpgSettingVmNic");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgSettingsIdentifier = vpgSettingsIdentifier_example; // Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
String *vmIdentifier = vmIdentifier_example; // Vm Identifier.Related endpoint: `v1/vms`
String *nicIdentifier = nicIdentifier_example; // 

VPGVirtualProtectionGroupSettingsApi *apiInstance = [[VPGVirtualProtectionGroupSettingsApi alloc] init];

// Get the NIC details of specific VM in VPG settings (Auth)
[apiInstance getVpgSettingVmNicWith:vpgSettingsIdentifier
    vmIdentifier:vmIdentifier
    nicIdentifier:nicIdentifier
              completionHandler: ^(VpgSettingsVmNicApi output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGVirtualProtectionGroupSettingsApi()
var vpgSettingsIdentifier = vpgSettingsIdentifier_example; // {{String}} Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
var vmIdentifier = vmIdentifier_example; // {{String}} Vm Identifier.Related endpoint: `v1/vms`
var nicIdentifier = nicIdentifier_example; // {{String}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVpgSettingVmNic(vpgSettingsIdentifier, vmIdentifier, nicIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVpgSettingVmNicExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGVirtualProtectionGroupSettingsApi();
            var vpgSettingsIdentifier = vpgSettingsIdentifier_example;  // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
            var vmIdentifier = vmIdentifier_example;  // String | Vm Identifier.Related endpoint: `v1/vms`
            var nicIdentifier = nicIdentifier_example;  // String | 

            try
            {
                // Get the NIC details of specific VM in VPG settings (Auth)
                VpgSettingsVmNicApi result = apiInstance.getVpgSettingVmNic(vpgSettingsIdentifier, vmIdentifier, nicIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGVirtualProtectionGroupSettingsApi.getVpgSettingVmNic: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGVirtualProtectionGroupSettingsApi();
$vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
$vmIdentifier = vmIdentifier_example; // String | Vm Identifier.Related endpoint: `v1/vms`
$nicIdentifier = nicIdentifier_example; // String | 

try {
    $result = $api_instance->getVpgSettingVmNic($vpgSettingsIdentifier, $vmIdentifier, $nicIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VPGVirtualProtectionGroupSettingsApi->getVpgSettingVmNic: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi->new();
my $vpgSettingsIdentifier = vpgSettingsIdentifier_example; # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
my $vmIdentifier = vmIdentifier_example; # String | Vm Identifier.Related endpoint: `v1/vms`
my $nicIdentifier = nicIdentifier_example; # String | 

eval { 
    my $result = $api_instance->getVpgSettingVmNic(vpgSettingsIdentifier => $vpgSettingsIdentifier, vmIdentifier => $vmIdentifier, nicIdentifier => $nicIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VPGVirtualProtectionGroupSettingsApi->getVpgSettingVmNic: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGVirtualProtectionGroupSettingsApi()
vpgSettingsIdentifier = vpgSettingsIdentifier_example # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
vmIdentifier = vmIdentifier_example # String | Vm Identifier.Related endpoint: `v1/vms`
nicIdentifier = nicIdentifier_example # String | 

try: 
    # Get the NIC details of specific VM in VPG settings (Auth)
    api_response = api_instance.get_vpg_setting_vm_nic(vpgSettingsIdentifier, vmIdentifier, nicIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VPGVirtualProtectionGroupSettingsApi->getVpgSettingVmNic: %s\n" % e)

Parameters

Path parameters
Name Description
vpgSettingsIdentifier*
String
Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
Required
vmIdentifier*
String
Vm Identifier.Related endpoint: `v1/vms`
Required
nicIdentifier*
String
Required

Responses

Status: 200 - Success

{
nicIdentifier:
string
failoverTest:
{
hypervisor:
{
networkIdentifier:
shouldReplaceMacAddress:
dnsSuffix:
ipConfig:
}
vcd:
{
isResetMacAddress:
isPrimary:
isConnected:
ipMode:
ipAddress:
recoveryOrgVdcNetworkIdentifier:
}
publicCloud:
{
subnetIdentifier:
securityGroupIdentifier:
privateIP:
isPrimary:
}
}
failover:
{
hypervisor:
{
networkIdentifier:
shouldReplaceMacAddress:
dnsSuffix:
ipConfig:
}
vcd:
{
isResetMacAddress:
isPrimary:
isConnected:
ipMode:
ipAddress:
recoveryOrgVdcNetworkIdentifier:
}
publicCloud:
{
subnetIdentifier:
securityGroupIdentifier:
privateIP:
isPrimary:
}
}
}

getVpgSettingVmNicAll

Get NICs of specific VM in VPG settings (Auth)


/v1/vpgSettings/{vpgSettingsIdentifier}/vms/{vmIdentifier}/nics

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgSettings/{vpgSettingsIdentifier}/vms/{vmIdentifier}/nics"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

import java.io.File;
import java.util.*;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        String vmIdentifier = vmIdentifier_example; // String | Vm Identifier.Related endpoint: `v1/vms`
        try {
            array[VpgSettingsVmNicApi] result = apiInstance.getVpgSettingVmNicAll(vpgSettingsIdentifier, vmIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#getVpgSettingVmNicAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        String vmIdentifier = vmIdentifier_example; // String | Vm Identifier.Related endpoint: `v1/vms`
        try {
            array[VpgSettingsVmNicApi] result = apiInstance.getVpgSettingVmNicAll(vpgSettingsIdentifier, vmIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#getVpgSettingVmNicAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgSettingsIdentifier = vpgSettingsIdentifier_example; // Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
String *vmIdentifier = vmIdentifier_example; // Vm Identifier.Related endpoint: `v1/vms`

VPGVirtualProtectionGroupSettingsApi *apiInstance = [[VPGVirtualProtectionGroupSettingsApi alloc] init];

// Get NICs of specific VM in VPG settings (Auth)
[apiInstance getVpgSettingVmNicAllWith:vpgSettingsIdentifier
    vmIdentifier:vmIdentifier
              completionHandler: ^(array[VpgSettingsVmNicApi] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGVirtualProtectionGroupSettingsApi()
var vpgSettingsIdentifier = vpgSettingsIdentifier_example; // {{String}} Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
var vmIdentifier = vmIdentifier_example; // {{String}} Vm Identifier.Related endpoint: `v1/vms`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVpgSettingVmNicAll(vpgSettingsIdentifier, vmIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVpgSettingVmNicAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGVirtualProtectionGroupSettingsApi();
            var vpgSettingsIdentifier = vpgSettingsIdentifier_example;  // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
            var vmIdentifier = vmIdentifier_example;  // String | Vm Identifier.Related endpoint: `v1/vms`

            try
            {
                // Get NICs of specific VM in VPG settings (Auth)
                array[VpgSettingsVmNicApi] result = apiInstance.getVpgSettingVmNicAll(vpgSettingsIdentifier, vmIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGVirtualProtectionGroupSettingsApi.getVpgSettingVmNicAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGVirtualProtectionGroupSettingsApi();
$vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
$vmIdentifier = vmIdentifier_example; // String | Vm Identifier.Related endpoint: `v1/vms`

try {
    $result = $api_instance->getVpgSettingVmNicAll($vpgSettingsIdentifier, $vmIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VPGVirtualProtectionGroupSettingsApi->getVpgSettingVmNicAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi->new();
my $vpgSettingsIdentifier = vpgSettingsIdentifier_example; # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
my $vmIdentifier = vmIdentifier_example; # String | Vm Identifier.Related endpoint: `v1/vms`

eval { 
    my $result = $api_instance->getVpgSettingVmNicAll(vpgSettingsIdentifier => $vpgSettingsIdentifier, vmIdentifier => $vmIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VPGVirtualProtectionGroupSettingsApi->getVpgSettingVmNicAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGVirtualProtectionGroupSettingsApi()
vpgSettingsIdentifier = vpgSettingsIdentifier_example # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
vmIdentifier = vmIdentifier_example # String | Vm Identifier.Related endpoint: `v1/vms`

try: 
    # Get NICs of specific VM in VPG settings (Auth)
    api_response = api_instance.get_vpg_setting_vm_nic_all(vpgSettingsIdentifier, vmIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VPGVirtualProtectionGroupSettingsApi->getVpgSettingVmNicAll: %s\n" % e)

Parameters

Path parameters
Name Description
vpgSettingsIdentifier*
String
Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
Required
vmIdentifier*
String
Vm Identifier.Related endpoint: `v1/vms`
Required

Responses

Status: 200 - Success

[
{
nicIdentifier:
string
failoverTest:
{
hypervisor:
{
networkIdentifier:
string
shouldReplaceMacAddress:
boolean
dnsSuffix:
string
ipConfig:
{
staticIp:
string
subnetMask:
string
gateway:
string
primaryDns:
string
secondaryDns:
string
isDhcp:
boolean
}
}
vcd:
{
isResetMacAddress:
boolean
isPrimary:
boolean
isConnected:
boolean
ipMode:
string
ipAddress:
string
recoveryOrgVdcNetworkIdentifier:
string
}
publicCloud:
{
subnetIdentifier:
string
securityGroupIdentifier:
string
privateIP:
string
isPrimary:
boolean
}
}
failover:
{
hypervisor:
{
networkIdentifier:
string
shouldReplaceMacAddress:
boolean
dnsSuffix:
string
ipConfig:
{
staticIp:
string
subnetMask:
string
gateway:
string
primaryDns:
string
secondaryDns:
string
isDhcp:
boolean
}
}
vcd:
{
isResetMacAddress:
boolean
isPrimary:
boolean
isConnected:
boolean
ipMode:
string
ipAddress:
string
recoveryOrgVdcNetworkIdentifier:
string
}
publicCloud:
{
subnetIdentifier:
string
securityGroupIdentifier:
string
privateIP:
string
isPrimary:
boolean
}
}
}
]

getVpgSettingVmVolume

Get the Volume details of specific VM in VPG settings (Auth)


/v1/vpgSettings/{vpgSettingsIdentifier}/vms/{vmIdentifier}/volumes/{volumeIdentifier}

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgSettings/{vpgSettingsIdentifier}/vms/{vmIdentifier}/volumes/{volumeIdentifier}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

import java.io.File;
import java.util.*;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        String vmIdentifier = vmIdentifier_example; // String | Vm Identifier.Related endpoint: `v1/vms`
        String volumeIdentifier = volumeIdentifier_example; // String | Volume Identifier. Related endpoint: `Get: v1/volumes`
        try {
            VpgSettingsVmVolumeApi result = apiInstance.getVpgSettingVmVolume(vpgSettingsIdentifier, vmIdentifier, volumeIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#getVpgSettingVmVolume");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        String vmIdentifier = vmIdentifier_example; // String | Vm Identifier.Related endpoint: `v1/vms`
        String volumeIdentifier = volumeIdentifier_example; // String | Volume Identifier. Related endpoint: `Get: v1/volumes`
        try {
            VpgSettingsVmVolumeApi result = apiInstance.getVpgSettingVmVolume(vpgSettingsIdentifier, vmIdentifier, volumeIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#getVpgSettingVmVolume");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgSettingsIdentifier = vpgSettingsIdentifier_example; // Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
String *vmIdentifier = vmIdentifier_example; // Vm Identifier.Related endpoint: `v1/vms`
String *volumeIdentifier = volumeIdentifier_example; // Volume Identifier. Related endpoint: `Get: v1/volumes`

VPGVirtualProtectionGroupSettingsApi *apiInstance = [[VPGVirtualProtectionGroupSettingsApi alloc] init];

// Get the Volume details of specific VM in VPG settings (Auth)
[apiInstance getVpgSettingVmVolumeWith:vpgSettingsIdentifier
    vmIdentifier:vmIdentifier
    volumeIdentifier:volumeIdentifier
              completionHandler: ^(VpgSettingsVmVolumeApi output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGVirtualProtectionGroupSettingsApi()
var vpgSettingsIdentifier = vpgSettingsIdentifier_example; // {{String}} Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
var vmIdentifier = vmIdentifier_example; // {{String}} Vm Identifier.Related endpoint: `v1/vms`
var volumeIdentifier = volumeIdentifier_example; // {{String}} Volume Identifier. Related endpoint: `Get: v1/volumes`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVpgSettingVmVolume(vpgSettingsIdentifier, vmIdentifier, volumeIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVpgSettingVmVolumeExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGVirtualProtectionGroupSettingsApi();
            var vpgSettingsIdentifier = vpgSettingsIdentifier_example;  // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
            var vmIdentifier = vmIdentifier_example;  // String | Vm Identifier.Related endpoint: `v1/vms`
            var volumeIdentifier = volumeIdentifier_example;  // String | Volume Identifier. Related endpoint: `Get: v1/volumes`

            try
            {
                // Get the Volume details of specific VM in VPG settings (Auth)
                VpgSettingsVmVolumeApi result = apiInstance.getVpgSettingVmVolume(vpgSettingsIdentifier, vmIdentifier, volumeIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGVirtualProtectionGroupSettingsApi.getVpgSettingVmVolume: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGVirtualProtectionGroupSettingsApi();
$vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
$vmIdentifier = vmIdentifier_example; // String | Vm Identifier.Related endpoint: `v1/vms`
$volumeIdentifier = volumeIdentifier_example; // String | Volume Identifier. Related endpoint: `Get: v1/volumes`

try {
    $result = $api_instance->getVpgSettingVmVolume($vpgSettingsIdentifier, $vmIdentifier, $volumeIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VPGVirtualProtectionGroupSettingsApi->getVpgSettingVmVolume: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi->new();
my $vpgSettingsIdentifier = vpgSettingsIdentifier_example; # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
my $vmIdentifier = vmIdentifier_example; # String | Vm Identifier.Related endpoint: `v1/vms`
my $volumeIdentifier = volumeIdentifier_example; # String | Volume Identifier. Related endpoint: `Get: v1/volumes`

eval { 
    my $result = $api_instance->getVpgSettingVmVolume(vpgSettingsIdentifier => $vpgSettingsIdentifier, vmIdentifier => $vmIdentifier, volumeIdentifier => $volumeIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VPGVirtualProtectionGroupSettingsApi->getVpgSettingVmVolume: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGVirtualProtectionGroupSettingsApi()
vpgSettingsIdentifier = vpgSettingsIdentifier_example # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
vmIdentifier = vmIdentifier_example # String | Vm Identifier.Related endpoint: `v1/vms`
volumeIdentifier = volumeIdentifier_example # String | Volume Identifier. Related endpoint: `Get: v1/volumes`

try: 
    # Get the Volume details of specific VM in VPG settings (Auth)
    api_response = api_instance.get_vpg_setting_vm_volume(vpgSettingsIdentifier, vmIdentifier, volumeIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VPGVirtualProtectionGroupSettingsApi->getVpgSettingVmVolume: %s\n" % e)

Parameters

Path parameters
Name Description
vpgSettingsIdentifier*
String
Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
Required
vmIdentifier*
String
Vm Identifier.Related endpoint: `v1/vms`
Required
volumeIdentifier*
String
Volume Identifier. Related endpoint: `Get: v1/volumes`
Required

Responses

Status: 200 - Success

{
volumeIdentifier:
string
vcd:
{
isThin:
boolean
}
preseed:
{
datastoreIdentifier:
string
path:
string
}
rdm:
{
deviceIdentifier:
string
isPhysical:
boolean
}
datastore:
{
datastoreClusterIdentifier:
string
datastoreIdentifier:
string
isThin:
boolean
}
isSwap:
boolean
}

getVpgSettingVmVolumeAll

Get Volumes of specific VM in VPG settings (Auth)


/v1/vpgSettings/{vpgSettingsIdentifier}/vms/{vmIdentifier}/volumes

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgSettings/{vpgSettingsIdentifier}/vms/{vmIdentifier}/volumes"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

import java.io.File;
import java.util.*;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        String vmIdentifier = vmIdentifier_example; // String | Vm Identifier.Related endpoint: `v1/vms`
        try {
            array[VpgSettingsVmVolumeApi] result = apiInstance.getVpgSettingVmVolumeAll(vpgSettingsIdentifier, vmIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#getVpgSettingVmVolumeAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        String vmIdentifier = vmIdentifier_example; // String | Vm Identifier.Related endpoint: `v1/vms`
        try {
            array[VpgSettingsVmVolumeApi] result = apiInstance.getVpgSettingVmVolumeAll(vpgSettingsIdentifier, vmIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#getVpgSettingVmVolumeAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgSettingsIdentifier = vpgSettingsIdentifier_example; // Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
String *vmIdentifier = vmIdentifier_example; // Vm Identifier.Related endpoint: `v1/vms`

VPGVirtualProtectionGroupSettingsApi *apiInstance = [[VPGVirtualProtectionGroupSettingsApi alloc] init];

// Get Volumes of specific VM in VPG settings (Auth)
[apiInstance getVpgSettingVmVolumeAllWith:vpgSettingsIdentifier
    vmIdentifier:vmIdentifier
              completionHandler: ^(array[VpgSettingsVmVolumeApi] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGVirtualProtectionGroupSettingsApi()
var vpgSettingsIdentifier = vpgSettingsIdentifier_example; // {{String}} Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
var vmIdentifier = vmIdentifier_example; // {{String}} Vm Identifier.Related endpoint: `v1/vms`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVpgSettingVmVolumeAll(vpgSettingsIdentifier, vmIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVpgSettingVmVolumeAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGVirtualProtectionGroupSettingsApi();
            var vpgSettingsIdentifier = vpgSettingsIdentifier_example;  // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
            var vmIdentifier = vmIdentifier_example;  // String | Vm Identifier.Related endpoint: `v1/vms`

            try
            {
                // Get Volumes of specific VM in VPG settings (Auth)
                array[VpgSettingsVmVolumeApi] result = apiInstance.getVpgSettingVmVolumeAll(vpgSettingsIdentifier, vmIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGVirtualProtectionGroupSettingsApi.getVpgSettingVmVolumeAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGVirtualProtectionGroupSettingsApi();
$vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
$vmIdentifier = vmIdentifier_example; // String | Vm Identifier.Related endpoint: `v1/vms`

try {
    $result = $api_instance->getVpgSettingVmVolumeAll($vpgSettingsIdentifier, $vmIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VPGVirtualProtectionGroupSettingsApi->getVpgSettingVmVolumeAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi->new();
my $vpgSettingsIdentifier = vpgSettingsIdentifier_example; # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
my $vmIdentifier = vmIdentifier_example; # String | Vm Identifier.Related endpoint: `v1/vms`

eval { 
    my $result = $api_instance->getVpgSettingVmVolumeAll(vpgSettingsIdentifier => $vpgSettingsIdentifier, vmIdentifier => $vmIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VPGVirtualProtectionGroupSettingsApi->getVpgSettingVmVolumeAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGVirtualProtectionGroupSettingsApi()
vpgSettingsIdentifier = vpgSettingsIdentifier_example # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
vmIdentifier = vmIdentifier_example # String | Vm Identifier.Related endpoint: `v1/vms`

try: 
    # Get Volumes of specific VM in VPG settings (Auth)
    api_response = api_instance.get_vpg_setting_vm_volume_all(vpgSettingsIdentifier, vmIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VPGVirtualProtectionGroupSettingsApi->getVpgSettingVmVolumeAll: %s\n" % e)

Parameters

Path parameters
Name Description
vpgSettingsIdentifier*
String
Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
Required
vmIdentifier*
String
Vm Identifier.Related endpoint: `v1/vms`
Required

Responses

Status: 200 - Success

[
{
volumeIdentifier:
string
vcd:
{
isThin:
boolean
}
preseed:
{
datastoreIdentifier:
string
path:
string
}
rdm:
{
deviceIdentifier:
string
isPhysical:
boolean
}
datastore:
{
datastoreClusterIdentifier:
string
datastoreIdentifier:
string
isThin:
boolean
}
isSwap:
boolean
}
]

newVpgSetting

Create a new VPG settings object, returns the settings object identifier (Auth)


/v1/vpgSettings

Usage and SDK Samples

curl -X POST\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
-H "Content-Type: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgSettings"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

import java.io.File;
import java.util.*;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        VpgSettingsApi body = ; // VpgSettingsApi | 
        try {
            'String' result = apiInstance.newVpgSetting(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#newVpgSetting");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        VpgSettingsApi body = ; // VpgSettingsApi | 
        try {
            'String' result = apiInstance.newVpgSetting(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#newVpgSetting");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
VpgSettingsApi *body = ; //  (optional)

VPGVirtualProtectionGroupSettingsApi *apiInstance = [[VPGVirtualProtectionGroupSettingsApi alloc] init];

// Create a new VPG settings object, returns the settings object identifier (Auth)
[apiInstance newVpgSettingWith:body
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGVirtualProtectionGroupSettingsApi()
var opts = { 
  'body':  // {{VpgSettingsApi}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.newVpgSetting(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class newVpgSettingExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGVirtualProtectionGroupSettingsApi();
            var body = new VpgSettingsApi(); // VpgSettingsApi |  (optional) 

            try
            {
                // Create a new VPG settings object, returns the settings object identifier (Auth)
                'String' result = apiInstance.newVpgSetting(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGVirtualProtectionGroupSettingsApi.newVpgSetting: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGVirtualProtectionGroupSettingsApi();
$body = ; // VpgSettingsApi | 

try {
    $result = $api_instance->newVpgSetting($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VPGVirtualProtectionGroupSettingsApi->newVpgSetting: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi->new();
my $body = WWW::SwaggerClient::Object::VpgSettingsApi->new(); # VpgSettingsApi | 

eval { 
    my $result = $api_instance->newVpgSetting(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VPGVirtualProtectionGroupSettingsApi->newVpgSetting: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGVirtualProtectionGroupSettingsApi()
body =  # VpgSettingsApi |  (optional)

try: 
    # Create a new VPG settings object, returns the settings object identifier (Auth)
    api_response = api_instance.new_vpg_setting(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VPGVirtualProtectionGroupSettingsApi->newVpgSetting: %s\n" % e)

Parameters

Body parameters
Name Description
body
{
vpgIdentifier:
string
vpgSettingsIdentifier:
string
basic:
{
zorgIdentifier:
name:
vpgType:
rpoInSeconds:
testIntervalInMinutes:
journalHistoryInHours:
priority:
useWanCompression:
serviceProfileIdentifier:
protectedSiteIdentifier:
recoverySiteIdentifier:
}
scripting:
{
preRecovery:
postRecovery:
postBackup:
}
bootGroups:
{
bootGroups:
}
journal:
{
limitation:
datastoreIdentifier:
}
longTermRetention:
{
enabled:
repositoryIdentifier:
retentionRunTime:
schedulerPolicy:
retry:
indexing:
compression:
}
recovery:
{
defaultHostIdentifier:
defaultHostClusterIdentifier:
defaultDatastoreIdentifier:
defaultDatastoreClusterIdentifier:
defaultFolderIdentifier:
resourcePoolIdentifier:
vcd:
publicCloud:
}
networks:
{
failover:
failoverTest:
}
vms:
[
{
vmIdentifier:
string
recovery:
{
hostIdentifier:
string
hostClusterIdentifier:
string
datastoreIdentifier:
string
datastoreClusterIdentifier:
string
folderIdentifier:
string
resourcePoolIdentifier:
string
vcd:
{
storagePolicyIdentifier:
string
}
publicCloud:
{
failover:
{
vmInstanceType:
string
azure:
{
recoveryDiskType:
string
}
virtualNetworkIdentifier:
string
}
failoverTest:
{
vmInstanceType:
string
azure:
{
recoveryDiskType:
string
}
virtualNetworkIdentifier:
string
}
}
useVmEncryption:
boolean
}
bootGroupIdentifier:
string
journal:
{
limitation:
{
hardLimitInMB:
integer (int32)
hardLimitInPercent:
integer (int32)
warningThresholdInMB:
integer (int32)
warningThresholdInPercent:
integer (int32)
}
datastoreIdentifier:
string
}
volumes:
[
{
volumeIdentifier:
string
vcd:
{
isThin:
boolean
}
preseed:
{
datastoreIdentifier:
string
path:
string
}
rdm:
{
deviceIdentifier:
string
isPhysical:
boolean
}
datastore:
{
datastoreClusterIdentifier:
string
datastoreIdentifier:
string
isThin:
boolean
}
isSwap:
boolean
}
]
nics:
[
{
nicIdentifier:
string
failoverTest:
{
hypervisor:
{
networkIdentifier:
string
shouldReplaceMacAddress:
boolean
dnsSuffix:
string
ipConfig:
{
staticIp:
string
subnetMask:
string
gateway:
string
primaryDns:
string
secondaryDns:
string
isDhcp:
boolean
}
}
vcd:
{
isResetMacAddress:
boolean
isPrimary:
boolean
isConnected:
boolean
ipMode:
string
ipAddress:
string
recoveryOrgVdcNetworkIdentifier:
string
}
publicCloud:
{
subnetIdentifier:
string
securityGroupIdentifier:
string
privateIP:
string
isPrimary:
boolean
}
}
failover:
{
hypervisor:
{
networkIdentifier:
string
shouldReplaceMacAddress:
boolean
dnsSuffix:
string
ipConfig:
{
staticIp:
string
subnetMask:
string
gateway:
string
primaryDns:
string
secondaryDns:
string
isDhcp:
boolean
}
}
vcd:
{
isResetMacAddress:
boolean
isPrimary:
boolean
isConnected:
boolean
ipMode:
string
ipAddress:
string
recoveryOrgVdcNetworkIdentifier:
string
}
publicCloud:
{
subnetIdentifier:
string
securityGroupIdentifier:
string
privateIP:
string
isPrimary:
boolean
}
}
}
]
}
]
protected:
{
vcd:
}
}

Responses

Status: 200 - Success

string

newVpgSettingLtr

Create Long-term Retention VPG settings (Auth)


/v1/vpgSettings/{vpgSettingsIdentifier}/ltr

Usage and SDK Samples

curl -X POST\
-H "x-zerto-session: [[apiKey]]"\
-H "Content-Type: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgSettings/{vpgSettingsIdentifier}/ltr"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

import java.io.File;
import java.util.*;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        VpgSettingsLtrApi body = ; // VpgSettingsLtrApi | 
        try {
            apiInstance.newVpgSettingLtr(vpgSettingsIdentifier, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#newVpgSettingLtr");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        VpgSettingsLtrApi body = ; // VpgSettingsLtrApi | 
        try {
            apiInstance.newVpgSettingLtr(vpgSettingsIdentifier, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#newVpgSettingLtr");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgSettingsIdentifier = vpgSettingsIdentifier_example; // Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
VpgSettingsLtrApi *body = ; //  (optional)

VPGVirtualProtectionGroupSettingsApi *apiInstance = [[VPGVirtualProtectionGroupSettingsApi alloc] init];

// Create Long-term Retention VPG settings (Auth)
[apiInstance newVpgSettingLtrWith:vpgSettingsIdentifier
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGVirtualProtectionGroupSettingsApi()
var vpgSettingsIdentifier = vpgSettingsIdentifier_example; // {{String}} Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
var opts = { 
  'body':  // {{VpgSettingsLtrApi}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.newVpgSettingLtr(vpgSettingsIdentifier, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class newVpgSettingLtrExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGVirtualProtectionGroupSettingsApi();
            var vpgSettingsIdentifier = vpgSettingsIdentifier_example;  // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
            var body = new VpgSettingsLtrApi(); // VpgSettingsLtrApi |  (optional) 

            try
            {
                // Create Long-term Retention VPG settings (Auth)
                apiInstance.newVpgSettingLtr(vpgSettingsIdentifier, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGVirtualProtectionGroupSettingsApi.newVpgSettingLtr: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGVirtualProtectionGroupSettingsApi();
$vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
$body = ; // VpgSettingsLtrApi | 

try {
    $api_instance->newVpgSettingLtr($vpgSettingsIdentifier, $body);
} catch (Exception $e) {
    echo 'Exception when calling VPGVirtualProtectionGroupSettingsApi->newVpgSettingLtr: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi->new();
my $vpgSettingsIdentifier = vpgSettingsIdentifier_example; # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
my $body = WWW::SwaggerClient::Object::VpgSettingsLtrApi->new(); # VpgSettingsLtrApi | 

eval { 
    $api_instance->newVpgSettingLtr(vpgSettingsIdentifier => $vpgSettingsIdentifier, body => $body);
};
if ($@) {
    warn "Exception when calling VPGVirtualProtectionGroupSettingsApi->newVpgSettingLtr: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGVirtualProtectionGroupSettingsApi()
vpgSettingsIdentifier = vpgSettingsIdentifier_example # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
body =  # VpgSettingsLtrApi |  (optional)

try: 
    # Create Long-term Retention VPG settings (Auth)
    api_instance.new_vpg_setting_ltr(vpgSettingsIdentifier, body=body)
except ApiException as e:
    print("Exception when calling VPGVirtualProtectionGroupSettingsApi->newVpgSettingLtr: %s\n" % e)

Parameters

Path parameters
Name Description
vpgSettingsIdentifier*
String
Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
Required
Body parameters
Name Description
body
{
enabled:
boolean
repositoryIdentifier:
string
retentionRunTime:
string
schedulerPolicy:
{
daily:
weekly:
monthly:
yearly:
}
retry:
{
enabled:
number:
intervalInMinutes:
}
indexing:
{
vms:
}
compression:
string
}

Responses

Status: 200 - Success


newVpgSettingVm

Add new VMs to VPG settings (Auth)


/v1/vpgSettings/{vpgSettingsIdentifier}/vms

Usage and SDK Samples

curl -X POST\
-H "x-zerto-session: [[apiKey]]"\
-H "Content-Type: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgSettings/{vpgSettingsIdentifier}/vms"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

import java.io.File;
import java.util.*;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        VpgSettingsVmApi body = ; // VpgSettingsVmApi | 
        try {
            apiInstance.newVpgSettingVm(vpgSettingsIdentifier, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#newVpgSettingVm");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        VpgSettingsVmApi body = ; // VpgSettingsVmApi | 
        try {
            apiInstance.newVpgSettingVm(vpgSettingsIdentifier, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#newVpgSettingVm");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgSettingsIdentifier = vpgSettingsIdentifier_example; // Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
VpgSettingsVmApi *body = ; //  (optional)

VPGVirtualProtectionGroupSettingsApi *apiInstance = [[VPGVirtualProtectionGroupSettingsApi alloc] init];

// Add new VMs to VPG settings (Auth)
[apiInstance newVpgSettingVmWith:vpgSettingsIdentifier
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGVirtualProtectionGroupSettingsApi()
var vpgSettingsIdentifier = vpgSettingsIdentifier_example; // {{String}} Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
var opts = { 
  'body':  // {{VpgSettingsVmApi}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.newVpgSettingVm(vpgSettingsIdentifier, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class newVpgSettingVmExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGVirtualProtectionGroupSettingsApi();
            var vpgSettingsIdentifier = vpgSettingsIdentifier_example;  // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
            var body = new VpgSettingsVmApi(); // VpgSettingsVmApi |  (optional) 

            try
            {
                // Add new VMs to VPG settings (Auth)
                apiInstance.newVpgSettingVm(vpgSettingsIdentifier, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGVirtualProtectionGroupSettingsApi.newVpgSettingVm: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGVirtualProtectionGroupSettingsApi();
$vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
$body = ; // VpgSettingsVmApi | 

try {
    $api_instance->newVpgSettingVm($vpgSettingsIdentifier, $body);
} catch (Exception $e) {
    echo 'Exception when calling VPGVirtualProtectionGroupSettingsApi->newVpgSettingVm: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi->new();
my $vpgSettingsIdentifier = vpgSettingsIdentifier_example; # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
my $body = WWW::SwaggerClient::Object::VpgSettingsVmApi->new(); # VpgSettingsVmApi | 

eval { 
    $api_instance->newVpgSettingVm(vpgSettingsIdentifier => $vpgSettingsIdentifier, body => $body);
};
if ($@) {
    warn "Exception when calling VPGVirtualProtectionGroupSettingsApi->newVpgSettingVm: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGVirtualProtectionGroupSettingsApi()
vpgSettingsIdentifier = vpgSettingsIdentifier_example # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
body =  # VpgSettingsVmApi |  (optional)

try: 
    # Add new VMs to VPG settings (Auth)
    api_instance.new_vpg_setting_vm(vpgSettingsIdentifier, body=body)
except ApiException as e:
    print("Exception when calling VPGVirtualProtectionGroupSettingsApi->newVpgSettingVm: %s\n" % e)

Parameters

Path parameters
Name Description
vpgSettingsIdentifier*
String
Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
Required
Body parameters
Name Description
body
{
vmIdentifier:
string
recovery:
{
hostIdentifier:
hostClusterIdentifier:
datastoreIdentifier:
datastoreClusterIdentifier:
folderIdentifier:
resourcePoolIdentifier:
vcd:
publicCloud:
useVmEncryption:
}
bootGroupIdentifier:
string
journal:
{
limitation:
datastoreIdentifier:
}
volumes:
[
{
volumeIdentifier:
string
vcd:
{
isThin:
boolean
}
preseed:
{
datastoreIdentifier:
string
path:
string
}
rdm:
{
deviceIdentifier:
string
isPhysical:
boolean
}
datastore:
{
datastoreClusterIdentifier:
string
datastoreIdentifier:
string
isThin:
boolean
}
isSwap:
boolean
}
]
nics:
[
{
nicIdentifier:
string
failoverTest:
{
hypervisor:
{
networkIdentifier:
string
shouldReplaceMacAddress:
boolean
dnsSuffix:
string
ipConfig:
{
staticIp:
string
subnetMask:
string
gateway:
string
primaryDns:
string
secondaryDns:
string
isDhcp:
boolean
}
}
vcd:
{
isResetMacAddress:
boolean
isPrimary:
boolean
isConnected:
boolean
ipMode:
string
ipAddress:
string
recoveryOrgVdcNetworkIdentifier:
string
}
publicCloud:
{
subnetIdentifier:
string
securityGroupIdentifier:
string
privateIP:
string
isPrimary:
boolean
}
}
failover:
{
hypervisor:
{
networkIdentifier:
string
shouldReplaceMacAddress:
boolean
dnsSuffix:
string
ipConfig:
{
staticIp:
string
subnetMask:
string
gateway:
string
primaryDns:
string
secondaryDns:
string
isDhcp:
boolean
}
}
vcd:
{
isResetMacAddress:
boolean
isPrimary:
boolean
isConnected:
boolean
ipMode:
string
ipAddress:
string
recoveryOrgVdcNetworkIdentifier:
string
}
publicCloud:
{
subnetIdentifier:
string
securityGroupIdentifier:
string
privateIP:
string
isPrimary:
boolean
}
}
}
]
}

Responses

Status: 200 - Success


removeVpgSetting

Delete VPG settings. (Auth)


/v1/vpgSettings/{vpgSettingsIdentifier}

Usage and SDK Samples

curl -X DELETE\
-H "x-zerto-session: [[apiKey]]"\
"https://localhost:9669//v1/vpgSettings/{vpgSettingsIdentifier}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

import java.io.File;
import java.util.*;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        try {
            apiInstance.removeVpgSetting(vpgSettingsIdentifier);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#removeVpgSetting");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        try {
            apiInstance.removeVpgSetting(vpgSettingsIdentifier);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#removeVpgSetting");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgSettingsIdentifier = vpgSettingsIdentifier_example; // Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

VPGVirtualProtectionGroupSettingsApi *apiInstance = [[VPGVirtualProtectionGroupSettingsApi alloc] init];

// Delete VPG settings. (Auth)
[apiInstance removeVpgSettingWith:vpgSettingsIdentifier
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGVirtualProtectionGroupSettingsApi()
var vpgSettingsIdentifier = vpgSettingsIdentifier_example; // {{String}} Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.removeVpgSetting(vpgSettingsIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class removeVpgSettingExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGVirtualProtectionGroupSettingsApi();
            var vpgSettingsIdentifier = vpgSettingsIdentifier_example;  // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

            try
            {
                // Delete VPG settings. (Auth)
                apiInstance.removeVpgSetting(vpgSettingsIdentifier);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGVirtualProtectionGroupSettingsApi.removeVpgSetting: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGVirtualProtectionGroupSettingsApi();
$vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

try {
    $api_instance->removeVpgSetting($vpgSettingsIdentifier);
} catch (Exception $e) {
    echo 'Exception when calling VPGVirtualProtectionGroupSettingsApi->removeVpgSetting: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi->new();
my $vpgSettingsIdentifier = vpgSettingsIdentifier_example; # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

eval { 
    $api_instance->removeVpgSetting(vpgSettingsIdentifier => $vpgSettingsIdentifier);
};
if ($@) {
    warn "Exception when calling VPGVirtualProtectionGroupSettingsApi->removeVpgSetting: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGVirtualProtectionGroupSettingsApi()
vpgSettingsIdentifier = vpgSettingsIdentifier_example # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

try: 
    # Delete VPG settings. (Auth)
    api_instance.remove_vpg_setting(vpgSettingsIdentifier)
except ApiException as e:
    print("Exception when calling VPGVirtualProtectionGroupSettingsApi->removeVpgSetting: %s\n" % e)

Parameters

Path parameters
Name Description
vpgSettingsIdentifier*
String
Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
Required

Responses

Status: 200 - Success


removeVpgSettingJournal

Delete Journal VPG settings (Auth)


/v1/vpgSettings/{vpgSettingsIdentifier}/journal

Usage and SDK Samples

curl -X DELETE\
-H "x-zerto-session: [[apiKey]]"\
"https://localhost:9669//v1/vpgSettings/{vpgSettingsIdentifier}/journal"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

import java.io.File;
import java.util.*;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        try {
            apiInstance.removeVpgSettingJournal(vpgSettingsIdentifier);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#removeVpgSettingJournal");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        try {
            apiInstance.removeVpgSettingJournal(vpgSettingsIdentifier);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#removeVpgSettingJournal");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgSettingsIdentifier = vpgSettingsIdentifier_example; // Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

VPGVirtualProtectionGroupSettingsApi *apiInstance = [[VPGVirtualProtectionGroupSettingsApi alloc] init];

// Delete Journal VPG settings (Auth)
[apiInstance removeVpgSettingJournalWith:vpgSettingsIdentifier
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGVirtualProtectionGroupSettingsApi()
var vpgSettingsIdentifier = vpgSettingsIdentifier_example; // {{String}} Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.removeVpgSettingJournal(vpgSettingsIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class removeVpgSettingJournalExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGVirtualProtectionGroupSettingsApi();
            var vpgSettingsIdentifier = vpgSettingsIdentifier_example;  // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

            try
            {
                // Delete Journal VPG settings (Auth)
                apiInstance.removeVpgSettingJournal(vpgSettingsIdentifier);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGVirtualProtectionGroupSettingsApi.removeVpgSettingJournal: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGVirtualProtectionGroupSettingsApi();
$vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

try {
    $api_instance->removeVpgSettingJournal($vpgSettingsIdentifier);
} catch (Exception $e) {
    echo 'Exception when calling VPGVirtualProtectionGroupSettingsApi->removeVpgSettingJournal: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi->new();
my $vpgSettingsIdentifier = vpgSettingsIdentifier_example; # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

eval { 
    $api_instance->removeVpgSettingJournal(vpgSettingsIdentifier => $vpgSettingsIdentifier);
};
if ($@) {
    warn "Exception when calling VPGVirtualProtectionGroupSettingsApi->removeVpgSettingJournal: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGVirtualProtectionGroupSettingsApi()
vpgSettingsIdentifier = vpgSettingsIdentifier_example # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

try: 
    # Delete Journal VPG settings (Auth)
    api_instance.remove_vpg_setting_journal(vpgSettingsIdentifier)
except ApiException as e:
    print("Exception when calling VPGVirtualProtectionGroupSettingsApi->removeVpgSettingJournal: %s\n" % e)

Parameters

Path parameters
Name Description
vpgSettingsIdentifier*
String
Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
Required

Responses

Status: 200 - Success


removeVpgSettingLtr

Delete Long-term Retention VPG settings (Auth)


/v1/vpgSettings/{vpgSettingsIdentifier}/ltr

Usage and SDK Samples

curl -X DELETE\
-H "x-zerto-session: [[apiKey]]"\
"https://localhost:9669//v1/vpgSettings/{vpgSettingsIdentifier}/ltr"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

import java.io.File;
import java.util.*;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        try {
            apiInstance.removeVpgSettingLtr(vpgSettingsIdentifier);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#removeVpgSettingLtr");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        try {
            apiInstance.removeVpgSettingLtr(vpgSettingsIdentifier);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#removeVpgSettingLtr");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgSettingsIdentifier = vpgSettingsIdentifier_example; // Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

VPGVirtualProtectionGroupSettingsApi *apiInstance = [[VPGVirtualProtectionGroupSettingsApi alloc] init];

// Delete Long-term Retention VPG settings (Auth)
[apiInstance removeVpgSettingLtrWith:vpgSettingsIdentifier
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGVirtualProtectionGroupSettingsApi()
var vpgSettingsIdentifier = vpgSettingsIdentifier_example; // {{String}} Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.removeVpgSettingLtr(vpgSettingsIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class removeVpgSettingLtrExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGVirtualProtectionGroupSettingsApi();
            var vpgSettingsIdentifier = vpgSettingsIdentifier_example;  // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

            try
            {
                // Delete Long-term Retention VPG settings (Auth)
                apiInstance.removeVpgSettingLtr(vpgSettingsIdentifier);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGVirtualProtectionGroupSettingsApi.removeVpgSettingLtr: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGVirtualProtectionGroupSettingsApi();
$vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

try {
    $api_instance->removeVpgSettingLtr($vpgSettingsIdentifier);
} catch (Exception $e) {
    echo 'Exception when calling VPGVirtualProtectionGroupSettingsApi->removeVpgSettingLtr: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi->new();
my $vpgSettingsIdentifier = vpgSettingsIdentifier_example; # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

eval { 
    $api_instance->removeVpgSettingLtr(vpgSettingsIdentifier => $vpgSettingsIdentifier);
};
if ($@) {
    warn "Exception when calling VPGVirtualProtectionGroupSettingsApi->removeVpgSettingLtr: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGVirtualProtectionGroupSettingsApi()
vpgSettingsIdentifier = vpgSettingsIdentifier_example # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

try: 
    # Delete Long-term Retention VPG settings (Auth)
    api_instance.remove_vpg_setting_ltr(vpgSettingsIdentifier)
except ApiException as e:
    print("Exception when calling VPGVirtualProtectionGroupSettingsApi->removeVpgSettingLtr: %s\n" % e)

Parameters

Path parameters
Name Description
vpgSettingsIdentifier*
String
Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
Required

Responses

Status: 200 - Success


removeVpgSettingLtrNetwork

Delete Network VPG settings (Auth)


/v1/vpgSettings/{vpgSettingsIdentifier}/networks

Usage and SDK Samples

curl -X DELETE\
-H "x-zerto-session: [[apiKey]]"\
"https://localhost:9669//v1/vpgSettings/{vpgSettingsIdentifier}/networks"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

import java.io.File;
import java.util.*;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        try {
            apiInstance.removeVpgSettingLtrNetwork(vpgSettingsIdentifier);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#removeVpgSettingLtrNetwork");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        try {
            apiInstance.removeVpgSettingLtrNetwork(vpgSettingsIdentifier);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#removeVpgSettingLtrNetwork");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgSettingsIdentifier = vpgSettingsIdentifier_example; // Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

VPGVirtualProtectionGroupSettingsApi *apiInstance = [[VPGVirtualProtectionGroupSettingsApi alloc] init];

// Delete Network VPG settings (Auth)
[apiInstance removeVpgSettingLtrNetworkWith:vpgSettingsIdentifier
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGVirtualProtectionGroupSettingsApi()
var vpgSettingsIdentifier = vpgSettingsIdentifier_example; // {{String}} Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.removeVpgSettingLtrNetwork(vpgSettingsIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class removeVpgSettingLtrNetworkExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGVirtualProtectionGroupSettingsApi();
            var vpgSettingsIdentifier = vpgSettingsIdentifier_example;  // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

            try
            {
                // Delete Network VPG settings (Auth)
                apiInstance.removeVpgSettingLtrNetwork(vpgSettingsIdentifier);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGVirtualProtectionGroupSettingsApi.removeVpgSettingLtrNetwork: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGVirtualProtectionGroupSettingsApi();
$vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

try {
    $api_instance->removeVpgSettingLtrNetwork($vpgSettingsIdentifier);
} catch (Exception $e) {
    echo 'Exception when calling VPGVirtualProtectionGroupSettingsApi->removeVpgSettingLtrNetwork: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi->new();
my $vpgSettingsIdentifier = vpgSettingsIdentifier_example; # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

eval { 
    $api_instance->removeVpgSettingLtrNetwork(vpgSettingsIdentifier => $vpgSettingsIdentifier);
};
if ($@) {
    warn "Exception when calling VPGVirtualProtectionGroupSettingsApi->removeVpgSettingLtrNetwork: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGVirtualProtectionGroupSettingsApi()
vpgSettingsIdentifier = vpgSettingsIdentifier_example # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

try: 
    # Delete Network VPG settings (Auth)
    api_instance.remove_vpg_setting_ltr_network(vpgSettingsIdentifier)
except ApiException as e:
    print("Exception when calling VPGVirtualProtectionGroupSettingsApi->removeVpgSettingLtrNetwork: %s\n" % e)

Parameters

Path parameters
Name Description
vpgSettingsIdentifier*
String
Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
Required

Responses

Status: 200 - Success


removeVpgSettingRecovery

Delete Recovery VPG settings (Auth)


/v1/vpgSettings/{vpgSettingsIdentifier}/recovery

Usage and SDK Samples

curl -X DELETE\
-H "x-zerto-session: [[apiKey]]"\
"https://localhost:9669//v1/vpgSettings/{vpgSettingsIdentifier}/recovery"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

import java.io.File;
import java.util.*;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        try {
            apiInstance.removeVpgSettingRecovery(vpgSettingsIdentifier);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#removeVpgSettingRecovery");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        try {
            apiInstance.removeVpgSettingRecovery(vpgSettingsIdentifier);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#removeVpgSettingRecovery");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgSettingsIdentifier = vpgSettingsIdentifier_example; // Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

VPGVirtualProtectionGroupSettingsApi *apiInstance = [[VPGVirtualProtectionGroupSettingsApi alloc] init];

// Delete Recovery VPG settings (Auth)
[apiInstance removeVpgSettingRecoveryWith:vpgSettingsIdentifier
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGVirtualProtectionGroupSettingsApi()
var vpgSettingsIdentifier = vpgSettingsIdentifier_example; // {{String}} Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.removeVpgSettingRecovery(vpgSettingsIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class removeVpgSettingRecoveryExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGVirtualProtectionGroupSettingsApi();
            var vpgSettingsIdentifier = vpgSettingsIdentifier_example;  // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

            try
            {
                // Delete Recovery VPG settings (Auth)
                apiInstance.removeVpgSettingRecovery(vpgSettingsIdentifier);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGVirtualProtectionGroupSettingsApi.removeVpgSettingRecovery: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGVirtualProtectionGroupSettingsApi();
$vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

try {
    $api_instance->removeVpgSettingRecovery($vpgSettingsIdentifier);
} catch (Exception $e) {
    echo 'Exception when calling VPGVirtualProtectionGroupSettingsApi->removeVpgSettingRecovery: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi->new();
my $vpgSettingsIdentifier = vpgSettingsIdentifier_example; # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

eval { 
    $api_instance->removeVpgSettingRecovery(vpgSettingsIdentifier => $vpgSettingsIdentifier);
};
if ($@) {
    warn "Exception when calling VPGVirtualProtectionGroupSettingsApi->removeVpgSettingRecovery: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGVirtualProtectionGroupSettingsApi()
vpgSettingsIdentifier = vpgSettingsIdentifier_example # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

try: 
    # Delete Recovery VPG settings (Auth)
    api_instance.remove_vpg_setting_recovery(vpgSettingsIdentifier)
except ApiException as e:
    print("Exception when calling VPGVirtualProtectionGroupSettingsApi->removeVpgSettingRecovery: %s\n" % e)

Parameters

Path parameters
Name Description
vpgSettingsIdentifier*
String
Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
Required

Responses

Status: 200 - Success


removeVpgSettingVm

Delete the VPG settings of a single VM (Auth)


/v1/vpgSettings/{vpgSettingsIdentifier}/vms/{vmIdentifier}

Usage and SDK Samples

curl -X DELETE\
-H "x-zerto-session: [[apiKey]]"\
"https://localhost:9669//v1/vpgSettings/{vpgSettingsIdentifier}/vms/{vmIdentifier}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

import java.io.File;
import java.util.*;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        String vmIdentifier = vmIdentifier_example; // String | Vm Identifier.Related endpoint: `v1/vms`
        try {
            apiInstance.removeVpgSettingVm(vpgSettingsIdentifier, vmIdentifier);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#removeVpgSettingVm");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        String vmIdentifier = vmIdentifier_example; // String | Vm Identifier.Related endpoint: `v1/vms`
        try {
            apiInstance.removeVpgSettingVm(vpgSettingsIdentifier, vmIdentifier);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#removeVpgSettingVm");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgSettingsIdentifier = vpgSettingsIdentifier_example; // Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
String *vmIdentifier = vmIdentifier_example; // Vm Identifier.Related endpoint: `v1/vms`

VPGVirtualProtectionGroupSettingsApi *apiInstance = [[VPGVirtualProtectionGroupSettingsApi alloc] init];

// Delete the VPG settings of a single VM (Auth)
[apiInstance removeVpgSettingVmWith:vpgSettingsIdentifier
    vmIdentifier:vmIdentifier
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGVirtualProtectionGroupSettingsApi()
var vpgSettingsIdentifier = vpgSettingsIdentifier_example; // {{String}} Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
var vmIdentifier = vmIdentifier_example; // {{String}} Vm Identifier.Related endpoint: `v1/vms`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.removeVpgSettingVm(vpgSettingsIdentifier, vmIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class removeVpgSettingVmExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGVirtualProtectionGroupSettingsApi();
            var vpgSettingsIdentifier = vpgSettingsIdentifier_example;  // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
            var vmIdentifier = vmIdentifier_example;  // String | Vm Identifier.Related endpoint: `v1/vms`

            try
            {
                // Delete the VPG settings of a single VM (Auth)
                apiInstance.removeVpgSettingVm(vpgSettingsIdentifier, vmIdentifier);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGVirtualProtectionGroupSettingsApi.removeVpgSettingVm: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGVirtualProtectionGroupSettingsApi();
$vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
$vmIdentifier = vmIdentifier_example; // String | Vm Identifier.Related endpoint: `v1/vms`

try {
    $api_instance->removeVpgSettingVm($vpgSettingsIdentifier, $vmIdentifier);
} catch (Exception $e) {
    echo 'Exception when calling VPGVirtualProtectionGroupSettingsApi->removeVpgSettingVm: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi->new();
my $vpgSettingsIdentifier = vpgSettingsIdentifier_example; # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
my $vmIdentifier = vmIdentifier_example; # String | Vm Identifier.Related endpoint: `v1/vms`

eval { 
    $api_instance->removeVpgSettingVm(vpgSettingsIdentifier => $vpgSettingsIdentifier, vmIdentifier => $vmIdentifier);
};
if ($@) {
    warn "Exception when calling VPGVirtualProtectionGroupSettingsApi->removeVpgSettingVm: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGVirtualProtectionGroupSettingsApi()
vpgSettingsIdentifier = vpgSettingsIdentifier_example # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
vmIdentifier = vmIdentifier_example # String | Vm Identifier.Related endpoint: `v1/vms`

try: 
    # Delete the VPG settings of a single VM (Auth)
    api_instance.remove_vpg_setting_vm(vpgSettingsIdentifier, vmIdentifier)
except ApiException as e:
    print("Exception when calling VPGVirtualProtectionGroupSettingsApi->removeVpgSettingVm: %s\n" % e)

Parameters

Path parameters
Name Description
vpgSettingsIdentifier*
String
Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
Required
vmIdentifier*
String
Vm Identifier.Related endpoint: `v1/vms`
Required

Responses

Status: 200 - Success


removeVpgSettingVmNic

Delete NICs of specific VM in VPG settings (Auth)


/v1/vpgSettings/{vpgSettingsIdentifier}/vms/{vmIdentifier}/nics/{nicIdentifier}

Usage and SDK Samples

curl -X DELETE\
-H "x-zerto-session: [[apiKey]]"\
"https://localhost:9669//v1/vpgSettings/{vpgSettingsIdentifier}/vms/{vmIdentifier}/nics/{nicIdentifier}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

import java.io.File;
import java.util.*;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        String vmIdentifier = vmIdentifier_example; // String | Vm Identifier.Related endpoint: `v1/vms`
        String nicIdentifier = nicIdentifier_example; // String | 
        try {
            apiInstance.removeVpgSettingVmNic(vpgSettingsIdentifier, vmIdentifier, nicIdentifier);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#removeVpgSettingVmNic");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        String vmIdentifier = vmIdentifier_example; // String | Vm Identifier.Related endpoint: `v1/vms`
        String nicIdentifier = nicIdentifier_example; // String | 
        try {
            apiInstance.removeVpgSettingVmNic(vpgSettingsIdentifier, vmIdentifier, nicIdentifier);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#removeVpgSettingVmNic");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgSettingsIdentifier = vpgSettingsIdentifier_example; // Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
String *vmIdentifier = vmIdentifier_example; // Vm Identifier.Related endpoint: `v1/vms`
String *nicIdentifier = nicIdentifier_example; // 

VPGVirtualProtectionGroupSettingsApi *apiInstance = [[VPGVirtualProtectionGroupSettingsApi alloc] init];

// Delete NICs of specific VM in VPG settings (Auth)
[apiInstance removeVpgSettingVmNicWith:vpgSettingsIdentifier
    vmIdentifier:vmIdentifier
    nicIdentifier:nicIdentifier
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGVirtualProtectionGroupSettingsApi()
var vpgSettingsIdentifier = vpgSettingsIdentifier_example; // {{String}} Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
var vmIdentifier = vmIdentifier_example; // {{String}} Vm Identifier.Related endpoint: `v1/vms`
var nicIdentifier = nicIdentifier_example; // {{String}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.removeVpgSettingVmNic(vpgSettingsIdentifier, vmIdentifier, nicIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class removeVpgSettingVmNicExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGVirtualProtectionGroupSettingsApi();
            var vpgSettingsIdentifier = vpgSettingsIdentifier_example;  // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
            var vmIdentifier = vmIdentifier_example;  // String | Vm Identifier.Related endpoint: `v1/vms`
            var nicIdentifier = nicIdentifier_example;  // String | 

            try
            {
                // Delete NICs of specific VM in VPG settings (Auth)
                apiInstance.removeVpgSettingVmNic(vpgSettingsIdentifier, vmIdentifier, nicIdentifier);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGVirtualProtectionGroupSettingsApi.removeVpgSettingVmNic: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGVirtualProtectionGroupSettingsApi();
$vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
$vmIdentifier = vmIdentifier_example; // String | Vm Identifier.Related endpoint: `v1/vms`
$nicIdentifier = nicIdentifier_example; // String | 

try {
    $api_instance->removeVpgSettingVmNic($vpgSettingsIdentifier, $vmIdentifier, $nicIdentifier);
} catch (Exception $e) {
    echo 'Exception when calling VPGVirtualProtectionGroupSettingsApi->removeVpgSettingVmNic: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi->new();
my $vpgSettingsIdentifier = vpgSettingsIdentifier_example; # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
my $vmIdentifier = vmIdentifier_example; # String | Vm Identifier.Related endpoint: `v1/vms`
my $nicIdentifier = nicIdentifier_example; # String | 

eval { 
    $api_instance->removeVpgSettingVmNic(vpgSettingsIdentifier => $vpgSettingsIdentifier, vmIdentifier => $vmIdentifier, nicIdentifier => $nicIdentifier);
};
if ($@) {
    warn "Exception when calling VPGVirtualProtectionGroupSettingsApi->removeVpgSettingVmNic: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGVirtualProtectionGroupSettingsApi()
vpgSettingsIdentifier = vpgSettingsIdentifier_example # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
vmIdentifier = vmIdentifier_example # String | Vm Identifier.Related endpoint: `v1/vms`
nicIdentifier = nicIdentifier_example # String | 

try: 
    # Delete NICs of specific VM in VPG settings (Auth)
    api_instance.remove_vpg_setting_vm_nic(vpgSettingsIdentifier, vmIdentifier, nicIdentifier)
except ApiException as e:
    print("Exception when calling VPGVirtualProtectionGroupSettingsApi->removeVpgSettingVmNic: %s\n" % e)

Parameters

Path parameters
Name Description
vpgSettingsIdentifier*
String
Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
Required
vmIdentifier*
String
Vm Identifier.Related endpoint: `v1/vms`
Required
nicIdentifier*
String
Required

Responses

Status: 200 - Success


removeVpgSettingsBasic

Delete Basic VPG settings. (Auth)


/v1/vpgSettings/{vpgSettingsIdentifier}/basic

Usage and SDK Samples

curl -X DELETE\
-H "x-zerto-session: [[apiKey]]"\
"https://localhost:9669//v1/vpgSettings/{vpgSettingsIdentifier}/basic"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

import java.io.File;
import java.util.*;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        try {
            apiInstance.removeVpgSettingsBasic(vpgSettingsIdentifier);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#removeVpgSettingsBasic");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        try {
            apiInstance.removeVpgSettingsBasic(vpgSettingsIdentifier);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#removeVpgSettingsBasic");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgSettingsIdentifier = vpgSettingsIdentifier_example; // Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

VPGVirtualProtectionGroupSettingsApi *apiInstance = [[VPGVirtualProtectionGroupSettingsApi alloc] init];

// Delete Basic VPG settings. (Auth)
[apiInstance removeVpgSettingsBasicWith:vpgSettingsIdentifier
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGVirtualProtectionGroupSettingsApi()
var vpgSettingsIdentifier = vpgSettingsIdentifier_example; // {{String}} Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.removeVpgSettingsBasic(vpgSettingsIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class removeVpgSettingsBasicExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGVirtualProtectionGroupSettingsApi();
            var vpgSettingsIdentifier = vpgSettingsIdentifier_example;  // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

            try
            {
                // Delete Basic VPG settings. (Auth)
                apiInstance.removeVpgSettingsBasic(vpgSettingsIdentifier);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGVirtualProtectionGroupSettingsApi.removeVpgSettingsBasic: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGVirtualProtectionGroupSettingsApi();
$vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

try {
    $api_instance->removeVpgSettingsBasic($vpgSettingsIdentifier);
} catch (Exception $e) {
    echo 'Exception when calling VPGVirtualProtectionGroupSettingsApi->removeVpgSettingsBasic: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi->new();
my $vpgSettingsIdentifier = vpgSettingsIdentifier_example; # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

eval { 
    $api_instance->removeVpgSettingsBasic(vpgSettingsIdentifier => $vpgSettingsIdentifier);
};
if ($@) {
    warn "Exception when calling VPGVirtualProtectionGroupSettingsApi->removeVpgSettingsBasic: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGVirtualProtectionGroupSettingsApi()
vpgSettingsIdentifier = vpgSettingsIdentifier_example # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

try: 
    # Delete Basic VPG settings. (Auth)
    api_instance.remove_vpg_settings_basic(vpgSettingsIdentifier)
except ApiException as e:
    print("Exception when calling VPGVirtualProtectionGroupSettingsApi->removeVpgSettingsBasic: %s\n" % e)

Parameters

Path parameters
Name Description
vpgSettingsIdentifier*
String
Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
Required

Responses

Status: 200 - Success


startVpgSettingCommit

Commit and deploy the VPG settings. Returns the command task identifier. (Auth)


/v1/vpgSettings/{vpgSettingsIdentifier}/commit

Usage and SDK Samples

curl -X POST\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgSettings/{vpgSettingsIdentifier}/commit"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

import java.io.File;
import java.util.*;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        try {
            'String' result = apiInstance.startVpgSettingCommit(vpgSettingsIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#startVpgSettingCommit");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGVirtualProtectionGroupSettingsApi;

public class VPGVirtualProtectionGroupSettingsApiExample {

    public static void main(String[] args) {
        VPGVirtualProtectionGroupSettingsApi apiInstance = new VPGVirtualProtectionGroupSettingsApi();
        String vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
        try {
            'String' result = apiInstance.startVpgSettingCommit(vpgSettingsIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGVirtualProtectionGroupSettingsApi#startVpgSettingCommit");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgSettingsIdentifier = vpgSettingsIdentifier_example; // Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

VPGVirtualProtectionGroupSettingsApi *apiInstance = [[VPGVirtualProtectionGroupSettingsApi alloc] init];

// Commit and deploy the VPG settings. Returns the command task identifier. (Auth)
[apiInstance startVpgSettingCommitWith:vpgSettingsIdentifier
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGVirtualProtectionGroupSettingsApi()
var vpgSettingsIdentifier = vpgSettingsIdentifier_example; // {{String}} Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.startVpgSettingCommit(vpgSettingsIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class startVpgSettingCommitExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGVirtualProtectionGroupSettingsApi();
            var vpgSettingsIdentifier = vpgSettingsIdentifier_example;  // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

            try
            {
                // Commit and deploy the VPG settings. Returns the command task identifier. (Auth)
                'String' result = apiInstance.startVpgSettingCommit(vpgSettingsIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGVirtualProtectionGroupSettingsApi.startVpgSettingCommit: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGVirtualProtectionGroupSettingsApi();
$vpgSettingsIdentifier = vpgSettingsIdentifier_example; // String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

try {
    $result = $api_instance->startVpgSettingCommit($vpgSettingsIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VPGVirtualProtectionGroupSettingsApi->startVpgSettingCommit: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGVirtualProtectionGroupSettingsApi->new();
my $vpgSettingsIdentifier = vpgSettingsIdentifier_example; # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

eval { 
    my $result = $api_instance->startVpgSettingCommit(vpgSettingsIdentifier => $vpgSettingsIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VPGVirtualProtectionGroupSettingsApi->startVpgSettingCommit: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGVirtualProtectionGroupSettingsApi()
vpgSettingsIdentifier = vpgSettingsIdentifier_example # String | Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`

try: 
    # Commit and deploy the VPG settings. Returns the command task identifier. (Auth)
    api_response = api_instance.start_vpg_setting_commit(vpgSettingsIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VPGVirtualProtectionGroupSettingsApi->startVpgSettingCommit: %s\n" % e)

Parameters

Path parameters
Name Description
vpgSettingsIdentifier*
String
Vpg Settings Identfifier. Related endpoint: `/v1/vpgSettings`
Required

Responses

Status: 200 - Success

string

VPGsVirtualProtectionGroups

getVpg

Get information about the VPG. (Auth)


/v1/vpgs/{vpgIdentifier}

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgs/{vpgIdentifier}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGsVirtualProtectionGroupsApi;

import java.io.File;
import java.util.*;

public class VPGsVirtualProtectionGroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGsVirtualProtectionGroupsApi apiInstance = new VPGsVirtualProtectionGroupsApi();
        String vpgIdentifier = vpgIdentifier_example; // String | VPG identifier. Related endpoint: `v1/vpgs`
        try {
            VpgApi result = apiInstance.getVpg(vpgIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGsVirtualProtectionGroupsApi#getVpg");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGsVirtualProtectionGroupsApi;

public class VPGsVirtualProtectionGroupsApiExample {

    public static void main(String[] args) {
        VPGsVirtualProtectionGroupsApi apiInstance = new VPGsVirtualProtectionGroupsApi();
        String vpgIdentifier = vpgIdentifier_example; // String | VPG identifier. Related endpoint: `v1/vpgs`
        try {
            VpgApi result = apiInstance.getVpg(vpgIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGsVirtualProtectionGroupsApi#getVpg");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgIdentifier = vpgIdentifier_example; // VPG identifier. Related endpoint: `v1/vpgs`

VPGsVirtualProtectionGroupsApi *apiInstance = [[VPGsVirtualProtectionGroupsApi alloc] init];

// Get information about the VPG. (Auth)
[apiInstance getVpgWith:vpgIdentifier
              completionHandler: ^(VpgApi output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGsVirtualProtectionGroupsApi()
var vpgIdentifier = vpgIdentifier_example; // {{String}} VPG identifier. Related endpoint: `v1/vpgs`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVpg(vpgIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVpgExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGsVirtualProtectionGroupsApi();
            var vpgIdentifier = vpgIdentifier_example;  // String | VPG identifier. Related endpoint: `v1/vpgs`

            try
            {
                // Get information about the VPG. (Auth)
                VpgApi result = apiInstance.getVpg(vpgIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGsVirtualProtectionGroupsApi.getVpg: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGsVirtualProtectionGroupsApi();
$vpgIdentifier = vpgIdentifier_example; // String | VPG identifier. Related endpoint: `v1/vpgs`

try {
    $result = $api_instance->getVpg($vpgIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VPGsVirtualProtectionGroupsApi->getVpg: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGsVirtualProtectionGroupsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGsVirtualProtectionGroupsApi->new();
my $vpgIdentifier = vpgIdentifier_example; # String | VPG identifier. Related endpoint: `v1/vpgs`

eval { 
    my $result = $api_instance->getVpg(vpgIdentifier => $vpgIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VPGsVirtualProtectionGroupsApi->getVpg: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGsVirtualProtectionGroupsApi()
vpgIdentifier = vpgIdentifier_example # String | VPG identifier. Related endpoint: `v1/vpgs`

try: 
    # Get information about the VPG. (Auth)
    api_response = api_instance.get_vpg(vpgIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VPGsVirtualProtectionGroupsApi->getVpg: %s\n" % e)

Parameters

Path parameters
Name Description
vpgIdentifier*
String
VPG identifier. Related endpoint: `v1/vpgs`
Required

Responses

Status: 200 - Success

{
progressPercentage:
number (double)
organizationName:
string
zorg:
{
rel:
string
href:
string
type:
string
identifier:
string
}
priority:
integer (int32)
Enum: 0, 1, 2
vmsCount:
integer (int32)
provisionedStorageInMB:
integer (int64)
usedStorageInMB:
integer (int64)
ioPs:
integer (int32)
throughputInMB:
number (double)
actualRPO:
integer (int32)
configuredRpoSeconds:
integer (int32)
lastTest:
string (date-time)
vpgIdentifier:
string
vpgName:
string
vpgDescription:
string
vpgType:
string
link:
{
rel:
string
href:
string
type:
string
identifier:
string
}
Link_{0}:
{
rel:
string
href:
string
type:
string
}
sourceSite:
string
protectedSite:
{
rel:
string
href:
string
type:
string
identifier:
string
}
targetSite:
string
recoverySite:
{
rel:
string
href:
string
type:
string
identifier:
string
}
entities:
{
source:
integer (int32)
Enum: 0, 1, 2, 3, 4, 5
protected:
integer (int32)
Enum: 0, 1, 2, 3, 4, 5
target:
integer (int32)
Enum: 0, 1, 2, 3, 4, 5
recovery:
integer (int32)
Enum: 0, 1, 2, 3, 4, 5
}
status:
integer (int32)
Enum: 0, 1, 2, 3, 4, 5, 6, 7, 8
subStatus:
integer (int32)
Enum: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41
activeProcessesApi:
{
runningFailOverTestApi:
{
stage:
}
}
serviceProfile:
{
rel:
string
href:
string
type:
string
identifier:
string
}
serviceProfileName:
string
serviceProfileIdentifier:
string
backupEnabled:
boolean
failSafeHistory:
{
actualFailSafeHistory:
integer (int32)
configuredFailSafeHistory:
integer (int32)
failSafeDescription:
string
}
historyStatusApi:
{
actualHistoryInMinutes:
integer (int32)
configuredHistoryInMinutes:
integer (int32)
earliestCheckpoint:
{
checkpointIdentifier:
timeStamp:
tag:
type:
}
}
alertStatus:
integer (int32)
Enum: 0, 1, 2, 3, 4
}

getVpgAll

Get information about all VPGs. (Auth)


/v1/vpgs

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgs?name=&status=&subStatus=&protectedSiteType=&recoverySiteType=&protectedSiteIdentifier=&recoverySiteIdentifier=&sourceSite=&targetSite=&sourceType=&targetType=&orgName=&zorgIdentifier=&priority=&serviceProfileIdentifier=&backupEnabled="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGsVirtualProtectionGroupsApi;

import java.io.File;
import java.util.*;

public class VPGsVirtualProtectionGroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGsVirtualProtectionGroupsApi apiInstance = new VPGsVirtualProtectionGroupsApi();
        String name = name_example; // String | VPG name
        String status = status_example; // String | VPG status
        String subStatus = subStatus_example; // String | The substatus of the VPG, for example the VPG is in a bitmap sync
        String protectedSiteType = protectedSiteType_example; // String | The protected site type. This filter behaves in the same way as the sourceType filter. Possible values are: `0 or VCVpg` | `2 or VCDvApp | `4 or HyperV`
        String recoverySiteType = recoverySiteType_example; // String | The type of the recovery site. This filter behaves in the same way as the targetType filter
        String protectedSiteIdentifier = protectedSiteIdentifier_example; // String | The identifier of the protected site
        String recoverySiteIdentifier = recoverySiteIdentifier_example; // String | The identifier of the recovery site
        String sourceSite = sourceSite_example; // String | Deprecated. See protectedSiteIdentifier
        String targetSite = targetSite_example; // String | Deprecated. See recoverySiteIdentifier
        String sourceType = sourceType_example; // String | Deprecated. See protectedSiteType
        String targetType = targetType_example; // String | Deprecated. See recoverySiteType
        String orgName = orgName_example; // String | The ZORG for this VPG
        String zorgIdentifier = zorgIdentifier_example; // String | The internal identifier for the ZORG
        String priority = priority_example; // String | The VPG priority. Related endpoint: `/v1/vpgs/priorities`
        String serviceProfileIdentifier = serviceProfileIdentifier_example; // String | The identifier of the service profile to use for the VPG when a Zerto Cloud Manager is used
        Boolean backupEnabled = true; // Boolean | Deprecated
        try {
            array[VpgApi] result = apiInstance.getVpgAll(name, status, subStatus, protectedSiteType, recoverySiteType, protectedSiteIdentifier, recoverySiteIdentifier, sourceSite, targetSite, sourceType, targetType, orgName, zorgIdentifier, priority, serviceProfileIdentifier, backupEnabled);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGsVirtualProtectionGroupsApi#getVpgAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGsVirtualProtectionGroupsApi;

public class VPGsVirtualProtectionGroupsApiExample {

    public static void main(String[] args) {
        VPGsVirtualProtectionGroupsApi apiInstance = new VPGsVirtualProtectionGroupsApi();
        String name = name_example; // String | VPG name
        String status = status_example; // String | VPG status
        String subStatus = subStatus_example; // String | The substatus of the VPG, for example the VPG is in a bitmap sync
        String protectedSiteType = protectedSiteType_example; // String | The protected site type. This filter behaves in the same way as the sourceType filter. Possible values are: `0 or VCVpg` | `2 or VCDvApp | `4 or HyperV`
        String recoverySiteType = recoverySiteType_example; // String | The type of the recovery site. This filter behaves in the same way as the targetType filter
        String protectedSiteIdentifier = protectedSiteIdentifier_example; // String | The identifier of the protected site
        String recoverySiteIdentifier = recoverySiteIdentifier_example; // String | The identifier of the recovery site
        String sourceSite = sourceSite_example; // String | Deprecated. See protectedSiteIdentifier
        String targetSite = targetSite_example; // String | Deprecated. See recoverySiteIdentifier
        String sourceType = sourceType_example; // String | Deprecated. See protectedSiteType
        String targetType = targetType_example; // String | Deprecated. See recoverySiteType
        String orgName = orgName_example; // String | The ZORG for this VPG
        String zorgIdentifier = zorgIdentifier_example; // String | The internal identifier for the ZORG
        String priority = priority_example; // String | The VPG priority. Related endpoint: `/v1/vpgs/priorities`
        String serviceProfileIdentifier = serviceProfileIdentifier_example; // String | The identifier of the service profile to use for the VPG when a Zerto Cloud Manager is used
        Boolean backupEnabled = true; // Boolean | Deprecated
        try {
            array[VpgApi] result = apiInstance.getVpgAll(name, status, subStatus, protectedSiteType, recoverySiteType, protectedSiteIdentifier, recoverySiteIdentifier, sourceSite, targetSite, sourceType, targetType, orgName, zorgIdentifier, priority, serviceProfileIdentifier, backupEnabled);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGsVirtualProtectionGroupsApi#getVpgAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *name = name_example; // VPG name (optional)
String *status = status_example; // VPG status (optional)
String *subStatus = subStatus_example; // The substatus of the VPG, for example the VPG is in a bitmap sync (optional)
String *protectedSiteType = protectedSiteType_example; // The protected site type. This filter behaves in the same way as the sourceType filter. Possible values are: `0 or VCVpg` | `2 or VCDvApp | `4 or HyperV` (optional)
String *recoverySiteType = recoverySiteType_example; // The type of the recovery site. This filter behaves in the same way as the targetType filter (optional)
String *protectedSiteIdentifier = protectedSiteIdentifier_example; // The identifier of the protected site (optional)
String *recoverySiteIdentifier = recoverySiteIdentifier_example; // The identifier of the recovery site (optional)
String *sourceSite = sourceSite_example; // Deprecated. See protectedSiteIdentifier (optional)
String *targetSite = targetSite_example; // Deprecated. See recoverySiteIdentifier (optional)
String *sourceType = sourceType_example; // Deprecated. See protectedSiteType (optional)
String *targetType = targetType_example; // Deprecated. See recoverySiteType (optional)
String *orgName = orgName_example; // The ZORG for this VPG (optional)
String *zorgIdentifier = zorgIdentifier_example; // The internal identifier for the ZORG (optional)
String *priority = priority_example; // The VPG priority. Related endpoint: `/v1/vpgs/priorities` (optional)
String *serviceProfileIdentifier = serviceProfileIdentifier_example; // The identifier of the service profile to use for the VPG when a Zerto Cloud Manager is used (optional)
Boolean *backupEnabled = true; // Deprecated (optional)

VPGsVirtualProtectionGroupsApi *apiInstance = [[VPGsVirtualProtectionGroupsApi alloc] init];

// Get information about all VPGs. (Auth)
[apiInstance getVpgAllWith:name
    status:status
    subStatus:subStatus
    protectedSiteType:protectedSiteType
    recoverySiteType:recoverySiteType
    protectedSiteIdentifier:protectedSiteIdentifier
    recoverySiteIdentifier:recoverySiteIdentifier
    sourceSite:sourceSite
    targetSite:targetSite
    sourceType:sourceType
    targetType:targetType
    orgName:orgName
    zorgIdentifier:zorgIdentifier
    priority:priority
    serviceProfileIdentifier:serviceProfileIdentifier
    backupEnabled:backupEnabled
              completionHandler: ^(array[VpgApi] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGsVirtualProtectionGroupsApi()
var opts = { 
  'name': name_example, // {{String}} VPG name
  'status': status_example, // {{String}} VPG status
  'subStatus': subStatus_example, // {{String}} The substatus of the VPG, for example the VPG is in a bitmap sync
  'protectedSiteType': protectedSiteType_example, // {{String}} The protected site type. This filter behaves in the same way as the sourceType filter. Possible values are: `0 or VCVpg` | `2 or VCDvApp | `4 or HyperV`
  'recoverySiteType': recoverySiteType_example, // {{String}} The type of the recovery site. This filter behaves in the same way as the targetType filter
  'protectedSiteIdentifier': protectedSiteIdentifier_example, // {{String}} The identifier of the protected site
  'recoverySiteIdentifier': recoverySiteIdentifier_example, // {{String}} The identifier of the recovery site
  'sourceSite': sourceSite_example, // {{String}} Deprecated. See protectedSiteIdentifier
  'targetSite': targetSite_example, // {{String}} Deprecated. See recoverySiteIdentifier
  'sourceType': sourceType_example, // {{String}} Deprecated. See protectedSiteType
  'targetType': targetType_example, // {{String}} Deprecated. See recoverySiteType
  'orgName': orgName_example, // {{String}} The ZORG for this VPG
  'zorgIdentifier': zorgIdentifier_example, // {{String}} The internal identifier for the ZORG
  'priority': priority_example, // {{String}} The VPG priority. Related endpoint: `/v1/vpgs/priorities`
  'serviceProfileIdentifier': serviceProfileIdentifier_example, // {{String}} The identifier of the service profile to use for the VPG when a Zerto Cloud Manager is used
  'backupEnabled': true // {{Boolean}} Deprecated
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVpgAll(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVpgAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGsVirtualProtectionGroupsApi();
            var name = name_example;  // String | VPG name (optional) 
            var status = status_example;  // String | VPG status (optional) 
            var subStatus = subStatus_example;  // String | The substatus of the VPG, for example the VPG is in a bitmap sync (optional) 
            var protectedSiteType = protectedSiteType_example;  // String | The protected site type. This filter behaves in the same way as the sourceType filter. Possible values are: `0 or VCVpg` | `2 or VCDvApp | `4 or HyperV` (optional) 
            var recoverySiteType = recoverySiteType_example;  // String | The type of the recovery site. This filter behaves in the same way as the targetType filter (optional) 
            var protectedSiteIdentifier = protectedSiteIdentifier_example;  // String | The identifier of the protected site (optional) 
            var recoverySiteIdentifier = recoverySiteIdentifier_example;  // String | The identifier of the recovery site (optional) 
            var sourceSite = sourceSite_example;  // String | Deprecated. See protectedSiteIdentifier (optional) 
            var targetSite = targetSite_example;  // String | Deprecated. See recoverySiteIdentifier (optional) 
            var sourceType = sourceType_example;  // String | Deprecated. See protectedSiteType (optional) 
            var targetType = targetType_example;  // String | Deprecated. See recoverySiteType (optional) 
            var orgName = orgName_example;  // String | The ZORG for this VPG (optional) 
            var zorgIdentifier = zorgIdentifier_example;  // String | The internal identifier for the ZORG (optional) 
            var priority = priority_example;  // String | The VPG priority. Related endpoint: `/v1/vpgs/priorities` (optional) 
            var serviceProfileIdentifier = serviceProfileIdentifier_example;  // String | The identifier of the service profile to use for the VPG when a Zerto Cloud Manager is used (optional) 
            var backupEnabled = true;  // Boolean | Deprecated (optional) 

            try
            {
                // Get information about all VPGs. (Auth)
                array[VpgApi] result = apiInstance.getVpgAll(name, status, subStatus, protectedSiteType, recoverySiteType, protectedSiteIdentifier, recoverySiteIdentifier, sourceSite, targetSite, sourceType, targetType, orgName, zorgIdentifier, priority, serviceProfileIdentifier, backupEnabled);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGsVirtualProtectionGroupsApi.getVpgAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGsVirtualProtectionGroupsApi();
$name = name_example; // String | VPG name
$status = status_example; // String | VPG status
$subStatus = subStatus_example; // String | The substatus of the VPG, for example the VPG is in a bitmap sync
$protectedSiteType = protectedSiteType_example; // String | The protected site type. This filter behaves in the same way as the sourceType filter. Possible values are: `0 or VCVpg` | `2 or VCDvApp | `4 or HyperV`
$recoverySiteType = recoverySiteType_example; // String | The type of the recovery site. This filter behaves in the same way as the targetType filter
$protectedSiteIdentifier = protectedSiteIdentifier_example; // String | The identifier of the protected site
$recoverySiteIdentifier = recoverySiteIdentifier_example; // String | The identifier of the recovery site
$sourceSite = sourceSite_example; // String | Deprecated. See protectedSiteIdentifier
$targetSite = targetSite_example; // String | Deprecated. See recoverySiteIdentifier
$sourceType = sourceType_example; // String | Deprecated. See protectedSiteType
$targetType = targetType_example; // String | Deprecated. See recoverySiteType
$orgName = orgName_example; // String | The ZORG for this VPG
$zorgIdentifier = zorgIdentifier_example; // String | The internal identifier for the ZORG
$priority = priority_example; // String | The VPG priority. Related endpoint: `/v1/vpgs/priorities`
$serviceProfileIdentifier = serviceProfileIdentifier_example; // String | The identifier of the service profile to use for the VPG when a Zerto Cloud Manager is used
$backupEnabled = true; // Boolean | Deprecated

try {
    $result = $api_instance->getVpgAll($name, $status, $subStatus, $protectedSiteType, $recoverySiteType, $protectedSiteIdentifier, $recoverySiteIdentifier, $sourceSite, $targetSite, $sourceType, $targetType, $orgName, $zorgIdentifier, $priority, $serviceProfileIdentifier, $backupEnabled);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VPGsVirtualProtectionGroupsApi->getVpgAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGsVirtualProtectionGroupsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGsVirtualProtectionGroupsApi->new();
my $name = name_example; # String | VPG name
my $status = status_example; # String | VPG status
my $subStatus = subStatus_example; # String | The substatus of the VPG, for example the VPG is in a bitmap sync
my $protectedSiteType = protectedSiteType_example; # String | The protected site type. This filter behaves in the same way as the sourceType filter. Possible values are: `0 or VCVpg` | `2 or VCDvApp | `4 or HyperV`
my $recoverySiteType = recoverySiteType_example; # String | The type of the recovery site. This filter behaves in the same way as the targetType filter
my $protectedSiteIdentifier = protectedSiteIdentifier_example; # String | The identifier of the protected site
my $recoverySiteIdentifier = recoverySiteIdentifier_example; # String | The identifier of the recovery site
my $sourceSite = sourceSite_example; # String | Deprecated. See protectedSiteIdentifier
my $targetSite = targetSite_example; # String | Deprecated. See recoverySiteIdentifier
my $sourceType = sourceType_example; # String | Deprecated. See protectedSiteType
my $targetType = targetType_example; # String | Deprecated. See recoverySiteType
my $orgName = orgName_example; # String | The ZORG for this VPG
my $zorgIdentifier = zorgIdentifier_example; # String | The internal identifier for the ZORG
my $priority = priority_example; # String | The VPG priority. Related endpoint: `/v1/vpgs/priorities`
my $serviceProfileIdentifier = serviceProfileIdentifier_example; # String | The identifier of the service profile to use for the VPG when a Zerto Cloud Manager is used
my $backupEnabled = true; # Boolean | Deprecated

eval { 
    my $result = $api_instance->getVpgAll(name => $name, status => $status, subStatus => $subStatus, protectedSiteType => $protectedSiteType, recoverySiteType => $recoverySiteType, protectedSiteIdentifier => $protectedSiteIdentifier, recoverySiteIdentifier => $recoverySiteIdentifier, sourceSite => $sourceSite, targetSite => $targetSite, sourceType => $sourceType, targetType => $targetType, orgName => $orgName, zorgIdentifier => $zorgIdentifier, priority => $priority, serviceProfileIdentifier => $serviceProfileIdentifier, backupEnabled => $backupEnabled);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VPGsVirtualProtectionGroupsApi->getVpgAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGsVirtualProtectionGroupsApi()
name = name_example # String | VPG name (optional)
status = status_example # String | VPG status (optional)
subStatus = subStatus_example # String | The substatus of the VPG, for example the VPG is in a bitmap sync (optional)
protectedSiteType = protectedSiteType_example # String | The protected site type. This filter behaves in the same way as the sourceType filter. Possible values are: `0 or VCVpg` | `2 or VCDvApp | `4 or HyperV` (optional)
recoverySiteType = recoverySiteType_example # String | The type of the recovery site. This filter behaves in the same way as the targetType filter (optional)
protectedSiteIdentifier = protectedSiteIdentifier_example # String | The identifier of the protected site (optional)
recoverySiteIdentifier = recoverySiteIdentifier_example # String | The identifier of the recovery site (optional)
sourceSite = sourceSite_example # String | Deprecated. See protectedSiteIdentifier (optional)
targetSite = targetSite_example # String | Deprecated. See recoverySiteIdentifier (optional)
sourceType = sourceType_example # String | Deprecated. See protectedSiteType (optional)
targetType = targetType_example # String | Deprecated. See recoverySiteType (optional)
orgName = orgName_example # String | The ZORG for this VPG (optional)
zorgIdentifier = zorgIdentifier_example # String | The internal identifier for the ZORG (optional)
priority = priority_example # String | The VPG priority. Related endpoint: `/v1/vpgs/priorities` (optional)
serviceProfileIdentifier = serviceProfileIdentifier_example # String | The identifier of the service profile to use for the VPG when a Zerto Cloud Manager is used (optional)
backupEnabled = true # Boolean | Deprecated (optional)

try: 
    # Get information about all VPGs. (Auth)
    api_response = api_instance.get_vpg_all(name=name, status=status, subStatus=subStatus, protectedSiteType=protectedSiteType, recoverySiteType=recoverySiteType, protectedSiteIdentifier=protectedSiteIdentifier, recoverySiteIdentifier=recoverySiteIdentifier, sourceSite=sourceSite, targetSite=targetSite, sourceType=sourceType, targetType=targetType, orgName=orgName, zorgIdentifier=zorgIdentifier, priority=priority, serviceProfileIdentifier=serviceProfileIdentifier, backupEnabled=backupEnabled)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VPGsVirtualProtectionGroupsApi->getVpgAll: %s\n" % e)

Parameters

Query parameters
Name Description
name
String
VPG name
status
String
VPG status
subStatus
String
The substatus of the VPG, for example the VPG is in a bitmap sync
protectedSiteType
String
The protected site type. This filter behaves in the same way as the sourceType filter. Possible values are: `0 or VCVpg` | `2 or VCDvApp | `4 or HyperV`
recoverySiteType
String
The type of the recovery site. This filter behaves in the same way as the targetType filter
protectedSiteIdentifier
String
The identifier of the protected site
recoverySiteIdentifier
String
The identifier of the recovery site
sourceSite
String
Deprecated. See protectedSiteIdentifier
targetSite
String
Deprecated. See recoverySiteIdentifier
sourceType
String
Deprecated. See protectedSiteType
targetType
String
Deprecated. See recoverySiteType
orgName
String
The ZORG for this VPG
zorgIdentifier
String
The internal identifier for the ZORG
priority
String
The VPG priority. Related endpoint: `/v1/vpgs/priorities`
serviceProfileIdentifier
String
The identifier of the service profile to use for the VPG when a Zerto Cloud Manager is used
backupEnabled
Boolean
Deprecated

Responses

Status: 200 - Success

[
{
progressPercentage:
number (double)
organizationName:
string
zorg:
{
rel:
string
href:
string
type:
string
identifier:
string
}
priority:
integer (int32)
Enum: 0, 1, 2
vmsCount:
integer (int32)
provisionedStorageInMB:
integer (int64)
usedStorageInMB:
integer (int64)
ioPs:
integer (int32)
throughputInMB:
number (double)
actualRPO:
integer (int32)
configuredRpoSeconds:
integer (int32)
lastTest:
string (date-time)
vpgIdentifier:
string
vpgName:
string
vpgDescription:
string
vpgType:
string
link:
{
rel:
string
href:
string
type:
string
identifier:
string
}
Link_{0}:
{
rel:
string
href:
string
type:
string
}
sourceSite:
string
protectedSite:
{
rel:
string
href:
string
type:
string
identifier:
string
}
targetSite:
string
recoverySite:
{
rel:
string
href:
string
type:
string
identifier:
string
}
entities:
{
source:
integer (int32)
Enum: 0, 1, 2, 3, 4, 5
protected:
integer (int32)
Enum: 0, 1, 2, 3, 4, 5
target:
integer (int32)
Enum: 0, 1, 2, 3, 4, 5
recovery:
integer (int32)
Enum: 0, 1, 2, 3, 4, 5
}
status:
integer (int32)
Enum: 0, 1, 2, 3, 4, 5, 6, 7, 8
subStatus:
integer (int32)
Enum: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41
activeProcessesApi:
{
runningFailOverTestApi:
{
stage:
string
}
}
serviceProfile:
{
rel:
string
href:
string
type:
string
identifier:
string
}
serviceProfileName:
string
serviceProfileIdentifier:
string
backupEnabled:
boolean
failSafeHistory:
{
actualFailSafeHistory:
integer (int32)
configuredFailSafeHistory:
integer (int32)
failSafeDescription:
string
}
historyStatusApi:
{
actualHistoryInMinutes:
integer (int32)
configuredHistoryInMinutes:
integer (int32)
earliestCheckpoint:
{
checkpointIdentifier:
string
timeStamp:
string (date-time)
tag:
string
type:
integer (int32)
Enum: 0, 1, 2
}
}
alertStatus:
integer (int32)
Enum: 0, 1, 2, 3, 4
}
]

getVpgCheckpointAll

Get a list of checkpoints for the VPG. You can filter the results with additional parameters. (Auth)


/v1/vpgs/{vpgIdentifier}/checkpoints

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgs/{vpgIdentifier}/checkpoints?startDate=&endDate="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGsVirtualProtectionGroupsApi;

import java.io.File;
import java.util.*;

public class VPGsVirtualProtectionGroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGsVirtualProtectionGroupsApi apiInstance = new VPGsVirtualProtectionGroupsApi();
        String vpgIdentifier = vpgIdentifier_example; // String | VPG identifier. Related endpoint: `v1/vpgs`
        Date startDate = 2013-10-20T19:20:30+01:00; // Date | The start date of the checkpoint
        Date endDate = 2013-10-20T19:20:30+01:00; // Date | The end date of the checkpoint
        try {
            array[CheckpointApi] result = apiInstance.getVpgCheckpointAll(vpgIdentifier, startDate, endDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGsVirtualProtectionGroupsApi#getVpgCheckpointAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGsVirtualProtectionGroupsApi;

public class VPGsVirtualProtectionGroupsApiExample {

    public static void main(String[] args) {
        VPGsVirtualProtectionGroupsApi apiInstance = new VPGsVirtualProtectionGroupsApi();
        String vpgIdentifier = vpgIdentifier_example; // String | VPG identifier. Related endpoint: `v1/vpgs`
        Date startDate = 2013-10-20T19:20:30+01:00; // Date | The start date of the checkpoint
        Date endDate = 2013-10-20T19:20:30+01:00; // Date | The end date of the checkpoint
        try {
            array[CheckpointApi] result = apiInstance.getVpgCheckpointAll(vpgIdentifier, startDate, endDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGsVirtualProtectionGroupsApi#getVpgCheckpointAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgIdentifier = vpgIdentifier_example; // VPG identifier. Related endpoint: `v1/vpgs`
Date *startDate = 2013-10-20T19:20:30+01:00; // The start date of the checkpoint (optional)
Date *endDate = 2013-10-20T19:20:30+01:00; // The end date of the checkpoint (optional)

VPGsVirtualProtectionGroupsApi *apiInstance = [[VPGsVirtualProtectionGroupsApi alloc] init];

// Get a list of checkpoints for the VPG. You can filter the results with additional parameters. (Auth)
[apiInstance getVpgCheckpointAllWith:vpgIdentifier
    startDate:startDate
    endDate:endDate
              completionHandler: ^(array[CheckpointApi] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGsVirtualProtectionGroupsApi()
var vpgIdentifier = vpgIdentifier_example; // {{String}} VPG identifier. Related endpoint: `v1/vpgs`
var opts = { 
  'startDate': 2013-10-20T19:20:30+01:00, // {{Date}} The start date of the checkpoint
  'endDate': 2013-10-20T19:20:30+01:00 // {{Date}} The end date of the checkpoint
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVpgCheckpointAll(vpgIdentifier, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVpgCheckpointAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGsVirtualProtectionGroupsApi();
            var vpgIdentifier = vpgIdentifier_example;  // String | VPG identifier. Related endpoint: `v1/vpgs`
            var startDate = 2013-10-20T19:20:30+01:00;  // Date | The start date of the checkpoint (optional) 
            var endDate = 2013-10-20T19:20:30+01:00;  // Date | The end date of the checkpoint (optional) 

            try
            {
                // Get a list of checkpoints for the VPG. You can filter the results with additional parameters. (Auth)
                array[CheckpointApi] result = apiInstance.getVpgCheckpointAll(vpgIdentifier, startDate, endDate);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGsVirtualProtectionGroupsApi.getVpgCheckpointAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGsVirtualProtectionGroupsApi();
$vpgIdentifier = vpgIdentifier_example; // String | VPG identifier. Related endpoint: `v1/vpgs`
$startDate = 2013-10-20T19:20:30+01:00; // Date | The start date of the checkpoint
$endDate = 2013-10-20T19:20:30+01:00; // Date | The end date of the checkpoint

try {
    $result = $api_instance->getVpgCheckpointAll($vpgIdentifier, $startDate, $endDate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VPGsVirtualProtectionGroupsApi->getVpgCheckpointAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGsVirtualProtectionGroupsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGsVirtualProtectionGroupsApi->new();
my $vpgIdentifier = vpgIdentifier_example; # String | VPG identifier. Related endpoint: `v1/vpgs`
my $startDate = 2013-10-20T19:20:30+01:00; # Date | The start date of the checkpoint
my $endDate = 2013-10-20T19:20:30+01:00; # Date | The end date of the checkpoint

eval { 
    my $result = $api_instance->getVpgCheckpointAll(vpgIdentifier => $vpgIdentifier, startDate => $startDate, endDate => $endDate);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VPGsVirtualProtectionGroupsApi->getVpgCheckpointAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGsVirtualProtectionGroupsApi()
vpgIdentifier = vpgIdentifier_example # String | VPG identifier. Related endpoint: `v1/vpgs`
startDate = 2013-10-20T19:20:30+01:00 # Date | The start date of the checkpoint (optional)
endDate = 2013-10-20T19:20:30+01:00 # Date | The end date of the checkpoint (optional)

try: 
    # Get a list of checkpoints for the VPG. You can filter the results with additional parameters. (Auth)
    api_response = api_instance.get_vpg_checkpoint_all(vpgIdentifier, startDate=startDate, endDate=endDate)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VPGsVirtualProtectionGroupsApi->getVpgCheckpointAll: %s\n" % e)

Parameters

Path parameters
Name Description
vpgIdentifier*
String
VPG identifier. Related endpoint: `v1/vpgs`
Required
Query parameters
Name Description
startDate
Date (date-time)
The start date of the checkpoint
endDate
Date (date-time)
The end date of the checkpoint

Responses

Status: 200 - Success

[
{
checkpointIdentifier:
string
timeStamp:
string (date-time)
tag:
string
type:
integer (int32)
Enum: 0, 1, 2
}
]

getVpgCheckpointStatAll

Get checkpoints statistics for a VPG. (Auth)


/v1/vpgs/{vpgIdentifier}/checkpoints/stats

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgs/{vpgIdentifier}/checkpoints/stats"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGsVirtualProtectionGroupsApi;

import java.io.File;
import java.util.*;

public class VPGsVirtualProtectionGroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGsVirtualProtectionGroupsApi apiInstance = new VPGsVirtualProtectionGroupsApi();
        String vpgIdentifier = vpgIdentifier_example; // String | VPG identifier. Related endpoint: `v1/vpgs`
        try {
            VpgCheckpointsStatsApi result = apiInstance.getVpgCheckpointStatAll(vpgIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGsVirtualProtectionGroupsApi#getVpgCheckpointStatAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGsVirtualProtectionGroupsApi;

public class VPGsVirtualProtectionGroupsApiExample {

    public static void main(String[] args) {
        VPGsVirtualProtectionGroupsApi apiInstance = new VPGsVirtualProtectionGroupsApi();
        String vpgIdentifier = vpgIdentifier_example; // String | VPG identifier. Related endpoint: `v1/vpgs`
        try {
            VpgCheckpointsStatsApi result = apiInstance.getVpgCheckpointStatAll(vpgIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGsVirtualProtectionGroupsApi#getVpgCheckpointStatAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgIdentifier = vpgIdentifier_example; // VPG identifier. Related endpoint: `v1/vpgs`

VPGsVirtualProtectionGroupsApi *apiInstance = [[VPGsVirtualProtectionGroupsApi alloc] init];

// Get checkpoints statistics for a VPG. (Auth)
[apiInstance getVpgCheckpointStatAllWith:vpgIdentifier
              completionHandler: ^(VpgCheckpointsStatsApi output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGsVirtualProtectionGroupsApi()
var vpgIdentifier = vpgIdentifier_example; // {{String}} VPG identifier. Related endpoint: `v1/vpgs`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVpgCheckpointStatAll(vpgIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVpgCheckpointStatAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGsVirtualProtectionGroupsApi();
            var vpgIdentifier = vpgIdentifier_example;  // String | VPG identifier. Related endpoint: `v1/vpgs`

            try
            {
                // Get checkpoints statistics for a VPG. (Auth)
                VpgCheckpointsStatsApi result = apiInstance.getVpgCheckpointStatAll(vpgIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGsVirtualProtectionGroupsApi.getVpgCheckpointStatAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGsVirtualProtectionGroupsApi();
$vpgIdentifier = vpgIdentifier_example; // String | VPG identifier. Related endpoint: `v1/vpgs`

try {
    $result = $api_instance->getVpgCheckpointStatAll($vpgIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VPGsVirtualProtectionGroupsApi->getVpgCheckpointStatAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGsVirtualProtectionGroupsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGsVirtualProtectionGroupsApi->new();
my $vpgIdentifier = vpgIdentifier_example; # String | VPG identifier. Related endpoint: `v1/vpgs`

eval { 
    my $result = $api_instance->getVpgCheckpointStatAll(vpgIdentifier => $vpgIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VPGsVirtualProtectionGroupsApi->getVpgCheckpointStatAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGsVirtualProtectionGroupsApi()
vpgIdentifier = vpgIdentifier_example # String | VPG identifier. Related endpoint: `v1/vpgs`

try: 
    # Get checkpoints statistics for a VPG. (Auth)
    api_response = api_instance.get_vpg_checkpoint_stat_all(vpgIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VPGsVirtualProtectionGroupsApi->getVpgCheckpointStatAll: %s\n" % e)

Parameters

Path parameters
Name Description
vpgIdentifier*
String
VPG identifier. Related endpoint: `v1/vpgs`
Required

Responses

Status: 200 - Success

{
earliest:
{
checkpointIdentifier:
string
timeStamp:
string (date-time)
tag:
string
type:
integer (int32)
Enum: 0, 1, 2
}
latest:
{
checkpointIdentifier:
string
timeStamp:
string (date-time)
tag:
string
type:
integer (int32)
Enum: 0, 1, 2
}
}

getVpgEntityTypeAll

Get the list of values for VPG entity. (Auth)


/v1/vpgs/entitytypes

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgs/entitytypes"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGsVirtualProtectionGroupsApi;

import java.io.File;
import java.util.*;

public class VPGsVirtualProtectionGroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGsVirtualProtectionGroupsApi apiInstance = new VPGsVirtualProtectionGroupsApi();
        try {
            array['String'] result = apiInstance.getVpgEntityTypeAll();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGsVirtualProtectionGroupsApi#getVpgEntityTypeAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGsVirtualProtectionGroupsApi;

public class VPGsVirtualProtectionGroupsApiExample {

    public static void main(String[] args) {
        VPGsVirtualProtectionGroupsApi apiInstance = new VPGsVirtualProtectionGroupsApi();
        try {
            array['String'] result = apiInstance.getVpgEntityTypeAll();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGsVirtualProtectionGroupsApi#getVpgEntityTypeAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];

VPGsVirtualProtectionGroupsApi *apiInstance = [[VPGsVirtualProtectionGroupsApi alloc] init];

// Get the list of values for VPG entity. (Auth)
[apiInstance getVpgEntityTypeAllWithCompletionHandler: 
              ^(array['String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGsVirtualProtectionGroupsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVpgEntityTypeAll(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVpgEntityTypeAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGsVirtualProtectionGroupsApi();

            try
            {
                // Get the list of values for VPG entity. (Auth)
                array['String'] result = apiInstance.getVpgEntityTypeAll();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGsVirtualProtectionGroupsApi.getVpgEntityTypeAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGsVirtualProtectionGroupsApi();

try {
    $result = $api_instance->getVpgEntityTypeAll();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VPGsVirtualProtectionGroupsApi->getVpgEntityTypeAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGsVirtualProtectionGroupsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGsVirtualProtectionGroupsApi->new();

eval { 
    my $result = $api_instance->getVpgEntityTypeAll();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VPGsVirtualProtectionGroupsApi->getVpgEntityTypeAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGsVirtualProtectionGroupsApi()

try: 
    # Get the list of values for VPG entity. (Auth)
    api_response = api_instance.get_vpg_entity_type_all()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VPGsVirtualProtectionGroupsApi->getVpgEntityTypeAll: %s\n" % e)

Parameters

Responses

Status: 200 - Success

[
string
]

getVpgFailoverCommitPolicyAll

Get the list of values for VPG failover commit policy. (Auth)


/v1/vpgs/failovercommitpolicies

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgs/failovercommitpolicies"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGsVirtualProtectionGroupsApi;

import java.io.File;
import java.util.*;

public class VPGsVirtualProtectionGroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGsVirtualProtectionGroupsApi apiInstance = new VPGsVirtualProtectionGroupsApi();
        try {
            array['String'] result = apiInstance.getVpgFailoverCommitPolicyAll();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGsVirtualProtectionGroupsApi#getVpgFailoverCommitPolicyAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGsVirtualProtectionGroupsApi;

public class VPGsVirtualProtectionGroupsApiExample {

    public static void main(String[] args) {
        VPGsVirtualProtectionGroupsApi apiInstance = new VPGsVirtualProtectionGroupsApi();
        try {
            array['String'] result = apiInstance.getVpgFailoverCommitPolicyAll();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGsVirtualProtectionGroupsApi#getVpgFailoverCommitPolicyAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];

VPGsVirtualProtectionGroupsApi *apiInstance = [[VPGsVirtualProtectionGroupsApi alloc] init];

// Get the list of values for VPG failover commit policy. (Auth)
[apiInstance getVpgFailoverCommitPolicyAllWithCompletionHandler: 
              ^(array['String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGsVirtualProtectionGroupsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVpgFailoverCommitPolicyAll(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVpgFailoverCommitPolicyAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGsVirtualProtectionGroupsApi();

            try
            {
                // Get the list of values for VPG failover commit policy. (Auth)
                array['String'] result = apiInstance.getVpgFailoverCommitPolicyAll();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGsVirtualProtectionGroupsApi.getVpgFailoverCommitPolicyAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGsVirtualProtectionGroupsApi();

try {
    $result = $api_instance->getVpgFailoverCommitPolicyAll();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VPGsVirtualProtectionGroupsApi->getVpgFailoverCommitPolicyAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGsVirtualProtectionGroupsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGsVirtualProtectionGroupsApi->new();

eval { 
    my $result = $api_instance->getVpgFailoverCommitPolicyAll();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VPGsVirtualProtectionGroupsApi->getVpgFailoverCommitPolicyAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGsVirtualProtectionGroupsApi()

try: 
    # Get the list of values for VPG failover commit policy. (Auth)
    api_response = api_instance.get_vpg_failover_commit_policy_all()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VPGsVirtualProtectionGroupsApi->getVpgFailoverCommitPolicyAll: %s\n" % e)

Parameters

Responses

Status: 200 - Success

[
string
]

getVpgFailoverShutdownPolicyAll

Get the list of values for VPG failover shutdown policy. (Auth)


/v1/vpgs/failovershutdownpolicies

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgs/failovershutdownpolicies"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGsVirtualProtectionGroupsApi;

import java.io.File;
import java.util.*;

public class VPGsVirtualProtectionGroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGsVirtualProtectionGroupsApi apiInstance = new VPGsVirtualProtectionGroupsApi();
        try {
            array['String'] result = apiInstance.getVpgFailoverShutdownPolicyAll();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGsVirtualProtectionGroupsApi#getVpgFailoverShutdownPolicyAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGsVirtualProtectionGroupsApi;

public class VPGsVirtualProtectionGroupsApiExample {

    public static void main(String[] args) {
        VPGsVirtualProtectionGroupsApi apiInstance = new VPGsVirtualProtectionGroupsApi();
        try {
            array['String'] result = apiInstance.getVpgFailoverShutdownPolicyAll();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGsVirtualProtectionGroupsApi#getVpgFailoverShutdownPolicyAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];

VPGsVirtualProtectionGroupsApi *apiInstance = [[VPGsVirtualProtectionGroupsApi alloc] init];

// Get the list of values for VPG failover shutdown policy. (Auth)
[apiInstance getVpgFailoverShutdownPolicyAllWithCompletionHandler: 
              ^(array['String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGsVirtualProtectionGroupsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVpgFailoverShutdownPolicyAll(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVpgFailoverShutdownPolicyAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGsVirtualProtectionGroupsApi();

            try
            {
                // Get the list of values for VPG failover shutdown policy. (Auth)
                array['String'] result = apiInstance.getVpgFailoverShutdownPolicyAll();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGsVirtualProtectionGroupsApi.getVpgFailoverShutdownPolicyAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGsVirtualProtectionGroupsApi();

try {
    $result = $api_instance->getVpgFailoverShutdownPolicyAll();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VPGsVirtualProtectionGroupsApi->getVpgFailoverShutdownPolicyAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGsVirtualProtectionGroupsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGsVirtualProtectionGroupsApi->new();

eval { 
    my $result = $api_instance->getVpgFailoverShutdownPolicyAll();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VPGsVirtualProtectionGroupsApi->getVpgFailoverShutdownPolicyAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGsVirtualProtectionGroupsApi()

try: 
    # Get the list of values for VPG failover shutdown policy. (Auth)
    api_response = api_instance.get_vpg_failover_shutdown_policy_all()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VPGsVirtualProtectionGroupsApi->getVpgFailoverShutdownPolicyAll: %s\n" % e)

Parameters

Responses

Status: 200 - Success

[
string
]

getVpgPriorityAll

Get the list of values for VPG priority. (Auth)


/v1/vpgs/priorities

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgs/priorities"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGsVirtualProtectionGroupsApi;

import java.io.File;
import java.util.*;

public class VPGsVirtualProtectionGroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGsVirtualProtectionGroupsApi apiInstance = new VPGsVirtualProtectionGroupsApi();
        try {
            array['String'] result = apiInstance.getVpgPriorityAll();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGsVirtualProtectionGroupsApi#getVpgPriorityAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGsVirtualProtectionGroupsApi;

public class VPGsVirtualProtectionGroupsApiExample {

    public static void main(String[] args) {
        VPGsVirtualProtectionGroupsApi apiInstance = new VPGsVirtualProtectionGroupsApi();
        try {
            array['String'] result = apiInstance.getVpgPriorityAll();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGsVirtualProtectionGroupsApi#getVpgPriorityAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];

VPGsVirtualProtectionGroupsApi *apiInstance = [[VPGsVirtualProtectionGroupsApi alloc] init];

// Get the list of values for VPG priority. (Auth)
[apiInstance getVpgPriorityAllWithCompletionHandler: 
              ^(array['String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGsVirtualProtectionGroupsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVpgPriorityAll(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVpgPriorityAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGsVirtualProtectionGroupsApi();

            try
            {
                // Get the list of values for VPG priority. (Auth)
                array['String'] result = apiInstance.getVpgPriorityAll();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGsVirtualProtectionGroupsApi.getVpgPriorityAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGsVirtualProtectionGroupsApi();

try {
    $result = $api_instance->getVpgPriorityAll();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VPGsVirtualProtectionGroupsApi->getVpgPriorityAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGsVirtualProtectionGroupsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGsVirtualProtectionGroupsApi->new();

eval { 
    my $result = $api_instance->getVpgPriorityAll();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VPGsVirtualProtectionGroupsApi->getVpgPriorityAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGsVirtualProtectionGroupsApi()

try: 
    # Get the list of values for VPG priority. (Auth)
    api_response = api_instance.get_vpg_priority_all()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VPGsVirtualProtectionGroupsApi->getVpgPriorityAll: %s\n" % e)

Parameters

Responses

Status: 200 - Success

[
string
]

getVpgRetentionPolicyAll

Get the list of values for VPG retention policy. (Auth)


/v1/vpgs/retentionpolicies

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgs/retentionpolicies"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGsVirtualProtectionGroupsApi;

import java.io.File;
import java.util.*;

public class VPGsVirtualProtectionGroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGsVirtualProtectionGroupsApi apiInstance = new VPGsVirtualProtectionGroupsApi();
        try {
            array['String'] result = apiInstance.getVpgRetentionPolicyAll();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGsVirtualProtectionGroupsApi#getVpgRetentionPolicyAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGsVirtualProtectionGroupsApi;

public class VPGsVirtualProtectionGroupsApiExample {

    public static void main(String[] args) {
        VPGsVirtualProtectionGroupsApi apiInstance = new VPGsVirtualProtectionGroupsApi();
        try {
            array['String'] result = apiInstance.getVpgRetentionPolicyAll();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGsVirtualProtectionGroupsApi#getVpgRetentionPolicyAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];

VPGsVirtualProtectionGroupsApi *apiInstance = [[VPGsVirtualProtectionGroupsApi alloc] init];

// Get the list of values for VPG retention policy. (Auth)
[apiInstance getVpgRetentionPolicyAllWithCompletionHandler: 
              ^(array['String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGsVirtualProtectionGroupsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVpgRetentionPolicyAll(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVpgRetentionPolicyAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGsVirtualProtectionGroupsApi();

            try
            {
                // Get the list of values for VPG retention policy. (Auth)
                array['String'] result = apiInstance.getVpgRetentionPolicyAll();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGsVirtualProtectionGroupsApi.getVpgRetentionPolicyAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGsVirtualProtectionGroupsApi();

try {
    $result = $api_instance->getVpgRetentionPolicyAll();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VPGsVirtualProtectionGroupsApi->getVpgRetentionPolicyAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGsVirtualProtectionGroupsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGsVirtualProtectionGroupsApi->new();

eval { 
    my $result = $api_instance->getVpgRetentionPolicyAll();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VPGsVirtualProtectionGroupsApi->getVpgRetentionPolicyAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGsVirtualProtectionGroupsApi()

try: 
    # Get the list of values for VPG retention policy. (Auth)
    api_response = api_instance.get_vpg_retention_policy_all()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VPGsVirtualProtectionGroupsApi->getVpgRetentionPolicyAll: %s\n" % e)

Parameters

Responses

Status: 200 - Success

[
string
]

getVpgStatusAll

Get the list of values for VPG status. (Auth)


/v1/vpgs/statuses

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgs/statuses"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGsVirtualProtectionGroupsApi;

import java.io.File;
import java.util.*;

public class VPGsVirtualProtectionGroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGsVirtualProtectionGroupsApi apiInstance = new VPGsVirtualProtectionGroupsApi();
        try {
            array['String'] result = apiInstance.getVpgStatusAll();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGsVirtualProtectionGroupsApi#getVpgStatusAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGsVirtualProtectionGroupsApi;

public class VPGsVirtualProtectionGroupsApiExample {

    public static void main(String[] args) {
        VPGsVirtualProtectionGroupsApi apiInstance = new VPGsVirtualProtectionGroupsApi();
        try {
            array['String'] result = apiInstance.getVpgStatusAll();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGsVirtualProtectionGroupsApi#getVpgStatusAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];

VPGsVirtualProtectionGroupsApi *apiInstance = [[VPGsVirtualProtectionGroupsApi alloc] init];

// Get the list of values for VPG status. (Auth)
[apiInstance getVpgStatusAllWithCompletionHandler: 
              ^(array['String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGsVirtualProtectionGroupsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVpgStatusAll(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVpgStatusAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGsVirtualProtectionGroupsApi();

            try
            {
                // Get the list of values for VPG status. (Auth)
                array['String'] result = apiInstance.getVpgStatusAll();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGsVirtualProtectionGroupsApi.getVpgStatusAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGsVirtualProtectionGroupsApi();

try {
    $result = $api_instance->getVpgStatusAll();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VPGsVirtualProtectionGroupsApi->getVpgStatusAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGsVirtualProtectionGroupsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGsVirtualProtectionGroupsApi->new();

eval { 
    my $result = $api_instance->getVpgStatusAll();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VPGsVirtualProtectionGroupsApi->getVpgStatusAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGsVirtualProtectionGroupsApi()

try: 
    # Get the list of values for VPG status. (Auth)
    api_response = api_instance.get_vpg_status_all()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VPGsVirtualProtectionGroupsApi->getVpgStatusAll: %s\n" % e)

Parameters

Responses

Status: 200 - Success

[
string
]

getVpgSubStatusAll

Get the list of values for VPG sub status. (Auth)


/v1/vpgs/substatuses

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgs/substatuses"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGsVirtualProtectionGroupsApi;

import java.io.File;
import java.util.*;

public class VPGsVirtualProtectionGroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGsVirtualProtectionGroupsApi apiInstance = new VPGsVirtualProtectionGroupsApi();
        try {
            array['String'] result = apiInstance.getVpgSubStatusAll();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGsVirtualProtectionGroupsApi#getVpgSubStatusAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGsVirtualProtectionGroupsApi;

public class VPGsVirtualProtectionGroupsApiExample {

    public static void main(String[] args) {
        VPGsVirtualProtectionGroupsApi apiInstance = new VPGsVirtualProtectionGroupsApi();
        try {
            array['String'] result = apiInstance.getVpgSubStatusAll();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGsVirtualProtectionGroupsApi#getVpgSubStatusAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];

VPGsVirtualProtectionGroupsApi *apiInstance = [[VPGsVirtualProtectionGroupsApi alloc] init];

// Get the list of values for VPG sub status. (Auth)
[apiInstance getVpgSubStatusAllWithCompletionHandler: 
              ^(array['String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGsVirtualProtectionGroupsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVpgSubStatusAll(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVpgSubStatusAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGsVirtualProtectionGroupsApi();

            try
            {
                // Get the list of values for VPG sub status. (Auth)
                array['String'] result = apiInstance.getVpgSubStatusAll();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGsVirtualProtectionGroupsApi.getVpgSubStatusAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGsVirtualProtectionGroupsApi();

try {
    $result = $api_instance->getVpgSubStatusAll();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VPGsVirtualProtectionGroupsApi->getVpgSubStatusAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGsVirtualProtectionGroupsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGsVirtualProtectionGroupsApi->new();

eval { 
    my $result = $api_instance->getVpgSubStatusAll();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VPGsVirtualProtectionGroupsApi->getVpgSubStatusAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGsVirtualProtectionGroupsApi()

try: 
    # Get the list of values for VPG sub status. (Auth)
    api_response = api_instance.get_vpg_sub_status_all()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VPGsVirtualProtectionGroupsApi->getVpgSubStatusAll: %s\n" % e)

Parameters

Responses

Status: 200 - Success

[
string
]

startVpgClone

Clone a VPG using a specific checkpoint or the latest checkpoint if one is not (Auth)


/v1/vpgs/{vpgIdentifier}/CloneStart

Usage and SDK Samples

curl -X POST\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
-H "Content-Type: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgs/{vpgIdentifier}/CloneStart"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGsVirtualProtectionGroupsApi;

import java.io.File;
import java.util.*;

public class VPGsVirtualProtectionGroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGsVirtualProtectionGroupsApi apiInstance = new VPGsVirtualProtectionGroupsApi();
        String vpgIdentifier = vpgIdentifier_example; // String | VPG identifier. Related endpoint: `v1/vpgs`
        CloneStartDataApi body = ; // CloneStartDataApi | 
        try {
            'String' result = apiInstance.startVpgClone(vpgIdentifier, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGsVirtualProtectionGroupsApi#startVpgClone");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGsVirtualProtectionGroupsApi;

public class VPGsVirtualProtectionGroupsApiExample {

    public static void main(String[] args) {
        VPGsVirtualProtectionGroupsApi apiInstance = new VPGsVirtualProtectionGroupsApi();
        String vpgIdentifier = vpgIdentifier_example; // String | VPG identifier. Related endpoint: `v1/vpgs`
        CloneStartDataApi body = ; // CloneStartDataApi | 
        try {
            'String' result = apiInstance.startVpgClone(vpgIdentifier, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGsVirtualProtectionGroupsApi#startVpgClone");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgIdentifier = vpgIdentifier_example; // VPG identifier. Related endpoint: `v1/vpgs`
CloneStartDataApi *body = ; //  (optional)

VPGsVirtualProtectionGroupsApi *apiInstance = [[VPGsVirtualProtectionGroupsApi alloc] init];

// Clone a VPG using a specific checkpoint or the latest checkpoint if one is not (Auth)
[apiInstance startVpgCloneWith:vpgIdentifier
    body:body
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGsVirtualProtectionGroupsApi()
var vpgIdentifier = vpgIdentifier_example; // {{String}} VPG identifier. Related endpoint: `v1/vpgs`
var opts = { 
  'body':  // {{CloneStartDataApi}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.startVpgClone(vpgIdentifier, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class startVpgCloneExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGsVirtualProtectionGroupsApi();
            var vpgIdentifier = vpgIdentifier_example;  // String | VPG identifier. Related endpoint: `v1/vpgs`
            var body = new CloneStartDataApi(); // CloneStartDataApi |  (optional) 

            try
            {
                // Clone a VPG using a specific checkpoint or the latest checkpoint if one is not (Auth)
                'String' result = apiInstance.startVpgClone(vpgIdentifier, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGsVirtualProtectionGroupsApi.startVpgClone: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGsVirtualProtectionGroupsApi();
$vpgIdentifier = vpgIdentifier_example; // String | VPG identifier. Related endpoint: `v1/vpgs`
$body = ; // CloneStartDataApi | 

try {
    $result = $api_instance->startVpgClone($vpgIdentifier, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VPGsVirtualProtectionGroupsApi->startVpgClone: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGsVirtualProtectionGroupsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGsVirtualProtectionGroupsApi->new();
my $vpgIdentifier = vpgIdentifier_example; # String | VPG identifier. Related endpoint: `v1/vpgs`
my $body = WWW::SwaggerClient::Object::CloneStartDataApi->new(); # CloneStartDataApi | 

eval { 
    my $result = $api_instance->startVpgClone(vpgIdentifier => $vpgIdentifier, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VPGsVirtualProtectionGroupsApi->startVpgClone: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGsVirtualProtectionGroupsApi()
vpgIdentifier = vpgIdentifier_example # String | VPG identifier. Related endpoint: `v1/vpgs`
body =  # CloneStartDataApi |  (optional)

try: 
    # Clone a VPG using a specific checkpoint or the latest checkpoint if one is not (Auth)
    api_response = api_instance.start_vpg_clone(vpgIdentifier, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VPGsVirtualProtectionGroupsApi->startVpgClone: %s\n" % e)

Parameters

Path parameters
Name Description
vpgIdentifier*
String
VPG identifier. Related endpoint: `v1/vpgs`
Required
Body parameters
Name Description
body
{
checkpointId:
string
datastoreIdentifier:
string
vmIdentifiers:
[
string
]
}

Responses

Status: 200 - Success

string

startVpgDelete

Delete the VPG (Auth)


/v1/vpgs/{vpgIdentifier}

Usage and SDK Samples

curl -X DELETE\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
-H "Content-Type: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgs/{vpgIdentifier}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGsVirtualProtectionGroupsApi;

import java.io.File;
import java.util.*;

public class VPGsVirtualProtectionGroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGsVirtualProtectionGroupsApi apiInstance = new VPGsVirtualProtectionGroupsApi();
        String vpgIdentifier = vpgIdentifier_example; // String | VPG identifier. Related endpoint: `v1/vpgs`
        VpgDeleteDataApi body = ; // VpgDeleteDataApi | 
        try {
            'String' result = apiInstance.startVpgDelete(vpgIdentifier, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGsVirtualProtectionGroupsApi#startVpgDelete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGsVirtualProtectionGroupsApi;

public class VPGsVirtualProtectionGroupsApiExample {

    public static void main(String[] args) {
        VPGsVirtualProtectionGroupsApi apiInstance = new VPGsVirtualProtectionGroupsApi();
        String vpgIdentifier = vpgIdentifier_example; // String | VPG identifier. Related endpoint: `v1/vpgs`
        VpgDeleteDataApi body = ; // VpgDeleteDataApi | 
        try {
            'String' result = apiInstance.startVpgDelete(vpgIdentifier, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGsVirtualProtectionGroupsApi#startVpgDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgIdentifier = vpgIdentifier_example; // VPG identifier. Related endpoint: `v1/vpgs`
VpgDeleteDataApi *body = ; //  (optional)

VPGsVirtualProtectionGroupsApi *apiInstance = [[VPGsVirtualProtectionGroupsApi alloc] init];

// Delete the VPG (Auth)
[apiInstance startVpgDeleteWith:vpgIdentifier
    body:body
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGsVirtualProtectionGroupsApi()
var vpgIdentifier = vpgIdentifier_example; // {{String}} VPG identifier. Related endpoint: `v1/vpgs`
var opts = { 
  'body':  // {{VpgDeleteDataApi}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.startVpgDelete(vpgIdentifier, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class startVpgDeleteExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGsVirtualProtectionGroupsApi();
            var vpgIdentifier = vpgIdentifier_example;  // String | VPG identifier. Related endpoint: `v1/vpgs`
            var body = new VpgDeleteDataApi(); // VpgDeleteDataApi |  (optional) 

            try
            {
                // Delete the VPG (Auth)
                'String' result = apiInstance.startVpgDelete(vpgIdentifier, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGsVirtualProtectionGroupsApi.startVpgDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGsVirtualProtectionGroupsApi();
$vpgIdentifier = vpgIdentifier_example; // String | VPG identifier. Related endpoint: `v1/vpgs`
$body = ; // VpgDeleteDataApi | 

try {
    $result = $api_instance->startVpgDelete($vpgIdentifier, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VPGsVirtualProtectionGroupsApi->startVpgDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGsVirtualProtectionGroupsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGsVirtualProtectionGroupsApi->new();
my $vpgIdentifier = vpgIdentifier_example; # String | VPG identifier. Related endpoint: `v1/vpgs`
my $body = WWW::SwaggerClient::Object::VpgDeleteDataApi->new(); # VpgDeleteDataApi | 

eval { 
    my $result = $api_instance->startVpgDelete(vpgIdentifier => $vpgIdentifier, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VPGsVirtualProtectionGroupsApi->startVpgDelete: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGsVirtualProtectionGroupsApi()
vpgIdentifier = vpgIdentifier_example # String | VPG identifier. Related endpoint: `v1/vpgs`
body =  # VpgDeleteDataApi |  (optional)

try: 
    # Delete the VPG (Auth)
    api_response = api_instance.start_vpg_delete(vpgIdentifier, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VPGsVirtualProtectionGroupsApi->startVpgDelete: %s\n" % e)

Parameters

Path parameters
Name Description
vpgIdentifier*
String
VPG identifier. Related endpoint: `v1/vpgs`
Required
Body parameters
Name Description
body
{
keepRecoveryVolumes:
boolean
force:
boolean
}

Responses

Status: 200 - Success

string

startVpgFailover

Starts a Failover of a VPG using a checkpoint. Returns the TaskIdentifier of the operation, which can be used to monitor the operation. (Auth)


/v1/vpgs/{vpgIdentifier}/Failover

Usage and SDK Samples

curl -X POST\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
-H "Content-Type: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgs/{vpgIdentifier}/Failover"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGsVirtualProtectionGroupsApi;

import java.io.File;
import java.util.*;

public class VPGsVirtualProtectionGroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGsVirtualProtectionGroupsApi apiInstance = new VPGsVirtualProtectionGroupsApi();
        String vpgIdentifier = vpgIdentifier_example; // String | VPG identifier. Related endpoint: `v1/vpgs`
        FailoverDataApi body = ; // FailoverDataApi | 
        try {
            'String' result = apiInstance.startVpgFailover(vpgIdentifier, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGsVirtualProtectionGroupsApi#startVpgFailover");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGsVirtualProtectionGroupsApi;

public class VPGsVirtualProtectionGroupsApiExample {

    public static void main(String[] args) {
        VPGsVirtualProtectionGroupsApi apiInstance = new VPGsVirtualProtectionGroupsApi();
        String vpgIdentifier = vpgIdentifier_example; // String | VPG identifier. Related endpoint: `v1/vpgs`
        FailoverDataApi body = ; // FailoverDataApi | 
        try {
            'String' result = apiInstance.startVpgFailover(vpgIdentifier, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGsVirtualProtectionGroupsApi#startVpgFailover");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgIdentifier = vpgIdentifier_example; // VPG identifier. Related endpoint: `v1/vpgs`
FailoverDataApi *body = ; //  (optional)

VPGsVirtualProtectionGroupsApi *apiInstance = [[VPGsVirtualProtectionGroupsApi alloc] init];

// Starts a Failover of a VPG using a checkpoint. Returns the TaskIdentifier of the operation, which can be used to monitor the operation. (Auth)
[apiInstance startVpgFailoverWith:vpgIdentifier
    body:body
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGsVirtualProtectionGroupsApi()
var vpgIdentifier = vpgIdentifier_example; // {{String}} VPG identifier. Related endpoint: `v1/vpgs`
var opts = { 
  'body':  // {{FailoverDataApi}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.startVpgFailover(vpgIdentifier, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class startVpgFailoverExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGsVirtualProtectionGroupsApi();
            var vpgIdentifier = vpgIdentifier_example;  // String | VPG identifier. Related endpoint: `v1/vpgs`
            var body = new FailoverDataApi(); // FailoverDataApi |  (optional) 

            try
            {
                // Starts a Failover of a VPG using a checkpoint. Returns the TaskIdentifier of the operation, which can be used to monitor the operation. (Auth)
                'String' result = apiInstance.startVpgFailover(vpgIdentifier, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGsVirtualProtectionGroupsApi.startVpgFailover: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGsVirtualProtectionGroupsApi();
$vpgIdentifier = vpgIdentifier_example; // String | VPG identifier. Related endpoint: `v1/vpgs`
$body = ; // FailoverDataApi | 

try {
    $result = $api_instance->startVpgFailover($vpgIdentifier, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VPGsVirtualProtectionGroupsApi->startVpgFailover: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGsVirtualProtectionGroupsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGsVirtualProtectionGroupsApi->new();
my $vpgIdentifier = vpgIdentifier_example; # String | VPG identifier. Related endpoint: `v1/vpgs`
my $body = WWW::SwaggerClient::Object::FailoverDataApi->new(); # FailoverDataApi | 

eval { 
    my $result = $api_instance->startVpgFailover(vpgIdentifier => $vpgIdentifier, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VPGsVirtualProtectionGroupsApi->startVpgFailover: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGsVirtualProtectionGroupsApi()
vpgIdentifier = vpgIdentifier_example # String | VPG identifier. Related endpoint: `v1/vpgs`
body =  # FailoverDataApi |  (optional)

try: 
    # Starts a Failover of a VPG using a checkpoint. Returns the TaskIdentifier of the operation, which can be used to monitor the operation. (Auth)
    api_response = api_instance.start_vpg_failover(vpgIdentifier, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VPGsVirtualProtectionGroupsApi->startVpgFailover: %s\n" % e)

Parameters

Path parameters
Name Description
vpgIdentifier*
String
VPG identifier. Related endpoint: `v1/vpgs`
Required
Body parameters
Name Description
body
{
checkpointIdentifier:
string
commitPolicy:
integer (int32)
Enum: 0, 1, 2
timeToWaitBeforeShutdownInSec:
integer (int32)
shutdownPolicy:
integer (int32)
Enum: 0, 1, 2
isReverseProtection:
boolean
vmIdentifiers:
[
string
]
}

Responses

Status: 200 - Success

string

startVpgFailoverCommit

Commits the Failover of a VPG. Returns the TaskIdentifier of the operation, which can be used to monitor the operation. (Auth)


/v1/vpgs/{vpgIdentifier}/FailoverCommit

Usage and SDK Samples

curl -X POST\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
-H "Content-Type: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgs/{vpgIdentifier}/FailoverCommit"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGsVirtualProtectionGroupsApi;

import java.io.File;
import java.util.*;

public class VPGsVirtualProtectionGroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGsVirtualProtectionGroupsApi apiInstance = new VPGsVirtualProtectionGroupsApi();
        String vpgIdentifier = vpgIdentifier_example; // String | VPG identifier. Related endpoint: `v1/vpgs`
        FailoverCommitDataApi body = ; // FailoverCommitDataApi | 
        try {
            'String' result = apiInstance.startVpgFailoverCommit(vpgIdentifier, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGsVirtualProtectionGroupsApi#startVpgFailoverCommit");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGsVirtualProtectionGroupsApi;

public class VPGsVirtualProtectionGroupsApiExample {

    public static void main(String[] args) {
        VPGsVirtualProtectionGroupsApi apiInstance = new VPGsVirtualProtectionGroupsApi();
        String vpgIdentifier = vpgIdentifier_example; // String | VPG identifier. Related endpoint: `v1/vpgs`
        FailoverCommitDataApi body = ; // FailoverCommitDataApi | 
        try {
            'String' result = apiInstance.startVpgFailoverCommit(vpgIdentifier, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGsVirtualProtectionGroupsApi#startVpgFailoverCommit");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgIdentifier = vpgIdentifier_example; // VPG identifier. Related endpoint: `v1/vpgs`
FailoverCommitDataApi *body = ; //  (optional)

VPGsVirtualProtectionGroupsApi *apiInstance = [[VPGsVirtualProtectionGroupsApi alloc] init];

// Commits the Failover of a VPG. Returns the TaskIdentifier of the operation, which can be used to monitor the operation. (Auth)
[apiInstance startVpgFailoverCommitWith:vpgIdentifier
    body:body
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGsVirtualProtectionGroupsApi()
var vpgIdentifier = vpgIdentifier_example; // {{String}} VPG identifier. Related endpoint: `v1/vpgs`
var opts = { 
  'body':  // {{FailoverCommitDataApi}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.startVpgFailoverCommit(vpgIdentifier, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class startVpgFailoverCommitExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGsVirtualProtectionGroupsApi();
            var vpgIdentifier = vpgIdentifier_example;  // String | VPG identifier. Related endpoint: `v1/vpgs`
            var body = new FailoverCommitDataApi(); // FailoverCommitDataApi |  (optional) 

            try
            {
                // Commits the Failover of a VPG. Returns the TaskIdentifier of the operation, which can be used to monitor the operation. (Auth)
                'String' result = apiInstance.startVpgFailoverCommit(vpgIdentifier, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGsVirtualProtectionGroupsApi.startVpgFailoverCommit: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGsVirtualProtectionGroupsApi();
$vpgIdentifier = vpgIdentifier_example; // String | VPG identifier. Related endpoint: `v1/vpgs`
$body = ; // FailoverCommitDataApi | 

try {
    $result = $api_instance->startVpgFailoverCommit($vpgIdentifier, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VPGsVirtualProtectionGroupsApi->startVpgFailoverCommit: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGsVirtualProtectionGroupsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGsVirtualProtectionGroupsApi->new();
my $vpgIdentifier = vpgIdentifier_example; # String | VPG identifier. Related endpoint: `v1/vpgs`
my $body = WWW::SwaggerClient::Object::FailoverCommitDataApi->new(); # FailoverCommitDataApi | 

eval { 
    my $result = $api_instance->startVpgFailoverCommit(vpgIdentifier => $vpgIdentifier, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VPGsVirtualProtectionGroupsApi->startVpgFailoverCommit: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGsVirtualProtectionGroupsApi()
vpgIdentifier = vpgIdentifier_example # String | VPG identifier. Related endpoint: `v1/vpgs`
body =  # FailoverCommitDataApi |  (optional)

try: 
    # Commits the Failover of a VPG. Returns the TaskIdentifier of the operation, which can be used to monitor the operation. (Auth)
    api_response = api_instance.start_vpg_failover_commit(vpgIdentifier, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VPGsVirtualProtectionGroupsApi->startVpgFailoverCommit: %s\n" % e)

Parameters

Path parameters
Name Description
vpgIdentifier*
String
VPG identifier. Related endpoint: `v1/vpgs`
Required
Body parameters
Name Description
body
{
isReverseProtection:
boolean
}

Responses

Status: 200 - Success

string

startVpgFailoverRollback

Rolls back the VPG after Failover. Returns the TaskIdentifier of the operation, which can be used to monitor the operation. (Auth)


/v1/vpgs/{vpgIdentifier}/FailoverRollback

Usage and SDK Samples

curl -X POST\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgs/{vpgIdentifier}/FailoverRollback"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGsVirtualProtectionGroupsApi;

import java.io.File;
import java.util.*;

public class VPGsVirtualProtectionGroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGsVirtualProtectionGroupsApi apiInstance = new VPGsVirtualProtectionGroupsApi();
        String vpgIdentifier = vpgIdentifier_example; // String | VPG identifier. Related endpoint: `v1/vpgs`
        try {
            'String' result = apiInstance.startVpgFailoverRollback(vpgIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGsVirtualProtectionGroupsApi#startVpgFailoverRollback");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGsVirtualProtectionGroupsApi;

public class VPGsVirtualProtectionGroupsApiExample {

    public static void main(String[] args) {
        VPGsVirtualProtectionGroupsApi apiInstance = new VPGsVirtualProtectionGroupsApi();
        String vpgIdentifier = vpgIdentifier_example; // String | VPG identifier. Related endpoint: `v1/vpgs`
        try {
            'String' result = apiInstance.startVpgFailoverRollback(vpgIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGsVirtualProtectionGroupsApi#startVpgFailoverRollback");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgIdentifier = vpgIdentifier_example; // VPG identifier. Related endpoint: `v1/vpgs`

VPGsVirtualProtectionGroupsApi *apiInstance = [[VPGsVirtualProtectionGroupsApi alloc] init];

// Rolls back the VPG after Failover. Returns the TaskIdentifier of the operation, which can be used to monitor the operation. (Auth)
[apiInstance startVpgFailoverRollbackWith:vpgIdentifier
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGsVirtualProtectionGroupsApi()
var vpgIdentifier = vpgIdentifier_example; // {{String}} VPG identifier. Related endpoint: `v1/vpgs`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.startVpgFailoverRollback(vpgIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class startVpgFailoverRollbackExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGsVirtualProtectionGroupsApi();
            var vpgIdentifier = vpgIdentifier_example;  // String | VPG identifier. Related endpoint: `v1/vpgs`

            try
            {
                // Rolls back the VPG after Failover. Returns the TaskIdentifier of the operation, which can be used to monitor the operation. (Auth)
                'String' result = apiInstance.startVpgFailoverRollback(vpgIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGsVirtualProtectionGroupsApi.startVpgFailoverRollback: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGsVirtualProtectionGroupsApi();
$vpgIdentifier = vpgIdentifier_example; // String | VPG identifier. Related endpoint: `v1/vpgs`

try {
    $result = $api_instance->startVpgFailoverRollback($vpgIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VPGsVirtualProtectionGroupsApi->startVpgFailoverRollback: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGsVirtualProtectionGroupsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGsVirtualProtectionGroupsApi->new();
my $vpgIdentifier = vpgIdentifier_example; # String | VPG identifier. Related endpoint: `v1/vpgs`

eval { 
    my $result = $api_instance->startVpgFailoverRollback(vpgIdentifier => $vpgIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VPGsVirtualProtectionGroupsApi->startVpgFailoverRollback: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGsVirtualProtectionGroupsApi()
vpgIdentifier = vpgIdentifier_example # String | VPG identifier. Related endpoint: `v1/vpgs`

try: 
    # Rolls back the VPG after Failover. Returns the TaskIdentifier of the operation, which can be used to monitor the operation. (Auth)
    api_response = api_instance.start_vpg_failover_rollback(vpgIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VPGsVirtualProtectionGroupsApi->startVpgFailoverRollback: %s\n" % e)

Parameters

Path parameters
Name Description
vpgIdentifier*
String
VPG identifier. Related endpoint: `v1/vpgs`
Required

Responses

Status: 200 - Success

string

startVpgFailoverTest

Start a failover test using a specific checkpoint or the latest checkpoint if one is not . (Auth)


/v1/vpgs/{vpgIdentifier}/FailoverTest

Usage and SDK Samples

curl -X POST\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
-H "Content-Type: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgs/{vpgIdentifier}/FailoverTest"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGsVirtualProtectionGroupsApi;

import java.io.File;
import java.util.*;

public class VPGsVirtualProtectionGroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGsVirtualProtectionGroupsApi apiInstance = new VPGsVirtualProtectionGroupsApi();
        String vpgIdentifier = vpgIdentifier_example; // String | VPG identifier. Related endpoint: `v1/vpgs`
        FailOverTestStartDataApi body = ; // FailOverTestStartDataApi | 
        try {
            'String' result = apiInstance.startVpgFailoverTest(vpgIdentifier, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGsVirtualProtectionGroupsApi#startVpgFailoverTest");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGsVirtualProtectionGroupsApi;

public class VPGsVirtualProtectionGroupsApiExample {

    public static void main(String[] args) {
        VPGsVirtualProtectionGroupsApi apiInstance = new VPGsVirtualProtectionGroupsApi();
        String vpgIdentifier = vpgIdentifier_example; // String | VPG identifier. Related endpoint: `v1/vpgs`
        FailOverTestStartDataApi body = ; // FailOverTestStartDataApi | 
        try {
            'String' result = apiInstance.startVpgFailoverTest(vpgIdentifier, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGsVirtualProtectionGroupsApi#startVpgFailoverTest");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgIdentifier = vpgIdentifier_example; // VPG identifier. Related endpoint: `v1/vpgs`
FailOverTestStartDataApi *body = ; //  (optional)

VPGsVirtualProtectionGroupsApi *apiInstance = [[VPGsVirtualProtectionGroupsApi alloc] init];

// Start a failover test using a specific checkpoint or the latest checkpoint if one is not . (Auth)
[apiInstance startVpgFailoverTestWith:vpgIdentifier
    body:body
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGsVirtualProtectionGroupsApi()
var vpgIdentifier = vpgIdentifier_example; // {{String}} VPG identifier. Related endpoint: `v1/vpgs`
var opts = { 
  'body':  // {{FailOverTestStartDataApi}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.startVpgFailoverTest(vpgIdentifier, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class startVpgFailoverTestExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGsVirtualProtectionGroupsApi();
            var vpgIdentifier = vpgIdentifier_example;  // String | VPG identifier. Related endpoint: `v1/vpgs`
            var body = new FailOverTestStartDataApi(); // FailOverTestStartDataApi |  (optional) 

            try
            {
                // Start a failover test using a specific checkpoint or the latest checkpoint if one is not . (Auth)
                'String' result = apiInstance.startVpgFailoverTest(vpgIdentifier, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGsVirtualProtectionGroupsApi.startVpgFailoverTest: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGsVirtualProtectionGroupsApi();
$vpgIdentifier = vpgIdentifier_example; // String | VPG identifier. Related endpoint: `v1/vpgs`
$body = ; // FailOverTestStartDataApi | 

try {
    $result = $api_instance->startVpgFailoverTest($vpgIdentifier, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VPGsVirtualProtectionGroupsApi->startVpgFailoverTest: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGsVirtualProtectionGroupsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGsVirtualProtectionGroupsApi->new();
my $vpgIdentifier = vpgIdentifier_example; # String | VPG identifier. Related endpoint: `v1/vpgs`
my $body = WWW::SwaggerClient::Object::FailOverTestStartDataApi->new(); # FailOverTestStartDataApi | 

eval { 
    my $result = $api_instance->startVpgFailoverTest(vpgIdentifier => $vpgIdentifier, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VPGsVirtualProtectionGroupsApi->startVpgFailoverTest: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGsVirtualProtectionGroupsApi()
vpgIdentifier = vpgIdentifier_example # String | VPG identifier. Related endpoint: `v1/vpgs`
body =  # FailOverTestStartDataApi |  (optional)

try: 
    # Start a failover test using a specific checkpoint or the latest checkpoint if one is not . (Auth)
    api_response = api_instance.start_vpg_failover_test(vpgIdentifier, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VPGsVirtualProtectionGroupsApi->startVpgFailoverTest: %s\n" % e)

Parameters

Path parameters
Name Description
vpgIdentifier*
String
VPG identifier. Related endpoint: `v1/vpgs`
Required
Body parameters
Name Description
body
{
checkpointId:
string
checkpointIdentifier:
string
vmIdentifiers:
[
string
]
}

Responses

Status: 200 - Success

string

startVpgForceSync

Force synchronization of the VPG. (Auth)


/v1/vpgs/{vpgIdentifier}/forcesync

Usage and SDK Samples

curl -X POST\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgs/{vpgIdentifier}/forcesync"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGsVirtualProtectionGroupsApi;

import java.io.File;
import java.util.*;

public class VPGsVirtualProtectionGroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGsVirtualProtectionGroupsApi apiInstance = new VPGsVirtualProtectionGroupsApi();
        String vpgIdentifier = vpgIdentifier_example; // String | VPG identifier. Related endpoint: `v1/vpgs`
        try {
            'String' result = apiInstance.startVpgForceSync(vpgIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGsVirtualProtectionGroupsApi#startVpgForceSync");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGsVirtualProtectionGroupsApi;

public class VPGsVirtualProtectionGroupsApiExample {

    public static void main(String[] args) {
        VPGsVirtualProtectionGroupsApi apiInstance = new VPGsVirtualProtectionGroupsApi();
        String vpgIdentifier = vpgIdentifier_example; // String | VPG identifier. Related endpoint: `v1/vpgs`
        try {
            'String' result = apiInstance.startVpgForceSync(vpgIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGsVirtualProtectionGroupsApi#startVpgForceSync");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgIdentifier = vpgIdentifier_example; // VPG identifier. Related endpoint: `v1/vpgs`

VPGsVirtualProtectionGroupsApi *apiInstance = [[VPGsVirtualProtectionGroupsApi alloc] init];

// Force synchronization of the VPG. (Auth)
[apiInstance startVpgForceSyncWith:vpgIdentifier
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGsVirtualProtectionGroupsApi()
var vpgIdentifier = vpgIdentifier_example; // {{String}} VPG identifier. Related endpoint: `v1/vpgs`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.startVpgForceSync(vpgIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class startVpgForceSyncExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGsVirtualProtectionGroupsApi();
            var vpgIdentifier = vpgIdentifier_example;  // String | VPG identifier. Related endpoint: `v1/vpgs`

            try
            {
                // Force synchronization of the VPG. (Auth)
                'String' result = apiInstance.startVpgForceSync(vpgIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGsVirtualProtectionGroupsApi.startVpgForceSync: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGsVirtualProtectionGroupsApi();
$vpgIdentifier = vpgIdentifier_example; // String | VPG identifier. Related endpoint: `v1/vpgs`

try {
    $result = $api_instance->startVpgForceSync($vpgIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VPGsVirtualProtectionGroupsApi->startVpgForceSync: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGsVirtualProtectionGroupsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGsVirtualProtectionGroupsApi->new();
my $vpgIdentifier = vpgIdentifier_example; # String | VPG identifier. Related endpoint: `v1/vpgs`

eval { 
    my $result = $api_instance->startVpgForceSync(vpgIdentifier => $vpgIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VPGsVirtualProtectionGroupsApi->startVpgForceSync: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGsVirtualProtectionGroupsApi()
vpgIdentifier = vpgIdentifier_example # String | VPG identifier. Related endpoint: `v1/vpgs`

try: 
    # Force synchronization of the VPG. (Auth)
    api_response = api_instance.start_vpg_force_sync(vpgIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VPGsVirtualProtectionGroupsApi->startVpgForceSync: %s\n" % e)

Parameters

Path parameters
Name Description
vpgIdentifier*
String
VPG identifier. Related endpoint: `v1/vpgs`
Required

Responses

Status: 200 - Success

string

startVpgMove

Starts a Move of a VPG using a checkpoint. Returns the TaskIdentifier of the operation, which can be used to monitor the operation. (Auth)


/v1/vpgs/{vpgIdentifier}/Move

Usage and SDK Samples

curl -X POST\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
-H "Content-Type: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgs/{vpgIdentifier}/Move"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGsVirtualProtectionGroupsApi;

import java.io.File;
import java.util.*;

public class VPGsVirtualProtectionGroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGsVirtualProtectionGroupsApi apiInstance = new VPGsVirtualProtectionGroupsApi();
        String vpgIdentifier = vpgIdentifier_example; // String | VPG identifier. Related endpoint: `v1/vpgs`
        MoveVpgDataApi body = ; // MoveVpgDataApi | 
        try {
            'String' result = apiInstance.startVpgMove(vpgIdentifier, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGsVirtualProtectionGroupsApi#startVpgMove");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGsVirtualProtectionGroupsApi;

public class VPGsVirtualProtectionGroupsApiExample {

    public static void main(String[] args) {
        VPGsVirtualProtectionGroupsApi apiInstance = new VPGsVirtualProtectionGroupsApi();
        String vpgIdentifier = vpgIdentifier_example; // String | VPG identifier. Related endpoint: `v1/vpgs`
        MoveVpgDataApi body = ; // MoveVpgDataApi | 
        try {
            'String' result = apiInstance.startVpgMove(vpgIdentifier, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGsVirtualProtectionGroupsApi#startVpgMove");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgIdentifier = vpgIdentifier_example; // VPG identifier. Related endpoint: `v1/vpgs`
MoveVpgDataApi *body = ; //  (optional)

VPGsVirtualProtectionGroupsApi *apiInstance = [[VPGsVirtualProtectionGroupsApi alloc] init];

// Starts a Move of a VPG using a checkpoint. Returns the TaskIdentifier of the operation, which can be used to monitor the operation. (Auth)
[apiInstance startVpgMoveWith:vpgIdentifier
    body:body
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGsVirtualProtectionGroupsApi()
var vpgIdentifier = vpgIdentifier_example; // {{String}} VPG identifier. Related endpoint: `v1/vpgs`
var opts = { 
  'body':  // {{MoveVpgDataApi}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.startVpgMove(vpgIdentifier, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class startVpgMoveExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGsVirtualProtectionGroupsApi();
            var vpgIdentifier = vpgIdentifier_example;  // String | VPG identifier. Related endpoint: `v1/vpgs`
            var body = new MoveVpgDataApi(); // MoveVpgDataApi |  (optional) 

            try
            {
                // Starts a Move of a VPG using a checkpoint. Returns the TaskIdentifier of the operation, which can be used to monitor the operation. (Auth)
                'String' result = apiInstance.startVpgMove(vpgIdentifier, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGsVirtualProtectionGroupsApi.startVpgMove: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGsVirtualProtectionGroupsApi();
$vpgIdentifier = vpgIdentifier_example; // String | VPG identifier. Related endpoint: `v1/vpgs`
$body = ; // MoveVpgDataApi | 

try {
    $result = $api_instance->startVpgMove($vpgIdentifier, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VPGsVirtualProtectionGroupsApi->startVpgMove: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGsVirtualProtectionGroupsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGsVirtualProtectionGroupsApi->new();
my $vpgIdentifier = vpgIdentifier_example; # String | VPG identifier. Related endpoint: `v1/vpgs`
my $body = WWW::SwaggerClient::Object::MoveVpgDataApi->new(); # MoveVpgDataApi | 

eval { 
    my $result = $api_instance->startVpgMove(vpgIdentifier => $vpgIdentifier, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VPGsVirtualProtectionGroupsApi->startVpgMove: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGsVirtualProtectionGroupsApi()
vpgIdentifier = vpgIdentifier_example # String | VPG identifier. Related endpoint: `v1/vpgs`
body =  # MoveVpgDataApi |  (optional)

try: 
    # Starts a Move of a VPG using a checkpoint. Returns the TaskIdentifier of the operation, which can be used to monitor the operation. (Auth)
    api_response = api_instance.start_vpg_move(vpgIdentifier, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VPGsVirtualProtectionGroupsApi->startVpgMove: %s\n" % e)

Parameters

Path parameters
Name Description
vpgIdentifier*
String
VPG identifier. Related endpoint: `v1/vpgs`
Required
Body parameters
Name Description
body
{
commitPolicy:
integer (int32)
Enum: 0, 1, 2
commitPolicyTimeout:
integer (int32)
forceShutdown:
boolean
reverseProtection:
boolean
keepSourceVms:
boolean
continueOnPreScriptFailure:
boolean
}

Responses

Status: 200 - Success

string

startVpgMoveCommit

Commits the VPG. Returns the TaskIdentifier of the operation, which can be used to monitor the operation. (Auth)


/v1/vpgs/{vpgIdentifier}/MoveCommit

Usage and SDK Samples

curl -X POST\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
-H "Content-Type: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgs/{vpgIdentifier}/MoveCommit"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGsVirtualProtectionGroupsApi;

import java.io.File;
import java.util.*;

public class VPGsVirtualProtectionGroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGsVirtualProtectionGroupsApi apiInstance = new VPGsVirtualProtectionGroupsApi();
        String vpgIdentifier = vpgIdentifier_example; // String | VPG identifier. Related endpoint: `v1/vpgs`
        MoveCommitVpgDataApi body = ; // MoveCommitVpgDataApi | 
        try {
            'String' result = apiInstance.startVpgMoveCommit(vpgIdentifier, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGsVirtualProtectionGroupsApi#startVpgMoveCommit");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGsVirtualProtectionGroupsApi;

public class VPGsVirtualProtectionGroupsApiExample {

    public static void main(String[] args) {
        VPGsVirtualProtectionGroupsApi apiInstance = new VPGsVirtualProtectionGroupsApi();
        String vpgIdentifier = vpgIdentifier_example; // String | VPG identifier. Related endpoint: `v1/vpgs`
        MoveCommitVpgDataApi body = ; // MoveCommitVpgDataApi | 
        try {
            'String' result = apiInstance.startVpgMoveCommit(vpgIdentifier, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGsVirtualProtectionGroupsApi#startVpgMoveCommit");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgIdentifier = vpgIdentifier_example; // VPG identifier. Related endpoint: `v1/vpgs`
MoveCommitVpgDataApi *body = ; //  (optional)

VPGsVirtualProtectionGroupsApi *apiInstance = [[VPGsVirtualProtectionGroupsApi alloc] init];

// Commits the VPG. Returns the TaskIdentifier of the operation, which can be used to monitor the operation. (Auth)
[apiInstance startVpgMoveCommitWith:vpgIdentifier
    body:body
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGsVirtualProtectionGroupsApi()
var vpgIdentifier = vpgIdentifier_example; // {{String}} VPG identifier. Related endpoint: `v1/vpgs`
var opts = { 
  'body':  // {{MoveCommitVpgDataApi}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.startVpgMoveCommit(vpgIdentifier, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class startVpgMoveCommitExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGsVirtualProtectionGroupsApi();
            var vpgIdentifier = vpgIdentifier_example;  // String | VPG identifier. Related endpoint: `v1/vpgs`
            var body = new MoveCommitVpgDataApi(); // MoveCommitVpgDataApi |  (optional) 

            try
            {
                // Commits the VPG. Returns the TaskIdentifier of the operation, which can be used to monitor the operation. (Auth)
                'String' result = apiInstance.startVpgMoveCommit(vpgIdentifier, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGsVirtualProtectionGroupsApi.startVpgMoveCommit: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGsVirtualProtectionGroupsApi();
$vpgIdentifier = vpgIdentifier_example; // String | VPG identifier. Related endpoint: `v1/vpgs`
$body = ; // MoveCommitVpgDataApi | 

try {
    $result = $api_instance->startVpgMoveCommit($vpgIdentifier, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VPGsVirtualProtectionGroupsApi->startVpgMoveCommit: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGsVirtualProtectionGroupsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGsVirtualProtectionGroupsApi->new();
my $vpgIdentifier = vpgIdentifier_example; # String | VPG identifier. Related endpoint: `v1/vpgs`
my $body = WWW::SwaggerClient::Object::MoveCommitVpgDataApi->new(); # MoveCommitVpgDataApi | 

eval { 
    my $result = $api_instance->startVpgMoveCommit(vpgIdentifier => $vpgIdentifier, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VPGsVirtualProtectionGroupsApi->startVpgMoveCommit: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGsVirtualProtectionGroupsApi()
vpgIdentifier = vpgIdentifier_example # String | VPG identifier. Related endpoint: `v1/vpgs`
body =  # MoveCommitVpgDataApi |  (optional)

try: 
    # Commits the VPG. Returns the TaskIdentifier of the operation, which can be used to monitor the operation. (Auth)
    api_response = api_instance.start_vpg_move_commit(vpgIdentifier, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VPGsVirtualProtectionGroupsApi->startVpgMoveCommit: %s\n" % e)

Parameters

Path parameters
Name Description
vpgIdentifier*
String
VPG identifier. Related endpoint: `v1/vpgs`
Required
Body parameters
Name Description
body
{
reverseProtection:
boolean
keepSourceVms:
boolean
}

Responses

Status: 200 - Success

string

startVpgMoveRollback

Rolls back the VPG after Move. Returns the TaskIdentifier of the operation, which can be used to monitor the operation. (Auth)


/v1/vpgs/{vpgIdentifier}/moveRollback

Usage and SDK Samples

curl -X POST\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgs/{vpgIdentifier}/moveRollback"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGsVirtualProtectionGroupsApi;

import java.io.File;
import java.util.*;

public class VPGsVirtualProtectionGroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGsVirtualProtectionGroupsApi apiInstance = new VPGsVirtualProtectionGroupsApi();
        String vpgIdentifier = vpgIdentifier_example; // String | VPG identifier. Related endpoint: `v1/vpgs`
        try {
            'String' result = apiInstance.startVpgMoveRollback(vpgIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGsVirtualProtectionGroupsApi#startVpgMoveRollback");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGsVirtualProtectionGroupsApi;

public class VPGsVirtualProtectionGroupsApiExample {

    public static void main(String[] args) {
        VPGsVirtualProtectionGroupsApi apiInstance = new VPGsVirtualProtectionGroupsApi();
        String vpgIdentifier = vpgIdentifier_example; // String | VPG identifier. Related endpoint: `v1/vpgs`
        try {
            'String' result = apiInstance.startVpgMoveRollback(vpgIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGsVirtualProtectionGroupsApi#startVpgMoveRollback");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgIdentifier = vpgIdentifier_example; // VPG identifier. Related endpoint: `v1/vpgs`

VPGsVirtualProtectionGroupsApi *apiInstance = [[VPGsVirtualProtectionGroupsApi alloc] init];

// Rolls back the VPG after Move. Returns the TaskIdentifier of the operation, which can be used to monitor the operation. (Auth)
[apiInstance startVpgMoveRollbackWith:vpgIdentifier
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGsVirtualProtectionGroupsApi()
var vpgIdentifier = vpgIdentifier_example; // {{String}} VPG identifier. Related endpoint: `v1/vpgs`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.startVpgMoveRollback(vpgIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class startVpgMoveRollbackExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGsVirtualProtectionGroupsApi();
            var vpgIdentifier = vpgIdentifier_example;  // String | VPG identifier. Related endpoint: `v1/vpgs`

            try
            {
                // Rolls back the VPG after Move. Returns the TaskIdentifier of the operation, which can be used to monitor the operation. (Auth)
                'String' result = apiInstance.startVpgMoveRollback(vpgIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGsVirtualProtectionGroupsApi.startVpgMoveRollback: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGsVirtualProtectionGroupsApi();
$vpgIdentifier = vpgIdentifier_example; // String | VPG identifier. Related endpoint: `v1/vpgs`

try {
    $result = $api_instance->startVpgMoveRollback($vpgIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VPGsVirtualProtectionGroupsApi->startVpgMoveRollback: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGsVirtualProtectionGroupsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGsVirtualProtectionGroupsApi->new();
my $vpgIdentifier = vpgIdentifier_example; # String | VPG identifier. Related endpoint: `v1/vpgs`

eval { 
    my $result = $api_instance->startVpgMoveRollback(vpgIdentifier => $vpgIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VPGsVirtualProtectionGroupsApi->startVpgMoveRollback: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGsVirtualProtectionGroupsApi()
vpgIdentifier = vpgIdentifier_example # String | VPG identifier. Related endpoint: `v1/vpgs`

try: 
    # Rolls back the VPG after Move. Returns the TaskIdentifier of the operation, which can be used to monitor the operation. (Auth)
    api_response = api_instance.start_vpg_move_rollback(vpgIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VPGsVirtualProtectionGroupsApi->startVpgMoveRollback: %s\n" % e)

Parameters

Path parameters
Name Description
vpgIdentifier*
String
VPG identifier. Related endpoint: `v1/vpgs`
Required

Responses

Status: 200 - Success

string

startVpgPause

Pause the protection of the VPG. (Auth)


/v1/vpgs/{vpgIdentifier}/pause

Usage and SDK Samples

curl -X POST\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgs/{vpgIdentifier}/pause"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGsVirtualProtectionGroupsApi;

import java.io.File;
import java.util.*;

public class VPGsVirtualProtectionGroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGsVirtualProtectionGroupsApi apiInstance = new VPGsVirtualProtectionGroupsApi();
        String vpgIdentifier = vpgIdentifier_example; // String | VPG identifier. Related endpoint: `v1/vpgs`
        try {
            'String' result = apiInstance.startVpgPause(vpgIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGsVirtualProtectionGroupsApi#startVpgPause");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGsVirtualProtectionGroupsApi;

public class VPGsVirtualProtectionGroupsApiExample {

    public static void main(String[] args) {
        VPGsVirtualProtectionGroupsApi apiInstance = new VPGsVirtualProtectionGroupsApi();
        String vpgIdentifier = vpgIdentifier_example; // String | VPG identifier. Related endpoint: `v1/vpgs`
        try {
            'String' result = apiInstance.startVpgPause(vpgIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGsVirtualProtectionGroupsApi#startVpgPause");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgIdentifier = vpgIdentifier_example; // VPG identifier. Related endpoint: `v1/vpgs`

VPGsVirtualProtectionGroupsApi *apiInstance = [[VPGsVirtualProtectionGroupsApi alloc] init];

// Pause the protection of the VPG. (Auth)
[apiInstance startVpgPauseWith:vpgIdentifier
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGsVirtualProtectionGroupsApi()
var vpgIdentifier = vpgIdentifier_example; // {{String}} VPG identifier. Related endpoint: `v1/vpgs`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.startVpgPause(vpgIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class startVpgPauseExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGsVirtualProtectionGroupsApi();
            var vpgIdentifier = vpgIdentifier_example;  // String | VPG identifier. Related endpoint: `v1/vpgs`

            try
            {
                // Pause the protection of the VPG. (Auth)
                'String' result = apiInstance.startVpgPause(vpgIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGsVirtualProtectionGroupsApi.startVpgPause: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGsVirtualProtectionGroupsApi();
$vpgIdentifier = vpgIdentifier_example; // String | VPG identifier. Related endpoint: `v1/vpgs`

try {
    $result = $api_instance->startVpgPause($vpgIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VPGsVirtualProtectionGroupsApi->startVpgPause: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGsVirtualProtectionGroupsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGsVirtualProtectionGroupsApi->new();
my $vpgIdentifier = vpgIdentifier_example; # String | VPG identifier. Related endpoint: `v1/vpgs`

eval { 
    my $result = $api_instance->startVpgPause(vpgIdentifier => $vpgIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VPGsVirtualProtectionGroupsApi->startVpgPause: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGsVirtualProtectionGroupsApi()
vpgIdentifier = vpgIdentifier_example # String | VPG identifier. Related endpoint: `v1/vpgs`

try: 
    # Pause the protection of the VPG. (Auth)
    api_response = api_instance.start_vpg_pause(vpgIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VPGsVirtualProtectionGroupsApi->startVpgPause: %s\n" % e)

Parameters

Path parameters
Name Description
vpgIdentifier*
String
VPG identifier. Related endpoint: `v1/vpgs`
Required

Responses

Status: 200 - Success

string

startVpgResume

Resume the protection of the VPG. (Auth)


/v1/vpgs/{vpgIdentifier}/resume

Usage and SDK Samples

curl -X POST\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgs/{vpgIdentifier}/resume"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGsVirtualProtectionGroupsApi;

import java.io.File;
import java.util.*;

public class VPGsVirtualProtectionGroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGsVirtualProtectionGroupsApi apiInstance = new VPGsVirtualProtectionGroupsApi();
        String vpgIdentifier = vpgIdentifier_example; // String | VPG identifier. Related endpoint: `v1/vpgs`
        try {
            'String' result = apiInstance.startVpgResume(vpgIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGsVirtualProtectionGroupsApi#startVpgResume");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGsVirtualProtectionGroupsApi;

public class VPGsVirtualProtectionGroupsApiExample {

    public static void main(String[] args) {
        VPGsVirtualProtectionGroupsApi apiInstance = new VPGsVirtualProtectionGroupsApi();
        String vpgIdentifier = vpgIdentifier_example; // String | VPG identifier. Related endpoint: `v1/vpgs`
        try {
            'String' result = apiInstance.startVpgResume(vpgIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGsVirtualProtectionGroupsApi#startVpgResume");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgIdentifier = vpgIdentifier_example; // VPG identifier. Related endpoint: `v1/vpgs`

VPGsVirtualProtectionGroupsApi *apiInstance = [[VPGsVirtualProtectionGroupsApi alloc] init];

// Resume the protection of the VPG. (Auth)
[apiInstance startVpgResumeWith:vpgIdentifier
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGsVirtualProtectionGroupsApi()
var vpgIdentifier = vpgIdentifier_example; // {{String}} VPG identifier. Related endpoint: `v1/vpgs`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.startVpgResume(vpgIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class startVpgResumeExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGsVirtualProtectionGroupsApi();
            var vpgIdentifier = vpgIdentifier_example;  // String | VPG identifier. Related endpoint: `v1/vpgs`

            try
            {
                // Resume the protection of the VPG. (Auth)
                'String' result = apiInstance.startVpgResume(vpgIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGsVirtualProtectionGroupsApi.startVpgResume: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGsVirtualProtectionGroupsApi();
$vpgIdentifier = vpgIdentifier_example; // String | VPG identifier. Related endpoint: `v1/vpgs`

try {
    $result = $api_instance->startVpgResume($vpgIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VPGsVirtualProtectionGroupsApi->startVpgResume: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGsVirtualProtectionGroupsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGsVirtualProtectionGroupsApi->new();
my $vpgIdentifier = vpgIdentifier_example; # String | VPG identifier. Related endpoint: `v1/vpgs`

eval { 
    my $result = $api_instance->startVpgResume(vpgIdentifier => $vpgIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VPGsVirtualProtectionGroupsApi->startVpgResume: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGsVirtualProtectionGroupsApi()
vpgIdentifier = vpgIdentifier_example # String | VPG identifier. Related endpoint: `v1/vpgs`

try: 
    # Resume the protection of the VPG. (Auth)
    api_response = api_instance.start_vpg_resume(vpgIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VPGsVirtualProtectionGroupsApi->startVpgResume: %s\n" % e)

Parameters

Path parameters
Name Description
vpgIdentifier*
String
VPG identifier. Related endpoint: `v1/vpgs`
Required

Responses

Status: 200 - Success

string

startVpgTaggedCheckpointInsert

Create a tagged checkpoint for the VPG. (Auth)


/v1/vpgs/{vpgIdentifier}/checkpoints

Usage and SDK Samples

curl -X POST\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
-H "Content-Type: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgs/{vpgIdentifier}/checkpoints"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGsVirtualProtectionGroupsApi;

import java.io.File;
import java.util.*;

public class VPGsVirtualProtectionGroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGsVirtualProtectionGroupsApi apiInstance = new VPGsVirtualProtectionGroupsApi();
        String vpgIdentifier = vpgIdentifier_example; // String | VPG identifier. Related endpoint: `v1/vpgs`
        VpgInsertTagCheckpointDataApi body = ; // VpgInsertTagCheckpointDataApi | 
        try {
            'String' result = apiInstance.startVpgTaggedCheckpointInsert(vpgIdentifier, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGsVirtualProtectionGroupsApi#startVpgTaggedCheckpointInsert");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGsVirtualProtectionGroupsApi;

public class VPGsVirtualProtectionGroupsApiExample {

    public static void main(String[] args) {
        VPGsVirtualProtectionGroupsApi apiInstance = new VPGsVirtualProtectionGroupsApi();
        String vpgIdentifier = vpgIdentifier_example; // String | VPG identifier. Related endpoint: `v1/vpgs`
        VpgInsertTagCheckpointDataApi body = ; // VpgInsertTagCheckpointDataApi | 
        try {
            'String' result = apiInstance.startVpgTaggedCheckpointInsert(vpgIdentifier, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGsVirtualProtectionGroupsApi#startVpgTaggedCheckpointInsert");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgIdentifier = vpgIdentifier_example; // VPG identifier. Related endpoint: `v1/vpgs`
VpgInsertTagCheckpointDataApi *body = ; //  (optional)

VPGsVirtualProtectionGroupsApi *apiInstance = [[VPGsVirtualProtectionGroupsApi alloc] init];

// Create a tagged checkpoint for the VPG. (Auth)
[apiInstance startVpgTaggedCheckpointInsertWith:vpgIdentifier
    body:body
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGsVirtualProtectionGroupsApi()
var vpgIdentifier = vpgIdentifier_example; // {{String}} VPG identifier. Related endpoint: `v1/vpgs`
var opts = { 
  'body':  // {{VpgInsertTagCheckpointDataApi}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.startVpgTaggedCheckpointInsert(vpgIdentifier, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class startVpgTaggedCheckpointInsertExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGsVirtualProtectionGroupsApi();
            var vpgIdentifier = vpgIdentifier_example;  // String | VPG identifier. Related endpoint: `v1/vpgs`
            var body = new VpgInsertTagCheckpointDataApi(); // VpgInsertTagCheckpointDataApi |  (optional) 

            try
            {
                // Create a tagged checkpoint for the VPG. (Auth)
                'String' result = apiInstance.startVpgTaggedCheckpointInsert(vpgIdentifier, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGsVirtualProtectionGroupsApi.startVpgTaggedCheckpointInsert: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGsVirtualProtectionGroupsApi();
$vpgIdentifier = vpgIdentifier_example; // String | VPG identifier. Related endpoint: `v1/vpgs`
$body = ; // VpgInsertTagCheckpointDataApi | 

try {
    $result = $api_instance->startVpgTaggedCheckpointInsert($vpgIdentifier, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VPGsVirtualProtectionGroupsApi->startVpgTaggedCheckpointInsert: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGsVirtualProtectionGroupsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGsVirtualProtectionGroupsApi->new();
my $vpgIdentifier = vpgIdentifier_example; # String | VPG identifier. Related endpoint: `v1/vpgs`
my $body = WWW::SwaggerClient::Object::VpgInsertTagCheckpointDataApi->new(); # VpgInsertTagCheckpointDataApi | 

eval { 
    my $result = $api_instance->startVpgTaggedCheckpointInsert(vpgIdentifier => $vpgIdentifier, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VPGsVirtualProtectionGroupsApi->startVpgTaggedCheckpointInsert: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGsVirtualProtectionGroupsApi()
vpgIdentifier = vpgIdentifier_example # String | VPG identifier. Related endpoint: `v1/vpgs`
body =  # VpgInsertTagCheckpointDataApi |  (optional)

try: 
    # Create a tagged checkpoint for the VPG. (Auth)
    api_response = api_instance.start_vpg_tagged_checkpoint_insert(vpgIdentifier, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VPGsVirtualProtectionGroupsApi->startVpgTaggedCheckpointInsert: %s\n" % e)

Parameters

Path parameters
Name Description
vpgIdentifier*
String
VPG identifier. Related endpoint: `v1/vpgs`
Required
Body parameters
Name Description
body
{
checkpointName:
string
}

Responses

Status: 200 - Success

string

stopVpgClone

Abort cloning of the VPG (Auth)


/v1/vpgs/{vpgIdentifier}/CloneAbort

Usage and SDK Samples

curl -X POST\
-H "x-zerto-session: [[apiKey]]"\
"https://localhost:9669//v1/vpgs/{vpgIdentifier}/CloneAbort"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGsVirtualProtectionGroupsApi;

import java.io.File;
import java.util.*;

public class VPGsVirtualProtectionGroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGsVirtualProtectionGroupsApi apiInstance = new VPGsVirtualProtectionGroupsApi();
        String vpgIdentifier = vpgIdentifier_example; // String | VPG identifier. Related endpoint: `v1/vpgs`
        try {
            apiInstance.stopVpgClone(vpgIdentifier);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGsVirtualProtectionGroupsApi#stopVpgClone");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGsVirtualProtectionGroupsApi;

public class VPGsVirtualProtectionGroupsApiExample {

    public static void main(String[] args) {
        VPGsVirtualProtectionGroupsApi apiInstance = new VPGsVirtualProtectionGroupsApi();
        String vpgIdentifier = vpgIdentifier_example; // String | VPG identifier. Related endpoint: `v1/vpgs`
        try {
            apiInstance.stopVpgClone(vpgIdentifier);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGsVirtualProtectionGroupsApi#stopVpgClone");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgIdentifier = vpgIdentifier_example; // VPG identifier. Related endpoint: `v1/vpgs`

VPGsVirtualProtectionGroupsApi *apiInstance = [[VPGsVirtualProtectionGroupsApi alloc] init];

// Abort cloning of the VPG (Auth)
[apiInstance stopVpgCloneWith:vpgIdentifier
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGsVirtualProtectionGroupsApi()
var vpgIdentifier = vpgIdentifier_example; // {{String}} VPG identifier. Related endpoint: `v1/vpgs`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.stopVpgClone(vpgIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class stopVpgCloneExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGsVirtualProtectionGroupsApi();
            var vpgIdentifier = vpgIdentifier_example;  // String | VPG identifier. Related endpoint: `v1/vpgs`

            try
            {
                // Abort cloning of the VPG (Auth)
                apiInstance.stopVpgClone(vpgIdentifier);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGsVirtualProtectionGroupsApi.stopVpgClone: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGsVirtualProtectionGroupsApi();
$vpgIdentifier = vpgIdentifier_example; // String | VPG identifier. Related endpoint: `v1/vpgs`

try {
    $api_instance->stopVpgClone($vpgIdentifier);
} catch (Exception $e) {
    echo 'Exception when calling VPGsVirtualProtectionGroupsApi->stopVpgClone: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGsVirtualProtectionGroupsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGsVirtualProtectionGroupsApi->new();
my $vpgIdentifier = vpgIdentifier_example; # String | VPG identifier. Related endpoint: `v1/vpgs`

eval { 
    $api_instance->stopVpgClone(vpgIdentifier => $vpgIdentifier);
};
if ($@) {
    warn "Exception when calling VPGsVirtualProtectionGroupsApi->stopVpgClone: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGsVirtualProtectionGroupsApi()
vpgIdentifier = vpgIdentifier_example # String | VPG identifier. Related endpoint: `v1/vpgs`

try: 
    # Abort cloning of the VPG (Auth)
    api_instance.stop_vpg_clone(vpgIdentifier)
except ApiException as e:
    print("Exception when calling VPGsVirtualProtectionGroupsApi->stopVpgClone: %s\n" % e)

Parameters

Path parameters
Name Description
vpgIdentifier*
String
VPG identifier. Related endpoint: `v1/vpgs`
Required

Responses

Status: 200 - Success


stopVpgFailoverTest

Stops a failover test. Specify if test was successful and provide a summary. (Auth)


/v1/vpgs/{vpgIdentifier}/FailoverTestStop

Usage and SDK Samples

curl -X POST\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
-H "Content-Type: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vpgs/{vpgIdentifier}/FailoverTestStop"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VPGsVirtualProtectionGroupsApi;

import java.io.File;
import java.util.*;

public class VPGsVirtualProtectionGroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VPGsVirtualProtectionGroupsApi apiInstance = new VPGsVirtualProtectionGroupsApi();
        String vpgIdentifier = vpgIdentifier_example; // String | VPG identifier. Related endpoint: `v1/vpgs`
        StopFailoverTestDataApi body = ; // StopFailoverTestDataApi | 
        try {
            'String' result = apiInstance.stopVpgFailoverTest(vpgIdentifier, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGsVirtualProtectionGroupsApi#stopVpgFailoverTest");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VPGsVirtualProtectionGroupsApi;

public class VPGsVirtualProtectionGroupsApiExample {

    public static void main(String[] args) {
        VPGsVirtualProtectionGroupsApi apiInstance = new VPGsVirtualProtectionGroupsApi();
        String vpgIdentifier = vpgIdentifier_example; // String | VPG identifier. Related endpoint: `v1/vpgs`
        StopFailoverTestDataApi body = ; // StopFailoverTestDataApi | 
        try {
            'String' result = apiInstance.stopVpgFailoverTest(vpgIdentifier, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VPGsVirtualProtectionGroupsApi#stopVpgFailoverTest");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgIdentifier = vpgIdentifier_example; // VPG identifier. Related endpoint: `v1/vpgs`
StopFailoverTestDataApi *body = ; //  (optional)

VPGsVirtualProtectionGroupsApi *apiInstance = [[VPGsVirtualProtectionGroupsApi alloc] init];

// Stops a failover test. Specify if test was successful and provide a summary. (Auth)
[apiInstance stopVpgFailoverTestWith:vpgIdentifier
    body:body
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VPGsVirtualProtectionGroupsApi()
var vpgIdentifier = vpgIdentifier_example; // {{String}} VPG identifier. Related endpoint: `v1/vpgs`
var opts = { 
  'body':  // {{StopFailoverTestDataApi}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.stopVpgFailoverTest(vpgIdentifier, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class stopVpgFailoverTestExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VPGsVirtualProtectionGroupsApi();
            var vpgIdentifier = vpgIdentifier_example;  // String | VPG identifier. Related endpoint: `v1/vpgs`
            var body = new StopFailoverTestDataApi(); // StopFailoverTestDataApi |  (optional) 

            try
            {
                // Stops a failover test. Specify if test was successful and provide a summary. (Auth)
                'String' result = apiInstance.stopVpgFailoverTest(vpgIdentifier, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VPGsVirtualProtectionGroupsApi.stopVpgFailoverTest: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVPGsVirtualProtectionGroupsApi();
$vpgIdentifier = vpgIdentifier_example; // String | VPG identifier. Related endpoint: `v1/vpgs`
$body = ; // StopFailoverTestDataApi | 

try {
    $result = $api_instance->stopVpgFailoverTest($vpgIdentifier, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VPGsVirtualProtectionGroupsApi->stopVpgFailoverTest: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VPGsVirtualProtectionGroupsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VPGsVirtualProtectionGroupsApi->new();
my $vpgIdentifier = vpgIdentifier_example; # String | VPG identifier. Related endpoint: `v1/vpgs`
my $body = WWW::SwaggerClient::Object::StopFailoverTestDataApi->new(); # StopFailoverTestDataApi | 

eval { 
    my $result = $api_instance->stopVpgFailoverTest(vpgIdentifier => $vpgIdentifier, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VPGsVirtualProtectionGroupsApi->stopVpgFailoverTest: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VPGsVirtualProtectionGroupsApi()
vpgIdentifier = vpgIdentifier_example # String | VPG identifier. Related endpoint: `v1/vpgs`
body =  # StopFailoverTestDataApi |  (optional)

try: 
    # Stops a failover test. Specify if test was successful and provide a summary. (Auth)
    api_response = api_instance.stop_vpg_failover_test(vpgIdentifier, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VPGsVirtualProtectionGroupsApi->stopVpgFailoverTest: %s\n" % e)

Parameters

Path parameters
Name Description
vpgIdentifier*
String
VPG identifier. Related endpoint: `v1/vpgs`
Required
Body parameters
Name Description
body
{
failoverTestSuccess:
boolean
failoverTestSummary:
string
}

Responses

Status: 200 - Success

string

VRAsVirtualReplicationAppliances

getVra

Get information about the VRA. (Auth)


/v1/vras/{vraIdentifier}

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vras/{vraIdentifier}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VRAsVirtualReplicationAppliancesApi;

import java.io.File;
import java.util.*;

public class VRAsVirtualReplicationAppliancesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VRAsVirtualReplicationAppliancesApi apiInstance = new VRAsVirtualReplicationAppliancesApi();
        String vraIdentifier = vraIdentifier_example; // String | Vra identifier. Related endpoint: `/v1/vras`
        try {
            VraApi result = apiInstance.getVra(vraIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VRAsVirtualReplicationAppliancesApi#getVra");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VRAsVirtualReplicationAppliancesApi;

public class VRAsVirtualReplicationAppliancesApiExample {

    public static void main(String[] args) {
        VRAsVirtualReplicationAppliancesApi apiInstance = new VRAsVirtualReplicationAppliancesApi();
        String vraIdentifier = vraIdentifier_example; // String | Vra identifier. Related endpoint: `/v1/vras`
        try {
            VraApi result = apiInstance.getVra(vraIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VRAsVirtualReplicationAppliancesApi#getVra");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vraIdentifier = vraIdentifier_example; // Vra identifier. Related endpoint: `/v1/vras`

VRAsVirtualReplicationAppliancesApi *apiInstance = [[VRAsVirtualReplicationAppliancesApi alloc] init];

// Get information about the VRA. (Auth)
[apiInstance getVraWith:vraIdentifier
              completionHandler: ^(VraApi output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VRAsVirtualReplicationAppliancesApi()
var vraIdentifier = vraIdentifier_example; // {{String}} Vra identifier. Related endpoint: `/v1/vras`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVra(vraIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVraExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VRAsVirtualReplicationAppliancesApi();
            var vraIdentifier = vraIdentifier_example;  // String | Vra identifier. Related endpoint: `/v1/vras`

            try
            {
                // Get information about the VRA. (Auth)
                VraApi result = apiInstance.getVra(vraIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VRAsVirtualReplicationAppliancesApi.getVra: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVRAsVirtualReplicationAppliancesApi();
$vraIdentifier = vraIdentifier_example; // String | Vra identifier. Related endpoint: `/v1/vras`

try {
    $result = $api_instance->getVra($vraIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VRAsVirtualReplicationAppliancesApi->getVra: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VRAsVirtualReplicationAppliancesApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VRAsVirtualReplicationAppliancesApi->new();
my $vraIdentifier = vraIdentifier_example; # String | Vra identifier. Related endpoint: `/v1/vras`

eval { 
    my $result = $api_instance->getVra(vraIdentifier => $vraIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VRAsVirtualReplicationAppliancesApi->getVra: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VRAsVirtualReplicationAppliancesApi()
vraIdentifier = vraIdentifier_example # String | Vra identifier. Related endpoint: `/v1/vras`

try: 
    # Get information about the VRA. (Auth)
    api_response = api_instance.get_vra(vraIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VRAsVirtualReplicationAppliancesApi->getVra: %s\n" % e)

Parameters

Path parameters
Name Description
vraIdentifier*
String
Vra identifier. Related endpoint: `/v1/vras`
Required

Responses

Status: 200 - Success

{
vraAlerts:
{
vraAlertsStatus:
integer (int32)
Enum: 0, 1, 2, 3, 4
}
link:
{
rel:
string
href:
string
type:
string
identifier:
string
}
vraIdentifier:
integer (int64)
vraIdentifierStr:
string
vraName:
string
status:
integer (int32)
Enum: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9
progress:
integer (int32)
vraVersion:
string
hostVersion:
string
ipAddress:
string
vraNetworkDataApi:
{
vraIPConfigurationTypeApi:
string
vraIPAddress:
string
vraIPAddressRangeEnd:
string
subnetMask:
string
defaultGateway:
string
}
vraGroup:
string
memoryInGB:
integer (int32)
datastoreName:
string
datastoreIdentifier:
string
datastoreClusterName:
string
datastoreClusterIdentifier:
string
networkName:
string
networkIdentifier:
string
hostIdentifier:
string
hostDisplayName:
string
protectedCounters:
{
vpgs:
integer (int32)
vms:
integer (int32)
volumes:
integer (int32)
}
recoveryCounters:
{
vpgs:
integer (int32)
vms:
integer (int32)
volumes:
integer (int32)
}
selfProtectedVpgs:
integer (int32)
Link_{0}:
{
rel:
string
href:
string
type:
string
}
numOfCpus:
integer (int32)
}

getVraAll

Get information about all VRAs. (Auth)


/v1/vras

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vras?vraName=&status=&vraVersion=&hostVersion=&ipAddress=&vraGroup=&datastoreName=&datastoreClusterName=&networkName=&vraIpConfigurationTypeApi="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VRAsVirtualReplicationAppliancesApi;

import java.io.File;
import java.util.*;

public class VRAsVirtualReplicationAppliancesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VRAsVirtualReplicationAppliancesApi apiInstance = new VRAsVirtualReplicationAppliancesApi();
        String vraName = vraName_example; // String | VRA name
        String status = status_example; // String | VRA status
        String vraVersion = vraVersion_example; // String | VRA version
        String hostVersion = hostVersion_example; // String | Host version where the VRA is installed
        String ipAddress = ipAddress_example; // String | VRA IP address
        String vraGroup = vraGroup_example; // String | VRA group
        String datastoreName = datastoreName_example; // String | Datastore name VRA uses for recovery data
        String datastoreClusterName = datastoreClusterName_example; // String | Cluster name VRA uses for recovery data
        String networkName = networkName_example; // String | VRA network
        String vraIpConfigurationTypeApi = vraIpConfigurationTypeApi_example; // String | IP configuration type
        try {
            array[VraApi] result = apiInstance.getVraAll(vraName, status, vraVersion, hostVersion, ipAddress, vraGroup, datastoreName, datastoreClusterName, networkName, vraIpConfigurationTypeApi);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VRAsVirtualReplicationAppliancesApi#getVraAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VRAsVirtualReplicationAppliancesApi;

public class VRAsVirtualReplicationAppliancesApiExample {

    public static void main(String[] args) {
        VRAsVirtualReplicationAppliancesApi apiInstance = new VRAsVirtualReplicationAppliancesApi();
        String vraName = vraName_example; // String | VRA name
        String status = status_example; // String | VRA status
        String vraVersion = vraVersion_example; // String | VRA version
        String hostVersion = hostVersion_example; // String | Host version where the VRA is installed
        String ipAddress = ipAddress_example; // String | VRA IP address
        String vraGroup = vraGroup_example; // String | VRA group
        String datastoreName = datastoreName_example; // String | Datastore name VRA uses for recovery data
        String datastoreClusterName = datastoreClusterName_example; // String | Cluster name VRA uses for recovery data
        String networkName = networkName_example; // String | VRA network
        String vraIpConfigurationTypeApi = vraIpConfigurationTypeApi_example; // String | IP configuration type
        try {
            array[VraApi] result = apiInstance.getVraAll(vraName, status, vraVersion, hostVersion, ipAddress, vraGroup, datastoreName, datastoreClusterName, networkName, vraIpConfigurationTypeApi);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VRAsVirtualReplicationAppliancesApi#getVraAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vraName = vraName_example; // VRA name (optional)
String *status = status_example; // VRA status (optional)
String *vraVersion = vraVersion_example; // VRA version (optional)
String *hostVersion = hostVersion_example; // Host version where the VRA is installed (optional)
String *ipAddress = ipAddress_example; // VRA IP address (optional)
String *vraGroup = vraGroup_example; // VRA group (optional)
String *datastoreName = datastoreName_example; // Datastore name VRA uses for recovery data (optional)
String *datastoreClusterName = datastoreClusterName_example; // Cluster name VRA uses for recovery data (optional)
String *networkName = networkName_example; // VRA network (optional)
String *vraIpConfigurationTypeApi = vraIpConfigurationTypeApi_example; // IP configuration type (optional)

VRAsVirtualReplicationAppliancesApi *apiInstance = [[VRAsVirtualReplicationAppliancesApi alloc] init];

// Get information about all VRAs. (Auth)
[apiInstance getVraAllWith:vraName
    status:status
    vraVersion:vraVersion
    hostVersion:hostVersion
    ipAddress:ipAddress
    vraGroup:vraGroup
    datastoreName:datastoreName
    datastoreClusterName:datastoreClusterName
    networkName:networkName
    vraIpConfigurationTypeApi:vraIpConfigurationTypeApi
              completionHandler: ^(array[VraApi] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VRAsVirtualReplicationAppliancesApi()
var opts = { 
  'vraName': vraName_example, // {{String}} VRA name
  'status': status_example, // {{String}} VRA status
  'vraVersion': vraVersion_example, // {{String}} VRA version
  'hostVersion': hostVersion_example, // {{String}} Host version where the VRA is installed
  'ipAddress': ipAddress_example, // {{String}} VRA IP address
  'vraGroup': vraGroup_example, // {{String}} VRA group
  'datastoreName': datastoreName_example, // {{String}} Datastore name VRA uses for recovery data
  'datastoreClusterName': datastoreClusterName_example, // {{String}} Cluster name VRA uses for recovery data
  'networkName': networkName_example, // {{String}} VRA network
  'vraIpConfigurationTypeApi': vraIpConfigurationTypeApi_example // {{String}} IP configuration type
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVraAll(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVraAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VRAsVirtualReplicationAppliancesApi();
            var vraName = vraName_example;  // String | VRA name (optional) 
            var status = status_example;  // String | VRA status (optional) 
            var vraVersion = vraVersion_example;  // String | VRA version (optional) 
            var hostVersion = hostVersion_example;  // String | Host version where the VRA is installed (optional) 
            var ipAddress = ipAddress_example;  // String | VRA IP address (optional) 
            var vraGroup = vraGroup_example;  // String | VRA group (optional) 
            var datastoreName = datastoreName_example;  // String | Datastore name VRA uses for recovery data (optional) 
            var datastoreClusterName = datastoreClusterName_example;  // String | Cluster name VRA uses for recovery data (optional) 
            var networkName = networkName_example;  // String | VRA network (optional) 
            var vraIpConfigurationTypeApi = vraIpConfigurationTypeApi_example;  // String | IP configuration type (optional) 

            try
            {
                // Get information about all VRAs. (Auth)
                array[VraApi] result = apiInstance.getVraAll(vraName, status, vraVersion, hostVersion, ipAddress, vraGroup, datastoreName, datastoreClusterName, networkName, vraIpConfigurationTypeApi);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VRAsVirtualReplicationAppliancesApi.getVraAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVRAsVirtualReplicationAppliancesApi();
$vraName = vraName_example; // String | VRA name
$status = status_example; // String | VRA status
$vraVersion = vraVersion_example; // String | VRA version
$hostVersion = hostVersion_example; // String | Host version where the VRA is installed
$ipAddress = ipAddress_example; // String | VRA IP address
$vraGroup = vraGroup_example; // String | VRA group
$datastoreName = datastoreName_example; // String | Datastore name VRA uses for recovery data
$datastoreClusterName = datastoreClusterName_example; // String | Cluster name VRA uses for recovery data
$networkName = networkName_example; // String | VRA network
$vraIpConfigurationTypeApi = vraIpConfigurationTypeApi_example; // String | IP configuration type

try {
    $result = $api_instance->getVraAll($vraName, $status, $vraVersion, $hostVersion, $ipAddress, $vraGroup, $datastoreName, $datastoreClusterName, $networkName, $vraIpConfigurationTypeApi);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VRAsVirtualReplicationAppliancesApi->getVraAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VRAsVirtualReplicationAppliancesApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VRAsVirtualReplicationAppliancesApi->new();
my $vraName = vraName_example; # String | VRA name
my $status = status_example; # String | VRA status
my $vraVersion = vraVersion_example; # String | VRA version
my $hostVersion = hostVersion_example; # String | Host version where the VRA is installed
my $ipAddress = ipAddress_example; # String | VRA IP address
my $vraGroup = vraGroup_example; # String | VRA group
my $datastoreName = datastoreName_example; # String | Datastore name VRA uses for recovery data
my $datastoreClusterName = datastoreClusterName_example; # String | Cluster name VRA uses for recovery data
my $networkName = networkName_example; # String | VRA network
my $vraIpConfigurationTypeApi = vraIpConfigurationTypeApi_example; # String | IP configuration type

eval { 
    my $result = $api_instance->getVraAll(vraName => $vraName, status => $status, vraVersion => $vraVersion, hostVersion => $hostVersion, ipAddress => $ipAddress, vraGroup => $vraGroup, datastoreName => $datastoreName, datastoreClusterName => $datastoreClusterName, networkName => $networkName, vraIpConfigurationTypeApi => $vraIpConfigurationTypeApi);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VRAsVirtualReplicationAppliancesApi->getVraAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VRAsVirtualReplicationAppliancesApi()
vraName = vraName_example # String | VRA name (optional)
status = status_example # String | VRA status (optional)
vraVersion = vraVersion_example # String | VRA version (optional)
hostVersion = hostVersion_example # String | Host version where the VRA is installed (optional)
ipAddress = ipAddress_example # String | VRA IP address (optional)
vraGroup = vraGroup_example # String | VRA group (optional)
datastoreName = datastoreName_example # String | Datastore name VRA uses for recovery data (optional)
datastoreClusterName = datastoreClusterName_example # String | Cluster name VRA uses for recovery data (optional)
networkName = networkName_example # String | VRA network (optional)
vraIpConfigurationTypeApi = vraIpConfigurationTypeApi_example # String | IP configuration type (optional)

try: 
    # Get information about all VRAs. (Auth)
    api_response = api_instance.get_vra_all(vraName=vraName, status=status, vraVersion=vraVersion, hostVersion=hostVersion, ipAddress=ipAddress, vraGroup=vraGroup, datastoreName=datastoreName, datastoreClusterName=datastoreClusterName, networkName=networkName, vraIpConfigurationTypeApi=vraIpConfigurationTypeApi)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VRAsVirtualReplicationAppliancesApi->getVraAll: %s\n" % e)

Parameters

Query parameters
Name Description
vraName
String
VRA name
status
String
VRA status
vraVersion
String
VRA version
hostVersion
String
Host version where the VRA is installed
ipAddress
String
VRA IP address
vraGroup
String
VRA group
datastoreName
String
Datastore name VRA uses for recovery data
datastoreClusterName
String
Cluster name VRA uses for recovery data
networkName
String
VRA network
vraIpConfigurationTypeApi
String
IP configuration type

Responses

Status: 200 - Success

[
{
vraAlerts:
{
vraAlertsStatus:
integer (int32)
Enum: 0, 1, 2, 3, 4
}
link:
{
rel:
string
href:
string
type:
string
identifier:
string
}
vraIdentifier:
integer (int64)
vraIdentifierStr:
string
vraName:
string
status:
integer (int32)
Enum: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9
progress:
integer (int32)
vraVersion:
string
hostVersion:
string
ipAddress:
string
vraNetworkDataApi:
{
vraIPConfigurationTypeApi:
string
vraIPAddress:
string
vraIPAddressRangeEnd:
string
subnetMask:
string
defaultGateway:
string
}
vraGroup:
string
memoryInGB:
integer (int32)
datastoreName:
string
datastoreIdentifier:
string
datastoreClusterName:
string
datastoreClusterIdentifier:
string
networkName:
string
networkIdentifier:
string
hostIdentifier:
string
hostDisplayName:
string
protectedCounters:
{
vpgs:
integer (int32)
vms:
integer (int32)
volumes:
integer (int32)
}
recoveryCounters:
{
vpgs:
integer (int32)
vms:
integer (int32)
volumes:
integer (int32)
}
selfProtectedVpgs:
integer (int32)
Link_{0}:
{
rel:
string
href:
string
type:
string
}
numOfCpus:
integer (int32)
}
]

getVraChangeRecoveryHostPotential

Get potential replacement hosts for a change recovery host operation. Returns a list for a specified VmIdentifer. (Auth)


/v1/vras/{vraIdentifier}/changerecoveryvra/potentials

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vras/{vraIdentifier}/changerecoveryvra/potentials?vmIdentifier="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VRAsVirtualReplicationAppliancesApi;

import java.io.File;
import java.util.*;

public class VRAsVirtualReplicationAppliancesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VRAsVirtualReplicationAppliancesApi apiInstance = new VRAsVirtualReplicationAppliancesApi();
        String vraIdentifier = vraIdentifier_example; // String | Vra identifier. Related endpoint: `/v1/vras`
        String vmIdentifier = vmIdentifier_example; // String | 
        try {
            array[VraPotentialHostApi] result = apiInstance.getVraChangeRecoveryHostPotential(vraIdentifier, vmIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VRAsVirtualReplicationAppliancesApi#getVraChangeRecoveryHostPotential");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VRAsVirtualReplicationAppliancesApi;

public class VRAsVirtualReplicationAppliancesApiExample {

    public static void main(String[] args) {
        VRAsVirtualReplicationAppliancesApi apiInstance = new VRAsVirtualReplicationAppliancesApi();
        String vraIdentifier = vraIdentifier_example; // String | Vra identifier. Related endpoint: `/v1/vras`
        String vmIdentifier = vmIdentifier_example; // String | 
        try {
            array[VraPotentialHostApi] result = apiInstance.getVraChangeRecoveryHostPotential(vraIdentifier, vmIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VRAsVirtualReplicationAppliancesApi#getVraChangeRecoveryHostPotential");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vraIdentifier = vraIdentifier_example; // Vra identifier. Related endpoint: `/v1/vras`
String *vmIdentifier = vmIdentifier_example; //  (optional)

VRAsVirtualReplicationAppliancesApi *apiInstance = [[VRAsVirtualReplicationAppliancesApi alloc] init];

// Get potential replacement hosts for a change recovery host operation. 
Returns a list for a specified VmIdentifer. (Auth)
[apiInstance getVraChangeRecoveryHostPotentialWith:vraIdentifier
    vmIdentifier:vmIdentifier
              completionHandler: ^(array[VraPotentialHostApi] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VRAsVirtualReplicationAppliancesApi()
var vraIdentifier = vraIdentifier_example; // {{String}} Vra identifier. Related endpoint: `/v1/vras`
var opts = { 
  'vmIdentifier': vmIdentifier_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVraChangeRecoveryHostPotential(vraIdentifier, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVraChangeRecoveryHostPotentialExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VRAsVirtualReplicationAppliancesApi();
            var vraIdentifier = vraIdentifier_example;  // String | Vra identifier. Related endpoint: `/v1/vras`
            var vmIdentifier = vmIdentifier_example;  // String |  (optional) 

            try
            {
                // Get potential replacement hosts for a change recovery host operation. 
Returns a list for a specified VmIdentifer. (Auth)
                array[VraPotentialHostApi] result = apiInstance.getVraChangeRecoveryHostPotential(vraIdentifier, vmIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VRAsVirtualReplicationAppliancesApi.getVraChangeRecoveryHostPotential: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVRAsVirtualReplicationAppliancesApi();
$vraIdentifier = vraIdentifier_example; // String | Vra identifier. Related endpoint: `/v1/vras`
$vmIdentifier = vmIdentifier_example; // String | 

try {
    $result = $api_instance->getVraChangeRecoveryHostPotential($vraIdentifier, $vmIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VRAsVirtualReplicationAppliancesApi->getVraChangeRecoveryHostPotential: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VRAsVirtualReplicationAppliancesApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VRAsVirtualReplicationAppliancesApi->new();
my $vraIdentifier = vraIdentifier_example; # String | Vra identifier. Related endpoint: `/v1/vras`
my $vmIdentifier = vmIdentifier_example; # String | 

eval { 
    my $result = $api_instance->getVraChangeRecoveryHostPotential(vraIdentifier => $vraIdentifier, vmIdentifier => $vmIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VRAsVirtualReplicationAppliancesApi->getVraChangeRecoveryHostPotential: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VRAsVirtualReplicationAppliancesApi()
vraIdentifier = vraIdentifier_example # String | Vra identifier. Related endpoint: `/v1/vras`
vmIdentifier = vmIdentifier_example # String |  (optional)

try: 
    # Get potential replacement hosts for a change recovery host operation. 
Returns a list for a specified VmIdentifer. (Auth)
    api_response = api_instance.get_vra_change_recovery_host_potential(vraIdentifier, vmIdentifier=vmIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VRAsVirtualReplicationAppliancesApi->getVraChangeRecoveryHostPotential: %s\n" % e)

Parameters

Path parameters
Name Description
vraIdentifier*
String
Vra identifier. Related endpoint: `/v1/vras`
Required
Query parameters
Name Description
vmIdentifier
String

Responses

Status: 200 - Success

[
{
hostIdentifier:
string
hostName:
string
}
]

getVraChangeRecoveryHostRecommendation

Get recommendations for evacuate operation. (Auth)


/v1/vras/{vraIdentifier}/changerecoveryvra/recommendation

Usage and SDK Samples

curl -X POST\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
-H "Content-Type: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vras/{vraIdentifier}/changerecoveryvra/recommendation"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VRAsVirtualReplicationAppliancesApi;

import java.io.File;
import java.util.*;

public class VRAsVirtualReplicationAppliancesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VRAsVirtualReplicationAppliancesApi apiInstance = new VRAsVirtualReplicationAppliancesApi();
        String vraIdentifier = vraIdentifier_example; // String | Vra identifier. Related endpoint: `/v1/vras`
        VraChangeRecoveryHostRecommendationRequestApi body = ; // VraChangeRecoveryHostRecommendationRequestApi | 
        try {
            VraChangeRecoveryHostRecommendationResultApi result = apiInstance.getVraChangeRecoveryHostRecommendation(vraIdentifier, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VRAsVirtualReplicationAppliancesApi#getVraChangeRecoveryHostRecommendation");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VRAsVirtualReplicationAppliancesApi;

public class VRAsVirtualReplicationAppliancesApiExample {

    public static void main(String[] args) {
        VRAsVirtualReplicationAppliancesApi apiInstance = new VRAsVirtualReplicationAppliancesApi();
        String vraIdentifier = vraIdentifier_example; // String | Vra identifier. Related endpoint: `/v1/vras`
        VraChangeRecoveryHostRecommendationRequestApi body = ; // VraChangeRecoveryHostRecommendationRequestApi | 
        try {
            VraChangeRecoveryHostRecommendationResultApi result = apiInstance.getVraChangeRecoveryHostRecommendation(vraIdentifier, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VRAsVirtualReplicationAppliancesApi#getVraChangeRecoveryHostRecommendation");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vraIdentifier = vraIdentifier_example; // Vra identifier. Related endpoint: `/v1/vras`
VraChangeRecoveryHostRecommendationRequestApi *body = ; //  (optional)

VRAsVirtualReplicationAppliancesApi *apiInstance = [[VRAsVirtualReplicationAppliancesApi alloc] init];

// Get recommendations for evacuate operation. (Auth)
[apiInstance getVraChangeRecoveryHostRecommendationWith:vraIdentifier
    body:body
              completionHandler: ^(VraChangeRecoveryHostRecommendationResultApi output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VRAsVirtualReplicationAppliancesApi()
var vraIdentifier = vraIdentifier_example; // {{String}} Vra identifier. Related endpoint: `/v1/vras`
var opts = { 
  'body':  // {{VraChangeRecoveryHostRecommendationRequestApi}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVraChangeRecoveryHostRecommendation(vraIdentifier, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVraChangeRecoveryHostRecommendationExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VRAsVirtualReplicationAppliancesApi();
            var vraIdentifier = vraIdentifier_example;  // String | Vra identifier. Related endpoint: `/v1/vras`
            var body = new VraChangeRecoveryHostRecommendationRequestApi(); // VraChangeRecoveryHostRecommendationRequestApi |  (optional) 

            try
            {
                // Get recommendations for evacuate operation. (Auth)
                VraChangeRecoveryHostRecommendationResultApi result = apiInstance.getVraChangeRecoveryHostRecommendation(vraIdentifier, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VRAsVirtualReplicationAppliancesApi.getVraChangeRecoveryHostRecommendation: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVRAsVirtualReplicationAppliancesApi();
$vraIdentifier = vraIdentifier_example; // String | Vra identifier. Related endpoint: `/v1/vras`
$body = ; // VraChangeRecoveryHostRecommendationRequestApi | 

try {
    $result = $api_instance->getVraChangeRecoveryHostRecommendation($vraIdentifier, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VRAsVirtualReplicationAppliancesApi->getVraChangeRecoveryHostRecommendation: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VRAsVirtualReplicationAppliancesApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VRAsVirtualReplicationAppliancesApi->new();
my $vraIdentifier = vraIdentifier_example; # String | Vra identifier. Related endpoint: `/v1/vras`
my $body = WWW::SwaggerClient::Object::VraChangeRecoveryHostRecommendationRequestApi->new(); # VraChangeRecoveryHostRecommendationRequestApi | 

eval { 
    my $result = $api_instance->getVraChangeRecoveryHostRecommendation(vraIdentifier => $vraIdentifier, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VRAsVirtualReplicationAppliancesApi->getVraChangeRecoveryHostRecommendation: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VRAsVirtualReplicationAppliancesApi()
vraIdentifier = vraIdentifier_example # String | Vra identifier. Related endpoint: `/v1/vras`
body =  # VraChangeRecoveryHostRecommendationRequestApi |  (optional)

try: 
    # Get recommendations for evacuate operation. (Auth)
    api_response = api_instance.get_vra_change_recovery_host_recommendation(vraIdentifier, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VRAsVirtualReplicationAppliancesApi->getVraChangeRecoveryHostRecommendation: %s\n" % e)

Parameters

Path parameters
Name Description
vraIdentifier*
String
Vra identifier. Related endpoint: `/v1/vras`
Required
Body parameters
Name Description
body
{
constraints:
{
fixedVmsAllocations:
}
vmsToCalculate:
[
string
]
}

Responses

Status: 200 - Success

{
recommendations:
[
{
vmIdentifier:
string
hostIdentifier:
string
hostName:
string
reason:
string
}
]
}

getVraClusterSettings

Get VRA cluster install settings. (Auth)


/v1/vras/clusters/{clusterIdentifier}/settings

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vras/clusters/{clusterIdentifier}/settings"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VRAsVirtualReplicationAppliancesApi;

import java.io.File;
import java.util.*;

public class VRAsVirtualReplicationAppliancesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VRAsVirtualReplicationAppliancesApi apiInstance = new VRAsVirtualReplicationAppliancesApi();
        String clusterIdentifier = clusterIdentifier_example; // String | Cluster identifier. Related endpoint `/v1/virtualizationsites/{siteIdentifier}/hostclusters`
        try {
            VrasOnClusterCreateDataApi result = apiInstance.getVraClusterSettings(clusterIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VRAsVirtualReplicationAppliancesApi#getVraClusterSettings");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VRAsVirtualReplicationAppliancesApi;

public class VRAsVirtualReplicationAppliancesApiExample {

    public static void main(String[] args) {
        VRAsVirtualReplicationAppliancesApi apiInstance = new VRAsVirtualReplicationAppliancesApi();
        String clusterIdentifier = clusterIdentifier_example; // String | Cluster identifier. Related endpoint `/v1/virtualizationsites/{siteIdentifier}/hostclusters`
        try {
            VrasOnClusterCreateDataApi result = apiInstance.getVraClusterSettings(clusterIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VRAsVirtualReplicationAppliancesApi#getVraClusterSettings");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *clusterIdentifier = clusterIdentifier_example; // Cluster identifier. Related endpoint `/v1/virtualizationsites/{siteIdentifier}/hostclusters`

VRAsVirtualReplicationAppliancesApi *apiInstance = [[VRAsVirtualReplicationAppliancesApi alloc] init];

// Get VRA cluster install settings. (Auth)
[apiInstance getVraClusterSettingsWith:clusterIdentifier
              completionHandler: ^(VrasOnClusterCreateDataApi output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VRAsVirtualReplicationAppliancesApi()
var clusterIdentifier = clusterIdentifier_example; // {{String}} Cluster identifier. Related endpoint `/v1/virtualizationsites/{siteIdentifier}/hostclusters`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVraClusterSettings(clusterIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVraClusterSettingsExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VRAsVirtualReplicationAppliancesApi();
            var clusterIdentifier = clusterIdentifier_example;  // String | Cluster identifier. Related endpoint `/v1/virtualizationsites/{siteIdentifier}/hostclusters`

            try
            {
                // Get VRA cluster install settings. (Auth)
                VrasOnClusterCreateDataApi result = apiInstance.getVraClusterSettings(clusterIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VRAsVirtualReplicationAppliancesApi.getVraClusterSettings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVRAsVirtualReplicationAppliancesApi();
$clusterIdentifier = clusterIdentifier_example; // String | Cluster identifier. Related endpoint `/v1/virtualizationsites/{siteIdentifier}/hostclusters`

try {
    $result = $api_instance->getVraClusterSettings($clusterIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VRAsVirtualReplicationAppliancesApi->getVraClusterSettings: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VRAsVirtualReplicationAppliancesApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VRAsVirtualReplicationAppliancesApi->new();
my $clusterIdentifier = clusterIdentifier_example; # String | Cluster identifier. Related endpoint `/v1/virtualizationsites/{siteIdentifier}/hostclusters`

eval { 
    my $result = $api_instance->getVraClusterSettings(clusterIdentifier => $clusterIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VRAsVirtualReplicationAppliancesApi->getVraClusterSettings: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VRAsVirtualReplicationAppliancesApi()
clusterIdentifier = clusterIdentifier_example # String | Cluster identifier. Related endpoint `/v1/virtualizationsites/{siteIdentifier}/hostclusters`

try: 
    # Get VRA cluster install settings. (Auth)
    api_response = api_instance.get_vra_cluster_settings(clusterIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VRAsVirtualReplicationAppliancesApi->getVraClusterSettings: %s\n" % e)

Parameters

Path parameters
Name Description
clusterIdentifier*
String
Cluster identifier. Related endpoint `/v1/virtualizationsites/{siteIdentifier}/hostclusters`
Required

Responses

Status: 200 - Success

{
clusterIdentifier:
string
datastoreIdentifier:
string
networkIdentifier:
string
memoryInGb:
integer (int32)
numOfCpus:
integer (int32)
groupName:
string
vraNetworkDataApi:
{
vraIPConfigurationTypeApi:
string
vraIPAddress:
string
vraIPAddressRangeEnd:
string
subnetMask:
string
defaultGateway:
string
}
usePublicKeyInsteadOfCredentials:
boolean
autoPopulatePostInstalltion:
boolean
hostRootPassword:
string
}

getVraConfigurationTypeAll

Get the list of values for VRA IP configuration type (Auth)


/v1/vras/ipconfigurationtypes

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vras/ipconfigurationtypes"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VRAsVirtualReplicationAppliancesApi;

import java.io.File;
import java.util.*;

public class VRAsVirtualReplicationAppliancesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VRAsVirtualReplicationAppliancesApi apiInstance = new VRAsVirtualReplicationAppliancesApi();
        try {
            array['String'] result = apiInstance.getVraConfigurationTypeAll();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VRAsVirtualReplicationAppliancesApi#getVraConfigurationTypeAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VRAsVirtualReplicationAppliancesApi;

public class VRAsVirtualReplicationAppliancesApiExample {

    public static void main(String[] args) {
        VRAsVirtualReplicationAppliancesApi apiInstance = new VRAsVirtualReplicationAppliancesApi();
        try {
            array['String'] result = apiInstance.getVraConfigurationTypeAll();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VRAsVirtualReplicationAppliancesApi#getVraConfigurationTypeAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];

VRAsVirtualReplicationAppliancesApi *apiInstance = [[VRAsVirtualReplicationAppliancesApi alloc] init];

// Get the list of values for VRA IP configuration type (Auth)
[apiInstance getVraConfigurationTypeAllWithCompletionHandler: 
              ^(array['String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VRAsVirtualReplicationAppliancesApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVraConfigurationTypeAll(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVraConfigurationTypeAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VRAsVirtualReplicationAppliancesApi();

            try
            {
                // Get the list of values for VRA IP configuration type (Auth)
                array['String'] result = apiInstance.getVraConfigurationTypeAll();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VRAsVirtualReplicationAppliancesApi.getVraConfigurationTypeAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVRAsVirtualReplicationAppliancesApi();

try {
    $result = $api_instance->getVraConfigurationTypeAll();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VRAsVirtualReplicationAppliancesApi->getVraConfigurationTypeAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VRAsVirtualReplicationAppliancesApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VRAsVirtualReplicationAppliancesApi->new();

eval { 
    my $result = $api_instance->getVraConfigurationTypeAll();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VRAsVirtualReplicationAppliancesApi->getVraConfigurationTypeAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VRAsVirtualReplicationAppliancesApi()

try: 
    # Get the list of values for VRA IP configuration type (Auth)
    api_response = api_instance.get_vra_configuration_type_all()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VRAsVirtualReplicationAppliancesApi->getVraConfigurationTypeAll: %s\n" % e)

Parameters

Responses

Status: 200 - Success

[
string
]

getVraStatusAll

Get the list of values for VRA status (Auth)


/v1/vras/statuses

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vras/statuses"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VRAsVirtualReplicationAppliancesApi;

import java.io.File;
import java.util.*;

public class VRAsVirtualReplicationAppliancesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VRAsVirtualReplicationAppliancesApi apiInstance = new VRAsVirtualReplicationAppliancesApi();
        try {
            array['String'] result = apiInstance.getVraStatusAll();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VRAsVirtualReplicationAppliancesApi#getVraStatusAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VRAsVirtualReplicationAppliancesApi;

public class VRAsVirtualReplicationAppliancesApiExample {

    public static void main(String[] args) {
        VRAsVirtualReplicationAppliancesApi apiInstance = new VRAsVirtualReplicationAppliancesApi();
        try {
            array['String'] result = apiInstance.getVraStatusAll();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VRAsVirtualReplicationAppliancesApi#getVraStatusAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];

VRAsVirtualReplicationAppliancesApi *apiInstance = [[VRAsVirtualReplicationAppliancesApi alloc] init];

// Get the list of values for VRA status (Auth)
[apiInstance getVraStatusAllWithCompletionHandler: 
              ^(array['String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VRAsVirtualReplicationAppliancesApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVraStatusAll(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVraStatusAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VRAsVirtualReplicationAppliancesApi();

            try
            {
                // Get the list of values for VRA status (Auth)
                array['String'] result = apiInstance.getVraStatusAll();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VRAsVirtualReplicationAppliancesApi.getVraStatusAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVRAsVirtualReplicationAppliancesApi();

try {
    $result = $api_instance->getVraStatusAll();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VRAsVirtualReplicationAppliancesApi->getVraStatusAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VRAsVirtualReplicationAppliancesApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VRAsVirtualReplicationAppliancesApi->new();

eval { 
    my $result = $api_instance->getVraStatusAll();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VRAsVirtualReplicationAppliancesApi->getVraStatusAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VRAsVirtualReplicationAppliancesApi()

try: 
    # Get the list of values for VRA status (Auth)
    api_response = api_instance.get_vra_status_all()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VRAsVirtualReplicationAppliancesApi->getVraStatusAll: %s\n" % e)

Parameters

Responses

Status: 200 - Success

[
string
]

startClusterVrasUninstall

UnInstall VRAs from cluster. Returns TaskIdentifier (Auth)


/v1/vras/clusters/{clusterIdentifier}

Usage and SDK Samples

curl -X DELETE\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vras/clusters/{clusterIdentifier}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VRAsVirtualReplicationAppliancesApi;

import java.io.File;
import java.util.*;

public class VRAsVirtualReplicationAppliancesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VRAsVirtualReplicationAppliancesApi apiInstance = new VRAsVirtualReplicationAppliancesApi();
        String clusterIdentifier = clusterIdentifier_example; // String | Cluster identifier. Related endpoint `/v1/virtualizationsites/{siteIdentifier}/hostclusters`
        try {
            'String' result = apiInstance.startClusterVrasUninstall(clusterIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VRAsVirtualReplicationAppliancesApi#startClusterVrasUninstall");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VRAsVirtualReplicationAppliancesApi;

public class VRAsVirtualReplicationAppliancesApiExample {

    public static void main(String[] args) {
        VRAsVirtualReplicationAppliancesApi apiInstance = new VRAsVirtualReplicationAppliancesApi();
        String clusterIdentifier = clusterIdentifier_example; // String | Cluster identifier. Related endpoint `/v1/virtualizationsites/{siteIdentifier}/hostclusters`
        try {
            'String' result = apiInstance.startClusterVrasUninstall(clusterIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VRAsVirtualReplicationAppliancesApi#startClusterVrasUninstall");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *clusterIdentifier = clusterIdentifier_example; // Cluster identifier. Related endpoint `/v1/virtualizationsites/{siteIdentifier}/hostclusters`

VRAsVirtualReplicationAppliancesApi *apiInstance = [[VRAsVirtualReplicationAppliancesApi alloc] init];

// UnInstall VRAs from cluster. Returns TaskIdentifier (Auth)
[apiInstance startClusterVrasUninstallWith:clusterIdentifier
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VRAsVirtualReplicationAppliancesApi()
var clusterIdentifier = clusterIdentifier_example; // {{String}} Cluster identifier. Related endpoint `/v1/virtualizationsites/{siteIdentifier}/hostclusters`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.startClusterVrasUninstall(clusterIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class startClusterVrasUninstallExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VRAsVirtualReplicationAppliancesApi();
            var clusterIdentifier = clusterIdentifier_example;  // String | Cluster identifier. Related endpoint `/v1/virtualizationsites/{siteIdentifier}/hostclusters`

            try
            {
                // UnInstall VRAs from cluster. Returns TaskIdentifier (Auth)
                'String' result = apiInstance.startClusterVrasUninstall(clusterIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VRAsVirtualReplicationAppliancesApi.startClusterVrasUninstall: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVRAsVirtualReplicationAppliancesApi();
$clusterIdentifier = clusterIdentifier_example; // String | Cluster identifier. Related endpoint `/v1/virtualizationsites/{siteIdentifier}/hostclusters`

try {
    $result = $api_instance->startClusterVrasUninstall($clusterIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VRAsVirtualReplicationAppliancesApi->startClusterVrasUninstall: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VRAsVirtualReplicationAppliancesApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VRAsVirtualReplicationAppliancesApi->new();
my $clusterIdentifier = clusterIdentifier_example; # String | Cluster identifier. Related endpoint `/v1/virtualizationsites/{siteIdentifier}/hostclusters`

eval { 
    my $result = $api_instance->startClusterVrasUninstall(clusterIdentifier => $clusterIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VRAsVirtualReplicationAppliancesApi->startClusterVrasUninstall: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VRAsVirtualReplicationAppliancesApi()
clusterIdentifier = clusterIdentifier_example # String | Cluster identifier. Related endpoint `/v1/virtualizationsites/{siteIdentifier}/hostclusters`

try: 
    # UnInstall VRAs from cluster. Returns TaskIdentifier (Auth)
    api_response = api_instance.start_cluster_vras_uninstall(clusterIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VRAsVirtualReplicationAppliancesApi->startClusterVrasUninstall: %s\n" % e)

Parameters

Path parameters
Name Description
clusterIdentifier*
String
Cluster identifier. Related endpoint `/v1/virtualizationsites/{siteIdentifier}/hostclusters`
Required

Responses

Status: 200 - Success

string

startClusterVrasUpgrade

Upgrade VRA on cluster. Returns TaskIdentifier (Auth)


/v1/vras/clusters/{clusterIdentifier}

Usage and SDK Samples

curl -X PUT\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vras/clusters/{clusterIdentifier}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VRAsVirtualReplicationAppliancesApi;

import java.io.File;
import java.util.*;

public class VRAsVirtualReplicationAppliancesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VRAsVirtualReplicationAppliancesApi apiInstance = new VRAsVirtualReplicationAppliancesApi();
        String clusterIdentifier = clusterIdentifier_example; // String | Cluster identifier. Related endpoint `/v1/virtualizationsites/{siteIdentifier}/hostclusters`
        try {
            'String' result = apiInstance.startClusterVrasUpgrade(clusterIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VRAsVirtualReplicationAppliancesApi#startClusterVrasUpgrade");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VRAsVirtualReplicationAppliancesApi;

public class VRAsVirtualReplicationAppliancesApiExample {

    public static void main(String[] args) {
        VRAsVirtualReplicationAppliancesApi apiInstance = new VRAsVirtualReplicationAppliancesApi();
        String clusterIdentifier = clusterIdentifier_example; // String | Cluster identifier. Related endpoint `/v1/virtualizationsites/{siteIdentifier}/hostclusters`
        try {
            'String' result = apiInstance.startClusterVrasUpgrade(clusterIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VRAsVirtualReplicationAppliancesApi#startClusterVrasUpgrade");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *clusterIdentifier = clusterIdentifier_example; // Cluster identifier. Related endpoint `/v1/virtualizationsites/{siteIdentifier}/hostclusters`

VRAsVirtualReplicationAppliancesApi *apiInstance = [[VRAsVirtualReplicationAppliancesApi alloc] init];

// Upgrade VRA on cluster. Returns TaskIdentifier (Auth)
[apiInstance startClusterVrasUpgradeWith:clusterIdentifier
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VRAsVirtualReplicationAppliancesApi()
var clusterIdentifier = clusterIdentifier_example; // {{String}} Cluster identifier. Related endpoint `/v1/virtualizationsites/{siteIdentifier}/hostclusters`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.startClusterVrasUpgrade(clusterIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class startClusterVrasUpgradeExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VRAsVirtualReplicationAppliancesApi();
            var clusterIdentifier = clusterIdentifier_example;  // String | Cluster identifier. Related endpoint `/v1/virtualizationsites/{siteIdentifier}/hostclusters`

            try
            {
                // Upgrade VRA on cluster. Returns TaskIdentifier (Auth)
                'String' result = apiInstance.startClusterVrasUpgrade(clusterIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VRAsVirtualReplicationAppliancesApi.startClusterVrasUpgrade: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVRAsVirtualReplicationAppliancesApi();
$clusterIdentifier = clusterIdentifier_example; // String | Cluster identifier. Related endpoint `/v1/virtualizationsites/{siteIdentifier}/hostclusters`

try {
    $result = $api_instance->startClusterVrasUpgrade($clusterIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VRAsVirtualReplicationAppliancesApi->startClusterVrasUpgrade: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VRAsVirtualReplicationAppliancesApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VRAsVirtualReplicationAppliancesApi->new();
my $clusterIdentifier = clusterIdentifier_example; # String | Cluster identifier. Related endpoint `/v1/virtualizationsites/{siteIdentifier}/hostclusters`

eval { 
    my $result = $api_instance->startClusterVrasUpgrade(clusterIdentifier => $clusterIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VRAsVirtualReplicationAppliancesApi->startClusterVrasUpgrade: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VRAsVirtualReplicationAppliancesApi()
clusterIdentifier = clusterIdentifier_example # String | Cluster identifier. Related endpoint `/v1/virtualizationsites/{siteIdentifier}/hostclusters`

try: 
    # Upgrade VRA on cluster. Returns TaskIdentifier (Auth)
    api_response = api_instance.start_cluster_vras_upgrade(clusterIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VRAsVirtualReplicationAppliancesApi->startClusterVrasUpgrade: %s\n" % e)

Parameters

Path parameters
Name Description
clusterIdentifier*
String
Cluster identifier. Related endpoint `/v1/virtualizationsites/{siteIdentifier}/hostclusters`
Required

Responses

Status: 200 - Success

string

startSetVraClusterSettings

Store VRA install settings for a cluster. (Auth)


/v1/vras/clusters/{clusterIdentifier}/settings

Usage and SDK Samples

curl -X POST\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
-H "Content-Type: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vras/clusters/{clusterIdentifier}/settings"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VRAsVirtualReplicationAppliancesApi;

import java.io.File;
import java.util.*;

public class VRAsVirtualReplicationAppliancesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VRAsVirtualReplicationAppliancesApi apiInstance = new VRAsVirtualReplicationAppliancesApi();
        String clusterIdentifier = clusterIdentifier_example; // String | Cluster identifier. Related endpoint `/v1/virtualizationsites/{siteIdentifier}/hostclusters`
        VrasOnClusterCreateDataApi body = ; // VrasOnClusterCreateDataApi | 
        try {
            'String' result = apiInstance.startSetVraClusterSettings(clusterIdentifier, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VRAsVirtualReplicationAppliancesApi#startSetVraClusterSettings");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VRAsVirtualReplicationAppliancesApi;

public class VRAsVirtualReplicationAppliancesApiExample {

    public static void main(String[] args) {
        VRAsVirtualReplicationAppliancesApi apiInstance = new VRAsVirtualReplicationAppliancesApi();
        String clusterIdentifier = clusterIdentifier_example; // String | Cluster identifier. Related endpoint `/v1/virtualizationsites/{siteIdentifier}/hostclusters`
        VrasOnClusterCreateDataApi body = ; // VrasOnClusterCreateDataApi | 
        try {
            'String' result = apiInstance.startSetVraClusterSettings(clusterIdentifier, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VRAsVirtualReplicationAppliancesApi#startSetVraClusterSettings");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *clusterIdentifier = clusterIdentifier_example; // Cluster identifier. Related endpoint `/v1/virtualizationsites/{siteIdentifier}/hostclusters`
VrasOnClusterCreateDataApi *body = ; //  (optional)

VRAsVirtualReplicationAppliancesApi *apiInstance = [[VRAsVirtualReplicationAppliancesApi alloc] init];

// Store VRA install settings for a cluster. (Auth)
[apiInstance startSetVraClusterSettingsWith:clusterIdentifier
    body:body
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VRAsVirtualReplicationAppliancesApi()
var clusterIdentifier = clusterIdentifier_example; // {{String}} Cluster identifier. Related endpoint `/v1/virtualizationsites/{siteIdentifier}/hostclusters`
var opts = { 
  'body':  // {{VrasOnClusterCreateDataApi}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.startSetVraClusterSettings(clusterIdentifier, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class startSetVraClusterSettingsExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VRAsVirtualReplicationAppliancesApi();
            var clusterIdentifier = clusterIdentifier_example;  // String | Cluster identifier. Related endpoint `/v1/virtualizationsites/{siteIdentifier}/hostclusters`
            var body = new VrasOnClusterCreateDataApi(); // VrasOnClusterCreateDataApi |  (optional) 

            try
            {
                // Store VRA install settings for a cluster. (Auth)
                'String' result = apiInstance.startSetVraClusterSettings(clusterIdentifier, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VRAsVirtualReplicationAppliancesApi.startSetVraClusterSettings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVRAsVirtualReplicationAppliancesApi();
$clusterIdentifier = clusterIdentifier_example; // String | Cluster identifier. Related endpoint `/v1/virtualizationsites/{siteIdentifier}/hostclusters`
$body = ; // VrasOnClusterCreateDataApi | 

try {
    $result = $api_instance->startSetVraClusterSettings($clusterIdentifier, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VRAsVirtualReplicationAppliancesApi->startSetVraClusterSettings: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VRAsVirtualReplicationAppliancesApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VRAsVirtualReplicationAppliancesApi->new();
my $clusterIdentifier = clusterIdentifier_example; # String | Cluster identifier. Related endpoint `/v1/virtualizationsites/{siteIdentifier}/hostclusters`
my $body = WWW::SwaggerClient::Object::VrasOnClusterCreateDataApi->new(); # VrasOnClusterCreateDataApi | 

eval { 
    my $result = $api_instance->startSetVraClusterSettings(clusterIdentifier => $clusterIdentifier, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VRAsVirtualReplicationAppliancesApi->startSetVraClusterSettings: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VRAsVirtualReplicationAppliancesApi()
clusterIdentifier = clusterIdentifier_example # String | Cluster identifier. Related endpoint `/v1/virtualizationsites/{siteIdentifier}/hostclusters`
body =  # VrasOnClusterCreateDataApi |  (optional)

try: 
    # Store VRA install settings for a cluster. (Auth)
    api_response = api_instance.start_set_vra_cluster_settings(clusterIdentifier, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VRAsVirtualReplicationAppliancesApi->startSetVraClusterSettings: %s\n" % e)

Parameters

Path parameters
Name Description
clusterIdentifier*
String
Cluster identifier. Related endpoint `/v1/virtualizationsites/{siteIdentifier}/hostclusters`
Required
Body parameters
Name Description
body
{
clusterIdentifier:
string
datastoreIdentifier:
string
networkIdentifier:
string
memoryInGb:
integer (int32)
numOfCpus:
integer (int32)
groupName:
string
vraNetworkDataApi:
{
vraIPConfigurationTypeApi:
vraIPAddress:
vraIPAddressRangeEnd:
subnetMask:
defaultGateway:
}
usePublicKeyInsteadOfCredentials:
boolean
autoPopulatePostInstalltion:
boolean
hostRootPassword:
string
}

Responses

Status: 200 - Success

string

startVraChangeRecoveryHost

Change recovery host. (Auth)


/v1/vras/{vraIdentifier}/changerecoveryvra/execute

Usage and SDK Samples

curl -X POST\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
-H "Content-Type: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vras/{vraIdentifier}/changerecoveryvra/execute"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VRAsVirtualReplicationAppliancesApi;

import java.io.File;
import java.util.*;

public class VRAsVirtualReplicationAppliancesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VRAsVirtualReplicationAppliancesApi apiInstance = new VRAsVirtualReplicationAppliancesApi();
        String vraIdentifier = vraIdentifier_example; // String | Vra identifier. Related endpoint: `/v1/vras`
        VraChangeRecoveryHostSettingsApi body = ; // VraChangeRecoveryHostSettingsApi | 
        try {
            'String' result = apiInstance.startVraChangeRecoveryHost(vraIdentifier, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VRAsVirtualReplicationAppliancesApi#startVraChangeRecoveryHost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VRAsVirtualReplicationAppliancesApi;

public class VRAsVirtualReplicationAppliancesApiExample {

    public static void main(String[] args) {
        VRAsVirtualReplicationAppliancesApi apiInstance = new VRAsVirtualReplicationAppliancesApi();
        String vraIdentifier = vraIdentifier_example; // String | Vra identifier. Related endpoint: `/v1/vras`
        VraChangeRecoveryHostSettingsApi body = ; // VraChangeRecoveryHostSettingsApi | 
        try {
            'String' result = apiInstance.startVraChangeRecoveryHost(vraIdentifier, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VRAsVirtualReplicationAppliancesApi#startVraChangeRecoveryHost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vraIdentifier = vraIdentifier_example; // Vra identifier. Related endpoint: `/v1/vras`
VraChangeRecoveryHostSettingsApi *body = ; //  (optional)

VRAsVirtualReplicationAppliancesApi *apiInstance = [[VRAsVirtualReplicationAppliancesApi alloc] init];

// Change recovery host. (Auth)
[apiInstance startVraChangeRecoveryHostWith:vraIdentifier
    body:body
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VRAsVirtualReplicationAppliancesApi()
var vraIdentifier = vraIdentifier_example; // {{String}} Vra identifier. Related endpoint: `/v1/vras`
var opts = { 
  'body':  // {{VraChangeRecoveryHostSettingsApi}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.startVraChangeRecoveryHost(vraIdentifier, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class startVraChangeRecoveryHostExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VRAsVirtualReplicationAppliancesApi();
            var vraIdentifier = vraIdentifier_example;  // String | Vra identifier. Related endpoint: `/v1/vras`
            var body = new VraChangeRecoveryHostSettingsApi(); // VraChangeRecoveryHostSettingsApi |  (optional) 

            try
            {
                // Change recovery host. (Auth)
                'String' result = apiInstance.startVraChangeRecoveryHost(vraIdentifier, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VRAsVirtualReplicationAppliancesApi.startVraChangeRecoveryHost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVRAsVirtualReplicationAppliancesApi();
$vraIdentifier = vraIdentifier_example; // String | Vra identifier. Related endpoint: `/v1/vras`
$body = ; // VraChangeRecoveryHostSettingsApi | 

try {
    $result = $api_instance->startVraChangeRecoveryHost($vraIdentifier, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VRAsVirtualReplicationAppliancesApi->startVraChangeRecoveryHost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VRAsVirtualReplicationAppliancesApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VRAsVirtualReplicationAppliancesApi->new();
my $vraIdentifier = vraIdentifier_example; # String | Vra identifier. Related endpoint: `/v1/vras`
my $body = WWW::SwaggerClient::Object::VraChangeRecoveryHostSettingsApi->new(); # VraChangeRecoveryHostSettingsApi | 

eval { 
    my $result = $api_instance->startVraChangeRecoveryHost(vraIdentifier => $vraIdentifier, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VRAsVirtualReplicationAppliancesApi->startVraChangeRecoveryHost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VRAsVirtualReplicationAppliancesApi()
vraIdentifier = vraIdentifier_example # String | Vra identifier. Related endpoint: `/v1/vras`
body =  # VraChangeRecoveryHostSettingsApi |  (optional)

try: 
    # Change recovery host. (Auth)
    api_response = api_instance.start_vra_change_recovery_host(vraIdentifier, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VRAsVirtualReplicationAppliancesApi->startVraChangeRecoveryHost: %s\n" % e)

Parameters

Path parameters
Name Description
vraIdentifier*
String
Vra identifier. Related endpoint: `/v1/vras`
Required
Body parameters
Name Description
body
{
vmsAllocations:
[
{
hostIdentifier:
string
vmIdentifier:
string
}
]
}

Responses

Status: 200 - Success

string

startVraEdit

Edit VRA. Returns TaskIdentifier (Auth)


/v1/vras/{vraIdentifier}

Usage and SDK Samples

curl -X PUT\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
-H "Content-Type: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vras/{vraIdentifier}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VRAsVirtualReplicationAppliancesApi;

import java.io.File;
import java.util.*;

public class VRAsVirtualReplicationAppliancesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VRAsVirtualReplicationAppliancesApi apiInstance = new VRAsVirtualReplicationAppliancesApi();
        String vraIdentifier = vraIdentifier_example; // String | Vra identifier. Related endpoint: `/v1/vras`
        VraEditDataApi body = ; // VraEditDataApi | 
        try {
            'String' result = apiInstance.startVraEdit(vraIdentifier, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VRAsVirtualReplicationAppliancesApi#startVraEdit");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VRAsVirtualReplicationAppliancesApi;

public class VRAsVirtualReplicationAppliancesApiExample {

    public static void main(String[] args) {
        VRAsVirtualReplicationAppliancesApi apiInstance = new VRAsVirtualReplicationAppliancesApi();
        String vraIdentifier = vraIdentifier_example; // String | Vra identifier. Related endpoint: `/v1/vras`
        VraEditDataApi body = ; // VraEditDataApi | 
        try {
            'String' result = apiInstance.startVraEdit(vraIdentifier, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VRAsVirtualReplicationAppliancesApi#startVraEdit");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vraIdentifier = vraIdentifier_example; // Vra identifier. Related endpoint: `/v1/vras`
VraEditDataApi *body = ; //  (optional)

VRAsVirtualReplicationAppliancesApi *apiInstance = [[VRAsVirtualReplicationAppliancesApi alloc] init];

// Edit VRA. Returns TaskIdentifier (Auth)
[apiInstance startVraEditWith:vraIdentifier
    body:body
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VRAsVirtualReplicationAppliancesApi()
var vraIdentifier = vraIdentifier_example; // {{String}} Vra identifier. Related endpoint: `/v1/vras`
var opts = { 
  'body':  // {{VraEditDataApi}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.startVraEdit(vraIdentifier, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class startVraEditExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VRAsVirtualReplicationAppliancesApi();
            var vraIdentifier = vraIdentifier_example;  // String | Vra identifier. Related endpoint: `/v1/vras`
            var body = new VraEditDataApi(); // VraEditDataApi |  (optional) 

            try
            {
                // Edit VRA. Returns TaskIdentifier (Auth)
                'String' result = apiInstance.startVraEdit(vraIdentifier, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VRAsVirtualReplicationAppliancesApi.startVraEdit: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVRAsVirtualReplicationAppliancesApi();
$vraIdentifier = vraIdentifier_example; // String | Vra identifier. Related endpoint: `/v1/vras`
$body = ; // VraEditDataApi | 

try {
    $result = $api_instance->startVraEdit($vraIdentifier, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VRAsVirtualReplicationAppliancesApi->startVraEdit: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VRAsVirtualReplicationAppliancesApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VRAsVirtualReplicationAppliancesApi->new();
my $vraIdentifier = vraIdentifier_example; # String | Vra identifier. Related endpoint: `/v1/vras`
my $body = WWW::SwaggerClient::Object::VraEditDataApi->new(); # VraEditDataApi | 

eval { 
    my $result = $api_instance->startVraEdit(vraIdentifier => $vraIdentifier, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VRAsVirtualReplicationAppliancesApi->startVraEdit: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VRAsVirtualReplicationAppliancesApi()
vraIdentifier = vraIdentifier_example # String | Vra identifier. Related endpoint: `/v1/vras`
body =  # VraEditDataApi |  (optional)

try: 
    # Edit VRA. Returns TaskIdentifier (Auth)
    api_response = api_instance.start_vra_edit(vraIdentifier, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VRAsVirtualReplicationAppliancesApi->startVraEdit: %s\n" % e)

Parameters

Path parameters
Name Description
vraIdentifier*
String
Vra identifier. Related endpoint: `/v1/vras`
Required
Body parameters
Name Description
body
{
hostRootPassword:
string
groupName:
string
usePublicKeyInsteadOfCredentials:
boolean
vraNetworkDataApi:
{
vraIPConfigurationTypeApi:
vraIPAddress:
vraIPAddressRangeEnd:
subnetMask:
defaultGateway:
}
memoryInGb:
integer (int32)
numOfCpus:
integer (int32)
}

Responses

Status: 200 - Success

string

startVraInstall

Install VRA. Returns TaskIdentifier. (Auth)


/v1/vras

Usage and SDK Samples

curl -X POST\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
-H "Content-Type: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vras"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VRAsVirtualReplicationAppliancesApi;

import java.io.File;
import java.util.*;

public class VRAsVirtualReplicationAppliancesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VRAsVirtualReplicationAppliancesApi apiInstance = new VRAsVirtualReplicationAppliancesApi();
        VraCreateDataApi body = ; // VraCreateDataApi | 
        try {
            'String' result = apiInstance.startVraInstall(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VRAsVirtualReplicationAppliancesApi#startVraInstall");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VRAsVirtualReplicationAppliancesApi;

public class VRAsVirtualReplicationAppliancesApiExample {

    public static void main(String[] args) {
        VRAsVirtualReplicationAppliancesApi apiInstance = new VRAsVirtualReplicationAppliancesApi();
        VraCreateDataApi body = ; // VraCreateDataApi | 
        try {
            'String' result = apiInstance.startVraInstall(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VRAsVirtualReplicationAppliancesApi#startVraInstall");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
VraCreateDataApi *body = ; //  (optional)

VRAsVirtualReplicationAppliancesApi *apiInstance = [[VRAsVirtualReplicationAppliancesApi alloc] init];

// Install VRA. Returns TaskIdentifier. (Auth)
[apiInstance startVraInstallWith:body
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VRAsVirtualReplicationAppliancesApi()
var opts = { 
  'body':  // {{VraCreateDataApi}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.startVraInstall(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class startVraInstallExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VRAsVirtualReplicationAppliancesApi();
            var body = new VraCreateDataApi(); // VraCreateDataApi |  (optional) 

            try
            {
                // Install VRA. Returns TaskIdentifier. (Auth)
                'String' result = apiInstance.startVraInstall(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VRAsVirtualReplicationAppliancesApi.startVraInstall: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVRAsVirtualReplicationAppliancesApi();
$body = ; // VraCreateDataApi | 

try {
    $result = $api_instance->startVraInstall($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VRAsVirtualReplicationAppliancesApi->startVraInstall: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VRAsVirtualReplicationAppliancesApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VRAsVirtualReplicationAppliancesApi->new();
my $body = WWW::SwaggerClient::Object::VraCreateDataApi->new(); # VraCreateDataApi | 

eval { 
    my $result = $api_instance->startVraInstall(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VRAsVirtualReplicationAppliancesApi->startVraInstall: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VRAsVirtualReplicationAppliancesApi()
body =  # VraCreateDataApi |  (optional)

try: 
    # Install VRA. Returns TaskIdentifier. (Auth)
    api_response = api_instance.start_vra_install(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VRAsVirtualReplicationAppliancesApi->startVraInstall: %s\n" % e)

Parameters

Body parameters
Name Description
body
{
hostIdentifier:
string
datastoreIdentifier:
string
networkIdentifier:
string
hostRootPassword:
string
memoryInGb:
integer (int32)
groupName:
string
vraNetworkDataApi:
{
vraIPConfigurationTypeApi:
vraIPAddress:
vraIPAddressRangeEnd:
subnetMask:
defaultGateway:
}
usePublicKeyInsteadOfCredentials:
boolean
populatePostInstallation:
boolean
numOfCpus:
integer (int32)
}

Responses

Status: 200 - Success

string

startVraUninstall

UnInstall VRA. Returns TaskIdentifier (Auth)


/v1/vras/{vraIdentifier}

Usage and SDK Samples

curl -X DELETE\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vras/{vraIdentifier}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VRAsVirtualReplicationAppliancesApi;

import java.io.File;
import java.util.*;

public class VRAsVirtualReplicationAppliancesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VRAsVirtualReplicationAppliancesApi apiInstance = new VRAsVirtualReplicationAppliancesApi();
        String vraIdentifier = vraIdentifier_example; // String | Vra identifier. Related endpoint: `/v1/vras`
        try {
            'String' result = apiInstance.startVraUninstall(vraIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VRAsVirtualReplicationAppliancesApi#startVraUninstall");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VRAsVirtualReplicationAppliancesApi;

public class VRAsVirtualReplicationAppliancesApiExample {

    public static void main(String[] args) {
        VRAsVirtualReplicationAppliancesApi apiInstance = new VRAsVirtualReplicationAppliancesApi();
        String vraIdentifier = vraIdentifier_example; // String | Vra identifier. Related endpoint: `/v1/vras`
        try {
            'String' result = apiInstance.startVraUninstall(vraIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VRAsVirtualReplicationAppliancesApi#startVraUninstall");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vraIdentifier = vraIdentifier_example; // Vra identifier. Related endpoint: `/v1/vras`

VRAsVirtualReplicationAppliancesApi *apiInstance = [[VRAsVirtualReplicationAppliancesApi alloc] init];

// UnInstall VRA. Returns TaskIdentifier (Auth)
[apiInstance startVraUninstallWith:vraIdentifier
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VRAsVirtualReplicationAppliancesApi()
var vraIdentifier = vraIdentifier_example; // {{String}} Vra identifier. Related endpoint: `/v1/vras`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.startVraUninstall(vraIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class startVraUninstallExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VRAsVirtualReplicationAppliancesApi();
            var vraIdentifier = vraIdentifier_example;  // String | Vra identifier. Related endpoint: `/v1/vras`

            try
            {
                // UnInstall VRA. Returns TaskIdentifier (Auth)
                'String' result = apiInstance.startVraUninstall(vraIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VRAsVirtualReplicationAppliancesApi.startVraUninstall: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVRAsVirtualReplicationAppliancesApi();
$vraIdentifier = vraIdentifier_example; // String | Vra identifier. Related endpoint: `/v1/vras`

try {
    $result = $api_instance->startVraUninstall($vraIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VRAsVirtualReplicationAppliancesApi->startVraUninstall: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VRAsVirtualReplicationAppliancesApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VRAsVirtualReplicationAppliancesApi->new();
my $vraIdentifier = vraIdentifier_example; # String | Vra identifier. Related endpoint: `/v1/vras`

eval { 
    my $result = $api_instance->startVraUninstall(vraIdentifier => $vraIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VRAsVirtualReplicationAppliancesApi->startVraUninstall: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VRAsVirtualReplicationAppliancesApi()
vraIdentifier = vraIdentifier_example # String | Vra identifier. Related endpoint: `/v1/vras`

try: 
    # UnInstall VRA. Returns TaskIdentifier (Auth)
    api_response = api_instance.start_vra_uninstall(vraIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VRAsVirtualReplicationAppliancesApi->startVraUninstall: %s\n" % e)

Parameters

Path parameters
Name Description
vraIdentifier*
String
Vra identifier. Related endpoint: `/v1/vras`
Required

Responses

Status: 200 - Success

string

startVraUpgrade

Upgrade VRA. Returns TaskIdentifier (Auth)


/v1/vras/{vraIdentifier}/upgrade

Usage and SDK Samples

curl -X POST\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vras/{vraIdentifier}/upgrade"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VRAsVirtualReplicationAppliancesApi;

import java.io.File;
import java.util.*;

public class VRAsVirtualReplicationAppliancesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VRAsVirtualReplicationAppliancesApi apiInstance = new VRAsVirtualReplicationAppliancesApi();
        String vraIdentifier = vraIdentifier_example; // String | Vra identifier. Related endpoint: `/v1/vras`
        try {
            'String' result = apiInstance.startVraUpgrade(vraIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VRAsVirtualReplicationAppliancesApi#startVraUpgrade");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VRAsVirtualReplicationAppliancesApi;

public class VRAsVirtualReplicationAppliancesApiExample {

    public static void main(String[] args) {
        VRAsVirtualReplicationAppliancesApi apiInstance = new VRAsVirtualReplicationAppliancesApi();
        String vraIdentifier = vraIdentifier_example; // String | Vra identifier. Related endpoint: `/v1/vras`
        try {
            'String' result = apiInstance.startVraUpgrade(vraIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VRAsVirtualReplicationAppliancesApi#startVraUpgrade");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vraIdentifier = vraIdentifier_example; // Vra identifier. Related endpoint: `/v1/vras`

VRAsVirtualReplicationAppliancesApi *apiInstance = [[VRAsVirtualReplicationAppliancesApi alloc] init];

// Upgrade VRA. Returns TaskIdentifier (Auth)
[apiInstance startVraUpgradeWith:vraIdentifier
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VRAsVirtualReplicationAppliancesApi()
var vraIdentifier = vraIdentifier_example; // {{String}} Vra identifier. Related endpoint: `/v1/vras`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.startVraUpgrade(vraIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class startVraUpgradeExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VRAsVirtualReplicationAppliancesApi();
            var vraIdentifier = vraIdentifier_example;  // String | Vra identifier. Related endpoint: `/v1/vras`

            try
            {
                // Upgrade VRA. Returns TaskIdentifier (Auth)
                'String' result = apiInstance.startVraUpgrade(vraIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VRAsVirtualReplicationAppliancesApi.startVraUpgrade: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVRAsVirtualReplicationAppliancesApi();
$vraIdentifier = vraIdentifier_example; // String | Vra identifier. Related endpoint: `/v1/vras`

try {
    $result = $api_instance->startVraUpgrade($vraIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VRAsVirtualReplicationAppliancesApi->startVraUpgrade: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VRAsVirtualReplicationAppliancesApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VRAsVirtualReplicationAppliancesApi->new();
my $vraIdentifier = vraIdentifier_example; # String | Vra identifier. Related endpoint: `/v1/vras`

eval { 
    my $result = $api_instance->startVraUpgrade(vraIdentifier => $vraIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VRAsVirtualReplicationAppliancesApi->startVraUpgrade: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VRAsVirtualReplicationAppliancesApi()
vraIdentifier = vraIdentifier_example # String | Vra identifier. Related endpoint: `/v1/vras`

try: 
    # Upgrade VRA. Returns TaskIdentifier (Auth)
    api_response = api_instance.start_vra_upgrade(vraIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VRAsVirtualReplicationAppliancesApi->startVraUpgrade: %s\n" % e)

Parameters

Path parameters
Name Description
vraIdentifier*
String
Vra identifier. Related endpoint: `/v1/vras`
Required

Responses

Status: 200 - Success

string

testVraChangeRecoveryHostSetting

Validate change recovery host settings. (Auth)


/v1/vras/{vraIdentifier}/changerecoveryvra/validate

Usage and SDK Samples

curl -X POST\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
-H "Content-Type: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vras/{vraIdentifier}/changerecoveryvra/validate"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VRAsVirtualReplicationAppliancesApi;

import java.io.File;
import java.util.*;

public class VRAsVirtualReplicationAppliancesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VRAsVirtualReplicationAppliancesApi apiInstance = new VRAsVirtualReplicationAppliancesApi();
        String vraIdentifier = vraIdentifier_example; // String | Vra identifier. Related endpoint: `/v1/vras`
        VraChangeRecoveryHostSettingsApi body = ; // VraChangeRecoveryHostSettingsApi | 
        try {
            VraChangeRecoveryHostValidationResultsApi result = apiInstance.testVraChangeRecoveryHostSetting(vraIdentifier, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VRAsVirtualReplicationAppliancesApi#testVraChangeRecoveryHostSetting");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VRAsVirtualReplicationAppliancesApi;

public class VRAsVirtualReplicationAppliancesApiExample {

    public static void main(String[] args) {
        VRAsVirtualReplicationAppliancesApi apiInstance = new VRAsVirtualReplicationAppliancesApi();
        String vraIdentifier = vraIdentifier_example; // String | Vra identifier. Related endpoint: `/v1/vras`
        VraChangeRecoveryHostSettingsApi body = ; // VraChangeRecoveryHostSettingsApi | 
        try {
            VraChangeRecoveryHostValidationResultsApi result = apiInstance.testVraChangeRecoveryHostSetting(vraIdentifier, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VRAsVirtualReplicationAppliancesApi#testVraChangeRecoveryHostSetting");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vraIdentifier = vraIdentifier_example; // Vra identifier. Related endpoint: `/v1/vras`
VraChangeRecoveryHostSettingsApi *body = ; //  (optional)

VRAsVirtualReplicationAppliancesApi *apiInstance = [[VRAsVirtualReplicationAppliancesApi alloc] init];

// Validate change recovery host settings. (Auth)
[apiInstance testVraChangeRecoveryHostSettingWith:vraIdentifier
    body:body
              completionHandler: ^(VraChangeRecoveryHostValidationResultsApi output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VRAsVirtualReplicationAppliancesApi()
var vraIdentifier = vraIdentifier_example; // {{String}} Vra identifier. Related endpoint: `/v1/vras`
var opts = { 
  'body':  // {{VraChangeRecoveryHostSettingsApi}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.testVraChangeRecoveryHostSetting(vraIdentifier, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class testVraChangeRecoveryHostSettingExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VRAsVirtualReplicationAppliancesApi();
            var vraIdentifier = vraIdentifier_example;  // String | Vra identifier. Related endpoint: `/v1/vras`
            var body = new VraChangeRecoveryHostSettingsApi(); // VraChangeRecoveryHostSettingsApi |  (optional) 

            try
            {
                // Validate change recovery host settings. (Auth)
                VraChangeRecoveryHostValidationResultsApi result = apiInstance.testVraChangeRecoveryHostSetting(vraIdentifier, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VRAsVirtualReplicationAppliancesApi.testVraChangeRecoveryHostSetting: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVRAsVirtualReplicationAppliancesApi();
$vraIdentifier = vraIdentifier_example; // String | Vra identifier. Related endpoint: `/v1/vras`
$body = ; // VraChangeRecoveryHostSettingsApi | 

try {
    $result = $api_instance->testVraChangeRecoveryHostSetting($vraIdentifier, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VRAsVirtualReplicationAppliancesApi->testVraChangeRecoveryHostSetting: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VRAsVirtualReplicationAppliancesApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VRAsVirtualReplicationAppliancesApi->new();
my $vraIdentifier = vraIdentifier_example; # String | Vra identifier. Related endpoint: `/v1/vras`
my $body = WWW::SwaggerClient::Object::VraChangeRecoveryHostSettingsApi->new(); # VraChangeRecoveryHostSettingsApi | 

eval { 
    my $result = $api_instance->testVraChangeRecoveryHostSetting(vraIdentifier => $vraIdentifier, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VRAsVirtualReplicationAppliancesApi->testVraChangeRecoveryHostSetting: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VRAsVirtualReplicationAppliancesApi()
vraIdentifier = vraIdentifier_example # String | Vra identifier. Related endpoint: `/v1/vras`
body =  # VraChangeRecoveryHostSettingsApi |  (optional)

try: 
    # Validate change recovery host settings. (Auth)
    api_response = api_instance.test_vra_change_recovery_host_setting(vraIdentifier, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VRAsVirtualReplicationAppliancesApi->testVraChangeRecoveryHostSetting: %s\n" % e)

Parameters

Path parameters
Name Description
vraIdentifier*
String
Vra identifier. Related endpoint: `/v1/vras`
Required
Body parameters
Name Description
body
{
vmsAllocations:
[
{
hostIdentifier:
string
vmIdentifier:
string
}
]
}

Responses

Status: 200 - Success

{
vmsValidationsResults:
[
{
vmIdentifier:
string
hostIdentifier:
string
status:
integer (int32)
Enum: 0, 1, 2
reason:
string
}
]
}

VirtualMachines

getVm

Get information about a single protected VM. VpgId may be required if VM is protected by more than one VPG. (Auth)


/v1/vms/{vmIdentifier}

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vms/{vmIdentifier}?vpgIdentifier=&includeBackupedVMs="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VirtualMachinesApi;

import java.io.File;
import java.util.*;

public class VirtualMachinesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VirtualMachinesApi apiInstance = new VirtualMachinesApi();
        String vmIdentifier = vmIdentifier_example; // String | The idenfier of the VM. Related endpoint: `v1/vms`
        String vpgIdentifier = vpgIdentifier_example; // String | The identifier of the VPG. Related endpoint: `v1/vpgs`
        Boolean includeBackupedVMs = true; // Boolean | 
        try {
            VmApi result = apiInstance.getVm(vmIdentifier, vpgIdentifier, includeBackupedVMs);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualMachinesApi#getVm");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VirtualMachinesApi;

public class VirtualMachinesApiExample {

    public static void main(String[] args) {
        VirtualMachinesApi apiInstance = new VirtualMachinesApi();
        String vmIdentifier = vmIdentifier_example; // String | The idenfier of the VM. Related endpoint: `v1/vms`
        String vpgIdentifier = vpgIdentifier_example; // String | The identifier of the VPG. Related endpoint: `v1/vpgs`
        Boolean includeBackupedVMs = true; // Boolean | 
        try {
            VmApi result = apiInstance.getVm(vmIdentifier, vpgIdentifier, includeBackupedVMs);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualMachinesApi#getVm");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vmIdentifier = vmIdentifier_example; // The idenfier of the VM. Related endpoint: `v1/vms`
String *vpgIdentifier = vpgIdentifier_example; // The identifier of the VPG. Related endpoint: `v1/vpgs` (optional)
Boolean *includeBackupedVMs = true; //  (optional)

VirtualMachinesApi *apiInstance = [[VirtualMachinesApi alloc] init];

// Get information about a single protected VM. VpgId may be required if VM is protected by more than one VPG. (Auth)
[apiInstance getVmWith:vmIdentifier
    vpgIdentifier:vpgIdentifier
    includeBackupedVMs:includeBackupedVMs
              completionHandler: ^(VmApi output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VirtualMachinesApi()
var vmIdentifier = vmIdentifier_example; // {{String}} The idenfier of the VM. Related endpoint: `v1/vms`
var opts = { 
  'vpgIdentifier': vpgIdentifier_example, // {{String}} The identifier of the VPG. Related endpoint: `v1/vpgs`
  'includeBackupedVMs': true // {{Boolean}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVm(vmIdentifier, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVmExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VirtualMachinesApi();
            var vmIdentifier = vmIdentifier_example;  // String | The idenfier of the VM. Related endpoint: `v1/vms`
            var vpgIdentifier = vpgIdentifier_example;  // String | The identifier of the VPG. Related endpoint: `v1/vpgs` (optional) 
            var includeBackupedVMs = true;  // Boolean |  (optional) 

            try
            {
                // Get information about a single protected VM. VpgId may be required if VM is protected by more than one VPG. (Auth)
                VmApi result = apiInstance.getVm(vmIdentifier, vpgIdentifier, includeBackupedVMs);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VirtualMachinesApi.getVm: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVirtualMachinesApi();
$vmIdentifier = vmIdentifier_example; // String | The idenfier of the VM. Related endpoint: `v1/vms`
$vpgIdentifier = vpgIdentifier_example; // String | The identifier of the VPG. Related endpoint: `v1/vpgs`
$includeBackupedVMs = true; // Boolean | 

try {
    $result = $api_instance->getVm($vmIdentifier, $vpgIdentifier, $includeBackupedVMs);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VirtualMachinesApi->getVm: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VirtualMachinesApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VirtualMachinesApi->new();
my $vmIdentifier = vmIdentifier_example; # String | The idenfier of the VM. Related endpoint: `v1/vms`
my $vpgIdentifier = vpgIdentifier_example; # String | The identifier of the VPG. Related endpoint: `v1/vpgs`
my $includeBackupedVMs = true; # Boolean | 

eval { 
    my $result = $api_instance->getVm(vmIdentifier => $vmIdentifier, vpgIdentifier => $vpgIdentifier, includeBackupedVMs => $includeBackupedVMs);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VirtualMachinesApi->getVm: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VirtualMachinesApi()
vmIdentifier = vmIdentifier_example # String | The idenfier of the VM. Related endpoint: `v1/vms`
vpgIdentifier = vpgIdentifier_example # String | The identifier of the VPG. Related endpoint: `v1/vpgs` (optional)
includeBackupedVMs = true # Boolean |  (optional)

try: 
    # Get information about a single protected VM. VpgId may be required if VM is protected by more than one VPG. (Auth)
    api_response = api_instance.get_vm(vmIdentifier, vpgIdentifier=vpgIdentifier, includeBackupedVMs=includeBackupedVMs)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VirtualMachinesApi->getVm: %s\n" % e)

Parameters

Path parameters
Name Description
vmIdentifier*
String
The idenfier of the VM. Related endpoint: `v1/vms`
Required
Query parameters
Name Description
vpgIdentifier
String
The identifier of the VPG. Related endpoint: `v1/vpgs`
includeBackupedVMs
Boolean

Responses

Status: 200 - Success

{
link:
{
rel:
string
href:
string
type:
string
identifier:
string
}
organizationName:
string
priority:
integer (int32)
Enum: 0, 1, 2
provisionedStorageInMB:
integer (int32)
usedStorageInMB:
integer (int32)
journalUsedStorageMb:
integer (int64)
journalWarningThreshold:
{
limitType:
integer (int32)
Enum: 0, 1, 2
limitValue:
integer (int32)
}
journalHardLimit:
{
limitType:
integer (int32)
Enum: 0, 1, 2
limitValue:
integer (int32)
}
ioPs:
integer (int32)
throughputInMB:
number (double)
outgoingBandWidthInMbps:
number (double)
actualRPO:
integer (int32)
lastTest:
string (date-time)
vmIdentifier:
string
vpgName:
string
vmName:
string
volumes:
[
{
vmVolumeIdentifier:
string
}
]
Link_{0}:
{
rel:
string
href:
string
type:
string
}
sourceSite:
string
targetSite:
string
entities:
{
source:
integer (int32)
Enum: 0, 1, 2, 3, 4, 5
protected:
integer (int32)
Enum: 0, 1, 2, 3, 4, 5
target:
integer (int32)
Enum: 0, 1, 2, 3, 4, 5
recovery:
integer (int32)
Enum: 0, 1, 2, 3, 4, 5
}
status:
integer (int32)
Enum: 0, 1, 2, 3, 4, 5, 6, 7, 8
subStatus:
integer (int32)
Enum: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41
protectedSite:
{
rel:
string
href:
string
type:
string
identifier:
string
}
recoverySite:
{
rel:
string
href:
string
type:
string
identifier:
string
}
enabledActions:
{
isFlrEnabled:
boolean
}
vpgIdentifier:
string
isVmExists:
boolean
recoveryHostIdentifier:
string
recoveryHostName:
string
hardwareVersion:
string
}

getVmAll

Get information about protected virtual machines. You can filter the results with additional parameters. (Auth)


/v1/vms

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/vms?vpgName=&vmName=&status=&subStatus=&protectedSiteType=&recoverySiteType=&sourceType=&targetType=&protectedSiteIdentifier=&recoverySiteIdentifier=&sourceSite=&targetSite=&organizationName=&priority=&vmIdentifier=&includeBackupedVMs="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VirtualMachinesApi;

import java.io.File;
import java.util.*;

public class VirtualMachinesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VirtualMachinesApi apiInstance = new VirtualMachinesApi();
        String vpgName = vpgName_example; // String | The name of the VPG
        String vmName = vmName_example; // String | The name of the virtual machine
        String status = status_example; // String | The status of the VPG
        String subStatus = subStatus_example; // String | The substatus of the VPG, for example the VPG is in a bitmap sync
        String protectedSiteType = protectedSiteType_example; // String | The protected site type
        String recoverySiteType = recoverySiteType_example; // String | The recovery site environment
        String sourceType = sourceType_example; // String | Deprecated. See protectedSiteIdentifier
        String targetType = targetType_example; // String | Deprecated. See recoverySiteIdentifier
        String protectedSiteIdentifier = protectedSiteIdentifier_example; // String | The identifier of the protected site where the VPG virtual machines are
        String recoverySiteIdentifier = recoverySiteIdentifier_example; // String | The identifier of the recovery site where the VPG virtual machines are
        String sourceSite = sourceSite_example; // String | Deprecated. See protectedSiteIdentifier
        String targetSite = targetSite_example; // String | Deprecated. See recoverySiteIdentifier
        String organizationName = organizationName_example; // String | The ZORG for this VPG
        String priority = priority_example; // String | The priority specified for the VPG
        String vmIdentifier = vmIdentifier_example; // String | The identifier of the virtual machine. Format: `serverid.moref`
        Boolean includeBackupedVMs = true; // Boolean | True for including backup virtual machines. False for protected virtual machines only
        try {
            array[VmApi] result = apiInstance.getVmAll(vpgName, vmName, status, subStatus, protectedSiteType, recoverySiteType, sourceType, targetType, protectedSiteIdentifier, recoverySiteIdentifier, sourceSite, targetSite, organizationName, priority, vmIdentifier, includeBackupedVMs);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualMachinesApi#getVmAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VirtualMachinesApi;

public class VirtualMachinesApiExample {

    public static void main(String[] args) {
        VirtualMachinesApi apiInstance = new VirtualMachinesApi();
        String vpgName = vpgName_example; // String | The name of the VPG
        String vmName = vmName_example; // String | The name of the virtual machine
        String status = status_example; // String | The status of the VPG
        String subStatus = subStatus_example; // String | The substatus of the VPG, for example the VPG is in a bitmap sync
        String protectedSiteType = protectedSiteType_example; // String | The protected site type
        String recoverySiteType = recoverySiteType_example; // String | The recovery site environment
        String sourceType = sourceType_example; // String | Deprecated. See protectedSiteIdentifier
        String targetType = targetType_example; // String | Deprecated. See recoverySiteIdentifier
        String protectedSiteIdentifier = protectedSiteIdentifier_example; // String | The identifier of the protected site where the VPG virtual machines are
        String recoverySiteIdentifier = recoverySiteIdentifier_example; // String | The identifier of the recovery site where the VPG virtual machines are
        String sourceSite = sourceSite_example; // String | Deprecated. See protectedSiteIdentifier
        String targetSite = targetSite_example; // String | Deprecated. See recoverySiteIdentifier
        String organizationName = organizationName_example; // String | The ZORG for this VPG
        String priority = priority_example; // String | The priority specified for the VPG
        String vmIdentifier = vmIdentifier_example; // String | The identifier of the virtual machine. Format: `serverid.moref`
        Boolean includeBackupedVMs = true; // Boolean | True for including backup virtual machines. False for protected virtual machines only
        try {
            array[VmApi] result = apiInstance.getVmAll(vpgName, vmName, status, subStatus, protectedSiteType, recoverySiteType, sourceType, targetType, protectedSiteIdentifier, recoverySiteIdentifier, sourceSite, targetSite, organizationName, priority, vmIdentifier, includeBackupedVMs);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualMachinesApi#getVmAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *vpgName = vpgName_example; // The name of the VPG (optional)
String *vmName = vmName_example; // The name of the virtual machine (optional)
String *status = status_example; // The status of the VPG (optional)
String *subStatus = subStatus_example; // The substatus of the VPG, for example the VPG is in a bitmap sync (optional)
String *protectedSiteType = protectedSiteType_example; // The protected site type (optional)
String *recoverySiteType = recoverySiteType_example; // The recovery site environment (optional)
String *sourceType = sourceType_example; // Deprecated. See protectedSiteIdentifier (optional)
String *targetType = targetType_example; // Deprecated. See recoverySiteIdentifier (optional)
String *protectedSiteIdentifier = protectedSiteIdentifier_example; // The identifier of the protected site where the VPG virtual machines are (optional)
String *recoverySiteIdentifier = recoverySiteIdentifier_example; // The identifier of the recovery site where the VPG virtual machines are (optional)
String *sourceSite = sourceSite_example; // Deprecated. See protectedSiteIdentifier (optional)
String *targetSite = targetSite_example; // Deprecated. See recoverySiteIdentifier (optional)
String *organizationName = organizationName_example; // The ZORG for this VPG (optional)
String *priority = priority_example; // The priority specified for the VPG (optional)
String *vmIdentifier = vmIdentifier_example; // The identifier of the virtual machine. Format: `serverid.moref` (optional)
Boolean *includeBackupedVMs = true; // True for including backup virtual machines. False for protected virtual machines only (optional)

VirtualMachinesApi *apiInstance = [[VirtualMachinesApi alloc] init];

// Get information about protected virtual machines. You can filter the results with additional parameters. (Auth)
[apiInstance getVmAllWith:vpgName
    vmName:vmName
    status:status
    subStatus:subStatus
    protectedSiteType:protectedSiteType
    recoverySiteType:recoverySiteType
    sourceType:sourceType
    targetType:targetType
    protectedSiteIdentifier:protectedSiteIdentifier
    recoverySiteIdentifier:recoverySiteIdentifier
    sourceSite:sourceSite
    targetSite:targetSite
    organizationName:organizationName
    priority:priority
    vmIdentifier:vmIdentifier
    includeBackupedVMs:includeBackupedVMs
              completionHandler: ^(array[VmApi] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VirtualMachinesApi()
var opts = { 
  'vpgName': vpgName_example, // {{String}} The name of the VPG
  'vmName': vmName_example, // {{String}} The name of the virtual machine
  'status': status_example, // {{String}} The status of the VPG
  'subStatus': subStatus_example, // {{String}} The substatus of the VPG, for example the VPG is in a bitmap sync
  'protectedSiteType': protectedSiteType_example, // {{String}} The protected site type
  'recoverySiteType': recoverySiteType_example, // {{String}} The recovery site environment
  'sourceType': sourceType_example, // {{String}} Deprecated. See protectedSiteIdentifier
  'targetType': targetType_example, // {{String}} Deprecated. See recoverySiteIdentifier
  'protectedSiteIdentifier': protectedSiteIdentifier_example, // {{String}} The identifier of the protected site where the VPG virtual machines are
  'recoverySiteIdentifier': recoverySiteIdentifier_example, // {{String}} The identifier of the recovery site where the VPG virtual machines are
  'sourceSite': sourceSite_example, // {{String}} Deprecated. See protectedSiteIdentifier
  'targetSite': targetSite_example, // {{String}} Deprecated. See recoverySiteIdentifier
  'organizationName': organizationName_example, // {{String}} The ZORG for this VPG
  'priority': priority_example, // {{String}} The priority specified for the VPG
  'vmIdentifier': vmIdentifier_example, // {{String}} The identifier of the virtual machine. Format: `serverid.moref`
  'includeBackupedVMs': true // {{Boolean}} True for including backup virtual machines. False for protected virtual machines only
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVmAll(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVmAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VirtualMachinesApi();
            var vpgName = vpgName_example;  // String | The name of the VPG (optional) 
            var vmName = vmName_example;  // String | The name of the virtual machine (optional) 
            var status = status_example;  // String | The status of the VPG (optional) 
            var subStatus = subStatus_example;  // String | The substatus of the VPG, for example the VPG is in a bitmap sync (optional) 
            var protectedSiteType = protectedSiteType_example;  // String | The protected site type (optional) 
            var recoverySiteType = recoverySiteType_example;  // String | The recovery site environment (optional) 
            var sourceType = sourceType_example;  // String | Deprecated. See protectedSiteIdentifier (optional) 
            var targetType = targetType_example;  // String | Deprecated. See recoverySiteIdentifier (optional) 
            var protectedSiteIdentifier = protectedSiteIdentifier_example;  // String | The identifier of the protected site where the VPG virtual machines are (optional) 
            var recoverySiteIdentifier = recoverySiteIdentifier_example;  // String | The identifier of the recovery site where the VPG virtual machines are (optional) 
            var sourceSite = sourceSite_example;  // String | Deprecated. See protectedSiteIdentifier (optional) 
            var targetSite = targetSite_example;  // String | Deprecated. See recoverySiteIdentifier (optional) 
            var organizationName = organizationName_example;  // String | The ZORG for this VPG (optional) 
            var priority = priority_example;  // String | The priority specified for the VPG (optional) 
            var vmIdentifier = vmIdentifier_example;  // String | The identifier of the virtual machine. Format: `serverid.moref` (optional) 
            var includeBackupedVMs = true;  // Boolean | True for including backup virtual machines. False for protected virtual machines only (optional) 

            try
            {
                // Get information about protected virtual machines. You can filter the results with additional parameters. (Auth)
                array[VmApi] result = apiInstance.getVmAll(vpgName, vmName, status, subStatus, protectedSiteType, recoverySiteType, sourceType, targetType, protectedSiteIdentifier, recoverySiteIdentifier, sourceSite, targetSite, organizationName, priority, vmIdentifier, includeBackupedVMs);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VirtualMachinesApi.getVmAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVirtualMachinesApi();
$vpgName = vpgName_example; // String | The name of the VPG
$vmName = vmName_example; // String | The name of the virtual machine
$status = status_example; // String | The status of the VPG
$subStatus = subStatus_example; // String | The substatus of the VPG, for example the VPG is in a bitmap sync
$protectedSiteType = protectedSiteType_example; // String | The protected site type
$recoverySiteType = recoverySiteType_example; // String | The recovery site environment
$sourceType = sourceType_example; // String | Deprecated. See protectedSiteIdentifier
$targetType = targetType_example; // String | Deprecated. See recoverySiteIdentifier
$protectedSiteIdentifier = protectedSiteIdentifier_example; // String | The identifier of the protected site where the VPG virtual machines are
$recoverySiteIdentifier = recoverySiteIdentifier_example; // String | The identifier of the recovery site where the VPG virtual machines are
$sourceSite = sourceSite_example; // String | Deprecated. See protectedSiteIdentifier
$targetSite = targetSite_example; // String | Deprecated. See recoverySiteIdentifier
$organizationName = organizationName_example; // String | The ZORG for this VPG
$priority = priority_example; // String | The priority specified for the VPG
$vmIdentifier = vmIdentifier_example; // String | The identifier of the virtual machine. Format: `serverid.moref`
$includeBackupedVMs = true; // Boolean | True for including backup virtual machines. False for protected virtual machines only

try {
    $result = $api_instance->getVmAll($vpgName, $vmName, $status, $subStatus, $protectedSiteType, $recoverySiteType, $sourceType, $targetType, $protectedSiteIdentifier, $recoverySiteIdentifier, $sourceSite, $targetSite, $organizationName, $priority, $vmIdentifier, $includeBackupedVMs);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VirtualMachinesApi->getVmAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VirtualMachinesApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VirtualMachinesApi->new();
my $vpgName = vpgName_example; # String | The name of the VPG
my $vmName = vmName_example; # String | The name of the virtual machine
my $status = status_example; # String | The status of the VPG
my $subStatus = subStatus_example; # String | The substatus of the VPG, for example the VPG is in a bitmap sync
my $protectedSiteType = protectedSiteType_example; # String | The protected site type
my $recoverySiteType = recoverySiteType_example; # String | The recovery site environment
my $sourceType = sourceType_example; # String | Deprecated. See protectedSiteIdentifier
my $targetType = targetType_example; # String | Deprecated. See recoverySiteIdentifier
my $protectedSiteIdentifier = protectedSiteIdentifier_example; # String | The identifier of the protected site where the VPG virtual machines are
my $recoverySiteIdentifier = recoverySiteIdentifier_example; # String | The identifier of the recovery site where the VPG virtual machines are
my $sourceSite = sourceSite_example; # String | Deprecated. See protectedSiteIdentifier
my $targetSite = targetSite_example; # String | Deprecated. See recoverySiteIdentifier
my $organizationName = organizationName_example; # String | The ZORG for this VPG
my $priority = priority_example; # String | The priority specified for the VPG
my $vmIdentifier = vmIdentifier_example; # String | The identifier of the virtual machine. Format: `serverid.moref`
my $includeBackupedVMs = true; # Boolean | True for including backup virtual machines. False for protected virtual machines only

eval { 
    my $result = $api_instance->getVmAll(vpgName => $vpgName, vmName => $vmName, status => $status, subStatus => $subStatus, protectedSiteType => $protectedSiteType, recoverySiteType => $recoverySiteType, sourceType => $sourceType, targetType => $targetType, protectedSiteIdentifier => $protectedSiteIdentifier, recoverySiteIdentifier => $recoverySiteIdentifier, sourceSite => $sourceSite, targetSite => $targetSite, organizationName => $organizationName, priority => $priority, vmIdentifier => $vmIdentifier, includeBackupedVMs => $includeBackupedVMs);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VirtualMachinesApi->getVmAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VirtualMachinesApi()
vpgName = vpgName_example # String | The name of the VPG (optional)
vmName = vmName_example # String | The name of the virtual machine (optional)
status = status_example # String | The status of the VPG (optional)
subStatus = subStatus_example # String | The substatus of the VPG, for example the VPG is in a bitmap sync (optional)
protectedSiteType = protectedSiteType_example # String | The protected site type (optional)
recoverySiteType = recoverySiteType_example # String | The recovery site environment (optional)
sourceType = sourceType_example # String | Deprecated. See protectedSiteIdentifier (optional)
targetType = targetType_example # String | Deprecated. See recoverySiteIdentifier (optional)
protectedSiteIdentifier = protectedSiteIdentifier_example # String | The identifier of the protected site where the VPG virtual machines are (optional)
recoverySiteIdentifier = recoverySiteIdentifier_example # String | The identifier of the recovery site where the VPG virtual machines are (optional)
sourceSite = sourceSite_example # String | Deprecated. See protectedSiteIdentifier (optional)
targetSite = targetSite_example # String | Deprecated. See recoverySiteIdentifier (optional)
organizationName = organizationName_example # String | The ZORG for this VPG (optional)
priority = priority_example # String | The priority specified for the VPG (optional)
vmIdentifier = vmIdentifier_example # String | The identifier of the virtual machine. Format: `serverid.moref` (optional)
includeBackupedVMs = true # Boolean | True for including backup virtual machines. False for protected virtual machines only (optional)

try: 
    # Get information about protected virtual machines. You can filter the results with additional parameters. (Auth)
    api_response = api_instance.get_vm_all(vpgName=vpgName, vmName=vmName, status=status, subStatus=subStatus, protectedSiteType=protectedSiteType, recoverySiteType=recoverySiteType, sourceType=sourceType, targetType=targetType, protectedSiteIdentifier=protectedSiteIdentifier, recoverySiteIdentifier=recoverySiteIdentifier, sourceSite=sourceSite, targetSite=targetSite, organizationName=organizationName, priority=priority, vmIdentifier=vmIdentifier, includeBackupedVMs=includeBackupedVMs)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VirtualMachinesApi->getVmAll: %s\n" % e)

Parameters

Query parameters
Name Description
vpgName
String
The name of the VPG
vmName
String
The name of the virtual machine
status
String
The status of the VPG
subStatus
String
The substatus of the VPG, for example the VPG is in a bitmap sync
protectedSiteType
String
The protected site type
recoverySiteType
String
The recovery site environment
sourceType
String
Deprecated. See protectedSiteIdentifier
targetType
String
Deprecated. See recoverySiteIdentifier
protectedSiteIdentifier
String
The identifier of the protected site where the VPG virtual machines are
recoverySiteIdentifier
String
The identifier of the recovery site where the VPG virtual machines are
sourceSite
String
Deprecated. See protectedSiteIdentifier
targetSite
String
Deprecated. See recoverySiteIdentifier
organizationName
String
The ZORG for this VPG
priority
String
The priority specified for the VPG
vmIdentifier
String
The identifier of the virtual machine. Format: `serverid.moref`
includeBackupedVMs
Boolean
True for including backup virtual machines. False for protected virtual machines only

Responses

Status: 200 - Success

[
{
link:
{
rel:
string
href:
string
type:
string
identifier:
string
}
organizationName:
string
priority:
integer (int32)
Enum: 0, 1, 2
provisionedStorageInMB:
integer (int32)
usedStorageInMB:
integer (int32)
journalUsedStorageMb:
integer (int64)
journalWarningThreshold:
{
limitType:
integer (int32)
Enum: 0, 1, 2
limitValue:
integer (int32)
}
journalHardLimit:
{
limitType:
integer (int32)
Enum: 0, 1, 2
limitValue:
integer (int32)
}
ioPs:
integer (int32)
throughputInMB:
number (double)
outgoingBandWidthInMbps:
number (double)
actualRPO:
integer (int32)
lastTest:
string (date-time)
vmIdentifier:
string
vpgName:
string
vmName:
string
volumes:
[
{
vmVolumeIdentifier:
string
}
]
Link_{0}:
{
rel:
string
href:
string
type:
string
}
sourceSite:
string
targetSite:
string
entities:
{
source:
integer (int32)
Enum: 0, 1, 2, 3, 4, 5
protected:
integer (int32)
Enum: 0, 1, 2, 3, 4, 5
target:
integer (int32)
Enum: 0, 1, 2, 3, 4, 5
recovery:
integer (int32)
Enum: 0, 1, 2, 3, 4, 5
}
status:
integer (int32)
Enum: 0, 1, 2, 3, 4, 5, 6, 7, 8
subStatus:
integer (int32)
Enum: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41
protectedSite:
{
rel:
string
href:
string
type:
string
identifier:
string
}
recoverySite:
{
rel:
string
href:
string
type:
string
identifier:
string
}
enabledActions:
{
isFlrEnabled:
boolean
}
vpgIdentifier:
string
isVmExists:
boolean
recoveryHostIdentifier:
string
recoveryHostName:
string
hardwareVersion:
string
}
]

VirtualizationSites

getPublicCloudNetworkAll

Get the list of virtual networks at the site (Auth)


/v1/virtualizationsites/{siteIdentifier}/publiccloud/virtualNetworks

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/virtualizationsites/{siteIdentifier}/publiccloud/virtualNetworks?virtualNetworkIdentifier="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VirtualizationSitesApi;

import java.io.File;
import java.util.*;

public class VirtualizationSitesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VirtualizationSitesApi apiInstance = new VirtualizationSitesApi();
        String siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
        String virtualNetworkIdentifier = virtualNetworkIdentifier_example; // String | The virtual network identifier. Related endpoint: `v1/virtualizationsites/{siteIdentifier}/publiccloud/virtualNetworks`
        try {
            array[VirtualNetworkApi] result = apiInstance.getPublicCloudNetworkAll(siteIdentifier, virtualNetworkIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualizationSitesApi#getPublicCloudNetworkAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VirtualizationSitesApi;

public class VirtualizationSitesApiExample {

    public static void main(String[] args) {
        VirtualizationSitesApi apiInstance = new VirtualizationSitesApi();
        String siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
        String virtualNetworkIdentifier = virtualNetworkIdentifier_example; // String | The virtual network identifier. Related endpoint: `v1/virtualizationsites/{siteIdentifier}/publiccloud/virtualNetworks`
        try {
            array[VirtualNetworkApi] result = apiInstance.getPublicCloudNetworkAll(siteIdentifier, virtualNetworkIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualizationSitesApi#getPublicCloudNetworkAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *siteIdentifier = siteIdentifier_example; // The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
String *virtualNetworkIdentifier = virtualNetworkIdentifier_example; // The virtual network identifier. Related endpoint: `v1/virtualizationsites/{siteIdentifier}/publiccloud/virtualNetworks` (optional)

VirtualizationSitesApi *apiInstance = [[VirtualizationSitesApi alloc] init];

// Get the list of virtual networks at the site (Auth)
[apiInstance getPublicCloudNetworkAllWith:siteIdentifier
    virtualNetworkIdentifier:virtualNetworkIdentifier
              completionHandler: ^(array[VirtualNetworkApi] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VirtualizationSitesApi()
var siteIdentifier = siteIdentifier_example; // {{String}} The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
var opts = { 
  'virtualNetworkIdentifier': virtualNetworkIdentifier_example // {{String}} The virtual network identifier. Related endpoint: `v1/virtualizationsites/{siteIdentifier}/publiccloud/virtualNetworks`
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPublicCloudNetworkAll(siteIdentifier, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPublicCloudNetworkAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VirtualizationSitesApi();
            var siteIdentifier = siteIdentifier_example;  // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
            var virtualNetworkIdentifier = virtualNetworkIdentifier_example;  // String | The virtual network identifier. Related endpoint: `v1/virtualizationsites/{siteIdentifier}/publiccloud/virtualNetworks` (optional) 

            try
            {
                // Get the list of virtual networks at the site (Auth)
                array[VirtualNetworkApi] result = apiInstance.getPublicCloudNetworkAll(siteIdentifier, virtualNetworkIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VirtualizationSitesApi.getPublicCloudNetworkAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVirtualizationSitesApi();
$siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
$virtualNetworkIdentifier = virtualNetworkIdentifier_example; // String | The virtual network identifier. Related endpoint: `v1/virtualizationsites/{siteIdentifier}/publiccloud/virtualNetworks`

try {
    $result = $api_instance->getPublicCloudNetworkAll($siteIdentifier, $virtualNetworkIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VirtualizationSitesApi->getPublicCloudNetworkAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VirtualizationSitesApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VirtualizationSitesApi->new();
my $siteIdentifier = siteIdentifier_example; # String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
my $virtualNetworkIdentifier = virtualNetworkIdentifier_example; # String | The virtual network identifier. Related endpoint: `v1/virtualizationsites/{siteIdentifier}/publiccloud/virtualNetworks`

eval { 
    my $result = $api_instance->getPublicCloudNetworkAll(siteIdentifier => $siteIdentifier, virtualNetworkIdentifier => $virtualNetworkIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VirtualizationSitesApi->getPublicCloudNetworkAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VirtualizationSitesApi()
siteIdentifier = siteIdentifier_example # String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
virtualNetworkIdentifier = virtualNetworkIdentifier_example # String | The virtual network identifier. Related endpoint: `v1/virtualizationsites/{siteIdentifier}/publiccloud/virtualNetworks` (optional)

try: 
    # Get the list of virtual networks at the site (Auth)
    api_response = api_instance.get_public_cloud_network_all(siteIdentifier, virtualNetworkIdentifier=virtualNetworkIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VirtualizationSitesApi->getPublicCloudNetworkAll: %s\n" % e)

Parameters

Path parameters
Name Description
siteIdentifier*
String
The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
Required
Query parameters
Name Description
virtualNetworkIdentifier
String
The virtual network identifier. Related endpoint: `v1/virtualizationsites/{siteIdentifier}/publiccloud/virtualNetworks`

Responses

Status: 200 - Success

[
{
virtualNetworkIdentifier:
string
virtualNetworkName:
string
}
]

getPublicCloudSecurityGroupAll

Get the list of security groups at the site (Auth)


/v1/virtualizationsites/{siteIdentifier}/publiccloud/securityGroups

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/virtualizationsites/{siteIdentifier}/publiccloud/securityGroups"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VirtualizationSitesApi;

import java.io.File;
import java.util.*;

public class VirtualizationSitesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VirtualizationSitesApi apiInstance = new VirtualizationSitesApi();
        String siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
        try {
            array[SecurityGroupApi] result = apiInstance.getPublicCloudSecurityGroupAll(siteIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualizationSitesApi#getPublicCloudSecurityGroupAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VirtualizationSitesApi;

public class VirtualizationSitesApiExample {

    public static void main(String[] args) {
        VirtualizationSitesApi apiInstance = new VirtualizationSitesApi();
        String siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
        try {
            array[SecurityGroupApi] result = apiInstance.getPublicCloudSecurityGroupAll(siteIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualizationSitesApi#getPublicCloudSecurityGroupAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *siteIdentifier = siteIdentifier_example; // The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

VirtualizationSitesApi *apiInstance = [[VirtualizationSitesApi alloc] init];

// Get the list of security groups at the site (Auth)
[apiInstance getPublicCloudSecurityGroupAllWith:siteIdentifier
              completionHandler: ^(array[SecurityGroupApi] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VirtualizationSitesApi()
var siteIdentifier = siteIdentifier_example; // {{String}} The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPublicCloudSecurityGroupAll(siteIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPublicCloudSecurityGroupAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VirtualizationSitesApi();
            var siteIdentifier = siteIdentifier_example;  // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

            try
            {
                // Get the list of security groups at the site (Auth)
                array[SecurityGroupApi] result = apiInstance.getPublicCloudSecurityGroupAll(siteIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VirtualizationSitesApi.getPublicCloudSecurityGroupAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVirtualizationSitesApi();
$siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

try {
    $result = $api_instance->getPublicCloudSecurityGroupAll($siteIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VirtualizationSitesApi->getPublicCloudSecurityGroupAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VirtualizationSitesApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VirtualizationSitesApi->new();
my $siteIdentifier = siteIdentifier_example; # String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

eval { 
    my $result = $api_instance->getPublicCloudSecurityGroupAll(siteIdentifier => $siteIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VirtualizationSitesApi->getPublicCloudSecurityGroupAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VirtualizationSitesApi()
siteIdentifier = siteIdentifier_example # String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

try: 
    # Get the list of security groups at the site (Auth)
    api_response = api_instance.get_public_cloud_security_group_all(siteIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VirtualizationSitesApi->getPublicCloudSecurityGroupAll: %s\n" % e)

Parameters

Path parameters
Name Description
siteIdentifier*
String
The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
Required

Responses

Status: 200 - Success

[
{
securityGroupIdentifier:
string
securityGroupName:
string
}
]

getPublicCloudSubnetAll

Get the list of subnets at the site (Auth)


/v1/virtualizationsites/{siteIdentifier}/publiccloud/subnets

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/virtualizationsites/{siteIdentifier}/publiccloud/subnets?virtualNetworkIdentifier="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VirtualizationSitesApi;

import java.io.File;
import java.util.*;

public class VirtualizationSitesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VirtualizationSitesApi apiInstance = new VirtualizationSitesApi();
        String siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
        String virtualNetworkIdentifier = virtualNetworkIdentifier_example; // String | The virtual network identifier. Related endpoint: `v1/virtualizationsites/{siteIdentifier}/publiccloud/virtualNetworks`
        try {
            array[SubnetApi] result = apiInstance.getPublicCloudSubnetAll(siteIdentifier, virtualNetworkIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualizationSitesApi#getPublicCloudSubnetAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VirtualizationSitesApi;

public class VirtualizationSitesApiExample {

    public static void main(String[] args) {
        VirtualizationSitesApi apiInstance = new VirtualizationSitesApi();
        String siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
        String virtualNetworkIdentifier = virtualNetworkIdentifier_example; // String | The virtual network identifier. Related endpoint: `v1/virtualizationsites/{siteIdentifier}/publiccloud/virtualNetworks`
        try {
            array[SubnetApi] result = apiInstance.getPublicCloudSubnetAll(siteIdentifier, virtualNetworkIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualizationSitesApi#getPublicCloudSubnetAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *siteIdentifier = siteIdentifier_example; // The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
String *virtualNetworkIdentifier = virtualNetworkIdentifier_example; // The virtual network identifier. Related endpoint: `v1/virtualizationsites/{siteIdentifier}/publiccloud/virtualNetworks` (optional)

VirtualizationSitesApi *apiInstance = [[VirtualizationSitesApi alloc] init];

// Get the list of subnets at the site (Auth)
[apiInstance getPublicCloudSubnetAllWith:siteIdentifier
    virtualNetworkIdentifier:virtualNetworkIdentifier
              completionHandler: ^(array[SubnetApi] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VirtualizationSitesApi()
var siteIdentifier = siteIdentifier_example; // {{String}} The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
var opts = { 
  'virtualNetworkIdentifier': virtualNetworkIdentifier_example // {{String}} The virtual network identifier. Related endpoint: `v1/virtualizationsites/{siteIdentifier}/publiccloud/virtualNetworks`
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPublicCloudSubnetAll(siteIdentifier, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPublicCloudSubnetAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VirtualizationSitesApi();
            var siteIdentifier = siteIdentifier_example;  // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
            var virtualNetworkIdentifier = virtualNetworkIdentifier_example;  // String | The virtual network identifier. Related endpoint: `v1/virtualizationsites/{siteIdentifier}/publiccloud/virtualNetworks` (optional) 

            try
            {
                // Get the list of subnets at the site (Auth)
                array[SubnetApi] result = apiInstance.getPublicCloudSubnetAll(siteIdentifier, virtualNetworkIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VirtualizationSitesApi.getPublicCloudSubnetAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVirtualizationSitesApi();
$siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
$virtualNetworkIdentifier = virtualNetworkIdentifier_example; // String | The virtual network identifier. Related endpoint: `v1/virtualizationsites/{siteIdentifier}/publiccloud/virtualNetworks`

try {
    $result = $api_instance->getPublicCloudSubnetAll($siteIdentifier, $virtualNetworkIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VirtualizationSitesApi->getPublicCloudSubnetAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VirtualizationSitesApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VirtualizationSitesApi->new();
my $siteIdentifier = siteIdentifier_example; # String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
my $virtualNetworkIdentifier = virtualNetworkIdentifier_example; # String | The virtual network identifier. Related endpoint: `v1/virtualizationsites/{siteIdentifier}/publiccloud/virtualNetworks`

eval { 
    my $result = $api_instance->getPublicCloudSubnetAll(siteIdentifier => $siteIdentifier, virtualNetworkIdentifier => $virtualNetworkIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VirtualizationSitesApi->getPublicCloudSubnetAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VirtualizationSitesApi()
siteIdentifier = siteIdentifier_example # String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
virtualNetworkIdentifier = virtualNetworkIdentifier_example # String | The virtual network identifier. Related endpoint: `v1/virtualizationsites/{siteIdentifier}/publiccloud/virtualNetworks` (optional)

try: 
    # Get the list of subnets at the site (Auth)
    api_response = api_instance.get_public_cloud_subnet_all(siteIdentifier, virtualNetworkIdentifier=virtualNetworkIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VirtualizationSitesApi->getPublicCloudSubnetAll: %s\n" % e)

Parameters

Path parameters
Name Description
siteIdentifier*
String
The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
Required
Query parameters
Name Description
virtualNetworkIdentifier
String
The virtual network identifier. Related endpoint: `v1/virtualizationsites/{siteIdentifier}/publiccloud/virtualNetworks`

Responses

Status: 200 - Success

[
{
virtualNetworkIdentifier:
string
subnetIdentifier:
string
subnetName:
string
ipRange:
string
}
]

getPublicCloudVmInstanceTypeAll

Get the list of virtual machine instance types at the site (Auth)


/v1/virtualizationsites/{siteIdentifier}/publiccloud/vmInstanceTypes

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/virtualizationsites/{siteIdentifier}/publiccloud/vmInstanceTypes"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VirtualizationSitesApi;

import java.io.File;
import java.util.*;

public class VirtualizationSitesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VirtualizationSitesApi apiInstance = new VirtualizationSitesApi();
        String siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
        try {
            array[VmInstanceTypeApi] result = apiInstance.getPublicCloudVmInstanceTypeAll(siteIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualizationSitesApi#getPublicCloudVmInstanceTypeAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VirtualizationSitesApi;

public class VirtualizationSitesApiExample {

    public static void main(String[] args) {
        VirtualizationSitesApi apiInstance = new VirtualizationSitesApi();
        String siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
        try {
            array[VmInstanceTypeApi] result = apiInstance.getPublicCloudVmInstanceTypeAll(siteIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualizationSitesApi#getPublicCloudVmInstanceTypeAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *siteIdentifier = siteIdentifier_example; // The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

VirtualizationSitesApi *apiInstance = [[VirtualizationSitesApi alloc] init];

// Get the list of virtual machine instance types at the site (Auth)
[apiInstance getPublicCloudVmInstanceTypeAllWith:siteIdentifier
              completionHandler: ^(array[VmInstanceTypeApi] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VirtualizationSitesApi()
var siteIdentifier = siteIdentifier_example; // {{String}} The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPublicCloudVmInstanceTypeAll(siteIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPublicCloudVmInstanceTypeAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VirtualizationSitesApi();
            var siteIdentifier = siteIdentifier_example;  // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

            try
            {
                // Get the list of virtual machine instance types at the site (Auth)
                array[VmInstanceTypeApi] result = apiInstance.getPublicCloudVmInstanceTypeAll(siteIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VirtualizationSitesApi.getPublicCloudVmInstanceTypeAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVirtualizationSitesApi();
$siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

try {
    $result = $api_instance->getPublicCloudVmInstanceTypeAll($siteIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VirtualizationSitesApi->getPublicCloudVmInstanceTypeAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VirtualizationSitesApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VirtualizationSitesApi->new();
my $siteIdentifier = siteIdentifier_example; # String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

eval { 
    my $result = $api_instance->getPublicCloudVmInstanceTypeAll(siteIdentifier => $siteIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VirtualizationSitesApi->getPublicCloudVmInstanceTypeAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VirtualizationSitesApi()
siteIdentifier = siteIdentifier_example # String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

try: 
    # Get the list of virtual machine instance types at the site (Auth)
    api_response = api_instance.get_public_cloud_vm_instance_type_all(siteIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VirtualizationSitesApi->getPublicCloudVmInstanceTypeAll: %s\n" % e)

Parameters

Path parameters
Name Description
siteIdentifier*
String
The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
Required

Responses

Status: 200 - Success

[
{
vmInstanceType:
string
description:
string
vmSeries:
string
isPremiumSupported:
boolean
}
]

getVirtualizationSite

Get details of the site. (Auth)


/v1/virtualizationsites/{siteIdentifier}

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/virtualizationsites/{siteIdentifier}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VirtualizationSitesApi;

import java.io.File;
import java.util.*;

public class VirtualizationSitesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VirtualizationSitesApi apiInstance = new VirtualizationSitesApi();
        String siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
        try {
            VirtualizationSiteApi result = apiInstance.getVirtualizationSite(siteIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualizationSitesApi#getVirtualizationSite");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VirtualizationSitesApi;

public class VirtualizationSitesApiExample {

    public static void main(String[] args) {
        VirtualizationSitesApi apiInstance = new VirtualizationSitesApi();
        String siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
        try {
            VirtualizationSiteApi result = apiInstance.getVirtualizationSite(siteIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualizationSitesApi#getVirtualizationSite");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *siteIdentifier = siteIdentifier_example; // The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

VirtualizationSitesApi *apiInstance = [[VirtualizationSitesApi alloc] init];

// Get details of the site. (Auth)
[apiInstance getVirtualizationSiteWith:siteIdentifier
              completionHandler: ^(VirtualizationSiteApi output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VirtualizationSitesApi()
var siteIdentifier = siteIdentifier_example; // {{String}} The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVirtualizationSite(siteIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVirtualizationSiteExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VirtualizationSitesApi();
            var siteIdentifier = siteIdentifier_example;  // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

            try
            {
                // Get details of the site. (Auth)
                VirtualizationSiteApi result = apiInstance.getVirtualizationSite(siteIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VirtualizationSitesApi.getVirtualizationSite: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVirtualizationSitesApi();
$siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

try {
    $result = $api_instance->getVirtualizationSite($siteIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VirtualizationSitesApi->getVirtualizationSite: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VirtualizationSitesApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VirtualizationSitesApi->new();
my $siteIdentifier = siteIdentifier_example; # String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

eval { 
    my $result = $api_instance->getVirtualizationSite(siteIdentifier => $siteIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VirtualizationSitesApi->getVirtualizationSite: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VirtualizationSitesApi()
siteIdentifier = siteIdentifier_example # String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

try: 
    # Get details of the site. (Auth)
    api_response = api_instance.get_virtualization_site(siteIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VirtualizationSitesApi->getVirtualizationSite: %s\n" % e)

Parameters

Path parameters
Name Description
siteIdentifier*
String
The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
Required

Responses

Status: 200 - Success

{
siteIdentifier:
string
virtualizationSiteName:
string
}

getVirtualizationSiteAll

Get a list of virtual sites connected to this site and all peer sites. (Auth)


/v1/virtualizationsites

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/virtualizationsites"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VirtualizationSitesApi;

import java.io.File;
import java.util.*;

public class VirtualizationSitesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VirtualizationSitesApi apiInstance = new VirtualizationSitesApi();
        try {
            array[VirtualizationSiteApi] result = apiInstance.getVirtualizationSiteAll();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualizationSitesApi#getVirtualizationSiteAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VirtualizationSitesApi;

public class VirtualizationSitesApiExample {

    public static void main(String[] args) {
        VirtualizationSitesApi apiInstance = new VirtualizationSitesApi();
        try {
            array[VirtualizationSiteApi] result = apiInstance.getVirtualizationSiteAll();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualizationSitesApi#getVirtualizationSiteAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];

VirtualizationSitesApi *apiInstance = [[VirtualizationSitesApi alloc] init];

// Get a list of virtual sites connected to this site and all peer sites. (Auth)
[apiInstance getVirtualizationSiteAllWithCompletionHandler: 
              ^(array[VirtualizationSiteApi] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VirtualizationSitesApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVirtualizationSiteAll(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVirtualizationSiteAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VirtualizationSitesApi();

            try
            {
                // Get a list of virtual sites connected to this site and all peer sites. (Auth)
                array[VirtualizationSiteApi] result = apiInstance.getVirtualizationSiteAll();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VirtualizationSitesApi.getVirtualizationSiteAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVirtualizationSitesApi();

try {
    $result = $api_instance->getVirtualizationSiteAll();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VirtualizationSitesApi->getVirtualizationSiteAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VirtualizationSitesApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VirtualizationSitesApi->new();

eval { 
    my $result = $api_instance->getVirtualizationSiteAll();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VirtualizationSitesApi->getVirtualizationSiteAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VirtualizationSitesApi()

try: 
    # Get a list of virtual sites connected to this site and all peer sites. (Auth)
    api_response = api_instance.get_virtualization_site_all()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VirtualizationSitesApi->getVirtualizationSiteAll: %s\n" % e)

Parameters

Responses

Status: 200 - Success

[
{
siteIdentifier:
string
virtualizationSiteName:
string
}
]

getVirtualizationSiteDatastoreAll

Get information about datastores at the site (Auth)


/v1/virtualizationsites/{siteIdentifier}/datastores

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/virtualizationsites/{siteIdentifier}/datastores"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VirtualizationSitesApi;

import java.io.File;
import java.util.*;

public class VirtualizationSitesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VirtualizationSitesApi apiInstance = new VirtualizationSitesApi();
        String siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
        try {
            array[DatastoreNativeApi] result = apiInstance.getVirtualizationSiteDatastoreAll(siteIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualizationSitesApi#getVirtualizationSiteDatastoreAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VirtualizationSitesApi;

public class VirtualizationSitesApiExample {

    public static void main(String[] args) {
        VirtualizationSitesApi apiInstance = new VirtualizationSitesApi();
        String siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
        try {
            array[DatastoreNativeApi] result = apiInstance.getVirtualizationSiteDatastoreAll(siteIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualizationSitesApi#getVirtualizationSiteDatastoreAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *siteIdentifier = siteIdentifier_example; // The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

VirtualizationSitesApi *apiInstance = [[VirtualizationSitesApi alloc] init];

// Get information about datastores at the site (Auth)
[apiInstance getVirtualizationSiteDatastoreAllWith:siteIdentifier
              completionHandler: ^(array[DatastoreNativeApi] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VirtualizationSitesApi()
var siteIdentifier = siteIdentifier_example; // {{String}} The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVirtualizationSiteDatastoreAll(siteIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVirtualizationSiteDatastoreAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VirtualizationSitesApi();
            var siteIdentifier = siteIdentifier_example;  // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

            try
            {
                // Get information about datastores at the site (Auth)
                array[DatastoreNativeApi] result = apiInstance.getVirtualizationSiteDatastoreAll(siteIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VirtualizationSitesApi.getVirtualizationSiteDatastoreAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVirtualizationSitesApi();
$siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

try {
    $result = $api_instance->getVirtualizationSiteDatastoreAll($siteIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VirtualizationSitesApi->getVirtualizationSiteDatastoreAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VirtualizationSitesApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VirtualizationSitesApi->new();
my $siteIdentifier = siteIdentifier_example; # String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

eval { 
    my $result = $api_instance->getVirtualizationSiteDatastoreAll(siteIdentifier => $siteIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VirtualizationSitesApi->getVirtualizationSiteDatastoreAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VirtualizationSitesApi()
siteIdentifier = siteIdentifier_example # String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

try: 
    # Get information about datastores at the site (Auth)
    api_response = api_instance.get_virtualization_site_datastore_all(siteIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VirtualizationSitesApi->getVirtualizationSiteDatastoreAll: %s\n" % e)

Parameters

Path parameters
Name Description
siteIdentifier*
String
The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
Required

Responses

Status: 200 - Success

[
{
datastoreName:
string
datastoreIdentifier:
string
}
]

getVirtualizationSiteDatastoreClusterAll

Get the list of datastore clusters for the site (Auth)


/v1/virtualizationsites/{siteIdentifier}/datastoreclusters

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/virtualizationsites/{siteIdentifier}/datastoreclusters"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VirtualizationSitesApi;

import java.io.File;
import java.util.*;

public class VirtualizationSitesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VirtualizationSitesApi apiInstance = new VirtualizationSitesApi();
        String siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
        try {
            array[DatastoreClusterNativeApi] result = apiInstance.getVirtualizationSiteDatastoreClusterAll(siteIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualizationSitesApi#getVirtualizationSiteDatastoreClusterAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VirtualizationSitesApi;

public class VirtualizationSitesApiExample {

    public static void main(String[] args) {
        VirtualizationSitesApi apiInstance = new VirtualizationSitesApi();
        String siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
        try {
            array[DatastoreClusterNativeApi] result = apiInstance.getVirtualizationSiteDatastoreClusterAll(siteIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualizationSitesApi#getVirtualizationSiteDatastoreClusterAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *siteIdentifier = siteIdentifier_example; // The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

VirtualizationSitesApi *apiInstance = [[VirtualizationSitesApi alloc] init];

// Get the list of datastore clusters for the site (Auth)
[apiInstance getVirtualizationSiteDatastoreClusterAllWith:siteIdentifier
              completionHandler: ^(array[DatastoreClusterNativeApi] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VirtualizationSitesApi()
var siteIdentifier = siteIdentifier_example; // {{String}} The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVirtualizationSiteDatastoreClusterAll(siteIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVirtualizationSiteDatastoreClusterAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VirtualizationSitesApi();
            var siteIdentifier = siteIdentifier_example;  // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

            try
            {
                // Get the list of datastore clusters for the site (Auth)
                array[DatastoreClusterNativeApi] result = apiInstance.getVirtualizationSiteDatastoreClusterAll(siteIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VirtualizationSitesApi.getVirtualizationSiteDatastoreClusterAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVirtualizationSitesApi();
$siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

try {
    $result = $api_instance->getVirtualizationSiteDatastoreClusterAll($siteIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VirtualizationSitesApi->getVirtualizationSiteDatastoreClusterAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VirtualizationSitesApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VirtualizationSitesApi->new();
my $siteIdentifier = siteIdentifier_example; # String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

eval { 
    my $result = $api_instance->getVirtualizationSiteDatastoreClusterAll(siteIdentifier => $siteIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VirtualizationSitesApi->getVirtualizationSiteDatastoreClusterAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VirtualizationSitesApi()
siteIdentifier = siteIdentifier_example # String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

try: 
    # Get the list of datastore clusters for the site (Auth)
    api_response = api_instance.get_virtualization_site_datastore_cluster_all(siteIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VirtualizationSitesApi->getVirtualizationSiteDatastoreClusterAll: %s\n" % e)

Parameters

Path parameters
Name Description
siteIdentifier*
String
The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
Required

Responses

Status: 200 - Success

[
{
datastoreClusterName:
string
datastoreClusterIdentifier:
string
}
]

getVirtualizationSiteDeviceAll

Get a list of all avaialable devices for all available hosts in the site (Auth)


/v1/virtualizationsites/{siteIdentifier}/devices

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/virtualizationsites/{siteIdentifier}/devices?hostIdentifier=&deviceName="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VirtualizationSitesApi;

import java.io.File;
import java.util.*;

public class VirtualizationSitesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VirtualizationSitesApi apiInstance = new VirtualizationSitesApi();
        String siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
        String hostIdentifier = hostIdentifier_example; // String | The identifier of the host. Related endpoint: `/v1/virtualizationsites/{siteIdentifier}/hosts`
        String deviceName = deviceName_example; // String | The name of the device
        try {
            array[DeviceDataApi] result = apiInstance.getVirtualizationSiteDeviceAll(siteIdentifier, hostIdentifier, deviceName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualizationSitesApi#getVirtualizationSiteDeviceAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VirtualizationSitesApi;

public class VirtualizationSitesApiExample {

    public static void main(String[] args) {
        VirtualizationSitesApi apiInstance = new VirtualizationSitesApi();
        String siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
        String hostIdentifier = hostIdentifier_example; // String | The identifier of the host. Related endpoint: `/v1/virtualizationsites/{siteIdentifier}/hosts`
        String deviceName = deviceName_example; // String | The name of the device
        try {
            array[DeviceDataApi] result = apiInstance.getVirtualizationSiteDeviceAll(siteIdentifier, hostIdentifier, deviceName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualizationSitesApi#getVirtualizationSiteDeviceAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *siteIdentifier = siteIdentifier_example; // The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
String *hostIdentifier = hostIdentifier_example; // The identifier of the host. Related endpoint: `/v1/virtualizationsites/{siteIdentifier}/hosts` (optional)
String *deviceName = deviceName_example; // The name of the device (optional)

VirtualizationSitesApi *apiInstance = [[VirtualizationSitesApi alloc] init];

// Get a list of all avaialable devices for all available hosts in the site (Auth)
[apiInstance getVirtualizationSiteDeviceAllWith:siteIdentifier
    hostIdentifier:hostIdentifier
    deviceName:deviceName
              completionHandler: ^(array[DeviceDataApi] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VirtualizationSitesApi()
var siteIdentifier = siteIdentifier_example; // {{String}} The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
var opts = { 
  'hostIdentifier': hostIdentifier_example, // {{String}} The identifier of the host. Related endpoint: `/v1/virtualizationsites/{siteIdentifier}/hosts`
  'deviceName': deviceName_example // {{String}} The name of the device
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVirtualizationSiteDeviceAll(siteIdentifier, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVirtualizationSiteDeviceAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VirtualizationSitesApi();
            var siteIdentifier = siteIdentifier_example;  // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
            var hostIdentifier = hostIdentifier_example;  // String | The identifier of the host. Related endpoint: `/v1/virtualizationsites/{siteIdentifier}/hosts` (optional) 
            var deviceName = deviceName_example;  // String | The name of the device (optional) 

            try
            {
                // Get a list of all avaialable devices for all available hosts in the site (Auth)
                array[DeviceDataApi] result = apiInstance.getVirtualizationSiteDeviceAll(siteIdentifier, hostIdentifier, deviceName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VirtualizationSitesApi.getVirtualizationSiteDeviceAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVirtualizationSitesApi();
$siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
$hostIdentifier = hostIdentifier_example; // String | The identifier of the host. Related endpoint: `/v1/virtualizationsites/{siteIdentifier}/hosts`
$deviceName = deviceName_example; // String | The name of the device

try {
    $result = $api_instance->getVirtualizationSiteDeviceAll($siteIdentifier, $hostIdentifier, $deviceName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VirtualizationSitesApi->getVirtualizationSiteDeviceAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VirtualizationSitesApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VirtualizationSitesApi->new();
my $siteIdentifier = siteIdentifier_example; # String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
my $hostIdentifier = hostIdentifier_example; # String | The identifier of the host. Related endpoint: `/v1/virtualizationsites/{siteIdentifier}/hosts`
my $deviceName = deviceName_example; # String | The name of the device

eval { 
    my $result = $api_instance->getVirtualizationSiteDeviceAll(siteIdentifier => $siteIdentifier, hostIdentifier => $hostIdentifier, deviceName => $deviceName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VirtualizationSitesApi->getVirtualizationSiteDeviceAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VirtualizationSitesApi()
siteIdentifier = siteIdentifier_example # String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
hostIdentifier = hostIdentifier_example # String | The identifier of the host. Related endpoint: `/v1/virtualizationsites/{siteIdentifier}/hosts` (optional)
deviceName = deviceName_example # String | The name of the device (optional)

try: 
    # Get a list of all avaialable devices for all available hosts in the site (Auth)
    api_response = api_instance.get_virtualization_site_device_all(siteIdentifier, hostIdentifier=hostIdentifier, deviceName=deviceName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VirtualizationSitesApi->getVirtualizationSiteDeviceAll: %s\n" % e)

Parameters

Path parameters
Name Description
siteIdentifier*
String
The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
Required
Query parameters
Name Description
hostIdentifier
String
The identifier of the host. Related endpoint: `/v1/virtualizationsites/{siteIdentifier}/hosts`
deviceName
String
The name of the device

Responses

Status: 200 - Success

[
{
deviceIdentifier:
string
datastoreIdentifier:
string
deviceName:
string
sizeInBytes:
integer (int64)
hostIdentifiers:
[
string
]
vmIdentifier:
string
}
]

getVirtualizationSiteFolderAll

Get the list of folders for the site (Auth)


/v1/virtualizationsites/{siteIdentifier}/folders

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/virtualizationsites/{siteIdentifier}/folders"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VirtualizationSitesApi;

import java.io.File;
import java.util.*;

public class VirtualizationSitesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VirtualizationSitesApi apiInstance = new VirtualizationSitesApi();
        String siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
        try {
            array[FolderNativeApi] result = apiInstance.getVirtualizationSiteFolderAll(siteIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualizationSitesApi#getVirtualizationSiteFolderAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VirtualizationSitesApi;

public class VirtualizationSitesApiExample {

    public static void main(String[] args) {
        VirtualizationSitesApi apiInstance = new VirtualizationSitesApi();
        String siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
        try {
            array[FolderNativeApi] result = apiInstance.getVirtualizationSiteFolderAll(siteIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualizationSitesApi#getVirtualizationSiteFolderAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *siteIdentifier = siteIdentifier_example; // The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

VirtualizationSitesApi *apiInstance = [[VirtualizationSitesApi alloc] init];

// Get the list of folders for the site (Auth)
[apiInstance getVirtualizationSiteFolderAllWith:siteIdentifier
              completionHandler: ^(array[FolderNativeApi] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VirtualizationSitesApi()
var siteIdentifier = siteIdentifier_example; // {{String}} The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVirtualizationSiteFolderAll(siteIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVirtualizationSiteFolderAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VirtualizationSitesApi();
            var siteIdentifier = siteIdentifier_example;  // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

            try
            {
                // Get the list of folders for the site (Auth)
                array[FolderNativeApi] result = apiInstance.getVirtualizationSiteFolderAll(siteIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VirtualizationSitesApi.getVirtualizationSiteFolderAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVirtualizationSitesApi();
$siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

try {
    $result = $api_instance->getVirtualizationSiteFolderAll($siteIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VirtualizationSitesApi->getVirtualizationSiteFolderAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VirtualizationSitesApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VirtualizationSitesApi->new();
my $siteIdentifier = siteIdentifier_example; # String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

eval { 
    my $result = $api_instance->getVirtualizationSiteFolderAll(siteIdentifier => $siteIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VirtualizationSitesApi->getVirtualizationSiteFolderAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VirtualizationSitesApi()
siteIdentifier = siteIdentifier_example # String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

try: 
    # Get the list of folders for the site (Auth)
    api_response = api_instance.get_virtualization_site_folder_all(siteIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VirtualizationSitesApi->getVirtualizationSiteFolderAll: %s\n" % e)

Parameters

Path parameters
Name Description
siteIdentifier*
String
The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
Required

Responses

Status: 200 - Success

[
{
folderName:
string
folderIdentifier:
string
}
]

getVirtualizationSiteHost

Get information about specific host at the site (Auth)


/v1/virtualizationsites/{siteIdentifier}/hosts/{hostIdentifier}

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/virtualizationsites/{siteIdentifier}/hosts/{hostIdentifier}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VirtualizationSitesApi;

import java.io.File;
import java.util.*;

public class VirtualizationSitesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VirtualizationSitesApi apiInstance = new VirtualizationSitesApi();
        String siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
        String hostIdentifier = hostIdentifier_example; // String | The identifier of the host. Related endpoints: `/v1/virtualizationsites/{siteIdentifier}/hosts`
        try {
            HostNativeApi result = apiInstance.getVirtualizationSiteHost(siteIdentifier, hostIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualizationSitesApi#getVirtualizationSiteHost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VirtualizationSitesApi;

public class VirtualizationSitesApiExample {

    public static void main(String[] args) {
        VirtualizationSitesApi apiInstance = new VirtualizationSitesApi();
        String siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
        String hostIdentifier = hostIdentifier_example; // String | The identifier of the host. Related endpoints: `/v1/virtualizationsites/{siteIdentifier}/hosts`
        try {
            HostNativeApi result = apiInstance.getVirtualizationSiteHost(siteIdentifier, hostIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualizationSitesApi#getVirtualizationSiteHost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *siteIdentifier = siteIdentifier_example; // The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
String *hostIdentifier = hostIdentifier_example; // The identifier of the host. Related endpoints: `/v1/virtualizationsites/{siteIdentifier}/hosts`

VirtualizationSitesApi *apiInstance = [[VirtualizationSitesApi alloc] init];

// Get information about specific host at the site (Auth)
[apiInstance getVirtualizationSiteHostWith:siteIdentifier
    hostIdentifier:hostIdentifier
              completionHandler: ^(HostNativeApi output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VirtualizationSitesApi()
var siteIdentifier = siteIdentifier_example; // {{String}} The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
var hostIdentifier = hostIdentifier_example; // {{String}} The identifier of the host. Related endpoints: `/v1/virtualizationsites/{siteIdentifier}/hosts`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVirtualizationSiteHost(siteIdentifier, hostIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVirtualizationSiteHostExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VirtualizationSitesApi();
            var siteIdentifier = siteIdentifier_example;  // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
            var hostIdentifier = hostIdentifier_example;  // String | The identifier of the host. Related endpoints: `/v1/virtualizationsites/{siteIdentifier}/hosts`

            try
            {
                // Get information about specific host at the site (Auth)
                HostNativeApi result = apiInstance.getVirtualizationSiteHost(siteIdentifier, hostIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VirtualizationSitesApi.getVirtualizationSiteHost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVirtualizationSitesApi();
$siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
$hostIdentifier = hostIdentifier_example; // String | The identifier of the host. Related endpoints: `/v1/virtualizationsites/{siteIdentifier}/hosts`

try {
    $result = $api_instance->getVirtualizationSiteHost($siteIdentifier, $hostIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VirtualizationSitesApi->getVirtualizationSiteHost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VirtualizationSitesApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VirtualizationSitesApi->new();
my $siteIdentifier = siteIdentifier_example; # String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
my $hostIdentifier = hostIdentifier_example; # String | The identifier of the host. Related endpoints: `/v1/virtualizationsites/{siteIdentifier}/hosts`

eval { 
    my $result = $api_instance->getVirtualizationSiteHost(siteIdentifier => $siteIdentifier, hostIdentifier => $hostIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VirtualizationSitesApi->getVirtualizationSiteHost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VirtualizationSitesApi()
siteIdentifier = siteIdentifier_example # String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
hostIdentifier = hostIdentifier_example # String | The identifier of the host. Related endpoints: `/v1/virtualizationsites/{siteIdentifier}/hosts`

try: 
    # Get information about specific host at the site (Auth)
    api_response = api_instance.get_virtualization_site_host(siteIdentifier, hostIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VirtualizationSitesApi->getVirtualizationSiteHost: %s\n" % e)

Parameters

Path parameters
Name Description
siteIdentifier*
String
The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
Required
hostIdentifier*
String
The identifier of the host. Related endpoints: `/v1/virtualizationsites/{siteIdentifier}/hosts`
Required

Responses

Status: 200 - Success

{
hostIdentifier:
string
virtualizationHostName:
string
}

getVirtualizationSiteHostAll

Get information about hosts at the site (Auth)


/v1/virtualizationsites/{siteIdentifier}/hosts

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/virtualizationsites/{siteIdentifier}/hosts"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VirtualizationSitesApi;

import java.io.File;
import java.util.*;

public class VirtualizationSitesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VirtualizationSitesApi apiInstance = new VirtualizationSitesApi();
        String siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
        try {
            array[HostNativeApi] result = apiInstance.getVirtualizationSiteHostAll(siteIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualizationSitesApi#getVirtualizationSiteHostAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VirtualizationSitesApi;

public class VirtualizationSitesApiExample {

    public static void main(String[] args) {
        VirtualizationSitesApi apiInstance = new VirtualizationSitesApi();
        String siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
        try {
            array[HostNativeApi] result = apiInstance.getVirtualizationSiteHostAll(siteIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualizationSitesApi#getVirtualizationSiteHostAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *siteIdentifier = siteIdentifier_example; // The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

VirtualizationSitesApi *apiInstance = [[VirtualizationSitesApi alloc] init];

// Get information about hosts at the site (Auth)
[apiInstance getVirtualizationSiteHostAllWith:siteIdentifier
              completionHandler: ^(array[HostNativeApi] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VirtualizationSitesApi()
var siteIdentifier = siteIdentifier_example; // {{String}} The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVirtualizationSiteHostAll(siteIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVirtualizationSiteHostAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VirtualizationSitesApi();
            var siteIdentifier = siteIdentifier_example;  // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

            try
            {
                // Get information about hosts at the site (Auth)
                array[HostNativeApi] result = apiInstance.getVirtualizationSiteHostAll(siteIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VirtualizationSitesApi.getVirtualizationSiteHostAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVirtualizationSitesApi();
$siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

try {
    $result = $api_instance->getVirtualizationSiteHostAll($siteIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VirtualizationSitesApi->getVirtualizationSiteHostAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VirtualizationSitesApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VirtualizationSitesApi->new();
my $siteIdentifier = siteIdentifier_example; # String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

eval { 
    my $result = $api_instance->getVirtualizationSiteHostAll(siteIdentifier => $siteIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VirtualizationSitesApi->getVirtualizationSiteHostAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VirtualizationSitesApi()
siteIdentifier = siteIdentifier_example # String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

try: 
    # Get information about hosts at the site (Auth)
    api_response = api_instance.get_virtualization_site_host_all(siteIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VirtualizationSitesApi->getVirtualizationSiteHostAll: %s\n" % e)

Parameters

Path parameters
Name Description
siteIdentifier*
String
The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
Required

Responses

Status: 200 - Success

[
{
hostIdentifier:
string
virtualizationHostName:
string
}
]

getVirtualizationSiteHostClusterAll

Get the list of host clusters at the site (Auth)


/v1/virtualizationsites/{siteIdentifier}/hostclusters

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/virtualizationsites/{siteIdentifier}/hostclusters"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VirtualizationSitesApi;

import java.io.File;
import java.util.*;

public class VirtualizationSitesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VirtualizationSitesApi apiInstance = new VirtualizationSitesApi();
        String siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
        try {
            array[HostClusterNativeApi] result = apiInstance.getVirtualizationSiteHostClusterAll(siteIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualizationSitesApi#getVirtualizationSiteHostClusterAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VirtualizationSitesApi;

public class VirtualizationSitesApiExample {

    public static void main(String[] args) {
        VirtualizationSitesApi apiInstance = new VirtualizationSitesApi();
        String siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
        try {
            array[HostClusterNativeApi] result = apiInstance.getVirtualizationSiteHostClusterAll(siteIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualizationSitesApi#getVirtualizationSiteHostClusterAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *siteIdentifier = siteIdentifier_example; // The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

VirtualizationSitesApi *apiInstance = [[VirtualizationSitesApi alloc] init];

// Get the list of host clusters at the site (Auth)
[apiInstance getVirtualizationSiteHostClusterAllWith:siteIdentifier
              completionHandler: ^(array[HostClusterNativeApi] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VirtualizationSitesApi()
var siteIdentifier = siteIdentifier_example; // {{String}} The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVirtualizationSiteHostClusterAll(siteIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVirtualizationSiteHostClusterAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VirtualizationSitesApi();
            var siteIdentifier = siteIdentifier_example;  // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

            try
            {
                // Get the list of host clusters at the site (Auth)
                array[HostClusterNativeApi] result = apiInstance.getVirtualizationSiteHostClusterAll(siteIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VirtualizationSitesApi.getVirtualizationSiteHostClusterAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVirtualizationSitesApi();
$siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

try {
    $result = $api_instance->getVirtualizationSiteHostClusterAll($siteIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VirtualizationSitesApi->getVirtualizationSiteHostClusterAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VirtualizationSitesApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VirtualizationSitesApi->new();
my $siteIdentifier = siteIdentifier_example; # String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

eval { 
    my $result = $api_instance->getVirtualizationSiteHostClusterAll(siteIdentifier => $siteIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VirtualizationSitesApi->getVirtualizationSiteHostClusterAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VirtualizationSitesApi()
siteIdentifier = siteIdentifier_example # String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

try: 
    # Get the list of host clusters at the site (Auth)
    api_response = api_instance.get_virtualization_site_host_cluster_all(siteIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VirtualizationSitesApi->getVirtualizationSiteHostClusterAll: %s\n" % e)

Parameters

Path parameters
Name Description
siteIdentifier*
String
The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
Required

Responses

Status: 200 - Success

[
{
clusterIdentifier:
string
virtualizationClusterName:
string
}
]

getVirtualizationSiteNetworkAll

Get the list of networks (Auth)


/v1/virtualizationsites/{siteIdentifier}/networks

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/virtualizationsites/{siteIdentifier}/networks"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VirtualizationSitesApi;

import java.io.File;
import java.util.*;

public class VirtualizationSitesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VirtualizationSitesApi apiInstance = new VirtualizationSitesApi();
        String siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
        try {
            array[NetworkNativeApi] result = apiInstance.getVirtualizationSiteNetworkAll(siteIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualizationSitesApi#getVirtualizationSiteNetworkAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VirtualizationSitesApi;

public class VirtualizationSitesApiExample {

    public static void main(String[] args) {
        VirtualizationSitesApi apiInstance = new VirtualizationSitesApi();
        String siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
        try {
            array[NetworkNativeApi] result = apiInstance.getVirtualizationSiteNetworkAll(siteIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualizationSitesApi#getVirtualizationSiteNetworkAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *siteIdentifier = siteIdentifier_example; // The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

VirtualizationSitesApi *apiInstance = [[VirtualizationSitesApi alloc] init];

// Get the list of networks (Auth)
[apiInstance getVirtualizationSiteNetworkAllWith:siteIdentifier
              completionHandler: ^(array[NetworkNativeApi] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VirtualizationSitesApi()
var siteIdentifier = siteIdentifier_example; // {{String}} The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVirtualizationSiteNetworkAll(siteIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVirtualizationSiteNetworkAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VirtualizationSitesApi();
            var siteIdentifier = siteIdentifier_example;  // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

            try
            {
                // Get the list of networks (Auth)
                array[NetworkNativeApi] result = apiInstance.getVirtualizationSiteNetworkAll(siteIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VirtualizationSitesApi.getVirtualizationSiteNetworkAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVirtualizationSitesApi();
$siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

try {
    $result = $api_instance->getVirtualizationSiteNetworkAll($siteIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VirtualizationSitesApi->getVirtualizationSiteNetworkAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VirtualizationSitesApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VirtualizationSitesApi->new();
my $siteIdentifier = siteIdentifier_example; # String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

eval { 
    my $result = $api_instance->getVirtualizationSiteNetworkAll(siteIdentifier => $siteIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VirtualizationSitesApi->getVirtualizationSiteNetworkAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VirtualizationSitesApi()
siteIdentifier = siteIdentifier_example # String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

try: 
    # Get the list of networks (Auth)
    api_response = api_instance.get_virtualization_site_network_all(siteIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VirtualizationSitesApi->getVirtualizationSiteNetworkAll: %s\n" % e)

Parameters

Path parameters
Name Description
siteIdentifier*
String
The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
Required

Responses

Status: 200 - Success

[
{
virtualizationNetworkName:
string
networkIdentifier:
string
}
]

getVirtualizationSiteOrgVdcAll

Get the list of organization VDC at the site (Auth)


/v1/virtualizationsites/{siteIdentifier}/orgvdcs

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/virtualizationsites/{siteIdentifier}/orgvdcs"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VirtualizationSitesApi;

import java.io.File;
import java.util.*;

public class VirtualizationSitesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VirtualizationSitesApi apiInstance = new VirtualizationSitesApi();
        String siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
        try {
            array[OrgVdcNativeApi] result = apiInstance.getVirtualizationSiteOrgVdcAll(siteIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualizationSitesApi#getVirtualizationSiteOrgVdcAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VirtualizationSitesApi;

public class VirtualizationSitesApiExample {

    public static void main(String[] args) {
        VirtualizationSitesApi apiInstance = new VirtualizationSitesApi();
        String siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
        try {
            array[OrgVdcNativeApi] result = apiInstance.getVirtualizationSiteOrgVdcAll(siteIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualizationSitesApi#getVirtualizationSiteOrgVdcAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *siteIdentifier = siteIdentifier_example; // The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

VirtualizationSitesApi *apiInstance = [[VirtualizationSitesApi alloc] init];

// Get the list of organization VDC at the site (Auth)
[apiInstance getVirtualizationSiteOrgVdcAllWith:siteIdentifier
              completionHandler: ^(array[OrgVdcNativeApi] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VirtualizationSitesApi()
var siteIdentifier = siteIdentifier_example; // {{String}} The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVirtualizationSiteOrgVdcAll(siteIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVirtualizationSiteOrgVdcAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VirtualizationSitesApi();
            var siteIdentifier = siteIdentifier_example;  // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

            try
            {
                // Get the list of organization VDC at the site (Auth)
                array[OrgVdcNativeApi] result = apiInstance.getVirtualizationSiteOrgVdcAll(siteIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VirtualizationSitesApi.getVirtualizationSiteOrgVdcAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVirtualizationSitesApi();
$siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

try {
    $result = $api_instance->getVirtualizationSiteOrgVdcAll($siteIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VirtualizationSitesApi->getVirtualizationSiteOrgVdcAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VirtualizationSitesApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VirtualizationSitesApi->new();
my $siteIdentifier = siteIdentifier_example; # String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

eval { 
    my $result = $api_instance->getVirtualizationSiteOrgVdcAll(siteIdentifier => $siteIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VirtualizationSitesApi->getVirtualizationSiteOrgVdcAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VirtualizationSitesApi()
siteIdentifier = siteIdentifier_example # String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

try: 
    # Get the list of organization VDC at the site (Auth)
    api_response = api_instance.get_virtualization_site_org_vdc_all(siteIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VirtualizationSitesApi->getVirtualizationSiteOrgVdcAll: %s\n" % e)

Parameters

Path parameters
Name Description
siteIdentifier*
String
The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
Required

Responses

Status: 200 - Success

[
{
orgVdcName:
string
identifier:
string
}
]

getVirtualizationSiteOrgVdcNetworkAll

Get list of virtualization site networks for a specified org vDc (Auth)


/v1/virtualizationsites/{siteIdentifier}/orgvdcs/{orgVdcIdentifier}/networks

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/virtualizationsites/{siteIdentifier}/orgvdcs/{orgVdcIdentifier}/networks"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VirtualizationSitesApi;

import java.io.File;
import java.util.*;

public class VirtualizationSitesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VirtualizationSitesApi apiInstance = new VirtualizationSitesApi();
        String siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
        String orgVdcIdentifier = orgVdcIdentifier_example; // String | The identifier of the VDC org. Related endpoint: `/v1/virtualizationsites/{siteIdentifier}/orgvdcs`
        try {
            array[NetworkNativeApi] result = apiInstance.getVirtualizationSiteOrgVdcNetworkAll(siteIdentifier, orgVdcIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualizationSitesApi#getVirtualizationSiteOrgVdcNetworkAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VirtualizationSitesApi;

public class VirtualizationSitesApiExample {

    public static void main(String[] args) {
        VirtualizationSitesApi apiInstance = new VirtualizationSitesApi();
        String siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
        String orgVdcIdentifier = orgVdcIdentifier_example; // String | The identifier of the VDC org. Related endpoint: `/v1/virtualizationsites/{siteIdentifier}/orgvdcs`
        try {
            array[NetworkNativeApi] result = apiInstance.getVirtualizationSiteOrgVdcNetworkAll(siteIdentifier, orgVdcIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualizationSitesApi#getVirtualizationSiteOrgVdcNetworkAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *siteIdentifier = siteIdentifier_example; // The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
String *orgVdcIdentifier = orgVdcIdentifier_example; // The identifier of the VDC org. Related endpoint: `/v1/virtualizationsites/{siteIdentifier}/orgvdcs`

VirtualizationSitesApi *apiInstance = [[VirtualizationSitesApi alloc] init];

// Get list of virtualization site networks for a specified org vDc (Auth)
[apiInstance getVirtualizationSiteOrgVdcNetworkAllWith:siteIdentifier
    orgVdcIdentifier:orgVdcIdentifier
              completionHandler: ^(array[NetworkNativeApi] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VirtualizationSitesApi()
var siteIdentifier = siteIdentifier_example; // {{String}} The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
var orgVdcIdentifier = orgVdcIdentifier_example; // {{String}} The identifier of the VDC org. Related endpoint: `/v1/virtualizationsites/{siteIdentifier}/orgvdcs`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVirtualizationSiteOrgVdcNetworkAll(siteIdentifier, orgVdcIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVirtualizationSiteOrgVdcNetworkAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VirtualizationSitesApi();
            var siteIdentifier = siteIdentifier_example;  // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
            var orgVdcIdentifier = orgVdcIdentifier_example;  // String | The identifier of the VDC org. Related endpoint: `/v1/virtualizationsites/{siteIdentifier}/orgvdcs`

            try
            {
                // Get list of virtualization site networks for a specified org vDc (Auth)
                array[NetworkNativeApi] result = apiInstance.getVirtualizationSiteOrgVdcNetworkAll(siteIdentifier, orgVdcIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VirtualizationSitesApi.getVirtualizationSiteOrgVdcNetworkAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVirtualizationSitesApi();
$siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
$orgVdcIdentifier = orgVdcIdentifier_example; // String | The identifier of the VDC org. Related endpoint: `/v1/virtualizationsites/{siteIdentifier}/orgvdcs`

try {
    $result = $api_instance->getVirtualizationSiteOrgVdcNetworkAll($siteIdentifier, $orgVdcIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VirtualizationSitesApi->getVirtualizationSiteOrgVdcNetworkAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VirtualizationSitesApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VirtualizationSitesApi->new();
my $siteIdentifier = siteIdentifier_example; # String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
my $orgVdcIdentifier = orgVdcIdentifier_example; # String | The identifier of the VDC org. Related endpoint: `/v1/virtualizationsites/{siteIdentifier}/orgvdcs`

eval { 
    my $result = $api_instance->getVirtualizationSiteOrgVdcNetworkAll(siteIdentifier => $siteIdentifier, orgVdcIdentifier => $orgVdcIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VirtualizationSitesApi->getVirtualizationSiteOrgVdcNetworkAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VirtualizationSitesApi()
siteIdentifier = siteIdentifier_example # String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
orgVdcIdentifier = orgVdcIdentifier_example # String | The identifier of the VDC org. Related endpoint: `/v1/virtualizationsites/{siteIdentifier}/orgvdcs`

try: 
    # Get list of virtualization site networks for a specified org vDc (Auth)
    api_response = api_instance.get_virtualization_site_org_vdc_network_all(siteIdentifier, orgVdcIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VirtualizationSitesApi->getVirtualizationSiteOrgVdcNetworkAll: %s\n" % e)

Parameters

Path parameters
Name Description
siteIdentifier*
String
The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
Required
orgVdcIdentifier*
String
The identifier of the VDC org. Related endpoint: `/v1/virtualizationsites/{siteIdentifier}/orgvdcs`
Required

Responses

Status: 200 - Success

[
{
virtualizationNetworkName:
string
networkIdentifier:
string
}
]

getVirtualizationSiteRepositoryAll

Get the list of Repositories at the site (Auth)


/v1/virtualizationsites/{siteIdentifier}/repositories

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/virtualizationsites/{siteIdentifier}/repositories"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VirtualizationSitesApi;

import java.io.File;
import java.util.*;

public class VirtualizationSitesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VirtualizationSitesApi apiInstance = new VirtualizationSitesApi();
        String siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
        try {
            array[BackupTargetInfoRepositoriesApi] result = apiInstance.getVirtualizationSiteRepositoryAll(siteIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualizationSitesApi#getVirtualizationSiteRepositoryAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VirtualizationSitesApi;

public class VirtualizationSitesApiExample {

    public static void main(String[] args) {
        VirtualizationSitesApi apiInstance = new VirtualizationSitesApi();
        String siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
        try {
            array[BackupTargetInfoRepositoriesApi] result = apiInstance.getVirtualizationSiteRepositoryAll(siteIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualizationSitesApi#getVirtualizationSiteRepositoryAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *siteIdentifier = siteIdentifier_example; // The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

VirtualizationSitesApi *apiInstance = [[VirtualizationSitesApi alloc] init];

// Get the list of Repositories at the site (Auth)
[apiInstance getVirtualizationSiteRepositoryAllWith:siteIdentifier
              completionHandler: ^(array[BackupTargetInfoRepositoriesApi] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VirtualizationSitesApi()
var siteIdentifier = siteIdentifier_example; // {{String}} The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVirtualizationSiteRepositoryAll(siteIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVirtualizationSiteRepositoryAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VirtualizationSitesApi();
            var siteIdentifier = siteIdentifier_example;  // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

            try
            {
                // Get the list of Repositories at the site (Auth)
                array[BackupTargetInfoRepositoriesApi] result = apiInstance.getVirtualizationSiteRepositoryAll(siteIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VirtualizationSitesApi.getVirtualizationSiteRepositoryAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVirtualizationSitesApi();
$siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

try {
    $result = $api_instance->getVirtualizationSiteRepositoryAll($siteIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VirtualizationSitesApi->getVirtualizationSiteRepositoryAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VirtualizationSitesApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VirtualizationSitesApi->new();
my $siteIdentifier = siteIdentifier_example; # String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

eval { 
    my $result = $api_instance->getVirtualizationSiteRepositoryAll(siteIdentifier => $siteIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VirtualizationSitesApi->getVirtualizationSiteRepositoryAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VirtualizationSitesApi()
siteIdentifier = siteIdentifier_example # String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

try: 
    # Get the list of Repositories at the site (Auth)
    api_response = api_instance.get_virtualization_site_repository_all(siteIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VirtualizationSitesApi->getVirtualizationSiteRepositoryAll: %s\n" % e)

Parameters

Path parameters
Name Description
siteIdentifier*
String
The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
Required

Responses

Status: 200 - Success

[
{
repositoryIdentifier:
string
repositoryName:
string
path:
string
connectionType:
string
storageType:
string
}
]

getVirtualizationSiteResourcePoolAll

Get the list of resource pools for the site (Auth)


/v1/virtualizationsites/{siteIdentifier}/resourcepools

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/virtualizationsites/{siteIdentifier}/resourcepools"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VirtualizationSitesApi;

import java.io.File;
import java.util.*;

public class VirtualizationSitesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VirtualizationSitesApi apiInstance = new VirtualizationSitesApi();
        String siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
        try {
            array[ResourcePoolNativeApi] result = apiInstance.getVirtualizationSiteResourcePoolAll(siteIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualizationSitesApi#getVirtualizationSiteResourcePoolAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VirtualizationSitesApi;

public class VirtualizationSitesApiExample {

    public static void main(String[] args) {
        VirtualizationSitesApi apiInstance = new VirtualizationSitesApi();
        String siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
        try {
            array[ResourcePoolNativeApi] result = apiInstance.getVirtualizationSiteResourcePoolAll(siteIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualizationSitesApi#getVirtualizationSiteResourcePoolAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *siteIdentifier = siteIdentifier_example; // The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

VirtualizationSitesApi *apiInstance = [[VirtualizationSitesApi alloc] init];

// Get the list of resource pools for the site (Auth)
[apiInstance getVirtualizationSiteResourcePoolAllWith:siteIdentifier
              completionHandler: ^(array[ResourcePoolNativeApi] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VirtualizationSitesApi()
var siteIdentifier = siteIdentifier_example; // {{String}} The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVirtualizationSiteResourcePoolAll(siteIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVirtualizationSiteResourcePoolAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VirtualizationSitesApi();
            var siteIdentifier = siteIdentifier_example;  // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

            try
            {
                // Get the list of resource pools for the site (Auth)
                array[ResourcePoolNativeApi] result = apiInstance.getVirtualizationSiteResourcePoolAll(siteIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VirtualizationSitesApi.getVirtualizationSiteResourcePoolAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVirtualizationSitesApi();
$siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

try {
    $result = $api_instance->getVirtualizationSiteResourcePoolAll($siteIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VirtualizationSitesApi->getVirtualizationSiteResourcePoolAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VirtualizationSitesApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VirtualizationSitesApi->new();
my $siteIdentifier = siteIdentifier_example; # String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

eval { 
    my $result = $api_instance->getVirtualizationSiteResourcePoolAll(siteIdentifier => $siteIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VirtualizationSitesApi->getVirtualizationSiteResourcePoolAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VirtualizationSitesApi()
siteIdentifier = siteIdentifier_example # String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

try: 
    # Get the list of resource pools for the site (Auth)
    api_response = api_instance.get_virtualization_site_resource_pool_all(siteIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VirtualizationSitesApi->getVirtualizationSiteResourcePoolAll: %s\n" % e)

Parameters

Path parameters
Name Description
siteIdentifier*
String
The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
Required

Responses

Status: 200 - Success

[
{
resourcepoolName:
string
resourcePoolIdentifier:
string
}
]

getVirtualizationSiteStoragePolicyAll

Get the list of storage policies at the site (Auth)


/v1/virtualizationsites/{siteIdentifier}/orgvdcs/{orgVdcIdentifier}/storagepolicies

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/virtualizationsites/{siteIdentifier}/orgvdcs/{orgVdcIdentifier}/storagepolicies"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VirtualizationSitesApi;

import java.io.File;
import java.util.*;

public class VirtualizationSitesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VirtualizationSitesApi apiInstance = new VirtualizationSitesApi();
        String siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
        String orgVdcIdentifier = orgVdcIdentifier_example; // String | The identifier of the VDC org. Related endpoint: `/v1/virtualizationsites/{siteIdentifier}/orgvdcs`
        try {
            array[StoragePolicyApi] result = apiInstance.getVirtualizationSiteStoragePolicyAll(siteIdentifier, orgVdcIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualizationSitesApi#getVirtualizationSiteStoragePolicyAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VirtualizationSitesApi;

public class VirtualizationSitesApiExample {

    public static void main(String[] args) {
        VirtualizationSitesApi apiInstance = new VirtualizationSitesApi();
        String siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
        String orgVdcIdentifier = orgVdcIdentifier_example; // String | The identifier of the VDC org. Related endpoint: `/v1/virtualizationsites/{siteIdentifier}/orgvdcs`
        try {
            array[StoragePolicyApi] result = apiInstance.getVirtualizationSiteStoragePolicyAll(siteIdentifier, orgVdcIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualizationSitesApi#getVirtualizationSiteStoragePolicyAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *siteIdentifier = siteIdentifier_example; // The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
String *orgVdcIdentifier = orgVdcIdentifier_example; // The identifier of the VDC org. Related endpoint: `/v1/virtualizationsites/{siteIdentifier}/orgvdcs`

VirtualizationSitesApi *apiInstance = [[VirtualizationSitesApi alloc] init];

// Get the list of storage policies at the site (Auth)
[apiInstance getVirtualizationSiteStoragePolicyAllWith:siteIdentifier
    orgVdcIdentifier:orgVdcIdentifier
              completionHandler: ^(array[StoragePolicyApi] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VirtualizationSitesApi()
var siteIdentifier = siteIdentifier_example; // {{String}} The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
var orgVdcIdentifier = orgVdcIdentifier_example; // {{String}} The identifier of the VDC org. Related endpoint: `/v1/virtualizationsites/{siteIdentifier}/orgvdcs`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVirtualizationSiteStoragePolicyAll(siteIdentifier, orgVdcIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVirtualizationSiteStoragePolicyAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VirtualizationSitesApi();
            var siteIdentifier = siteIdentifier_example;  // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
            var orgVdcIdentifier = orgVdcIdentifier_example;  // String | The identifier of the VDC org. Related endpoint: `/v1/virtualizationsites/{siteIdentifier}/orgvdcs`

            try
            {
                // Get the list of storage policies at the site (Auth)
                array[StoragePolicyApi] result = apiInstance.getVirtualizationSiteStoragePolicyAll(siteIdentifier, orgVdcIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VirtualizationSitesApi.getVirtualizationSiteStoragePolicyAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVirtualizationSitesApi();
$siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
$orgVdcIdentifier = orgVdcIdentifier_example; // String | The identifier of the VDC org. Related endpoint: `/v1/virtualizationsites/{siteIdentifier}/orgvdcs`

try {
    $result = $api_instance->getVirtualizationSiteStoragePolicyAll($siteIdentifier, $orgVdcIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VirtualizationSitesApi->getVirtualizationSiteStoragePolicyAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VirtualizationSitesApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VirtualizationSitesApi->new();
my $siteIdentifier = siteIdentifier_example; # String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
my $orgVdcIdentifier = orgVdcIdentifier_example; # String | The identifier of the VDC org. Related endpoint: `/v1/virtualizationsites/{siteIdentifier}/orgvdcs`

eval { 
    my $result = $api_instance->getVirtualizationSiteStoragePolicyAll(siteIdentifier => $siteIdentifier, orgVdcIdentifier => $orgVdcIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VirtualizationSitesApi->getVirtualizationSiteStoragePolicyAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VirtualizationSitesApi()
siteIdentifier = siteIdentifier_example # String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
orgVdcIdentifier = orgVdcIdentifier_example # String | The identifier of the VDC org. Related endpoint: `/v1/virtualizationsites/{siteIdentifier}/orgvdcs`

try: 
    # Get the list of storage policies at the site (Auth)
    api_response = api_instance.get_virtualization_site_storage_policy_all(siteIdentifier, orgVdcIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VirtualizationSitesApi->getVirtualizationSiteStoragePolicyAll: %s\n" % e)

Parameters

Path parameters
Name Description
siteIdentifier*
String
The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
Required
orgVdcIdentifier*
String
The identifier of the VDC org. Related endpoint: `/v1/virtualizationsites/{siteIdentifier}/orgvdcs`
Required

Responses

Status: 200 - Success

[
{
storagePolicyIdentifier:
string
storagePolicyName:
string
isEnabled:
boolean
}
]

getVirtualizationSiteVmAll

Get the list of unprotected VMs at the site. (Auth)


/v1/virtualizationsites/{siteIdentifier}/vms

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/virtualizationsites/{siteIdentifier}/vms"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VirtualizationSitesApi;

import java.io.File;
import java.util.*;

public class VirtualizationSitesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VirtualizationSitesApi apiInstance = new VirtualizationSitesApi();
        String siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
        try {
            array[VmNativeApi] result = apiInstance.getVirtualizationSiteVmAll(siteIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualizationSitesApi#getVirtualizationSiteVmAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VirtualizationSitesApi;

public class VirtualizationSitesApiExample {

    public static void main(String[] args) {
        VirtualizationSitesApi apiInstance = new VirtualizationSitesApi();
        String siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
        try {
            array[VmNativeApi] result = apiInstance.getVirtualizationSiteVmAll(siteIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualizationSitesApi#getVirtualizationSiteVmAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *siteIdentifier = siteIdentifier_example; // The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

VirtualizationSitesApi *apiInstance = [[VirtualizationSitesApi alloc] init];

// Get the list of unprotected VMs at the site. (Auth)
[apiInstance getVirtualizationSiteVmAllWith:siteIdentifier
              completionHandler: ^(array[VmNativeApi] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VirtualizationSitesApi()
var siteIdentifier = siteIdentifier_example; // {{String}} The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVirtualizationSiteVmAll(siteIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVirtualizationSiteVmAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VirtualizationSitesApi();
            var siteIdentifier = siteIdentifier_example;  // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

            try
            {
                // Get the list of unprotected VMs at the site. (Auth)
                array[VmNativeApi] result = apiInstance.getVirtualizationSiteVmAll(siteIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VirtualizationSitesApi.getVirtualizationSiteVmAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVirtualizationSitesApi();
$siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

try {
    $result = $api_instance->getVirtualizationSiteVmAll($siteIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VirtualizationSitesApi->getVirtualizationSiteVmAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VirtualizationSitesApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VirtualizationSitesApi->new();
my $siteIdentifier = siteIdentifier_example; # String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

eval { 
    my $result = $api_instance->getVirtualizationSiteVmAll(siteIdentifier => $siteIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VirtualizationSitesApi->getVirtualizationSiteVmAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VirtualizationSitesApi()
siteIdentifier = siteIdentifier_example # String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

try: 
    # Get the list of unprotected VMs at the site. (Auth)
    api_response = api_instance.get_virtualization_site_vm_all(siteIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VirtualizationSitesApi->getVirtualizationSiteVmAll: %s\n" % e)

Parameters

Path parameters
Name Description
siteIdentifier*
String
The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
Required

Responses

Status: 200 - Success

[
{
vmName:
string
vmIdentifier:
string
}
]

getVirtualizationSiteVmVcdVappAll

Get the list of unprotected VCD vApps at the site (Auth)


/v1/virtualizationsites/{siteIdentifier}/vcdvapps

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/virtualizationsites/{siteIdentifier}/vcdvapps"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VirtualizationSitesApi;

import java.io.File;
import java.util.*;

public class VirtualizationSitesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VirtualizationSitesApi apiInstance = new VirtualizationSitesApi();
        String siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
        try {
            array[VCDVappNativeApi] result = apiInstance.getVirtualizationSiteVmVcdVappAll(siteIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualizationSitesApi#getVirtualizationSiteVmVcdVappAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VirtualizationSitesApi;

public class VirtualizationSitesApiExample {

    public static void main(String[] args) {
        VirtualizationSitesApi apiInstance = new VirtualizationSitesApi();
        String siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
        try {
            array[VCDVappNativeApi] result = apiInstance.getVirtualizationSiteVmVcdVappAll(siteIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualizationSitesApi#getVirtualizationSiteVmVcdVappAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *siteIdentifier = siteIdentifier_example; // The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

VirtualizationSitesApi *apiInstance = [[VirtualizationSitesApi alloc] init];

// Get the list of unprotected VCD vApps at the site (Auth)
[apiInstance getVirtualizationSiteVmVcdVappAllWith:siteIdentifier
              completionHandler: ^(array[VCDVappNativeApi] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VirtualizationSitesApi()
var siteIdentifier = siteIdentifier_example; // {{String}} The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVirtualizationSiteVmVcdVappAll(siteIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVirtualizationSiteVmVcdVappAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VirtualizationSitesApi();
            var siteIdentifier = siteIdentifier_example;  // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

            try
            {
                // Get the list of unprotected VCD vApps at the site (Auth)
                array[VCDVappNativeApi] result = apiInstance.getVirtualizationSiteVmVcdVappAll(siteIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VirtualizationSitesApi.getVirtualizationSiteVmVcdVappAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVirtualizationSitesApi();
$siteIdentifier = siteIdentifier_example; // String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

try {
    $result = $api_instance->getVirtualizationSiteVmVcdVappAll($siteIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VirtualizationSitesApi->getVirtualizationSiteVmVcdVappAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VirtualizationSitesApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VirtualizationSitesApi->new();
my $siteIdentifier = siteIdentifier_example; # String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

eval { 
    my $result = $api_instance->getVirtualizationSiteVmVcdVappAll(siteIdentifier => $siteIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VirtualizationSitesApi->getVirtualizationSiteVmVcdVappAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VirtualizationSitesApi()
siteIdentifier = siteIdentifier_example # String | The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`

try: 
    # Get the list of unprotected VCD vApps at the site (Auth)
    api_response = api_instance.get_virtualization_site_vm_vcd_vapp_all(siteIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VirtualizationSitesApi->getVirtualizationSiteVmVcdVappAll: %s\n" % e)

Parameters

Path parameters
Name Description
siteIdentifier*
String
The internal ZVM site identifier. Related endpoints: `v1/localsite`, `v1/peersites`
Required

Responses

Status: 200 - Success

[
{
vcdName:
string
vcdVappIdentifier:
string
}
]

Volumes

getVolumeAll

Get a list of volumes info in the current site (Auth)


/v1/volumes

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/volumes?volumeType=&vpgIdentifier=&datastoreIdentifier=&protectedVmIdentifier=&owningVmIdentifier="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VolumesApi;

import java.io.File;
import java.util.*;

public class VolumesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        VolumesApi apiInstance = new VolumesApi();
        String volumeType = volumeType_example; // String | The volume type
        String vpgIdentifier = vpgIdentifier_example; // String | The identifier of the VPG. Related endpoint: `v1/vpgs`
        String datastoreIdentifier = datastoreIdentifier_example; // String | The identifier of the datastore. Related endpoint: `/v1/datastores`
        String protectedVmIdentifier = protectedVmIdentifier_example; // String | The identifier of the protected virtual machine. Related endpoint: `v1/vms`
        String owningVmIdentifier = owningVmIdentifier_example; // String | The identifier of the owning virtual machine. Related endpoint: `v1/vms`
        try {
            array[VolumeApi] result = apiInstance.getVolumeAll(volumeType, vpgIdentifier, datastoreIdentifier, protectedVmIdentifier, owningVmIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VolumesApi#getVolumeAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VolumesApi;

public class VolumesApiExample {

    public static void main(String[] args) {
        VolumesApi apiInstance = new VolumesApi();
        String volumeType = volumeType_example; // String | The volume type
        String vpgIdentifier = vpgIdentifier_example; // String | The identifier of the VPG. Related endpoint: `v1/vpgs`
        String datastoreIdentifier = datastoreIdentifier_example; // String | The identifier of the datastore. Related endpoint: `/v1/datastores`
        String protectedVmIdentifier = protectedVmIdentifier_example; // String | The identifier of the protected virtual machine. Related endpoint: `v1/vms`
        String owningVmIdentifier = owningVmIdentifier_example; // String | The identifier of the owning virtual machine. Related endpoint: `v1/vms`
        try {
            array[VolumeApi] result = apiInstance.getVolumeAll(volumeType, vpgIdentifier, datastoreIdentifier, protectedVmIdentifier, owningVmIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VolumesApi#getVolumeAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *volumeType = volumeType_example; // The volume type (optional)
String *vpgIdentifier = vpgIdentifier_example; // The identifier of the VPG. Related endpoint: `v1/vpgs` (optional)
String *datastoreIdentifier = datastoreIdentifier_example; // The identifier of the datastore. Related endpoint: `/v1/datastores` (optional)
String *protectedVmIdentifier = protectedVmIdentifier_example; // The identifier of the protected virtual machine. Related endpoint: `v1/vms` (optional)
String *owningVmIdentifier = owningVmIdentifier_example; // The identifier of the owning virtual machine. Related endpoint: `v1/vms` (optional)

VolumesApi *apiInstance = [[VolumesApi alloc] init];

// Get a list of volumes info in the current site (Auth)
[apiInstance getVolumeAllWith:volumeType
    vpgIdentifier:vpgIdentifier
    datastoreIdentifier:datastoreIdentifier
    protectedVmIdentifier:protectedVmIdentifier
    owningVmIdentifier:owningVmIdentifier
              completionHandler: ^(array[VolumeApi] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.VolumesApi()
var opts = { 
  'volumeType': volumeType_example, // {{String}} The volume type
  'vpgIdentifier': vpgIdentifier_example, // {{String}} The identifier of the VPG. Related endpoint: `v1/vpgs`
  'datastoreIdentifier': datastoreIdentifier_example, // {{String}} The identifier of the datastore. Related endpoint: `/v1/datastores`
  'protectedVmIdentifier': protectedVmIdentifier_example, // {{String}} The identifier of the protected virtual machine. Related endpoint: `v1/vms`
  'owningVmIdentifier': owningVmIdentifier_example // {{String}} The identifier of the owning virtual machine. Related endpoint: `v1/vms`
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVolumeAll(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVolumeAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new VolumesApi();
            var volumeType = volumeType_example;  // String | The volume type (optional) 
            var vpgIdentifier = vpgIdentifier_example;  // String | The identifier of the VPG. Related endpoint: `v1/vpgs` (optional) 
            var datastoreIdentifier = datastoreIdentifier_example;  // String | The identifier of the datastore. Related endpoint: `/v1/datastores` (optional) 
            var protectedVmIdentifier = protectedVmIdentifier_example;  // String | The identifier of the protected virtual machine. Related endpoint: `v1/vms` (optional) 
            var owningVmIdentifier = owningVmIdentifier_example;  // String | The identifier of the owning virtual machine. Related endpoint: `v1/vms` (optional) 

            try
            {
                // Get a list of volumes info in the current site (Auth)
                array[VolumeApi] result = apiInstance.getVolumeAll(volumeType, vpgIdentifier, datastoreIdentifier, protectedVmIdentifier, owningVmIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VolumesApi.getVolumeAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiVolumesApi();
$volumeType = volumeType_example; // String | The volume type
$vpgIdentifier = vpgIdentifier_example; // String | The identifier of the VPG. Related endpoint: `v1/vpgs`
$datastoreIdentifier = datastoreIdentifier_example; // String | The identifier of the datastore. Related endpoint: `/v1/datastores`
$protectedVmIdentifier = protectedVmIdentifier_example; // String | The identifier of the protected virtual machine. Related endpoint: `v1/vms`
$owningVmIdentifier = owningVmIdentifier_example; // String | The identifier of the owning virtual machine. Related endpoint: `v1/vms`

try {
    $result = $api_instance->getVolumeAll($volumeType, $vpgIdentifier, $datastoreIdentifier, $protectedVmIdentifier, $owningVmIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VolumesApi->getVolumeAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VolumesApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VolumesApi->new();
my $volumeType = volumeType_example; # String | The volume type
my $vpgIdentifier = vpgIdentifier_example; # String | The identifier of the VPG. Related endpoint: `v1/vpgs`
my $datastoreIdentifier = datastoreIdentifier_example; # String | The identifier of the datastore. Related endpoint: `/v1/datastores`
my $protectedVmIdentifier = protectedVmIdentifier_example; # String | The identifier of the protected virtual machine. Related endpoint: `v1/vms`
my $owningVmIdentifier = owningVmIdentifier_example; # String | The identifier of the owning virtual machine. Related endpoint: `v1/vms`

eval { 
    my $result = $api_instance->getVolumeAll(volumeType => $volumeType, vpgIdentifier => $vpgIdentifier, datastoreIdentifier => $datastoreIdentifier, protectedVmIdentifier => $protectedVmIdentifier, owningVmIdentifier => $owningVmIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VolumesApi->getVolumeAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VolumesApi()
volumeType = volumeType_example # String | The volume type (optional)
vpgIdentifier = vpgIdentifier_example # String | The identifier of the VPG. Related endpoint: `v1/vpgs` (optional)
datastoreIdentifier = datastoreIdentifier_example # String | The identifier of the datastore. Related endpoint: `/v1/datastores` (optional)
protectedVmIdentifier = protectedVmIdentifier_example # String | The identifier of the protected virtual machine. Related endpoint: `v1/vms` (optional)
owningVmIdentifier = owningVmIdentifier_example # String | The identifier of the owning virtual machine. Related endpoint: `v1/vms` (optional)

try: 
    # Get a list of volumes info in the current site (Auth)
    api_response = api_instance.get_volume_all(volumeType=volumeType, vpgIdentifier=vpgIdentifier, datastoreIdentifier=datastoreIdentifier, protectedVmIdentifier=protectedVmIdentifier, owningVmIdentifier=owningVmIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VolumesApi->getVolumeAll: %s\n" % e)

Parameters

Query parameters
Name Description
volumeType
String
The volume type
vpgIdentifier
String
The identifier of the VPG. Related endpoint: `v1/vpgs`
datastoreIdentifier
String
The identifier of the datastore. Related endpoint: `/v1/datastores`
protectedVmIdentifier
String
The identifier of the protected virtual machine. Related endpoint: `v1/vms`
owningVmIdentifier
String
The identifier of the owning virtual machine. Related endpoint: `v1/vms`

Responses

Status: 200 - Success

[
{
volumeType:
string
isThinProvisioned:
boolean
volumeIdentifier:
string
path:
{
full:
string
relative:
string
fileName:
string
}
size:
{
usedInBytes:
integer (int64)
provisionedInBytes:
integer (int64)
}
datastore:
{
identifier:
string
name:
string
}
owningVm:
{
identifier:
string
name:
string
}
protectedVm:
{
identifier:
string
name:
string
}
vpg:
{
identifier:
string
name:
string
}
}
]

ZORGSZertoOrganizations

getZorg

Get details of a specific ZORG. (Auth)


/v1/zorgs/{zorgIdentifier}

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/zorgs/{zorgIdentifier}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ZORGSZertoOrganizationsApi;

import java.io.File;
import java.util.*;

public class ZORGSZertoOrganizationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        ZORGSZertoOrganizationsApi apiInstance = new ZORGSZertoOrganizationsApi();
        String zorgIdentifier = zorgIdentifier_example; // String | The identifier or the ZORG. Related endpoint `/v1/zorgs`
        try {
            ZorgApi result = apiInstance.getZorg(zorgIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ZORGSZertoOrganizationsApi#getZorg");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ZORGSZertoOrganizationsApi;

public class ZORGSZertoOrganizationsApiExample {

    public static void main(String[] args) {
        ZORGSZertoOrganizationsApi apiInstance = new ZORGSZertoOrganizationsApi();
        String zorgIdentifier = zorgIdentifier_example; // String | The identifier or the ZORG. Related endpoint `/v1/zorgs`
        try {
            ZorgApi result = apiInstance.getZorg(zorgIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ZORGSZertoOrganizationsApi#getZorg");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *zorgIdentifier = zorgIdentifier_example; // The identifier or the ZORG. Related endpoint `/v1/zorgs`

ZORGSZertoOrganizationsApi *apiInstance = [[ZORGSZertoOrganizationsApi alloc] init];

// Get details of a specific ZORG. (Auth)
[apiInstance getZorgWith:zorgIdentifier
              completionHandler: ^(ZorgApi output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.ZORGSZertoOrganizationsApi()
var zorgIdentifier = zorgIdentifier_example; // {{String}} The identifier or the ZORG. Related endpoint `/v1/zorgs`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getZorg(zorgIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getZorgExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new ZORGSZertoOrganizationsApi();
            var zorgIdentifier = zorgIdentifier_example;  // String | The identifier or the ZORG. Related endpoint `/v1/zorgs`

            try
            {
                // Get details of a specific ZORG. (Auth)
                ZorgApi result = apiInstance.getZorg(zorgIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ZORGSZertoOrganizationsApi.getZorg: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiZORGSZertoOrganizationsApi();
$zorgIdentifier = zorgIdentifier_example; // String | The identifier or the ZORG. Related endpoint `/v1/zorgs`

try {
    $result = $api_instance->getZorg($zorgIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ZORGSZertoOrganizationsApi->getZorg: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ZORGSZertoOrganizationsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ZORGSZertoOrganizationsApi->new();
my $zorgIdentifier = zorgIdentifier_example; # String | The identifier or the ZORG. Related endpoint `/v1/zorgs`

eval { 
    my $result = $api_instance->getZorg(zorgIdentifier => $zorgIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ZORGSZertoOrganizationsApi->getZorg: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ZORGSZertoOrganizationsApi()
zorgIdentifier = zorgIdentifier_example # String | The identifier or the ZORG. Related endpoint `/v1/zorgs`

try: 
    # Get details of a specific ZORG. (Auth)
    api_response = api_instance.get_zorg(zorgIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ZORGSZertoOrganizationsApi->getZorg: %s\n" % e)

Parameters

Path parameters
Name Description
zorgIdentifier*
String
The identifier or the ZORG. Related endpoint `/v1/zorgs`
Required

Responses

Status: 200 - Success

{
link:
{
rel:
string
href:
string
type:
string
identifier:
string
}
zorgIdentifier:
string
zorgName:
string
}

getZorgAll

Get the list of all the ZORGs defined in the Zerto Cloud Manager for this site. (Auth)


/v1/zorgs

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/zorgs"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ZORGSZertoOrganizationsApi;

import java.io.File;
import java.util.*;

public class ZORGSZertoOrganizationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        ZORGSZertoOrganizationsApi apiInstance = new ZORGSZertoOrganizationsApi();
        try {
            array[ZorgApi] result = apiInstance.getZorgAll();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ZORGSZertoOrganizationsApi#getZorgAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ZORGSZertoOrganizationsApi;

public class ZORGSZertoOrganizationsApiExample {

    public static void main(String[] args) {
        ZORGSZertoOrganizationsApi apiInstance = new ZORGSZertoOrganizationsApi();
        try {
            array[ZorgApi] result = apiInstance.getZorgAll();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ZORGSZertoOrganizationsApi#getZorgAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];

ZORGSZertoOrganizationsApi *apiInstance = [[ZORGSZertoOrganizationsApi alloc] init];

// Get the list of all the ZORGs defined in the Zerto Cloud Manager for this site. (Auth)
[apiInstance getZorgAllWithCompletionHandler: 
              ^(array[ZorgApi] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.ZORGSZertoOrganizationsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getZorgAll(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getZorgAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new ZORGSZertoOrganizationsApi();

            try
            {
                // Get the list of all the ZORGs defined in the Zerto Cloud Manager for this site. (Auth)
                array[ZorgApi] result = apiInstance.getZorgAll();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ZORGSZertoOrganizationsApi.getZorgAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiZORGSZertoOrganizationsApi();

try {
    $result = $api_instance->getZorgAll();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ZORGSZertoOrganizationsApi->getZorgAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ZORGSZertoOrganizationsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ZORGSZertoOrganizationsApi->new();

eval { 
    my $result = $api_instance->getZorgAll();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ZORGSZertoOrganizationsApi->getZorgAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ZORGSZertoOrganizationsApi()

try: 
    # Get the list of all the ZORGs defined in the Zerto Cloud Manager for this site. (Auth)
    api_response = api_instance.get_zorg_all()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ZORGSZertoOrganizationsApi->getZorgAll: %s\n" % e)

Parameters

Responses

Status: 200 - Success

[
{
link:
{
rel:
string
href:
string
type:
string
identifier:
string
}
zorgIdentifier:
string
zorgName:
string
}
]

ZSSPZertoSelfServicePortalSessions

connectZssp

Create a ZSSP session. (Auth)


/v1/zsspsessions

Usage and SDK Samples

curl -X POST\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
-H "Content-Type: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/zsspsessions"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ZSSPZertoSelfServicePortalSessionsApi;

import java.io.File;
import java.util.*;

public class ZSSPZertoSelfServicePortalSessionsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        ZSSPZertoSelfServicePortalSessionsApi apiInstance = new ZSSPZertoSelfServicePortalSessionsApi();
        ZsspSessionsApi body = ; // ZsspSessionsApi | 
        try {
            'String' result = apiInstance.connectZssp(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ZSSPZertoSelfServicePortalSessionsApi#connectZssp");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ZSSPZertoSelfServicePortalSessionsApi;

public class ZSSPZertoSelfServicePortalSessionsApiExample {

    public static void main(String[] args) {
        ZSSPZertoSelfServicePortalSessionsApi apiInstance = new ZSSPZertoSelfServicePortalSessionsApi();
        ZsspSessionsApi body = ; // ZsspSessionsApi | 
        try {
            'String' result = apiInstance.connectZssp(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ZSSPZertoSelfServicePortalSessionsApi#connectZssp");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
ZsspSessionsApi *body = ; //  (optional)

ZSSPZertoSelfServicePortalSessionsApi *apiInstance = [[ZSSPZertoSelfServicePortalSessionsApi alloc] init];

// Create a ZSSP session. (Auth)
[apiInstance connectZsspWith:body
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.ZSSPZertoSelfServicePortalSessionsApi()
var opts = { 
  'body':  // {{ZsspSessionsApi}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.connectZssp(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class connectZsspExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new ZSSPZertoSelfServicePortalSessionsApi();
            var body = new ZsspSessionsApi(); // ZsspSessionsApi |  (optional) 

            try
            {
                // Create a ZSSP session. (Auth)
                'String' result = apiInstance.connectZssp(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ZSSPZertoSelfServicePortalSessionsApi.connectZssp: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiZSSPZertoSelfServicePortalSessionsApi();
$body = ; // ZsspSessionsApi | 

try {
    $result = $api_instance->connectZssp($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ZSSPZertoSelfServicePortalSessionsApi->connectZssp: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ZSSPZertoSelfServicePortalSessionsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ZSSPZertoSelfServicePortalSessionsApi->new();
my $body = WWW::SwaggerClient::Object::ZsspSessionsApi->new(); # ZsspSessionsApi | 

eval { 
    my $result = $api_instance->connectZssp(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ZSSPZertoSelfServicePortalSessionsApi->connectZssp: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ZSSPZertoSelfServicePortalSessionsApi()
body =  # ZsspSessionsApi |  (optional)

try: 
    # Create a ZSSP session. (Auth)
    api_response = api_instance.connect_zssp(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ZSSPZertoSelfServicePortalSessionsApi->connectZssp: %s\n" % e)

Parameters

Body parameters
Name Description
body
{
Required: zorgIdentifier,zsspAddress
zorgIdentifier:
string
zsspAddress:
string
logoutRedirectUrl:
string
zorgUserName:
string
}

Responses

Status: 200 - Success

string

disconnectZssp

Delete a ZSSP session. (Auth)


/v1/zsspsessions/{zsspSessionIdentifier}

Usage and SDK Samples

curl -X DELETE\
-H "x-zerto-session: [[apiKey]]"\
"https://localhost:9669//v1/zsspsessions/{zsspSessionIdentifier}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ZSSPZertoSelfServicePortalSessionsApi;

import java.io.File;
import java.util.*;

public class ZSSPZertoSelfServicePortalSessionsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        ZSSPZertoSelfServicePortalSessionsApi apiInstance = new ZSSPZertoSelfServicePortalSessionsApi();
        String zsspSessionIdentifier = zsspSessionIdentifier_example; // String | Zssp session identifier. Realted endpoint `/v1/zsspsessions`
        try {
            apiInstance.disconnectZssp(zsspSessionIdentifier);
        } catch (ApiException e) {
            System.err.println("Exception when calling ZSSPZertoSelfServicePortalSessionsApi#disconnectZssp");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ZSSPZertoSelfServicePortalSessionsApi;

public class ZSSPZertoSelfServicePortalSessionsApiExample {

    public static void main(String[] args) {
        ZSSPZertoSelfServicePortalSessionsApi apiInstance = new ZSSPZertoSelfServicePortalSessionsApi();
        String zsspSessionIdentifier = zsspSessionIdentifier_example; // String | Zssp session identifier. Realted endpoint `/v1/zsspsessions`
        try {
            apiInstance.disconnectZssp(zsspSessionIdentifier);
        } catch (ApiException e) {
            System.err.println("Exception when calling ZSSPZertoSelfServicePortalSessionsApi#disconnectZssp");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *zsspSessionIdentifier = zsspSessionIdentifier_example; // Zssp session identifier. Realted endpoint `/v1/zsspsessions`

ZSSPZertoSelfServicePortalSessionsApi *apiInstance = [[ZSSPZertoSelfServicePortalSessionsApi alloc] init];

// Delete a ZSSP session. (Auth)
[apiInstance disconnectZsspWith:zsspSessionIdentifier
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.ZSSPZertoSelfServicePortalSessionsApi()
var zsspSessionIdentifier = zsspSessionIdentifier_example; // {{String}} Zssp session identifier. Realted endpoint `/v1/zsspsessions`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.disconnectZssp(zsspSessionIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class disconnectZsspExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new ZSSPZertoSelfServicePortalSessionsApi();
            var zsspSessionIdentifier = zsspSessionIdentifier_example;  // String | Zssp session identifier. Realted endpoint `/v1/zsspsessions`

            try
            {
                // Delete a ZSSP session. (Auth)
                apiInstance.disconnectZssp(zsspSessionIdentifier);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ZSSPZertoSelfServicePortalSessionsApi.disconnectZssp: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiZSSPZertoSelfServicePortalSessionsApi();
$zsspSessionIdentifier = zsspSessionIdentifier_example; // String | Zssp session identifier. Realted endpoint `/v1/zsspsessions`

try {
    $api_instance->disconnectZssp($zsspSessionIdentifier);
} catch (Exception $e) {
    echo 'Exception when calling ZSSPZertoSelfServicePortalSessionsApi->disconnectZssp: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ZSSPZertoSelfServicePortalSessionsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ZSSPZertoSelfServicePortalSessionsApi->new();
my $zsspSessionIdentifier = zsspSessionIdentifier_example; # String | Zssp session identifier. Realted endpoint `/v1/zsspsessions`

eval { 
    $api_instance->disconnectZssp(zsspSessionIdentifier => $zsspSessionIdentifier);
};
if ($@) {
    warn "Exception when calling ZSSPZertoSelfServicePortalSessionsApi->disconnectZssp: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ZSSPZertoSelfServicePortalSessionsApi()
zsspSessionIdentifier = zsspSessionIdentifier_example # String | Zssp session identifier. Realted endpoint `/v1/zsspsessions`

try: 
    # Delete a ZSSP session. (Auth)
    api_instance.disconnect_zssp(zsspSessionIdentifier)
except ApiException as e:
    print("Exception when calling ZSSPZertoSelfServicePortalSessionsApi->disconnectZssp: %s\n" % e)

Parameters

Path parameters
Name Description
zsspSessionIdentifier*
String
Zssp session identifier. Realted endpoint `/v1/zsspsessions`
Required

Responses

Status: 200 - Success


getZsspSession

Get details of a ZSSP session (Auth)


/v1/zsspsessions/{zsspSessionIdentifier}

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/zsspsessions/{zsspSessionIdentifier}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ZSSPZertoSelfServicePortalSessionsApi;

import java.io.File;
import java.util.*;

public class ZSSPZertoSelfServicePortalSessionsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        ZSSPZertoSelfServicePortalSessionsApi apiInstance = new ZSSPZertoSelfServicePortalSessionsApi();
        String zsspSessionIdentifier = zsspSessionIdentifier_example; // String | Zssp session identifier. Realted endpoint `/v1/zsspsessions`
        try {
            ZsspSessionDetailsApi result = apiInstance.getZsspSession(zsspSessionIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ZSSPZertoSelfServicePortalSessionsApi#getZsspSession");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ZSSPZertoSelfServicePortalSessionsApi;

public class ZSSPZertoSelfServicePortalSessionsApiExample {

    public static void main(String[] args) {
        ZSSPZertoSelfServicePortalSessionsApi apiInstance = new ZSSPZertoSelfServicePortalSessionsApi();
        String zsspSessionIdentifier = zsspSessionIdentifier_example; // String | Zssp session identifier. Realted endpoint `/v1/zsspsessions`
        try {
            ZsspSessionDetailsApi result = apiInstance.getZsspSession(zsspSessionIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ZSSPZertoSelfServicePortalSessionsApi#getZsspSession");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];
String *zsspSessionIdentifier = zsspSessionIdentifier_example; // Zssp session identifier. Realted endpoint `/v1/zsspsessions`

ZSSPZertoSelfServicePortalSessionsApi *apiInstance = [[ZSSPZertoSelfServicePortalSessionsApi alloc] init];

// Get details of a ZSSP session (Auth)
[apiInstance getZsspSessionWith:zsspSessionIdentifier
              completionHandler: ^(ZsspSessionDetailsApi output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.ZSSPZertoSelfServicePortalSessionsApi()
var zsspSessionIdentifier = zsspSessionIdentifier_example; // {{String}} Zssp session identifier. Realted endpoint `/v1/zsspsessions`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getZsspSession(zsspSessionIdentifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getZsspSessionExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new ZSSPZertoSelfServicePortalSessionsApi();
            var zsspSessionIdentifier = zsspSessionIdentifier_example;  // String | Zssp session identifier. Realted endpoint `/v1/zsspsessions`

            try
            {
                // Get details of a ZSSP session (Auth)
                ZsspSessionDetailsApi result = apiInstance.getZsspSession(zsspSessionIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ZSSPZertoSelfServicePortalSessionsApi.getZsspSession: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiZSSPZertoSelfServicePortalSessionsApi();
$zsspSessionIdentifier = zsspSessionIdentifier_example; // String | Zssp session identifier. Realted endpoint `/v1/zsspsessions`

try {
    $result = $api_instance->getZsspSession($zsspSessionIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ZSSPZertoSelfServicePortalSessionsApi->getZsspSession: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ZSSPZertoSelfServicePortalSessionsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ZSSPZertoSelfServicePortalSessionsApi->new();
my $zsspSessionIdentifier = zsspSessionIdentifier_example; # String | Zssp session identifier. Realted endpoint `/v1/zsspsessions`

eval { 
    my $result = $api_instance->getZsspSession(zsspSessionIdentifier => $zsspSessionIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ZSSPZertoSelfServicePortalSessionsApi->getZsspSession: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ZSSPZertoSelfServicePortalSessionsApi()
zsspSessionIdentifier = zsspSessionIdentifier_example # String | Zssp session identifier. Realted endpoint `/v1/zsspsessions`

try: 
    # Get details of a ZSSP session (Auth)
    api_response = api_instance.get_zssp_session(zsspSessionIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ZSSPZertoSelfServicePortalSessionsApi->getZsspSession: %s\n" % e)

Parameters

Path parameters
Name Description
zsspSessionIdentifier*
String
Zssp session identifier. Realted endpoint `/v1/zsspsessions`
Required

Responses

Status: 200 - Success

{
creationTime:
string
logoutRedirectUrl:
string
zorgUserName:
string
zsspSessionIdentifier:
string
url:
string
zorgIdentifier:
string
zsspAddress:
string
}

getZsspSessionAll

Get details of all ZSSP sessions (Auth)


/v1/zsspsessions

Usage and SDK Samples

curl -X GET\
-H "x-zerto-session: [[apiKey]]"\
-H "Accept: application/json,application/xml,text/xml"\
"https://localhost:9669//v1/zsspsessions"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ZSSPZertoSelfServicePortalSessionsApi;

import java.io.File;
import java.util.*;

public class ZSSPZertoSelfServicePortalSessionsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        ZSSPZertoSelfServicePortalSessionsApi apiInstance = new ZSSPZertoSelfServicePortalSessionsApi();
        try {
            array[ZsspSessionDetailsApi] result = apiInstance.getZsspSessionAll();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ZSSPZertoSelfServicePortalSessionsApi#getZsspSessionAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ZSSPZertoSelfServicePortalSessionsApi;

public class ZSSPZertoSelfServicePortalSessionsApiExample {

    public static void main(String[] args) {
        ZSSPZertoSelfServicePortalSessionsApi apiInstance = new ZSSPZertoSelfServicePortalSessionsApi();
        try {
            array[ZsspSessionDetailsApi] result = apiInstance.getZsspSessionAll();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ZSSPZertoSelfServicePortalSessionsApi#getZsspSessionAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-zerto-session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-zerto-session"];

ZSSPZertoSelfServicePortalSessionsApi *apiInstance = [[ZSSPZertoSelfServicePortalSessionsApi alloc] init];

// Get details of all ZSSP sessions (Auth)
[apiInstance getZsspSessionAllWithCompletionHandler: 
              ^(array[ZsspSessionDetailsApi] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ZvmRestApi = require('zvm_rest_api');
var defaultClient = ZvmRestApi.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['x-zerto-session'] = "Token"

var api = new ZvmRestApi.ZSSPZertoSelfServicePortalSessionsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getZsspSessionAll(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getZsspSessionAllExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("x-zerto-session", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-zerto-session", "Bearer");

            var apiInstance = new ZSSPZertoSelfServicePortalSessionsApi();

            try
            {
                // Get details of all ZSSP sessions (Auth)
                array[ZsspSessionDetailsApi] result = apiInstance.getZsspSessionAll();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ZSSPZertoSelfServicePortalSessionsApi.getZsspSessionAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-zerto-session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-zerto-session', 'Bearer');

$api_instance = new Swagger\Client\ApiZSSPZertoSelfServicePortalSessionsApi();

try {
    $result = $api_instance->getZsspSessionAll();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ZSSPZertoSelfServicePortalSessionsApi->getZsspSessionAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ZSSPZertoSelfServicePortalSessionsApi;

# Configure API key authorization: ApiKey
$WWW::SwaggerClient::Configuration::api_key->{'x-zerto-session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-zerto-session'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ZSSPZertoSelfServicePortalSessionsApi->new();

eval { 
    my $result = $api_instance->getZsspSessionAll();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ZSSPZertoSelfServicePortalSessionsApi->getZsspSessionAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
swagger_client.configuration.api_key['x-zerto-session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-zerto-session'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ZSSPZertoSelfServicePortalSessionsApi()

try: 
    # Get details of all ZSSP sessions (Auth)
    api_response = api_instance.get_zssp_session_all()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ZSSPZertoSelfServicePortalSessionsApi->getZsspSessionAll: %s\n" % e)

Parameters

Responses

Status: 200 - Success

[
{
creationTime:
string
logoutRedirectUrl:
string
zorgUserName:
string
zsspSessionIdentifier:
string
url:
string
zorgIdentifier:
string
zsspAddress:
string
}
]