Dell NetWorker 18.2 Software REST API Reference Guide PDF
Summary of Content for Dell NetWorker 18.2 Software REST API Reference Guide PDF
Dell EMC NetWorker Version 18.2
REST API Reference Guide 302-005-331
REV 01
Copyright 1990-2018 Dell Inc. or its subsidiaries All rights reserved.
Published December, 2018
Dell believes the information in this publication is accurate as of its publication date. The information is subject to change without notice.
THE INFORMATION IN THIS PUBLICATION IS PROVIDED AS-IS. DELL MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND
WITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND SPECIFICALLY DISCLAIMS IMPLIED WARRANTIES OF
MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. USE, COPYING, AND DISTRIBUTION OF ANY DELL SOFTWARE DESCRIBED
IN THIS PUBLICATION REQUIRES AN APPLICABLE SOFTWARE LICENSE.
Dell Technologies, Dell, EMC, Dell EMC and other trademarks are trademarks of Dell Inc. or its subsidiaries. Other trademarks may be the property
of their respective owners. Published in the USA.
Dell EMC Hopkinton, Massachusetts 01748-9103 1-508-435-1000 In North America 1-866-464-7381 www.DellEMC.com
2 NetWorker 18.2 REST API Reference Guide
Preface
As part of an effort to improve its product lines, Dell EMC periodically releases revisions of its software and hardware. Therefore, some functions that are described in this document might not be supported by all versions of the software or hardware currently in use. The product release notes provide the most up-to-date information on product features.
Contact your Dell EMC technical support professional if a product does not function correctly or does not function as described in this document.
Note
This document was accurate at publication time. Go to Dell EMC Online Support (https://support.emc.com) to ensure that you are using the latest version of this document.
Purpose This document describes how to configure and use NetWorker REST API.
Audience This guide is part of the NetWorker documentation set, and is intended for use by developers who are creating programmatic interfaces to NetWorker systems.
Revision history The following table presents the revision history of this document.
Table 1 Revision history
Revision Date Description
01 December 14, 2018 First release of the document for NetWorker 18.2.
Related documentation The NetWorker documentation set includes the following publications, available on the Support website:
l NetWorker E-LAB Navigator Provides compatibility information, including specific software and hardware configurations that NetWorker supports. To access E-LAB Navigator, go to https://elabnavigator.emc.com/eln/elnhome.
l NetWorker Administration Guide Describes how to configure and maintain the NetWorker software.
l NetWorker Network Data Management Protocol (NDMP) User Guide Describes how to use the NetWorker software to provide data protection for NDMP filers.
l NetWorker Cluster Integration Guide Contains information related to configuring NetWorker software on cluster servers and clients.
l NetWorker Installation Guide Provides information on how to install, uninstall, and update the NetWorker software for clients, storage nodes, and servers on all supported operating systems.
Preface 3
l NetWorker Updating from a Previous Release Guide Describes how to update the NetWorker software from a previously installed release.
l NetWorker Release Notes Contains information on new features and changes, fixed problems, known limitations, environment and system requirements for the latest NetWorker software release.
l NetWorker Command Reference Guide Provides reference information for NetWorker commands and options.
l NetWorker Data Domain Boost Integration Guide Provides planning and configuration information on the use of Data Domain devices for data deduplication backup and storage in a NetWorker environment.
l NetWorker Performance Optimization Planning Guide Contains basic performance tuning information for NetWorker.
l NetWorker Server Disaster Recovery and Availability Best Practices Guide Describes how to design, plan for, and perform a step-by-step NetWorker disaster recovery.
l NetWorker Snapshot Management Integration Guide Describes the ability to catalog and manage snapshot copies of production data that are created by using mirror technologies on storage arrays.
l NetWorkerSnapshot Management for NAS Devices Integration Guide Describes how to catalog and manage snapshot copies of production data that are created by using replication technologies on NAS devices.
l NetWorker Security Configuration Guide Provides an overview of security configuration settings available in NetWorker, secure deployment, and physical security controls needed to ensure the secure operation of the product.
l NetWorker VMware Integration Guide Provides planning and configuration information on the use of VMware in a NetWorker environment.
l NetWorker Error Message Guide Provides information on common NetWorker error messages.
l NetWorker Licensing Guide Provides information about licensing NetWorker products and features.
l NetWorker REST API Getting Started Guide Describes how to configure and use the NetWorker REST API to create programmatic interfaces to the NetWorker server.
l NetWorker REST API Reference Guide Provides the NetWorker REST API specification used to create programmatic interfaces to the NetWorker server.
l NetWorker 18.2 with CloudBoost 18.2 Integration Guide Describes the integration of NetWorker with CloudBoost.
l NetWorker 18.2 with CloudBoost 18.2 Security Configuration Guide Provides an overview of security configuration settings available in NetWorker and Cloud Boost, secure deployment, and physical security controls needed to ensure the secure operation of the product.
l NetWorker Management Console Online Help Describes the day-to-day administration tasks performed in the NetWorker Management Console and the NetWorker Administration window. To view the online help, click Help in the main menu.
Preface
4 NetWorker 18.2 REST API Reference Guide
l NetWorker User Online Help Describes how to use the NetWorker User program, which is the Windows client interface, to connect to a NetWorker server to back up, recover, archive, and retrieve files over a network.
Special notice conventions that are used in this document The following conventions are used for special notices:
NOTICE
Identifies content that warns of potential business or data loss.
Note
Contains information that is incidental, but not essential, to the topic.
Typographical conventions The following type style conventions are used in this document:
Table 2 Style conventions
Bold Used for interface elements that a user specifically selects or clicks, for example, names of buttons, fields, tab names, and menu paths. Also used for the name of a dialog box, page, pane, screen area with title, table label, and window.
Italic Used for full titles of publications that are referenced in text.
Monospace Used for:
l System code
l System output, such as an error message or script
l Pathnames, file names, file name extensions, prompts, and syntax
l Commands and options
Monospace italic Used for variables.
Monospace bold Used for user input.
[ ] Square brackets enclose optional values.
| Vertical line indicates alternate selections. The vertical line means or for the alternate selections.
{ } Braces enclose content that the user must specify, such as x, y, or z.
... Ellipses indicate non-essential information that is omitted from the example.
You can use the following resources to find more information about this product, obtain support, and provide feedback.
Where to find product documentation
l https://www.dell.com/support l https://community.emc.com
Where to get support The Support website https://www.dell.com/support provides access to product licensing, documentation, advisories, downloads, and how-to and troubleshooting
Preface
5
information. The information can enable you to resolve a product issue before you contact Support.
To access a product-specific page:
1. Go to https://www.dell.com/support.
2. In the search box, type a product name, and then from the list that appears, select the product.
Knowledgebase The Knowledgebase contains applicable solutions that you can search for either by solution number (for example, KB000xxxxxx) or by keyword.
To search the Knowledgebase:
1. Go to https://www.dell.com/support.
2. On the Support tab, click Knowledge Base.
3. In the search box, type either the solution number or keywords. Optionally, you can limit the search to specific products by typing a product name in the search box, and then selecting the product from the list that appears.
Live chat To participate in a live interactive chat with a support agent:
1. Go to https://www.dell.com/support.
2. On the Support tab, click Contact Support.
3. On the Contact Information page, click the relevant support, and then proceed.
Service requests To obtain in-depth help from Licensing, submit a service request. To submit a service request:
1. Go to https://www.dell.com/support.
2. On the Support tab, click Service Requests.
Note
To create a service request, you must have a valid support agreement. For details about either an account or obtaining a valid support agreement, contact a sales representative. To get the details of a service request, in the Service Request Number field, type the service request number, and then click the right arrow.
To review an open service request:
1. Go to https://www.dell.com/support.
2. On the Support tab, click Service Requests.
3. On the Service Requests page, under Manage Your Service Requests, click View All Dell Service Requests.
Online communities For peer contacts, conversations, and content on product support and solutions, go to the Community Network https://community.emc.com. Interactively engage with customers, partners, and certified professionals online.
How to provide feedback Feedback helps to improve the accuracy, organization, and overall quality of publications. You can send feedback to DPAD.Doc.Feedback@emc.com.
Preface
6 NetWorker 18.2 REST API Reference Guide
NetWorker 18.2 REST API Reference Guide 7
NetWorker REST API RESOURCE REFERENCE
The NetWorker REST API is available in the following base URI: https://{nw-server-hostname}:9090/nwrestapi/v3 There is one URI group: {baseuri}/global
To access client resources, you must use the URI group, followed by the associated tag. For example, https://{nw-server-hostname}:9090/nwrestapi/v3/global/{id} The {id} corresponds to the Resource tag of the client.
More information: https://helloreverb.com Contact Info: hello@helloreverb.com Version: 18.2.0 BasePath:/nwrestapi/v3/global Copyright 1990-2018 Dell Inc. or its subsidiaries. All rights reserved. https://www.dellemc.com
Access
1. HTTP Basic Authentication
Methods
[ Jump to Models ]
Table of Contents
Alerts
GET /alerts
Backups
DELETE /backups/{backupId} DELETE /backups/{backupId}/instances/{instanceId} GET /backups/{backupId} GET /backups/{backupId}/instances/{instanceId} GET /backups/{backupId}/instances GET /backups
Clients/
NetWorker 18.2 REST API Reference Guide 8
POST /clients/{clientId}/op/backup DELETE /clients/{clientId} GET /clients/{clientId} GET /clients/{clientId}/backups/{backupId} GET /clients/{clientId}/backups/{backupId}/instances/{instanceId} GET /clients/{clientId}/backups/{backupId}/instances GET /clients/{clientId}/backups GET /clients/{clientId}/indexes GET /clients POST /clients PUT /clients/{clientId}
Cloudboostappliances
GET /cloudboostappliances/{cloudboostapplianceId} GET /cloudboostappliances
Devices
DELETE /devices/{deviceId} GET /devices/{deviceId} GET /devices/{deviceId}/opstatus GET /devices POST /devices/{deviceId}/op/label POST /devices/{deviceId}/op/mount POST /devices/{deviceId}/op/unmount POST /devices/{deviceId}/op/verifylabel POST /devices PUT /devices/{deviceId}
Directives
DELETE /directives/{directiveId} GET /directives/{directiveId} GET /directives POST /directives PUT /directives/{directiveId}
Jobs
GET /jobs/{jobId} GET /jobgroups/{jobGroupId} GET /jobgroups GET /jobindications GET /jobs/{jobId}/log GET /jobs POST /jobs/{jobId}/op/cancel
NetWorker 18.2 REST API Reference Guide 9
Labels
DELETE /labels/{labelId} GET /labels/{labelId} GET /labels POST /labels PUT /labels/{labelId}
Licenses
GET /licenses/{licenseId} GET /licenses
Notifications
DELETE /notifications/{notificationId} GET /notifications/{notificationId} GET /notifications POST /notifications PUT /notifications/{notificationId}
Pools
DELETE /pools/{poolId} GET /pools/{poolId} GET /pools POST /pools PUT /pools/{poolId}
Probes
DELETE /probes/{probeId} GET /probes/{probeId} GET /probes POST /probes PUT /probes/{probeId}
Protectiongroups
DELETE /protectiongroups/{protectionGroupId} GET /protectiongroups/{protectionGroupId} GET /protectiongroups POST /protectiongroups PUT /protectiongroups/{protectionGroupId} POST
/protectiongroups/{protectionGroupId}/op/updatevmwareworkitems
Protectionpolicies
NetWorker 18.2 REST API Reference Guide 10
DELETE /protectionpolicies/{policyId} DELETE /protectionpolicies/{policyId}/workflows/{workflowId} GET /protectionpolicies GET /protectionpolicies/{policyId} GET /protectionpolicies/{policyId}/jobgroups/{jobGroupId} GET /protectionpolicies/{policyId}/jobgroups GET /protectionpolicies/{policyId}/workflows/{workflowId} GET
/protectionpolicies/{policyId}/workflows/{workflowId}/jobgroups/{j
obGroupId} GET
/protectionpolicies/{policyId}/workflows/{workflowId}/jobgroups GET /protectionpolicies/{policyId}/workflows POST /protectionpolicies POST /protectionpolicies/{policyId}/workflows POST
/protectionpolicies/{policyId}/workflows/{workflowId}/op/backup PUT /protectionpolicies/{policyId} PUT /protectionpolicies/{policyId}/workflows/{workflowId}
Recovers
DELETE /recovers/{recoverId} GET /recovers/{recoverId} GET /recovers POST /recovers
Rules
DELETE /rules/{ruleName} GET /rules/{ruleName} GET /rules POST /rules PUT /rules/{ruleName}
Server
DELETE /usergroups/{userGroupId} GET /auditlogconfig GET /serverconfig GET /servermessages GET /serverstatistics GET /usergroups/{userGroupId} GET /usergroups POST /usergroups PUT /auditlogconfig PUT /serverconfig PUT /usergroups/{userGroupId}
NetWorker 18.2 REST API Reference Guide 11
Sessions
GET /sessions/{sessionId} GET /sessions POST /sessions/{sessionId}/op/cancel
Storagenodes
DELETE /storagenodes/{storageNodeId} GET /storagenodes/{storageNodeId} GET /storagenodes POST /storagenodes PUT /storagenodes/{storageNodeId}
Tenants
DELETE /tenants/{tenantId} GET /tenants/{tenantId} GET /tenants POST /tenants PUT /tenants/{tenantId}
Vmware
DELETE /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/op/vmmount/{vproxy-mount-session-
id}/vmbrowse/{vproxy-browse-session-id} DELETE /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/instances/{instance-
id}/op/vmmount/{vproxy-mount-session-id}/vmbrowse/{vproxy-browse-
session-id} DELETE /vmware/vcenters/{vcenter-hostname} DELETE /vmware/vproxies/{vproxy-hostname} GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/op/vmmount/{vproxy-mount-session-
id}/vmbrowse/{vproxy-browse-session-id}/contents GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/op/vmmount/{vproxy-mount-session-
id}/vmbrowse/{vproxy-browse-session-id} GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/op/vmmount/{vproxy-mount-session-
id}/vmbrowse GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/op/vmmount/{vproxy-mount-session-id} GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/instances/{instance-
id}/op/vmmount/{vproxy-mount-session-id}/vmbrowse/{vproxy-browse-
session-id}/contents GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/instances/{instance-
NetWorker 18.2 REST API Reference Guide 12
id}/op/vmmount/{vproxy-mount-session-id}/vmbrowse/{vproxy-browse-
session-id} GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/instances/{instance-
id}/op/vmmount/{vproxy-mount-session-id}/vmbrowse GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/instances/{instance-
id}/op/vmmount/{vproxy-mount-session-id} GET /vmware/vcenters/{vcenter-hostname} GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-uuid} GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/instances GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups GET /vmware/vcenters/{vcenter-hostname}/protectedvms GET /vmware/vcenters/{vcenter-hostname}/vms/{vm-uuid} GET /vmware/vcenters/{vcenter-hostname}/vms GET /vmware/vcenters GET /vmware/protectedvms GET /vmware/vcenters/{vcenter-hostname}/vms/{vm-
uuid}/protectiondetails GET /vmware/vms GET /vmware/vproxies GET /vmware/vproxies/{vproxy-hostname} POST /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/op/vmmount/{vproxy-mount-session-
id}/vmbrowse POST /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/instances/{instance-
id}/op/vmmount/{vproxy-mount-session-id}/vmbrowse POST /vmware/vproxies/op/register POST /vmware/vcenters POST /vmware/vcenters/{vcenter-hostname}/op/refresh POST /vmware/vcenters/{vcenter-hostname}/plugins POST /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/op/inspectbackup POST /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/instances/{instance-id}/op/inspectbackup POST /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/instances/{instance-id}/op/recover POST /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/instances/{instance-id}/op/vmmount POST /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/op/recover POST /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/op/vmmount POST /vmware/op/refreshvcenters POST /vmware/vcenters/{vcenter-hostname}/vms/{vm-uuid}/op/backup POST /vmware/vproxies PUT /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/op/vmmount/{vproxy-mount-session-
id}/vmbrowse/{vproxy-browse-session-id}
NetWorker 18.2 REST API Reference Guide 13
PUT /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/instances/{instance-
id}/op/vmmount/{vproxy-mount-session-id}/vmbrowse/{vproxy-browse-
session-id} PUT /vmware/vcenters/{vcenter-hostname} PUT /vmware/vproxies/{vproxy-hostname}
Volumes
DELETE /volumes/{volumeId} GET /volumes/{volumeId} GET /volumes
Alerts
Up GET /alerts
(getAlerts)
Returns the most recent alert messages.
Return type
AlertList
Example data
Content-Type: application/json
{
"alerts" : [ {
"category" : "category",
"message" : "message",
"priority" : "priority",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"category" : "category",
"message" : "message",
"priority" : "priority",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"count" : 0,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
NetWorker 18.2 REST API Reference Guide 14
"id" : "id",
"title" : "title"
} ]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resources were retrieved successfully. AlertList
Backups
Up DELETE /backups/{backupId}
(deleteBackup)
Deletes the specified backup.
Path parameters
backupId (required) Path Parameter is the value of the id attribute in the backup object.
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
204 Resource was retrieved successfully.
Up DELETE /backups/{backupId}/instances/{instanceId}
(deleteBackupInstance)
NetWorker 18.2 REST API Reference Guide 15
Deletes the specific backup instance.
Path parameters
backupId (required) Path Parameter is the value of the id attribute in the backup object.
instanceId (required) Path Parameter is the value of the id attribute in the instance object.
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
204 Resource was retrieved successfully.
Up GET /backups/{backupId}
(getBackup)
Returns the information on the specific backup.
Path parameters
backupId (required) Path Parameter is the value of the id attribute in the backup object.
Return type
Backup
Example data
Content-Type: application/json
{
"shortId" : "shortId",
"clientId" : "clientId",
"browseTime" : "2000-01-23T04:56:07.000+00:00",
"creationTime" : "2000-01-23T04:56:07.000+00:00",
"instances" : [ {
"clone" : true,
"links" : [ {
"rel" : "create-form",
"href" : "href",
NetWorker 18.2 REST API Reference Guide 16
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"volumeIds" : [ "volumeIds", "volumeIds" ],
"id" : "id",
"status" : "Aborted"
}, {
"clone" : true,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"volumeIds" : [ "volumeIds", "volumeIds" ],
"id" : "id",
"status" : "Aborted"
} ],
"level" : "1",
"retentionTime" : "2000-01-23T04:56:07.000+00:00",
"type" : "CoverSet",
"fileCount" : 0,
"clientHostname" : "clientHostname",
"completionTime" : "2000-01-23T04:56:07.000+00:00",
"size" : {
"unit" : "Byte",
"value" : 6
},
"name" : "name",
"attributes" : [ {
"values" : [ "values", "values" ],
"key" : "key"
}, {
"values" : [ "values", "values" ],
"key" : "key"
} ],
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
NetWorker 18.2 REST API Reference Guide 17
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"id" : "id",
"saveTime" : "2000-01-23T04:56:07.000+00:00",
"vmInformation" : {
"vmName" : "vmName",
"disks" : [ {
"datastoreMoref" : "datastoreMoref",
"name" : "name",
"thinProvisioned" : true,
"datastoreName" : "datastoreName",
"sizeInKb" : 1,
"key" : "key"
}, {
"datastoreMoref" : "datastoreMoref",
"name" : "name",
"thinProvisioned" : true,
"datastoreName" : "datastoreName",
"sizeInKb" : 1,
"key" : "key"
} ],
"hostMoref" : "hostMoref",
"datastoreMoref" : "datastoreMoref",
"vmMoref" : "vmMoref",
"vCenterHostname" : "vCenterHostname",
"morefPath" : "morefPath"
},
"tenant" : "tenant"
}
Responses
200 Resource was retrieved successfully. Backup
Up GET /backups/{backupId}/instances/{instanceId}
(getBackupInstance)
Returns information on specific backup instance.
Path parameters
backupId (required) Path Parameter is the value of the id attribute in the backup object.
NetWorker 18.2 REST API Reference Guide 18
instanceId (required) Path Parameter is the value of the id attribute in the instance object.
Return type
BackupInstance
Example data
Content-Type: application/json
{
"clone" : true,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"volumeIds" : [ "volumeIds", "volumeIds" ],
"id" : "id",
"status" : "Aborted"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resource was retrieved successfully. BackupInstance
Up GET /backups/{backupId}/instances
(getBackupInstances)
Returns a list of backup instances.
Path parameters
backupId (required)
NetWorker 18.2 REST API Reference Guide 19
Path Parameter is the value of the id attribute in the backup object.
Return type
BackupInstanceList
Example data
Content-Type: application/json
{
"backupInstances" : [ {
"clone" : true,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"volumeIds" : [ "volumeIds", "volumeIds" ],
"id" : "id",
"status" : "Aborted"
}, {
"clone" : true,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"volumeIds" : [ "volumeIds", "volumeIds" ],
"id" : "id",
"status" : "Aborted"
} ],
"count" : 0,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
NetWorker 18.2 REST API Reference Guide 20
"href" : "href",
"id" : "id",
"title" : "title"
} ]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resources were retrieved successfully. BackupInstanceList
Up GET /backups
(getBackups)
Returns information on all the backups.
Return type
BackupList
Example data
Content-Type: application/json
{
"count" : 5,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"backups" : [ {
"shortId" : "shortId",
"clientId" : "clientId",
"browseTime" : "2000-01-23T04:56:07.000+00:00",
"creationTime" : "2000-01-23T04:56:07.000+00:00",
NetWorker 18.2 REST API Reference Guide 21
"instances" : [ {
"clone" : true,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"volumeIds" : [ "volumeIds", "volumeIds" ],
"id" : "id",
"status" : "Aborted"
}, {
"clone" : true,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"volumeIds" : [ "volumeIds", "volumeIds" ],
"id" : "id",
"status" : "Aborted"
} ],
"level" : "1",
"retentionTime" : "2000-01-23T04:56:07.000+00:00",
"type" : "CoverSet",
"fileCount" : 0,
"clientHostname" : "clientHostname",
"completionTime" : "2000-01-23T04:56:07.000+00:00",
"size" : {
"unit" : "Byte",
"value" : 6
},
"name" : "name",
"attributes" : [ {
"values" : [ "values", "values" ],
"key" : "key"
}, {
"values" : [ "values", "values" ],
"key" : "key"
NetWorker 18.2 REST API Reference Guide 22
} ],
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"id" : "id",
"saveTime" : "2000-01-23T04:56:07.000+00:00",
"vmInformation" : {
"vmName" : "vmName",
"disks" : [ {
"datastoreMoref" : "datastoreMoref",
"name" : "name",
"thinProvisioned" : true,
"datastoreName" : "datastoreName",
"sizeInKb" : 1,
"key" : "key"
}, {
"datastoreMoref" : "datastoreMoref",
"name" : "name",
"thinProvisioned" : true,
"datastoreName" : "datastoreName",
"sizeInKb" : 1,
"key" : "key"
} ],
"hostMoref" : "hostMoref",
"datastoreMoref" : "datastoreMoref",
"vmMoref" : "vmMoref",
"vCenterHostname" : "vCenterHostname",
"morefPath" : "morefPath"
},
"tenant" : "tenant"
}, {
"shortId" : "shortId",
"clientId" : "clientId",
"browseTime" : "2000-01-23T04:56:07.000+00:00",
"creationTime" : "2000-01-23T04:56:07.000+00:00",
"instances" : [ {
"clone" : true,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
NetWorker 18.2 REST API Reference Guide 23
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"volumeIds" : [ "volumeIds", "volumeIds" ],
"id" : "id",
"status" : "Aborted"
}, {
"clone" : true,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"volumeIds" : [ "volumeIds", "volumeIds" ],
"id" : "id",
"status" : "Aborted"
} ],
"level" : "1",
"retentionTime" : "2000-01-23T04:56:07.000+00:00",
"type" : "CoverSet",
"fileCount" : 0,
"clientHostname" : "clientHostname",
"completionTime" : "2000-01-23T04:56:07.000+00:00",
"size" : {
"unit" : "Byte",
"value" : 6
},
"name" : "name",
"attributes" : [ {
"values" : [ "values", "values" ],
"key" : "key"
}, {
"values" : [ "values", "values" ],
"key" : "key"
} ],
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
NetWorker 18.2 REST API Reference Guide 24
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"id" : "id",
"saveTime" : "2000-01-23T04:56:07.000+00:00",
"vmInformation" : {
"vmName" : "vmName",
"disks" : [ {
"datastoreMoref" : "datastoreMoref",
"name" : "name",
"thinProvisioned" : true,
"datastoreName" : "datastoreName",
"sizeInKb" : 1,
"key" : "key"
}, {
"datastoreMoref" : "datastoreMoref",
"name" : "name",
"thinProvisioned" : true,
"datastoreName" : "datastoreName",
"sizeInKb" : 1,
"key" : "key"
} ],
"hostMoref" : "hostMoref",
"datastoreMoref" : "datastoreMoref",
"vmMoref" : "vmMoref",
"vCenterHostname" : "vCenterHostname",
"morefPath" : "morefPath"
},
"tenant" : "tenant"
} ]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resources were retrieved successfully. BackupList
Clients
NetWorker 18.2 REST API Reference Guide 25
Up POST /clients/{clientId}/op/backup
(clientOpBackup)
Backup save sets for a given client.
Path parameters
clientId (required) Path Parameter is the value of the id attribute of the client object's resourceId.
Request body
clientOpBackup ClientOpBackup (required) Body Parameter Parameters to start the backup.
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
201 A job is created. The Job URI can be found in the location header of the response.
Up DELETE /clients/{clientId}
(deleteClient)
Deletes the specified client.
Path parameters
clientId (required) Path Parameter is the value of the id attribute of the client object's resourceId.
Responses
204 Resource was retrieved successfully.
Up
NetWorker 18.2 REST API Reference Guide 26
GET /clients/{clientId}
(getClient)
Returns the specific client.
Path parameters
clientId (required) Path Parameter is the value of the id attribute of the client object's resourceId.
Return type
Client
Example data
Content-Type: application/json
{
"postCommand" : "postCommand",
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"aliases" : [ "aliases", "aliases" ],
"nasDeviceManagementName" : "nasDeviceManagementName",
"nasFileAccessUser" : "nasFileAccessUser",
"hostname" : "hostname",
"password" : "password",
"serverNetworkInterface" : "serverNetworkInterface",
"ndmpArrayName" : "ndmpArrayName",
"scheduledBackup" : false,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"saveSets" : [ "saveSets", "saveSets" ],
"tenant" : "tenant",
"remoteUser" : "remoteUser",
"pool" : "pool",
"dataDomainInterface" : "Any",
"storageReplicationPolicyName" : "storageReplicationPolicyName",
"protectionGroups" : [ "protectionGroups", "protectionGroups" ],
"tags" : [ "tags", "tags" ],
NetWorker 18.2 REST API Reference Guide 27
"nasFileAccessPassword" : "nasFileAccessPassword",
"clientDirectEnabled" : true,
"saveOperations" : "saveOperations",
"nasManagementUser" : "nasManagementUser",
"parallelism" : 0,
"dataDomainBackup" : true,
"remoteAccessUsers" : [ "remoteAccessUsers", "remoteAccessUsers" ],
"backupType" : "backupType",
"parallelSaveStreamsPerSaveSet" : false,
"networkerVersion" : "networkerVersion",
"jobControl" : [ "jobControl", "jobControl" ],
"nasManagementPassword" : "nasManagementPassword",
"retentionPolicy" : "retentionPolicy",
"checkpointEnabled" : false,
"nasDevice" : false,
"clientId" : "clientId",
"ndmpMultiStreamsEnabled" : true,
"applicationInformation" : [ "applicationInformation",
"applicationInformation" ],
"probeResourceName" : "probeResourceName",
"ndmpVendorInformation" : [ "ndmpVendorInformation",
"ndmpVendorInformation" ],
"ndmp" : false,
"backupCommand" : "backupCommand",
"directive" : "directive",
"indexBackupContent" : false,
"schedule" : "schedule",
"executablePath" : "executablePath",
"blockBasedBackup" : false,
"preCommand" : "preCommand",
"comment" : "comment",
"storageNodes" : [ "storageNodes", "storageNodes" ]
}
Responses
200 Resource was retrieved successfully. Client
Up GET /clients/{clientId}/backups/{backupId}
(getClientBackup)
Returns information on specific backup for the given client.
Path parameters
clientId (required) Path Parameter is the value of the id attribute of the client object's resourceId.
NetWorker 18.2 REST API Reference Guide 28
backupId (required) Path Parameter is the value of the id attribute in the backup object.
Return type
Backup
Example data
Content-Type: application/json
{
"shortId" : "shortId",
"clientId" : "clientId",
"browseTime" : "2000-01-23T04:56:07.000+00:00",
"creationTime" : "2000-01-23T04:56:07.000+00:00",
"instances" : [ {
"clone" : true,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"volumeIds" : [ "volumeIds", "volumeIds" ],
"id" : "id",
"status" : "Aborted"
}, {
"clone" : true,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"volumeIds" : [ "volumeIds", "volumeIds" ],
"id" : "id",
"status" : "Aborted"
} ],
"level" : "1",
"retentionTime" : "2000-01-23T04:56:07.000+00:00",
"type" : "CoverSet",
NetWorker 18.2 REST API Reference Guide 29
"fileCount" : 0,
"clientHostname" : "clientHostname",
"completionTime" : "2000-01-23T04:56:07.000+00:00",
"size" : {
"unit" : "Byte",
"value" : 6
},
"name" : "name",
"attributes" : [ {
"values" : [ "values", "values" ],
"key" : "key"
}, {
"values" : [ "values", "values" ],
"key" : "key"
} ],
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"id" : "id",
"saveTime" : "2000-01-23T04:56:07.000+00:00",
"vmInformation" : {
"vmName" : "vmName",
"disks" : [ {
"datastoreMoref" : "datastoreMoref",
"name" : "name",
"thinProvisioned" : true,
"datastoreName" : "datastoreName",
"sizeInKb" : 1,
"key" : "key"
}, {
"datastoreMoref" : "datastoreMoref",
"name" : "name",
"thinProvisioned" : true,
"datastoreName" : "datastoreName",
"sizeInKb" : 1,
"key" : "key"
} ],
"hostMoref" : "hostMoref",
"datastoreMoref" : "datastoreMoref",
"vmMoref" : "vmMoref",
"vCenterHostname" : "vCenterHostname",
"morefPath" : "morefPath"
NetWorker 18.2 REST API Reference Guide 30
},
"tenant" : "tenant"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resource was retrieved successfully. Backup
Up GET /clients/{clientId}/backups/{backupId}/instances/{instanceId}
(getClientBackupInstance)
Returns a specific backup instance for a given backup associated with a specific client.
Path parameters
clientId (required) Path Parameter is the value of the id attribute of the client object's resourceId.
backupId (required) Path Parameter is the value of the id attribute in the backup object.
instanceId (required) Path Parameter is the value of the id attribute in the instance object.
Return type
BackupInstance
Example data
Content-Type: application/json
{
"clone" : true,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
NetWorker 18.2 REST API Reference Guide 31
"id" : "id",
"title" : "title"
} ],
"volumeIds" : [ "volumeIds", "volumeIds" ],
"id" : "id",
"status" : "Aborted"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resource was retrieved successfully. BackupInstance
Up GET /clients/{clientId}/backups/{backupId}/instances
(getClientBackupInstances)
Returns a list of backup instances for a given backup associated with a specific client.
Path parameters
clientId (required) Path Parameter is the value of the id attribute of the client object's resourceId.
backupId (required) Path Parameter is the value of the id attribute in the instance object.
Return type
BackupInstanceList
Example data
Content-Type: application/json
{
"backupInstances" : [ {
"clone" : true,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
NetWorker 18.2 REST API Reference Guide 32
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"volumeIds" : [ "volumeIds", "volumeIds" ],
"id" : "id",
"status" : "Aborted"
}, {
"clone" : true,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"volumeIds" : [ "volumeIds", "volumeIds" ],
"id" : "id",
"status" : "Aborted"
} ],
"count" : 0,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
NetWorker 18.2 REST API Reference Guide 33
200 Resources were retrieved successfully. BackupInstanceList
Up GET /clients/{clientId}/backups
(getClientBackups)
Returns a list of information on all the backups for a given client.
Path parameters
clientId (required) Path Parameter is the value of the id attribute of the client object's resourceId.
Return type
BackupList
Example data
Content-Type: application/json
{
"count" : 5,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"backups" : [ {
"shortId" : "shortId",
"clientId" : "clientId",
"browseTime" : "2000-01-23T04:56:07.000+00:00",
"creationTime" : "2000-01-23T04:56:07.000+00:00",
"instances" : [ {
"clone" : true,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
NetWorker 18.2 REST API Reference Guide 34
"id" : "id",
"title" : "title"
} ],
"volumeIds" : [ "volumeIds", "volumeIds" ],
"id" : "id",
"status" : "Aborted"
}, {
"clone" : true,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"volumeIds" : [ "volumeIds", "volumeIds" ],
"id" : "id",
"status" : "Aborted"
} ],
"level" : "1",
"retentionTime" : "2000-01-23T04:56:07.000+00:00",
"type" : "CoverSet",
"fileCount" : 0,
"clientHostname" : "clientHostname",
"completionTime" : "2000-01-23T04:56:07.000+00:00",
"size" : {
"unit" : "Byte",
"value" : 6
},
"name" : "name",
"attributes" : [ {
"values" : [ "values", "values" ],
"key" : "key"
}, {
"values" : [ "values", "values" ],
"key" : "key"
} ],
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
NetWorker 18.2 REST API Reference Guide 35
"title" : "title"
} ],
"id" : "id",
"saveTime" : "2000-01-23T04:56:07.000+00:00",
"vmInformation" : {
"vmName" : "vmName",
"disks" : [ {
"datastoreMoref" : "datastoreMoref",
"name" : "name",
"thinProvisioned" : true,
"datastoreName" : "datastoreName",
"sizeInKb" : 1,
"key" : "key"
}, {
"datastoreMoref" : "datastoreMoref",
"name" : "name",
"thinProvisioned" : true,
"datastoreName" : "datastoreName",
"sizeInKb" : 1,
"key" : "key"
} ],
"hostMoref" : "hostMoref",
"datastoreMoref" : "datastoreMoref",
"vmMoref" : "vmMoref",
"vCenterHostname" : "vCenterHostname",
"morefPath" : "morefPath"
},
"tenant" : "tenant"
}, {
"shortId" : "shortId",
"clientId" : "clientId",
"browseTime" : "2000-01-23T04:56:07.000+00:00",
"creationTime" : "2000-01-23T04:56:07.000+00:00",
"instances" : [ {
"clone" : true,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"volumeIds" : [ "volumeIds", "volumeIds" ],
"id" : "id",
"status" : "Aborted"
}, {
NetWorker 18.2 REST API Reference Guide 36
"clone" : true,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"volumeIds" : [ "volumeIds", "volumeIds" ],
"id" : "id",
"status" : "Aborted"
} ],
"level" : "1",
"retentionTime" : "2000-01-23T04:56:07.000+00:00",
"type" : "CoverSet",
"fileCount" : 0,
"clientHostname" : "clientHostname",
"completionTime" : "2000-01-23T04:56:07.000+00:00",
"size" : {
"unit" : "Byte",
"value" : 6
},
"name" : "name",
"attributes" : [ {
"values" : [ "values", "values" ],
"key" : "key"
}, {
"values" : [ "values", "values" ],
"key" : "key"
} ],
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"id" : "id",
"saveTime" : "2000-01-23T04:56:07.000+00:00",
"vmInformation" : {
"vmName" : "vmName",
"disks" : [ {
NetWorker 18.2 REST API Reference Guide 37
"datastoreMoref" : "datastoreMoref",
"name" : "name",
"thinProvisioned" : true,
"datastoreName" : "datastoreName",
"sizeInKb" : 1,
"key" : "key"
}, {
"datastoreMoref" : "datastoreMoref",
"name" : "name",
"thinProvisioned" : true,
"datastoreName" : "datastoreName",
"sizeInKb" : 1,
"key" : "key"
} ],
"hostMoref" : "hostMoref",
"datastoreMoref" : "datastoreMoref",
"vmMoref" : "vmMoref",
"vCenterHostname" : "vCenterHostname",
"morefPath" : "morefPath"
},
"tenant" : "tenant"
} ]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resources were retrieved successfully. BackupList
Up GET /clients/{clientId}/indexes
(getClientIndexes)
Returns a list of indexes.
Path parameters
clientId (required) Path Parameter is the value of the id attribute of the client object's resourceId.
Return type
NetWorker 18.2 REST API Reference Guide 38
IndexList
Example data
Content-Type: application/json
{
"count" : 0,
"items" : [ {
"fileName" : "fileName",
"offset" : 1,
"namespace" : "backup",
"fileSizeInBytes" : 6,
"saveTime" : "saveTime",
"clientFileId" : "clientFileId"
}, {
"fileName" : "fileName",
"offset" : 1,
"namespace" : "backup",
"fileSizeInBytes" : 6,
"saveTime" : "saveTime",
"clientFileId" : "clientFileId"
} ]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resources were retrieved successfully. IndexList
400 Bad request. ErrorResponse
401 Unauthorized. ErrorResponse
404 Not found. ErrorResponse
405 Method not allowed. ErrorResponse
500 Internal server error. ErrorResponse
Up GET /clients
NetWorker 18.2 REST API Reference Guide 39
(getClients)
Returns a list of all clients.
Return type
ClientList
Example data
Content-Type: application/json
{
"clients" : [ {
"postCommand" : "postCommand",
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"aliases" : [ "aliases", "aliases" ],
"nasDeviceManagementName" : "nasDeviceManagementName",
"nasFileAccessUser" : "nasFileAccessUser",
"hostname" : "hostname",
"password" : "password",
"serverNetworkInterface" : "serverNetworkInterface",
"ndmpArrayName" : "ndmpArrayName",
"scheduledBackup" : false,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"saveSets" : [ "saveSets", "saveSets" ],
"tenant" : "tenant",
"remoteUser" : "remoteUser",
"pool" : "pool",
"dataDomainInterface" : "Any",
"storageReplicationPolicyName" : "storageReplicationPolicyName",
"protectionGroups" : [ "protectionGroups", "protectionGroups" ],
"tags" : [ "tags", "tags" ],
"nasFileAccessPassword" : "nasFileAccessPassword",
"clientDirectEnabled" : true,
"saveOperations" : "saveOperations",
"nasManagementUser" : "nasManagementUser",
"parallelism" : 0,
"dataDomainBackup" : true,
NetWorker 18.2 REST API Reference Guide 40
"remoteAccessUsers" : [ "remoteAccessUsers", "remoteAccessUsers"
],
"backupType" : "backupType",
"parallelSaveStreamsPerSaveSet" : false,
"networkerVersion" : "networkerVersion",
"jobControl" : [ "jobControl", "jobControl" ],
"nasManagementPassword" : "nasManagementPassword",
"retentionPolicy" : "retentionPolicy",
"checkpointEnabled" : false,
"nasDevice" : false,
"clientId" : "clientId",
"ndmpMultiStreamsEnabled" : true,
"applicationInformation" : [ "applicationInformation",
"applicationInformation" ],
"probeResourceName" : "probeResourceName",
"ndmpVendorInformation" : [ "ndmpVendorInformation",
"ndmpVendorInformation" ],
"ndmp" : false,
"backupCommand" : "backupCommand",
"directive" : "directive",
"indexBackupContent" : false,
"schedule" : "schedule",
"executablePath" : "executablePath",
"blockBasedBackup" : false,
"preCommand" : "preCommand",
"comment" : "comment",
"storageNodes" : [ "storageNodes", "storageNodes" ]
}, {
"postCommand" : "postCommand",
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"aliases" : [ "aliases", "aliases" ],
"nasDeviceManagementName" : "nasDeviceManagementName",
"nasFileAccessUser" : "nasFileAccessUser",
"hostname" : "hostname",
"password" : "password",
"serverNetworkInterface" : "serverNetworkInterface",
"ndmpArrayName" : "ndmpArrayName",
"scheduledBackup" : false,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
NetWorker 18.2 REST API Reference Guide 41
"title" : "title"
} ],
"saveSets" : [ "saveSets", "saveSets" ],
"tenant" : "tenant",
"remoteUser" : "remoteUser",
"pool" : "pool",
"dataDomainInterface" : "Any",
"storageReplicationPolicyName" : "storageReplicationPolicyName",
"protectionGroups" : [ "protectionGroups", "protectionGroups" ],
"tags" : [ "tags", "tags" ],
"nasFileAccessPassword" : "nasFileAccessPassword",
"clientDirectEnabled" : true,
"saveOperations" : "saveOperations",
"nasManagementUser" : "nasManagementUser",
"parallelism" : 0,
"dataDomainBackup" : true,
"remoteAccessUsers" : [ "remoteAccessUsers", "remoteAccessUsers"
],
"backupType" : "backupType",
"parallelSaveStreamsPerSaveSet" : false,
"networkerVersion" : "networkerVersion",
"jobControl" : [ "jobControl", "jobControl" ],
"nasManagementPassword" : "nasManagementPassword",
"retentionPolicy" : "retentionPolicy",
"checkpointEnabled" : false,
"nasDevice" : false,
"clientId" : "clientId",
"ndmpMultiStreamsEnabled" : true,
"applicationInformation" : [ "applicationInformation",
"applicationInformation" ],
"probeResourceName" : "probeResourceName",
"ndmpVendorInformation" : [ "ndmpVendorInformation",
"ndmpVendorInformation" ],
"ndmp" : false,
"backupCommand" : "backupCommand",
"directive" : "directive",
"indexBackupContent" : false,
"schedule" : "schedule",
"executablePath" : "executablePath",
"blockBasedBackup" : false,
"preCommand" : "preCommand",
"comment" : "comment",
"storageNodes" : [ "storageNodes", "storageNodes" ]
} ],
"count" : 6,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
NetWorker 18.2 REST API Reference Guide 42
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resources were retrieved successfully. ClientList
Up POST /clients
(postClient)
Creates a new client.
Request body
client Client (required) Body Parameter Client to be created.
Responses
201 Resource was created successfully.
Up PUT /clients/{clientId}
(putClient)
Updates the specified client.
Path parameters
clientId (required) Path Parameter is the value of the id attribute of the client object's resourceId.
NetWorker 18.2 REST API Reference Guide 43
Request body
client Client (required) Body Parameter Client to modify.
Responses
204 Resource was updated successfully.
Cloudboostappliances
Up GET /cloudboostappliances/{cloudboostapplianceId}
(getCloudBoostAppliance)
Returns the specific CloudBoost appliance.
Path parameters
cloudboostapplianceId (required) Path Parameter is the value of the id attribute of the CloudBoost object's resourceId.
Return type
CloudboostAppliance
Example data
Content-Type: application/json
{
"password" : "password",
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"host" : "host",
"name" : "name",
"username" : "username"
}
Responses
200 Resource was retrieved successfully. CloudboostAppliance
400 Bad request. ErrorResponse
NetWorker 18.2 REST API Reference Guide 44
401 Unauthorized. ErrorResponse
404 Not found. ErrorResponse
405 Method not allowed. ErrorResponse
500 Internal server error. ErrorResponse
Up GET /cloudboostappliances
(getCloudBoostAppliances)
Returns a list of CloudBoost appliances.
Return type
CloudboostApplianceList
Example data
Content-Type: application/json
{
"cloudBoostAppliances" : [ {
"password" : "password",
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"host" : "host",
"name" : "name",
"username" : "username"
}, {
"password" : "password",
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"host" : "host",
"name" : "name",
"username" : "username"
} ],
"count" : 0
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
NetWorker 18.2 REST API Reference Guide 45
application/json
Responses
200 Resources were retrieved successfully. CloudboostApplianceList
400 Bad request. ErrorResponse
401 Unauthorized. ErrorResponse
404 Not found. ErrorResponse
405 Method not allowed. ErrorResponse
500 Internal server error. ErrorResponse
Devices
Up DELETE /devices/{deviceId}
(deleteDevice)
Deletes the specific device.
Path parameters
deviceId (required) Path Parameter is the value of the name attribute in the device object.
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
204 Resource was retrieved successfully.
Up GET /devices/{deviceId}
(getDevice)
NetWorker 18.2 REST API Reference Guide 46
Returns the specific device.
Path parameters
deviceId (required) Path Parameter is the value of the name attribute in the device object.
Return type
Device
Example data
Content-Type: application/json
{
"cloudServer" : "cloudServer",
"tapeAlertsCritical" : [ "tapeAlertsCritical", "tapeAlertsCritical"
],
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"deviceAccessInfo" : "deviceAccessInfo",
"cloudBandwidthThrottlingSettings" : [
"cloudBandwidthThrottlingSettings",
"cloudBandwidthThrottlingSettings" ],
"pathId" : "pathId",
"mountedVolume" : "mountedVolume",
"password" : "password",
"dataDomainFibreChannelHostname" :
"dataDomainFibreChannelHostname",
"parentJukebox" : "parentJukebox",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"maxNsrmmdCount" : 2,
"tenant" : "tenant",
"remoteUser" : "remoteUser",
"volumePool" : "volumePool",
"cloudCACertificate" : "cloudCACertificate",
"cdi" : "NotUsed",
"warnOnSuspectVolumesInPercent" : 3,
"mediaType" : "Data Domain",
NetWorker 18.2 REST API Reference Guide 47
"readOnly" : true,
"deviceSerialNumber" : "deviceSerialNumber",
"dataDomainRetentionLockMode" : "None",
"hardwareId" : "hardwareId",
"tapeAlertsInformation" : [ "tapeAlertsInformation",
"tapeAlertsInformation" ],
"autoMediaManagement" : true,
"name" : "name",
"wormCapable" : true,
"status" : "Enabled",
"dataDomainHost" : "dataDomainHost",
"mediaFamily" : "Tape",
"cloudTimeout" : 5,
"description" : "description",
"tapeAlertsWarning" : [ "tapeAlertsWarning", "tapeAlertsWarning" ],
"dataDomainFibreChannel" : true,
"writeEnabled" : true,
"cloudBandwithThrottlingEnabled" : true,
"volumeId" : "volumeId",
"dateLastCleaned" : "2000-01-23T04:56:07.000+00:00",
"maxSession" : 7,
"dataDomainRetentionLockPeriodMax" :
"dataDomainRetentionLockPeriodMax",
"cloudCompression" : "None",
"cloudWriteSizeInKB" : 5,
"dataDomainRetentionLockPeriodMin" :
"dataDomainRetentionLockPeriodMin",
"cloudNetworkFailureRetryInMin" : 6,
"targetSession" : 9,
"ndmp" : true,
"message" : "message",
"cleaningInterval" : "cleaningInterval",
"cloudEncryption" : "None",
"wormCartridgePresent" : true,
"verifyLabelOnEject" : true,
"suspectedDevice" : true,
"comment" : "comment",
"cleaningRequired" : true,
"cloudNumberOfRetries" : 1,
"dltWormCapable" : true
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
NetWorker 18.2 REST API Reference Guide 48
Responses
200 Resource was retrieved successfully. Device
Up GET /devices/{deviceId}/opstatus
(getDeviceOpStatus)
Returns status of the specific device.
Path parameters
deviceId (required) Path Parameter is the value of the name attribute in the device object.
Return type
DeviceOpStatus
Example data
Content-Type: application/json
{
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"volumeLabel" : "volumeLabel",
"operationInProgress" : true,
"error" : "error",
"message" : "message",
"operation" : "Unmount"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resource was retrieved successfully. DeviceOpStatus
Up GET /devices
NetWorker 18.2 REST API Reference Guide 49
(getDevices)
Returns a list of devices.
Return type
DeviceList
Example data
Content-Type: application/json
{
"devices" : [ {
"cloudServer" : "cloudServer",
"tapeAlertsCritical" : [ "tapeAlertsCritical",
"tapeAlertsCritical" ],
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"deviceAccessInfo" : "deviceAccessInfo",
"cloudBandwidthThrottlingSettings" : [
"cloudBandwidthThrottlingSettings",
"cloudBandwidthThrottlingSettings" ],
"pathId" : "pathId",
"mountedVolume" : "mountedVolume",
"password" : "password",
"dataDomainFibreChannelHostname" :
"dataDomainFibreChannelHostname",
"parentJukebox" : "parentJukebox",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"maxNsrmmdCount" : 2,
"tenant" : "tenant",
"remoteUser" : "remoteUser",
"volumePool" : "volumePool",
"cloudCACertificate" : "cloudCACertificate",
"cdi" : "NotUsed",
"warnOnSuspectVolumesInPercent" : 3,
"mediaType" : "Data Domain",
"readOnly" : true,
"deviceSerialNumber" : "deviceSerialNumber",
NetWorker 18.2 REST API Reference Guide 50
"dataDomainRetentionLockMode" : "None",
"hardwareId" : "hardwareId",
"tapeAlertsInformation" : [ "tapeAlertsInformation",
"tapeAlertsInformation" ],
"autoMediaManagement" : true,
"name" : "name",
"wormCapable" : true,
"status" : "Enabled",
"dataDomainHost" : "dataDomainHost",
"mediaFamily" : "Tape",
"cloudTimeout" : 5,
"description" : "description",
"tapeAlertsWarning" : [ "tapeAlertsWarning", "tapeAlertsWarning"
],
"dataDomainFibreChannel" : true,
"writeEnabled" : true,
"cloudBandwithThrottlingEnabled" : true,
"volumeId" : "volumeId",
"dateLastCleaned" : "2000-01-23T04:56:07.000+00:00",
"maxSession" : 7,
"dataDomainRetentionLockPeriodMax" :
"dataDomainRetentionLockPeriodMax",
"cloudCompression" : "None",
"cloudWriteSizeInKB" : 5,
"dataDomainRetentionLockPeriodMin" :
"dataDomainRetentionLockPeriodMin",
"cloudNetworkFailureRetryInMin" : 6,
"targetSession" : 9,
"ndmp" : true,
"message" : "message",
"cleaningInterval" : "cleaningInterval",
"cloudEncryption" : "None",
"wormCartridgePresent" : true,
"verifyLabelOnEject" : true,
"suspectedDevice" : true,
"comment" : "comment",
"cleaningRequired" : true,
"cloudNumberOfRetries" : 1,
"dltWormCapable" : true
}, {
"cloudServer" : "cloudServer",
"tapeAlertsCritical" : [ "tapeAlertsCritical",
"tapeAlertsCritical" ],
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"deviceAccessInfo" : "deviceAccessInfo",
"cloudBandwidthThrottlingSettings" : [
"cloudBandwidthThrottlingSettings",
"cloudBandwidthThrottlingSettings" ],
NetWorker 18.2 REST API Reference Guide 51
"pathId" : "pathId",
"mountedVolume" : "mountedVolume",
"password" : "password",
"dataDomainFibreChannelHostname" :
"dataDomainFibreChannelHostname",
"parentJukebox" : "parentJukebox",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"maxNsrmmdCount" : 2,
"tenant" : "tenant",
"remoteUser" : "remoteUser",
"volumePool" : "volumePool",
"cloudCACertificate" : "cloudCACertificate",
"cdi" : "NotUsed",
"warnOnSuspectVolumesInPercent" : 3,
"mediaType" : "Data Domain",
"readOnly" : true,
"deviceSerialNumber" : "deviceSerialNumber",
"dataDomainRetentionLockMode" : "None",
"hardwareId" : "hardwareId",
"tapeAlertsInformation" : [ "tapeAlertsInformation",
"tapeAlertsInformation" ],
"autoMediaManagement" : true,
"name" : "name",
"wormCapable" : true,
"status" : "Enabled",
"dataDomainHost" : "dataDomainHost",
"mediaFamily" : "Tape",
"cloudTimeout" : 5,
"description" : "description",
"tapeAlertsWarning" : [ "tapeAlertsWarning", "tapeAlertsWarning"
],
"dataDomainFibreChannel" : true,
"writeEnabled" : true,
"cloudBandwithThrottlingEnabled" : true,
"volumeId" : "volumeId",
"dateLastCleaned" : "2000-01-23T04:56:07.000+00:00",
"maxSession" : 7,
"dataDomainRetentionLockPeriodMax" :
"dataDomainRetentionLockPeriodMax",
"cloudCompression" : "None",
"cloudWriteSizeInKB" : 5,
NetWorker 18.2 REST API Reference Guide 52
"dataDomainRetentionLockPeriodMin" :
"dataDomainRetentionLockPeriodMin",
"cloudNetworkFailureRetryInMin" : 6,
"targetSession" : 9,
"ndmp" : true,
"message" : "message",
"cleaningInterval" : "cleaningInterval",
"cloudEncryption" : "None",
"wormCartridgePresent" : true,
"verifyLabelOnEject" : true,
"suspectedDevice" : true,
"comment" : "comment",
"cleaningRequired" : true,
"cloudNumberOfRetries" : 1,
"dltWormCapable" : true
} ],
"count" : 0,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resources were retrieved successfully. DeviceList
Up POST /devices/{deviceId}/op/label
(postDeviceOpLabel)
Creates a label for the specific device resource.
Path parameters
NetWorker 18.2 REST API Reference Guide 53
deviceId (required) Path Parameter is the value of the name attribute in the device object.
Request body
deviceOpLabel DeviceOpLabel (required) Body Parameter Device label to be applied.
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
202 Accepted.
Up POST /devices/{deviceId}/op/mount
(postDeviceOpMount)
Mounts a volume into a device.
Path parameters
deviceId (required) Path Parameter is the value of the name attribute in the device object.
Request body
deviceOpMount DeviceOpMount (required) Body Parameter Mount information.
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
202 Accepted.
NetWorker 18.2 REST API Reference Guide 54
Up POST /devices/{deviceId}/op/unmount
(postDeviceOpUnmount)
Unmounts a volume from the specific device.
Path parameters
deviceId (required) Path Parameter is the value of the name attribute in the device object.
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
202 Accepted.
Up POST /devices/{deviceId}/op/verifylabel
(postDeviceOpVerifyLabel)
Verifies the label in the specific device. Note: Verifying a label unmounts the mounted volumes.
Path parameters
deviceId (required) Path Parameter is the value of the name attribute in the device object.
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
202 Accepted.
NetWorker 18.2 REST API Reference Guide 55
Up POST /devices
(postDevices)
Creates a new device.
Request body
device Device (required) Body Parameter Device to be created.
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
201 Resource was created successfully.
Up PUT /devices/{deviceId}
(putDevice)
Updates the specific device.
Path parameters
deviceId (required) Path Parameter is the value of the name attribute in the device object.
Request body
device Device (required) Body Parameter Device data for the update.
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
NetWorker 18.2 REST API Reference Guide 56
204 Resource was updated successfully.
Directives
Up DELETE /directives/{directiveId}
(deleteDirective)
Deletes the specific directive.
Path parameters
directiveId (required) Path Parameter is the value of the name attribute in the directive object.
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
204 Resource was retrieved successfully.
Up GET /directives/{directiveId}
(getDirective)
Returns the specific directive.
Path parameters
directiveId (required) Path Parameter is the value of the name attribute in the directive object.
Return type
Directive
Example data
Content-Type: application/json
{
NetWorker 18.2 REST API Reference Guide 57
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"name" : "name",
"comment" : "comment",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"tenant" : "tenant",
"directive" : "directive"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resource was retrieved successfully. Directive
Up GET /directives
(getDirectives)
Returns a list of directives.
Return type
DirectiveList
Example data
Content-Type: application/json
{
"directives" : [ {
"resourceId" : {
NetWorker 18.2 REST API Reference Guide 58
"sequence" : 1,
"id" : "id"
},
"name" : "name",
"comment" : "comment",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"tenant" : "tenant",
"directive" : "directive"
}, {
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"name" : "name",
"comment" : "comment",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"tenant" : "tenant",
"directive" : "directive"
} ],
"count" : 0,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
NetWorker 18.2 REST API Reference Guide 59
} ]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resources were retrieved successfully. DirectiveList
Up POST /directives
(postDirectives)
Creates a new directive.
Request body
directive Directive (required) Body Parameter Directive to be created.
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
201 Resource was created successfully.
Up PUT /directives/{directiveId}
(putDirective)
Updates the specific directive.
Path parameters
directiveId (required)
NetWorker 18.2 REST API Reference Guide 60
Path Parameter is the value of the name attribute in the directive object.
Request body
directive Directive (required) Body Parameter Directive data for update.
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
204 Resource was updated successfully.
Jobs
Up GET /jobs/{jobId}
(getJob)
Returns the specific job.
Path parameters
jobId (required) Path Parameter is the value of the id attribute in the job object.
Return type
Job
Example data
Content-Type: application/json
{
"vProxyMountTargetVmInvalidUser" : true,
"vProxyMountVCenterHostname" : "vProxyMountVCenterHostname",
"adhocJob" : true,
"vProxyMountSessionId" : "vProxyMountSessionId",
"vProxyFlrAgentInstallRequired" : true,
"type" : "type",
"vProxyMountTargetVmUserId" : "vProxyMountTargetVmUserId",
NetWorker 18.2 REST API Reference Guide 61
"vProxyMountTargetVmInvalidAdminUser" : true,
"vProxyHostname" : "vProxyHostname",
"exitCode" : 1,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"startTime" : "2000-01-23T04:56:07.000+00:00",
"id" : 5,
"siblingJobIds" : [ 2, 2 ],
"state" : "Unknown",
"itemIdLong" : 2,
"rootParentJobId" : 3,
"runOnHost" : "runOnHost",
"recoverAppItemStatus" : "recoverAppItemStatus",
"tenant" : "tenant",
"terminationReason" : "terminationReason",
"vProxyMountTargetVmName" : "vProxyMountTargetVmName",
"vProxyInspectDescriptor" : "vProxyInspectDescriptor",
"dependentJobIds" : [ 6, 6 ],
"stopped" : true,
"completionReport" : "completionReport",
"vProxyMountState" : "vProxyMountState",
"dataSize" : {
"unit" : "Byte",
"value" : 6
},
"saveSetId" : "saveSetId",
"ndmp" : true,
"vProxyErrorMessages" : [ "vProxyErrorMessages",
"vProxyErrorMessages" ],
"message" : "message",
"command" : "command",
"itemCount" : 5,
"vProxyRecoverSessionId" : "vProxyRecoverSessionId",
"clientHostname" : "clientHostname",
"vProxyMountTargetVmMoref" : "vProxyMountTargetVmMoref",
"previousJobId" : 9,
"parentJobId" : 7,
"disabledClients" : [ "disabledClients", "disabledClients" ],
"logFile" : "logFile",
"missedClients" : [ "missedClients", "missedClients" ],
"name" : "name",
NetWorker 18.2 REST API Reference Guide 62
"progress" : "progress",
"completionStatus" : "Unknown",
"endTime" : "2000-01-23T04:56:07.000+00:00"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resource was retrieved successfully. Job
Up GET /jobgroups/{jobGroupId}
(getJobGroup)
Returns a list of jobs that belong to the job group.
Path parameters
jobGroupId (required) Path Parameter is the value of the id attribute in the job group object.
Return type
JobList
Example data
Content-Type: application/json
{
"jobs" : [ {
"vProxyMountTargetVmInvalidUser" : true,
"vProxyMountVCenterHostname" : "vProxyMountVCenterHostname",
"adhocJob" : true,
"vProxyMountSessionId" : "vProxyMountSessionId",
"vProxyFlrAgentInstallRequired" : true,
"type" : "type",
"vProxyMountTargetVmUserId" : "vProxyMountTargetVmUserId",
"vProxyMountTargetVmInvalidAdminUser" : true,
"vProxyHostname" : "vProxyHostname",
"exitCode" : 1,
"links" : [ {
"rel" : "create-form",
NetWorker 18.2 REST API Reference Guide 63
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"startTime" : "2000-01-23T04:56:07.000+00:00",
"id" : 5,
"siblingJobIds" : [ 2, 2 ],
"state" : "Unknown",
"itemIdLong" : 2,
"rootParentJobId" : 3,
"runOnHost" : "runOnHost",
"recoverAppItemStatus" : "recoverAppItemStatus",
"tenant" : "tenant",
"terminationReason" : "terminationReason",
"vProxyMountTargetVmName" : "vProxyMountTargetVmName",
"vProxyInspectDescriptor" : "vProxyInspectDescriptor",
"dependentJobIds" : [ 6, 6 ],
"stopped" : true,
"completionReport" : "completionReport",
"vProxyMountState" : "vProxyMountState",
"dataSize" : {
"unit" : "Byte",
"value" : 6
},
"saveSetId" : "saveSetId",
"ndmp" : true,
"vProxyErrorMessages" : [ "vProxyErrorMessages",
"vProxyErrorMessages" ],
"message" : "message",
"command" : "command",
"itemCount" : 5,
"vProxyRecoverSessionId" : "vProxyRecoverSessionId",
"clientHostname" : "clientHostname",
"vProxyMountTargetVmMoref" : "vProxyMountTargetVmMoref",
"previousJobId" : 9,
"parentJobId" : 7,
"disabledClients" : [ "disabledClients", "disabledClients" ],
"logFile" : "logFile",
"missedClients" : [ "missedClients", "missedClients" ],
"name" : "name",
"progress" : "progress",
"completionStatus" : "Unknown",
"endTime" : "2000-01-23T04:56:07.000+00:00"
}, {
"vProxyMountTargetVmInvalidUser" : true,
NetWorker 18.2 REST API Reference Guide 64
"vProxyMountVCenterHostname" : "vProxyMountVCenterHostname",
"adhocJob" : true,
"vProxyMountSessionId" : "vProxyMountSessionId",
"vProxyFlrAgentInstallRequired" : true,
"type" : "type",
"vProxyMountTargetVmUserId" : "vProxyMountTargetVmUserId",
"vProxyMountTargetVmInvalidAdminUser" : true,
"vProxyHostname" : "vProxyHostname",
"exitCode" : 1,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"startTime" : "2000-01-23T04:56:07.000+00:00",
"id" : 5,
"siblingJobIds" : [ 2, 2 ],
"state" : "Unknown",
"itemIdLong" : 2,
"rootParentJobId" : 3,
"runOnHost" : "runOnHost",
"recoverAppItemStatus" : "recoverAppItemStatus",
"tenant" : "tenant",
"terminationReason" : "terminationReason",
"vProxyMountTargetVmName" : "vProxyMountTargetVmName",
"vProxyInspectDescriptor" : "vProxyInspectDescriptor",
"dependentJobIds" : [ 6, 6 ],
"stopped" : true,
"completionReport" : "completionReport",
"vProxyMountState" : "vProxyMountState",
"dataSize" : {
"unit" : "Byte",
"value" : 6
},
"saveSetId" : "saveSetId",
"ndmp" : true,
"vProxyErrorMessages" : [ "vProxyErrorMessages",
"vProxyErrorMessages" ],
"message" : "message",
"command" : "command",
"itemCount" : 5,
"vProxyRecoverSessionId" : "vProxyRecoverSessionId",
"clientHostname" : "clientHostname",
"vProxyMountTargetVmMoref" : "vProxyMountTargetVmMoref",
NetWorker 18.2 REST API Reference Guide 65
"previousJobId" : 9,
"parentJobId" : 7,
"disabledClients" : [ "disabledClients", "disabledClients" ],
"logFile" : "logFile",
"missedClients" : [ "missedClients", "missedClients" ],
"name" : "name",
"progress" : "progress",
"completionStatus" : "Unknown",
"endTime" : "2000-01-23T04:56:07.000+00:00"
} ],
"count" : 0,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resources were retrieved successfully. JobList
Up GET /jobgroups
(getJobGroups)
Returns a list of job groups.
Return type
JobList
Example data
Content-Type: application/json
NetWorker 18.2 REST API Reference Guide 66
{
"jobs" : [ {
"vProxyMountTargetVmInvalidUser" : true,
"vProxyMountVCenterHostname" : "vProxyMountVCenterHostname",
"adhocJob" : true,
"vProxyMountSessionId" : "vProxyMountSessionId",
"vProxyFlrAgentInstallRequired" : true,
"type" : "type",
"vProxyMountTargetVmUserId" : "vProxyMountTargetVmUserId",
"vProxyMountTargetVmInvalidAdminUser" : true,
"vProxyHostname" : "vProxyHostname",
"exitCode" : 1,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"startTime" : "2000-01-23T04:56:07.000+00:00",
"id" : 5,
"siblingJobIds" : [ 2, 2 ],
"state" : "Unknown",
"itemIdLong" : 2,
"rootParentJobId" : 3,
"runOnHost" : "runOnHost",
"recoverAppItemStatus" : "recoverAppItemStatus",
"tenant" : "tenant",
"terminationReason" : "terminationReason",
"vProxyMountTargetVmName" : "vProxyMountTargetVmName",
"vProxyInspectDescriptor" : "vProxyInspectDescriptor",
"dependentJobIds" : [ 6, 6 ],
"stopped" : true,
"completionReport" : "completionReport",
"vProxyMountState" : "vProxyMountState",
"dataSize" : {
"unit" : "Byte",
"value" : 6
},
"saveSetId" : "saveSetId",
"ndmp" : true,
"vProxyErrorMessages" : [ "vProxyErrorMessages",
"vProxyErrorMessages" ],
"message" : "message",
"command" : "command",
"itemCount" : 5,
NetWorker 18.2 REST API Reference Guide 67
"vProxyRecoverSessionId" : "vProxyRecoverSessionId",
"clientHostname" : "clientHostname",
"vProxyMountTargetVmMoref" : "vProxyMountTargetVmMoref",
"previousJobId" : 9,
"parentJobId" : 7,
"disabledClients" : [ "disabledClients", "disabledClients" ],
"logFile" : "logFile",
"missedClients" : [ "missedClients", "missedClients" ],
"name" : "name",
"progress" : "progress",
"completionStatus" : "Unknown",
"endTime" : "2000-01-23T04:56:07.000+00:00"
}, {
"vProxyMountTargetVmInvalidUser" : true,
"vProxyMountVCenterHostname" : "vProxyMountVCenterHostname",
"adhocJob" : true,
"vProxyMountSessionId" : "vProxyMountSessionId",
"vProxyFlrAgentInstallRequired" : true,
"type" : "type",
"vProxyMountTargetVmUserId" : "vProxyMountTargetVmUserId",
"vProxyMountTargetVmInvalidAdminUser" : true,
"vProxyHostname" : "vProxyHostname",
"exitCode" : 1,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"startTime" : "2000-01-23T04:56:07.000+00:00",
"id" : 5,
"siblingJobIds" : [ 2, 2 ],
"state" : "Unknown",
"itemIdLong" : 2,
"rootParentJobId" : 3,
"runOnHost" : "runOnHost",
"recoverAppItemStatus" : "recoverAppItemStatus",
"tenant" : "tenant",
"terminationReason" : "terminationReason",
"vProxyMountTargetVmName" : "vProxyMountTargetVmName",
"vProxyInspectDescriptor" : "vProxyInspectDescriptor",
"dependentJobIds" : [ 6, 6 ],
"stopped" : true,
"completionReport" : "completionReport",
"vProxyMountState" : "vProxyMountState",
NetWorker 18.2 REST API Reference Guide 68
"dataSize" : {
"unit" : "Byte",
"value" : 6
},
"saveSetId" : "saveSetId",
"ndmp" : true,
"vProxyErrorMessages" : [ "vProxyErrorMessages",
"vProxyErrorMessages" ],
"message" : "message",
"command" : "command",
"itemCount" : 5,
"vProxyRecoverSessionId" : "vProxyRecoverSessionId",
"clientHostname" : "clientHostname",
"vProxyMountTargetVmMoref" : "vProxyMountTargetVmMoref",
"previousJobId" : 9,
"parentJobId" : 7,
"disabledClients" : [ "disabledClients", "disabledClients" ],
"logFile" : "logFile",
"missedClients" : [ "missedClients", "missedClients" ],
"name" : "name",
"progress" : "progress",
"completionStatus" : "Unknown",
"endTime" : "2000-01-23T04:56:07.000+00:00"
} ],
"count" : 0,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resources were retrieved successfully. JobList
NetWorker 18.2 REST API Reference Guide 69
Up GET /jobindications
(getJobIndications)
Returns a list of job indications.
Return type
JobIndicationList
Example data
Content-Type: application/json
{
"count" : 0,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"jobIndications" : [ {
"severity" : "Invalid",
"jobId" : 6,
"catalogId" : "catalogId",
"messageId" : "messageId",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"message" : "message",
"originComponent" : "originComponent",
"messageCatalogNumber" : "messageCatalogNumber",
"tenant" : "tenant",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"severity" : "Invalid",
NetWorker 18.2 REST API Reference Guide 70
"jobId" : 6,
"catalogId" : "catalogId",
"messageId" : "messageId",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"message" : "message",
"originComponent" : "originComponent",
"messageCatalogNumber" : "messageCatalogNumber",
"tenant" : "tenant",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resources were retrieved successfully. JobIndicationList
Up GET /jobs/{jobId}/log
(getJobLog)
Returns a log file for a job.
Path parameters
jobId (required) Path Parameter is the value of the id attribute in the job object.
Produces
NetWorker 18.2 REST API Reference Guide 71
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/octet-stream
Responses
200 Resource was retrieved successfully.
400 Bad request. ErrorResponse
401 Unauthorized. ErrorResponse
404 Not found. ErrorResponse
405 Method not allowed. ErrorResponse
500 Internal server error. ErrorResponse
Up GET /jobs
(getJobs)
Returns a list of jobs.
Return type
JobList
Example data
Content-Type: application/json
{
"jobs" : [ {
"vProxyMountTargetVmInvalidUser" : true,
"vProxyMountVCenterHostname" : "vProxyMountVCenterHostname",
"adhocJob" : true,
"vProxyMountSessionId" : "vProxyMountSessionId",
"vProxyFlrAgentInstallRequired" : true,
"type" : "type",
"vProxyMountTargetVmUserId" : "vProxyMountTargetVmUserId",
"vProxyMountTargetVmInvalidAdminUser" : true,
"vProxyHostname" : "vProxyHostname",
"exitCode" : 1,
"links" : [ {
"rel" : "create-form",
"href" : "href",
NetWorker 18.2 REST API Reference Guide 72
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"startTime" : "2000-01-23T04:56:07.000+00:00",
"id" : 5,
"siblingJobIds" : [ 2, 2 ],
"state" : "Unknown",
"itemIdLong" : 2,
"rootParentJobId" : 3,
"runOnHost" : "runOnHost",
"recoverAppItemStatus" : "recoverAppItemStatus",
"tenant" : "tenant",
"terminationReason" : "terminationReason",
"vProxyMountTargetVmName" : "vProxyMountTargetVmName",
"vProxyInspectDescriptor" : "vProxyInspectDescriptor",
"dependentJobIds" : [ 6, 6 ],
"stopped" : true,
"completionReport" : "completionReport",
"vProxyMountState" : "vProxyMountState",
"dataSize" : {
"unit" : "Byte",
"value" : 6
},
"saveSetId" : "saveSetId",
"ndmp" : true,
"vProxyErrorMessages" : [ "vProxyErrorMessages",
"vProxyErrorMessages" ],
"message" : "message",
"command" : "command",
"itemCount" : 5,
"vProxyRecoverSessionId" : "vProxyRecoverSessionId",
"clientHostname" : "clientHostname",
"vProxyMountTargetVmMoref" : "vProxyMountTargetVmMoref",
"previousJobId" : 9,
"parentJobId" : 7,
"disabledClients" : [ "disabledClients", "disabledClients" ],
"logFile" : "logFile",
"missedClients" : [ "missedClients", "missedClients" ],
"name" : "name",
"progress" : "progress",
"completionStatus" : "Unknown",
"endTime" : "2000-01-23T04:56:07.000+00:00"
}, {
"vProxyMountTargetVmInvalidUser" : true,
"vProxyMountVCenterHostname" : "vProxyMountVCenterHostname",
NetWorker 18.2 REST API Reference Guide 73
"adhocJob" : true,
"vProxyMountSessionId" : "vProxyMountSessionId",
"vProxyFlrAgentInstallRequired" : true,
"type" : "type",
"vProxyMountTargetVmUserId" : "vProxyMountTargetVmUserId",
"vProxyMountTargetVmInvalidAdminUser" : true,
"vProxyHostname" : "vProxyHostname",
"exitCode" : 1,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"startTime" : "2000-01-23T04:56:07.000+00:00",
"id" : 5,
"siblingJobIds" : [ 2, 2 ],
"state" : "Unknown",
"itemIdLong" : 2,
"rootParentJobId" : 3,
"runOnHost" : "runOnHost",
"recoverAppItemStatus" : "recoverAppItemStatus",
"tenant" : "tenant",
"terminationReason" : "terminationReason",
"vProxyMountTargetVmName" : "vProxyMountTargetVmName",
"vProxyInspectDescriptor" : "vProxyInspectDescriptor",
"dependentJobIds" : [ 6, 6 ],
"stopped" : true,
"completionReport" : "completionReport",
"vProxyMountState" : "vProxyMountState",
"dataSize" : {
"unit" : "Byte",
"value" : 6
},
"saveSetId" : "saveSetId",
"ndmp" : true,
"vProxyErrorMessages" : [ "vProxyErrorMessages",
"vProxyErrorMessages" ],
"message" : "message",
"command" : "command",
"itemCount" : 5,
"vProxyRecoverSessionId" : "vProxyRecoverSessionId",
"clientHostname" : "clientHostname",
"vProxyMountTargetVmMoref" : "vProxyMountTargetVmMoref",
"previousJobId" : 9,
NetWorker 18.2 REST API Reference Guide 74
"parentJobId" : 7,
"disabledClients" : [ "disabledClients", "disabledClients" ],
"logFile" : "logFile",
"missedClients" : [ "missedClients", "missedClients" ],
"name" : "name",
"progress" : "progress",
"completionStatus" : "Unknown",
"endTime" : "2000-01-23T04:56:07.000+00:00"
} ],
"count" : 0,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resources were retrieved successfully. JobList
Up POST /jobs/{jobId}/op/cancel
(postJobOpCancel)
Cancels the specific job.
Path parameters
jobId (required) Path Parameter is the value of the id attribute in the job object.
Request body
jobOpCancel JobOpCancel (required)
NetWorker 18.2 REST API Reference Guide 75
Body Parameter Empty JSON body as a parameter.
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
202 Accepted.
Labels
Up DELETE /labels/{labelId}
(deleteLabel)
Deletes the specific label.
Path parameters
labelId (required) Path Parameter is the value of the name attribute in the label object.
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
204 Resource was retrieved successfully.
Up GET /labels/{labelId}
(getLabel)
Returns the specific label.
NetWorker 18.2 REST API Reference Guide 76
Path parameters
labelId (required) Path Parameter is the value of the name attribute in the label object.
Return type
Label
Example data
Content-Type: application/json
{
"next" : "next",
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"name" : "name",
"comment" : "comment",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"fields" : [ "fields", "fields" ],
"separator" : ".",
"tenant" : "tenant"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resource was retrieved successfully. Label
Up
NetWorker 18.2 REST API Reference Guide 77
GET /labels
(getLabels)
Returns a list of labels.
Return type
LabelList
Example data
Content-Type: application/json
{
"count" : 0,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"labels" : [ {
"next" : "next",
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"name" : "name",
"comment" : "comment",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"fields" : [ "fields", "fields" ],
"separator" : ".",
"tenant" : "tenant"
}, {
"next" : "next",
"resourceId" : {
"sequence" : 1,
NetWorker 18.2 REST API Reference Guide 78
"id" : "id"
},
"name" : "name",
"comment" : "comment",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"fields" : [ "fields", "fields" ],
"separator" : ".",
"tenant" : "tenant"
} ]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resources were retrieved successfully. LabelList
Up POST /labels
(postLabel)
Creates a new label.
Request body
label Label (required) Body Parameter Label to be created.
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
NetWorker 18.2 REST API Reference Guide 79
application/json
Responses
201 Resource was created successfully.
Up PUT /labels/{labelId}
(putLabel)
Updates the specific label.
Path parameters
labelId (required) Path Parameter is the value of the name attribute in the label object.
Request body
label Label (required) Body Parameter Label data for update.
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
204 Resource was updated successfully.
Licenses
Up GET /licenses/{licenseId}
(getLicense)
Returns a specified license.
Path parameters
licenseId (required)
NetWorker 18.2 REST API Reference Guide 80
Path Parameter is the value of the id attribute of the license object's resourceId.
Return type
License
Example data
Content-Type: application/json
{
"licenseType" : "licenseType",
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"authCode" : "authCode",
"enablerCode" : "enablerCode",
"name" : "name",
"hostId" : "hostId",
"comment" : "comment",
"expirationDate" : "expirationDate"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resource was retrieved successfully. License
400 Bad request. ErrorResponse
401 Unauthorized. ErrorResponse
404 Not found. ErrorResponse
405 Method not allowed. ErrorResponse
500 Internal server error. ErrorResponse
Up GET /licenses
NetWorker 18.2 REST API Reference Guide 81
(getLicenses)
Returns a list of licenses.
Return type
LicenseList
Example data
Content-Type: application/json
{
"licenses" : [ {
"licenseType" : "licenseType",
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"authCode" : "authCode",
"enablerCode" : "enablerCode",
"name" : "name",
"hostId" : "hostId",
"comment" : "comment",
"expirationDate" : "expirationDate"
}, {
"licenseType" : "licenseType",
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"authCode" : "authCode",
"enablerCode" : "enablerCode",
"name" : "name",
"hostId" : "hostId",
"comment" : "comment",
"expirationDate" : "expirationDate"
} ],
"count" : 0,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ]
}
NetWorker 18.2 REST API Reference Guide 82
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resources were retrieved successfully. LicenseList
400 Bad request. ErrorResponse
401 Unauthorized. ErrorResponse
404 Not found. ErrorResponse
405 Method not allowed. ErrorResponse
500 Internal server error. ErrorResponse
Notifications
Up DELETE /notifications/{notificationId}
(deleteNotification)
Deletes the specific notification.
Path parameters
notificationId (required) Path Parameter is the value of the name attribute in the notification object.
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
NetWorker 18.2 REST API Reference Guide 83
204 Resource was retrieved successfully.
Up GET /notifications/{notificationId}
(getNotification)
Returns the specific notification.
Path parameters
notificationId (required) Path Parameter is the value of the name attribute in the notification object.
Return type
Notification
Example data
Content-Type: application/json
{
"priorities" : [ "Info", "Info" ],
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"name" : "name",
"action" : "action",
"comment" : "comment",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"additionalEmailRecipient" : "additionalEmailRecipient",
"enabled" : true,
"events" : [ "Media", "Media" ]
}
Produces
NetWorker 18.2 REST API Reference Guide 84
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resource was retrieved successfully. Notification
Up GET /notifications
(getNotifications)
Returns a list of notifications.
Return type
NotificationList
Example data
Content-Type: application/json
{
"count" : 0,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"notifications" : [ {
"priorities" : [ "Info", "Info" ],
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"name" : "name",
"action" : "action",
"comment" : "comment",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
NetWorker 18.2 REST API Reference Guide 85
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"additionalEmailRecipient" : "additionalEmailRecipient",
"enabled" : true,
"events" : [ "Media", "Media" ]
}, {
"priorities" : [ "Info", "Info" ],
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"name" : "name",
"action" : "action",
"comment" : "comment",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"additionalEmailRecipient" : "additionalEmailRecipient",
"enabled" : true,
"events" : [ "Media", "Media" ]
} ]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resources were retrieved successfully. NotificationList
NetWorker 18.2 REST API Reference Guide 86
Up POST /notifications
(postNotification)
Creates a new notification.
Request body
notification Notification (required) Body Parameter Notification to be created.
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
201 Resource was created successfully.
Up PUT /notifications/{notificationId}
(putNotification)
Updates the specific notification.
Path parameters
notificationId (required) Path Parameter is the value of the name attribute in the notification object.
Request body
notification Notification (required) Body Parameter Notification data for update.
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
NetWorker 18.2 REST API Reference Guide 87
Responses
204 Resource was updated successfully.
Pools
Up DELETE /pools/{poolId}
(deletePool)
Deletes the specific media pool.
Path parameters
poolId (required) Path Parameter is the value of the name attribute in the pool object.
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
204 Resource was retrieved successfully.
Up GET /pools/{poolId}
(getPool)
Returns the specific media pool.
Path parameters
poolId (required) Path Parameter is the value of the name attribute in the pool object.
Return type
Pool
Example data
NetWorker 18.2 REST API Reference Guide 88
Content-Type: application/json
{
"wormPool" : true,
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"recycleStart" : "recycleStart",
"devices" : [ "devices", "devices" ],
"volumeTypePreference" : "Data Domain",
"maxParallelism" : 6,
"recycleInterval" : "recycleInterval",
"autoMediaVerify" : true,
"poolType" : "Backup",
"createDltWorm" : true,
"enabled" : true,
"barcodePrefix" : "barcodePrefix",
"recycleToOtherPools" : true,
"name" : "name",
"comment" : "comment",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"recycleFromOtherPools" : true,
"storeIndexEntries" : true,
"maxVolumesToRecycle" : 1,
"labelTemplate" : "labelTemplate",
"tenant" : "tenant",
"mediaTypeRequired" : "Data Domain"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
NetWorker 18.2 REST API Reference Guide 89
200 Resource was retrieved successfully. Pool
Up GET /pools
(getPools)
Returns a list of media pools.
Return type
PoolList
Example data
Content-Type: application/json
{
"count" : 0,
"pools" : [ {
"wormPool" : true,
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"recycleStart" : "recycleStart",
"devices" : [ "devices", "devices" ],
"volumeTypePreference" : "Data Domain",
"maxParallelism" : 6,
"recycleInterval" : "recycleInterval",
"autoMediaVerify" : true,
"poolType" : "Backup",
"createDltWorm" : true,
"enabled" : true,
"barcodePrefix" : "barcodePrefix",
"recycleToOtherPools" : true,
"name" : "name",
"comment" : "comment",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"recycleFromOtherPools" : true,
"storeIndexEntries" : true,
NetWorker 18.2 REST API Reference Guide 90
"maxVolumesToRecycle" : 1,
"labelTemplate" : "labelTemplate",
"tenant" : "tenant",
"mediaTypeRequired" : "Data Domain"
}, {
"wormPool" : true,
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"recycleStart" : "recycleStart",
"devices" : [ "devices", "devices" ],
"volumeTypePreference" : "Data Domain",
"maxParallelism" : 6,
"recycleInterval" : "recycleInterval",
"autoMediaVerify" : true,
"poolType" : "Backup",
"createDltWorm" : true,
"enabled" : true,
"barcodePrefix" : "barcodePrefix",
"recycleToOtherPools" : true,
"name" : "name",
"comment" : "comment",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"recycleFromOtherPools" : true,
"storeIndexEntries" : true,
"maxVolumesToRecycle" : 1,
"labelTemplate" : "labelTemplate",
"tenant" : "tenant",
"mediaTypeRequired" : "Data Domain"
} ],
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
NetWorker 18.2 REST API Reference Guide 91
"title" : "title"
} ]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resources were retrieved successfully. PoolList
Up POST /pools
(postPools)
Creates a new media pool.
Request body
pool Pool (required) Body Parameter Media pool to be created.
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
201 Resource was created successfully.
Up PUT /pools/{poolId}
(putPool)
Updates the specific media pool.
Path parameters
NetWorker 18.2 REST API Reference Guide 92
poolId (required) Path Parameter is the value of the name attribute in the pool object.
Request body
pool Pool (required) Body Parameter Media pool data for the update.
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
204 Resource was updated successfully.
Probes
Up DELETE /probes/{probeId}
(deleteProbe)
Deletes the specific probe.
Path parameters
probeId (required) Path Parameter is the value of the name attribute in the probe object.
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
204 Resource was retrieved successfully.
NetWorker 18.2 REST API Reference Guide 93
Up GET /probes/{probeId}
(getProbe)
Returns the specific probe.
Path parameters
probeId (required) Path Parameter is the value of the name attribute in the probe object.
Return type
Probe
Example data
Content-Type: application/json
{
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"probeCommand" : "probeCommand",
"name" : "name",
"comment" : "comment",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"commandOptions" : "commandOptions"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
NetWorker 18.2 REST API Reference Guide 94
200 Resource was retrieved successfully. Probe
Up GET /probes
(getProbes)
Returns a list of probes.
Return type
ProbeList
Example data
Content-Type: application/json
{
"count" : 0,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"probes" : [ {
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"probeCommand" : "probeCommand",
"name" : "name",
"comment" : "comment",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"commandOptions" : "commandOptions"
}, {
NetWorker 18.2 REST API Reference Guide 95
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"probeCommand" : "probeCommand",
"name" : "name",
"comment" : "comment",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"commandOptions" : "commandOptions"
} ]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resources were retrieved successfully. ProbeList
Up POST /probes
(postProbes)
Creates a new probe.
Request body
probe Probe (required) Body Parameter Probe to be created.
Produces
NetWorker 18.2 REST API Reference Guide 96
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
201 Resource was created successfully.
Up PUT /probes/{probeId}
(putProbe)
Updates the specific probe.
Path parameters
probeId (required) Path Parameter is the value of the name attribute in the probe object.
Request body
probe Probe (required) Body Parameter Probe data for the update.
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
204 Resource was updated successfully.
Protectiongroups
Up DELETE /protectiongroups/{protectionGroupId}
(deleteProtectionGroup)
Deletes the specific protection group.
NetWorker 18.2 REST API Reference Guide 97
Path parameters
protectionGroupId (required) Path Parameter is the value of the name attribute in the protection group object.
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
204 Resource was retrieved successfully.
Up GET /protectiongroups/{protectionGroupId}
(getProtectionGroup)
Returns the specific protection group.
Path parameters
protectionGroupId (required) Path Parameter is the value of the name attribute in the protection group object.
Return type
ProtectionGroup
Example data
Content-Type: application/json
{
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"workItemQueries" : [ "workItemQueries", "workItemQueries" ],
"workItems" : [ "workItems", "workItems" ],
"workItemType" : "Client",
"vmwareWorkItemExclusion" : {
"containerMorefs" : [ "containerMorefs", "containerMorefs" ],
"vmdks" : [ {
"vmUuid" : "vmUuid",
NetWorker 18.2 REST API Reference Guide 98
"vmdkUuid" : "vmdkUuid"
}, {
"vmUuid" : "vmUuid",
"vmdkUuid" : "vmdkUuid"
} ],
"vmUuids" : [ "vmUuids", "vmUuids" ],
"vCenterHostname" : "vCenterHostname"
},
"backupOptimization" : "Capacity",
"rule" : "rule",
"dynamicAssociation" : true,
"workItemSubType" : "VirtualMachine",
"name" : "name",
"comment" : "comment",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"vmwareWorkItemSelection" : {
"containerMorefs" : [ "containerMorefs", "containerMorefs" ],
"vmdks" : [ {
"vmUuid" : "vmUuid",
"vmdkUuid" : "vmdkUuid"
}, {
"vmUuid" : "vmUuid",
"vmdkUuid" : "vmdkUuid"
} ],
"vmUuids" : [ "vmUuids", "vmUuids" ],
"vCenterHostname" : "vCenterHostname"
},
"tenant" : "tenant",
"workItemSource" : "Static"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
NetWorker 18.2 REST API Reference Guide 99
200 Resource was retrieved successfully. ProtectionGroup
Up GET /protectiongroups
(getProtectionGroups)
Returns a list of protection groups.
Return type
ProtectionGroupList
Example data
Content-Type: application/json
{
"count" : 0,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"protectionGroups" : [ {
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"workItemQueries" : [ "workItemQueries", "workItemQueries" ],
"workItems" : [ "workItems", "workItems" ],
"workItemType" : "Client",
"vmwareWorkItemExclusion" : {
"containerMorefs" : [ "containerMorefs", "containerMorefs" ],
"vmdks" : [ {
"vmUuid" : "vmUuid",
"vmdkUuid" : "vmdkUuid"
}, {
"vmUuid" : "vmUuid",
"vmdkUuid" : "vmdkUuid"
} ],
"vmUuids" : [ "vmUuids", "vmUuids" ],
"vCenterHostname" : "vCenterHostname"
},
"backupOptimization" : "Capacity",
NetWorker 18.2 REST API Reference Guide 100
"rule" : "rule",
"dynamicAssociation" : true,
"workItemSubType" : "VirtualMachine",
"name" : "name",
"comment" : "comment",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"vmwareWorkItemSelection" : {
"containerMorefs" : [ "containerMorefs", "containerMorefs" ],
"vmdks" : [ {
"vmUuid" : "vmUuid",
"vmdkUuid" : "vmdkUuid"
}, {
"vmUuid" : "vmUuid",
"vmdkUuid" : "vmdkUuid"
} ],
"vmUuids" : [ "vmUuids", "vmUuids" ],
"vCenterHostname" : "vCenterHostname"
},
"tenant" : "tenant",
"workItemSource" : "Static"
}, {
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"workItemQueries" : [ "workItemQueries", "workItemQueries" ],
"workItems" : [ "workItems", "workItems" ],
"workItemType" : "Client",
"vmwareWorkItemExclusion" : {
"containerMorefs" : [ "containerMorefs", "containerMorefs" ],
"vmdks" : [ {
"vmUuid" : "vmUuid",
"vmdkUuid" : "vmdkUuid"
}, {
"vmUuid" : "vmUuid",
"vmdkUuid" : "vmdkUuid"
} ],
"vmUuids" : [ "vmUuids", "vmUuids" ],
"vCenterHostname" : "vCenterHostname"
},
NetWorker 18.2 REST API Reference Guide 101
"backupOptimization" : "Capacity",
"rule" : "rule",
"dynamicAssociation" : true,
"workItemSubType" : "VirtualMachine",
"name" : "name",
"comment" : "comment",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"vmwareWorkItemSelection" : {
"containerMorefs" : [ "containerMorefs", "containerMorefs" ],
"vmdks" : [ {
"vmUuid" : "vmUuid",
"vmdkUuid" : "vmdkUuid"
}, {
"vmUuid" : "vmUuid",
"vmdkUuid" : "vmdkUuid"
} ],
"vmUuids" : [ "vmUuids", "vmUuids" ],
"vCenterHostname" : "vCenterHostname"
},
"tenant" : "tenant",
"workItemSource" : "Static"
} ]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resources were retrieved successfully. ProtectionGroupList
Up POST /protectiongroups
NetWorker 18.2 REST API Reference Guide 102
(postProtectionGroups)
Creates a new protection group.
Request body
protectiongroups ProtectionGroup (required) Body Parameter Protection group to be created.
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
201 Resource was created successfully.
Up PUT /protectiongroups/{protectionGroupId}
(putProtectionGroups)
Updates the specific protection group.
Path parameters
protectionGroupId (required) Path Parameter is the value of the name attribute in the protection group object.
Request body
protectionGroup ProtectionGroup (required) Body Parameter Protection group data for the update.
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
204
NetWorker 18.2 REST API Reference Guide 103
Resource was updated successfully.
Up POST /protectiongroups/{protectionGroupId}/op/updatevmwareworkitems
(updateVMwareWorkItems)
Updates the work items for VMware/all protection groups.
Path parameters
protectionGroupId (required) Path Parameter is the value of the name attribute in the protection group object.
Request body
VMwareWorkItemOpUpdate VMwareWorkItemOpUpdate (required) Body Parameter Parameters to update the VMware work items.
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
202 Accepted.
Protectionpolicies
Up DELETE /protectionpolicies/{policyId}
(deletePolicy)
Deletes the specific policy.
Path parameters
policyId (required) Path Parameter is the value of the name attribute in the protection policy object.
Produces
NetWorker 18.2 REST API Reference Guide 104
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
204 Resource was retrieved successfully.
Up DELETE /protectionpolicies/{policyId}/workflows/{workflowId}
(deletePolicyWorkflow)
Deletes the specific workflow.
Path parameters
policyId (required) Path Parameter is the value of the name attribute in the protection policy object.
workflowId (required) Path Parameter is the value of the name attribute in the workflow object.
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
204 Resource was retrieved successfully.
Up GET /protectionpolicies
(getPolicies)
Returns a list of policies.
Return type
PolicyList
NetWorker 18.2 REST API Reference Guide 105
Example data
Content-Type: application/json
{
"protectionPolicies" : [ {
"summaryNotification" : {
"executeOn" : "Completion",
"command" : "command"
},
"policyProtectionEnable" : true,
"policyProtectionPeriod" : "policyProtectionPeriod",
"applyEntireWorkflow" : true,
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"allowManualSaves" : true,
"name" : "name",
"comment" : "comment",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"workflows" : [ {
"nextStartDate" : "2000-01-23T04:56:07.000+00:00",
"completionNotification" : {
"executeOn" : "Completion",
"command" : "command"
},
"description" : "description",
"enabled" : true,
"protectionGroups" : [ "protectionGroups", "protectionGroups"
],
"newName" : "newName",
"startInterval" : "startInterval",
"name" : "name",
"restartTimeWindow" : "restartTimeWindow",
"comment" : "comment",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
NetWorker 18.2 REST API Reference Guide 106
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"startTime" : "startTime",
"endTime" : "endTime",
"actions" : [ {
"failureImpact" : "Continue",
"actionSpecificData" : {
"testConnectivity" : { },
"discover" : {
"discoverType" : "NAS snapshot"
},
"generateIndex" : {
"generateIndexType" : "NAS snapshot"
},
"backup" : {
"clientOverride" : "ClientCanNotOverride",
"destinationStorageNodes" : [ "destinationStorageNodes",
"destinationStorageNodes" ],
"overrideBackupSchedule" : true,
"successThreshold" : "Warning",
"backupSpecificData" : {
"vmwareVProxy" : {
"quiesceSystemAdminPassword" :
"quiesceSystemAdminPassword",
"enableDDRetentionLock" : true,
"proxyName" : "proxyName",
"destinationPool" : "destinationPool",
"quiesceTimeoutInMinutes" : 5,
"quiesceSystemAdminUsername" :
"quiesceSystemAdminUsername",
"appConsistentQuiesce" : "Basic",
"ddRetentionLockTime" : "ddRetentionLockTime",
"transactionLogBackup" : true
},
"traditional" : {
"enableDDRetentionLock" : true,
"revertToFullWhenSyntheticFullFails" : true,
"fileInactivityThresholdInDays" : 1,
"destinationPool" : "destinationPool",
"fileInactivityAlertThresholdPercentage" : 6,
"ddRetentionLockTime" : "ddRetentionLockTime",
"estimate" : true,
"timestampFormat" : "None",
"forceBackupLevel" : "forceBackupLevel",
"verifySyntheticFull" : true
},
NetWorker 18.2 REST API Reference Guide 107
"vmware" : {
"saveType" : "VMDK",
"useVbaInternalStorage" : true,
"destinationPool" : "destinationPool",
"vbaName" : "vbaName"
},
"snapshot" : {
"destinationPool" : "destinationPool",
"minimumRetentionPeriod" : "minimumRetentionPeriod",
"forceBackupLevel" : "forceBackupLevel"
}
},
"overrideRetentionPeriod" : true,
"retentionPeriod" : "retentionPeriod"
},
"vbaCheckpointBackup" : {
"destinationPool" : "destinationPool",
"retentionPeriod" : "retentionPeriod"
},
"expire" : { },
"clone" : {
"enableDDRetentionLock" : true,
"destinationPool" : "destinationPool",
"ddRetentionLockTime" : "ddRetentionLockTime",
"deleteSource" : true,
"sourceStorageNode" : "sourceStorageNode",
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"serverBackup" : {
"destinationPool" : "destinationPool",
"performBootstrap" : true,
"performClientFileIndexing" : true,
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"probe" : {
"allProbsMustSucceed" : true,
"maxBackupIntervalInDays" : 5
},
"vbaCheckpointDiscover" : { }
},
"workItemFilter" : {
"timeRangeStart" : "2000-01-23T04:56:07.000+00:00",
"clients" : [ "clients", "clients" ],
"saveSetTypes" : [ "saveSetTypes", "saveSetTypes" ],
"excludeTimeRange" : "true",
"timeRangeEnd" : "2000-01-23T04:56:07.000+00:00",
"excludeClient" : "true",
"excludeLevel" : "true",
NetWorker 18.2 REST API Reference Guide 108
"excludeSaveSetType" : "true",
"levels" : [ "levels", "levels" ]
},
"completionNotification" : {
"executeOn" : "Completion",
"command" : "command"
},
"parallelism" : 7,
"concurrent" : true,
"retryDelayInSec" : 3,
"scheduleComment" : "scheduleComment",
"drivenBy" : "drivenBy",
"enabled" : true,
"scheduleActivities" : [ "scheduleActivities",
"scheduleActivities" ],
"disableActionStartTime" : true,
"retries" : 9,
"customTags" : [ "customTags", "customTags" ],
"newName" : "newName",
"name" : "name",
"inactivityTimeoutInMin" : 2,
"actionStartTime" : "actionStartTime",
"comment" : "comment",
"hardLimit" : "hardLimit",
"scheduleOverrides" : [ "scheduleOverrides",
"scheduleOverrides" ],
"schedulePeriod" : "Week",
"softLimit" : "softLimit"
}, {
"failureImpact" : "Continue",
"actionSpecificData" : {
"testConnectivity" : { },
"discover" : {
"discoverType" : "NAS snapshot"
},
"generateIndex" : {
"generateIndexType" : "NAS snapshot"
},
"backup" : {
"clientOverride" : "ClientCanNotOverride",
"destinationStorageNodes" : [ "destinationStorageNodes",
"destinationStorageNodes" ],
"overrideBackupSchedule" : true,
"successThreshold" : "Warning",
"backupSpecificData" : {
"vmwareVProxy" : {
"quiesceSystemAdminPassword" :
"quiesceSystemAdminPassword",
"enableDDRetentionLock" : true,
"proxyName" : "proxyName",
"destinationPool" : "destinationPool",
NetWorker 18.2 REST API Reference Guide 109
"quiesceTimeoutInMinutes" : 5,
"quiesceSystemAdminUsername" :
"quiesceSystemAdminUsername",
"appConsistentQuiesce" : "Basic",
"ddRetentionLockTime" : "ddRetentionLockTime",
"transactionLogBackup" : true
},
"traditional" : {
"enableDDRetentionLock" : true,
"revertToFullWhenSyntheticFullFails" : true,
"fileInactivityThresholdInDays" : 1,
"destinationPool" : "destinationPool",
"fileInactivityAlertThresholdPercentage" : 6,
"ddRetentionLockTime" : "ddRetentionLockTime",
"estimate" : true,
"timestampFormat" : "None",
"forceBackupLevel" : "forceBackupLevel",
"verifySyntheticFull" : true
},
"vmware" : {
"saveType" : "VMDK",
"useVbaInternalStorage" : true,
"destinationPool" : "destinationPool",
"vbaName" : "vbaName"
},
"snapshot" : {
"destinationPool" : "destinationPool",
"minimumRetentionPeriod" : "minimumRetentionPeriod",
"forceBackupLevel" : "forceBackupLevel"
}
},
"overrideRetentionPeriod" : true,
"retentionPeriod" : "retentionPeriod"
},
"vbaCheckpointBackup" : {
"destinationPool" : "destinationPool",
"retentionPeriod" : "retentionPeriod"
},
"expire" : { },
"clone" : {
"enableDDRetentionLock" : true,
"destinationPool" : "destinationPool",
"ddRetentionLockTime" : "ddRetentionLockTime",
"deleteSource" : true,
"sourceStorageNode" : "sourceStorageNode",
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"serverBackup" : {
"destinationPool" : "destinationPool",
NetWorker 18.2 REST API Reference Guide 110
"performBootstrap" : true,
"performClientFileIndexing" : true,
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"probe" : {
"allProbsMustSucceed" : true,
"maxBackupIntervalInDays" : 5
},
"vbaCheckpointDiscover" : { }
},
"workItemFilter" : {
"timeRangeStart" : "2000-01-23T04:56:07.000+00:00",
"clients" : [ "clients", "clients" ],
"saveSetTypes" : [ "saveSetTypes", "saveSetTypes" ],
"excludeTimeRange" : "true",
"timeRangeEnd" : "2000-01-23T04:56:07.000+00:00",
"excludeClient" : "true",
"excludeLevel" : "true",
"excludeSaveSetType" : "true",
"levels" : [ "levels", "levels" ]
},
"completionNotification" : {
"executeOn" : "Completion",
"command" : "command"
},
"parallelism" : 7,
"concurrent" : true,
"retryDelayInSec" : 3,
"scheduleComment" : "scheduleComment",
"drivenBy" : "drivenBy",
"enabled" : true,
"scheduleActivities" : [ "scheduleActivities",
"scheduleActivities" ],
"disableActionStartTime" : true,
"retries" : 9,
"customTags" : [ "customTags", "customTags" ],
"newName" : "newName",
"name" : "name",
"inactivityTimeoutInMin" : 2,
"actionStartTime" : "actionStartTime",
"comment" : "comment",
"hardLimit" : "hardLimit",
"scheduleOverrides" : [ "scheduleOverrides",
"scheduleOverrides" ],
"schedulePeriod" : "Week",
"softLimit" : "softLimit"
} ],
"autoStartEnabled" : true
}, {
NetWorker 18.2 REST API Reference Guide 111
"nextStartDate" : "2000-01-23T04:56:07.000+00:00",
"completionNotification" : {
"executeOn" : "Completion",
"command" : "command"
},
"description" : "description",
"enabled" : true,
"protectionGroups" : [ "protectionGroups", "protectionGroups"
],
"newName" : "newName",
"startInterval" : "startInterval",
"name" : "name",
"restartTimeWindow" : "restartTimeWindow",
"comment" : "comment",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"startTime" : "startTime",
"endTime" : "endTime",
"actions" : [ {
"failureImpact" : "Continue",
"actionSpecificData" : {
"testConnectivity" : { },
"discover" : {
"discoverType" : "NAS snapshot"
},
"generateIndex" : {
"generateIndexType" : "NAS snapshot"
},
"backup" : {
"clientOverride" : "ClientCanNotOverride",
"destinationStorageNodes" : [ "destinationStorageNodes",
"destinationStorageNodes" ],
"overrideBackupSchedule" : true,
"successThreshold" : "Warning",
"backupSpecificData" : {
"vmwareVProxy" : {
"quiesceSystemAdminPassword" :
"quiesceSystemAdminPassword",
"enableDDRetentionLock" : true,
"proxyName" : "proxyName",
"destinationPool" : "destinationPool",
NetWorker 18.2 REST API Reference Guide 112
"quiesceTimeoutInMinutes" : 5,
"quiesceSystemAdminUsername" :
"quiesceSystemAdminUsername",
"appConsistentQuiesce" : "Basic",
"ddRetentionLockTime" : "ddRetentionLockTime",
"transactionLogBackup" : true
},
"traditional" : {
"enableDDRetentionLock" : true,
"revertToFullWhenSyntheticFullFails" : true,
"fileInactivityThresholdInDays" : 1,
"destinationPool" : "destinationPool",
"fileInactivityAlertThresholdPercentage" : 6,
"ddRetentionLockTime" : "ddRetentionLockTime",
"estimate" : true,
"timestampFormat" : "None",
"forceBackupLevel" : "forceBackupLevel",
"verifySyntheticFull" : true
},
"vmware" : {
"saveType" : "VMDK",
"useVbaInternalStorage" : true,
"destinationPool" : "destinationPool",
"vbaName" : "vbaName"
},
"snapshot" : {
"destinationPool" : "destinationPool",
"minimumRetentionPeriod" : "minimumRetentionPeriod",
"forceBackupLevel" : "forceBackupLevel"
}
},
"overrideRetentionPeriod" : true,
"retentionPeriod" : "retentionPeriod"
},
"vbaCheckpointBackup" : {
"destinationPool" : "destinationPool",
"retentionPeriod" : "retentionPeriod"
},
"expire" : { },
"clone" : {
"enableDDRetentionLock" : true,
"destinationPool" : "destinationPool",
"ddRetentionLockTime" : "ddRetentionLockTime",
"deleteSource" : true,
"sourceStorageNode" : "sourceStorageNode",
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"serverBackup" : {
"destinationPool" : "destinationPool",
NetWorker 18.2 REST API Reference Guide 113
"performBootstrap" : true,
"performClientFileIndexing" : true,
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"probe" : {
"allProbsMustSucceed" : true,
"maxBackupIntervalInDays" : 5
},
"vbaCheckpointDiscover" : { }
},
"workItemFilter" : {
"timeRangeStart" : "2000-01-23T04:56:07.000+00:00",
"clients" : [ "clients", "clients" ],
"saveSetTypes" : [ "saveSetTypes", "saveSetTypes" ],
"excludeTimeRange" : "true",
"timeRangeEnd" : "2000-01-23T04:56:07.000+00:00",
"excludeClient" : "true",
"excludeLevel" : "true",
"excludeSaveSetType" : "true",
"levels" : [ "levels", "levels" ]
},
"completionNotification" : {
"executeOn" : "Completion",
"command" : "command"
},
"parallelism" : 7,
"concurrent" : true,
"retryDelayInSec" : 3,
"scheduleComment" : "scheduleComment",
"drivenBy" : "drivenBy",
"enabled" : true,
"scheduleActivities" : [ "scheduleActivities",
"scheduleActivities" ],
"disableActionStartTime" : true,
"retries" : 9,
"customTags" : [ "customTags", "customTags" ],
"newName" : "newName",
"name" : "name",
"inactivityTimeoutInMin" : 2,
"actionStartTime" : "actionStartTime",
"comment" : "comment",
"hardLimit" : "hardLimit",
"scheduleOverrides" : [ "scheduleOverrides",
"scheduleOverrides" ],
"schedulePeriod" : "Week",
"softLimit" : "softLimit"
}, {
"failureImpact" : "Continue",
"actionSpecificData" : {
NetWorker 18.2 REST API Reference Guide 114
"testConnectivity" : { },
"discover" : {
"discoverType" : "NAS snapshot"
},
"generateIndex" : {
"generateIndexType" : "NAS snapshot"
},
"backup" : {
"clientOverride" : "ClientCanNotOverride",
"destinationStorageNodes" : [ "destinationStorageNodes",
"destinationStorageNodes" ],
"overrideBackupSchedule" : true,
"successThreshold" : "Warning",
"backupSpecificData" : {
"vmwareVProxy" : {
"quiesceSystemAdminPassword" :
"quiesceSystemAdminPassword",
"enableDDRetentionLock" : true,
"proxyName" : "proxyName",
"destinationPool" : "destinationPool",
"quiesceTimeoutInMinutes" : 5,
"quiesceSystemAdminUsername" :
"quiesceSystemAdminUsername",
"appConsistentQuiesce" : "Basic",
"ddRetentionLockTime" : "ddRetentionLockTime",
"transactionLogBackup" : true
},
"traditional" : {
"enableDDRetentionLock" : true,
"revertToFullWhenSyntheticFullFails" : true,
"fileInactivityThresholdInDays" : 1,
"destinationPool" : "destinationPool",
"fileInactivityAlertThresholdPercentage" : 6,
"ddRetentionLockTime" : "ddRetentionLockTime",
"estimate" : true,
"timestampFormat" : "None",
"forceBackupLevel" : "forceBackupLevel",
"verifySyntheticFull" : true
},
"vmware" : {
"saveType" : "VMDK",
"useVbaInternalStorage" : true,
"destinationPool" : "destinationPool",
"vbaName" : "vbaName"
},
"snapshot" : {
"destinationPool" : "destinationPool",
"minimumRetentionPeriod" : "minimumRetentionPeriod",
"forceBackupLevel" : "forceBackupLevel"
}
NetWorker 18.2 REST API Reference Guide 115
},
"overrideRetentionPeriod" : true,
"retentionPeriod" : "retentionPeriod"
},
"vbaCheckpointBackup" : {
"destinationPool" : "destinationPool",
"retentionPeriod" : "retentionPeriod"
},
"expire" : { },
"clone" : {
"enableDDRetentionLock" : true,
"destinationPool" : "destinationPool",
"ddRetentionLockTime" : "ddRetentionLockTime",
"deleteSource" : true,
"sourceStorageNode" : "sourceStorageNode",
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"serverBackup" : {
"destinationPool" : "destinationPool",
"performBootstrap" : true,
"performClientFileIndexing" : true,
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"probe" : {
"allProbsMustSucceed" : true,
"maxBackupIntervalInDays" : 5
},
"vbaCheckpointDiscover" : { }
},
"workItemFilter" : {
"timeRangeStart" : "2000-01-23T04:56:07.000+00:00",
"clients" : [ "clients", "clients" ],
"saveSetTypes" : [ "saveSetTypes", "saveSetTypes" ],
"excludeTimeRange" : "true",
"timeRangeEnd" : "2000-01-23T04:56:07.000+00:00",
"excludeClient" : "true",
"excludeLevel" : "true",
"excludeSaveSetType" : "true",
"levels" : [ "levels", "levels" ]
},
"completionNotification" : {
"executeOn" : "Completion",
"command" : "command"
},
"parallelism" : 7,
"concurrent" : true,
"retryDelayInSec" : 3,
"scheduleComment" : "scheduleComment",
NetWorker 18.2 REST API Reference Guide 116
"drivenBy" : "drivenBy",
"enabled" : true,
"scheduleActivities" : [ "scheduleActivities",
"scheduleActivities" ],
"disableActionStartTime" : true,
"retries" : 9,
"customTags" : [ "customTags", "customTags" ],
"newName" : "newName",
"name" : "name",
"inactivityTimeoutInMin" : 2,
"actionStartTime" : "actionStartTime",
"comment" : "comment",
"hardLimit" : "hardLimit",
"scheduleOverrides" : [ "scheduleOverrides",
"scheduleOverrides" ],
"schedulePeriod" : "Week",
"softLimit" : "softLimit"
} ],
"autoStartEnabled" : true
} ],
"tenant" : "tenant"
}, {
"summaryNotification" : {
"executeOn" : "Completion",
"command" : "command"
},
"policyProtectionEnable" : true,
"policyProtectionPeriod" : "policyProtectionPeriod",
"applyEntireWorkflow" : true,
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"allowManualSaves" : true,
"name" : "name",
"comment" : "comment",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"workflows" : [ {
"nextStartDate" : "2000-01-23T04:56:07.000+00:00",
"completionNotification" : {
NetWorker 18.2 REST API Reference Guide 117
"executeOn" : "Completion",
"command" : "command"
},
"description" : "description",
"enabled" : true,
"protectionGroups" : [ "protectionGroups", "protectionGroups"
],
"newName" : "newName",
"startInterval" : "startInterval",
"name" : "name",
"restartTimeWindow" : "restartTimeWindow",
"comment" : "comment",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"startTime" : "startTime",
"endTime" : "endTime",
"actions" : [ {
"failureImpact" : "Continue",
"actionSpecificData" : {
"testConnectivity" : { },
"discover" : {
"discoverType" : "NAS snapshot"
},
"generateIndex" : {
"generateIndexType" : "NAS snapshot"
},
"backup" : {
"clientOverride" : "ClientCanNotOverride",
"destinationStorageNodes" : [ "destinationStorageNodes",
"destinationStorageNodes" ],
"overrideBackupSchedule" : true,
"successThreshold" : "Warning",
"backupSpecificData" : {
"vmwareVProxy" : {
"quiesceSystemAdminPassword" :
"quiesceSystemAdminPassword",
"enableDDRetentionLock" : true,
"proxyName" : "proxyName",
"destinationPool" : "destinationPool",
"quiesceTimeoutInMinutes" : 5,
"quiesceSystemAdminUsername" :
"quiesceSystemAdminUsername",
NetWorker 18.2 REST API Reference Guide 118
"appConsistentQuiesce" : "Basic",
"ddRetentionLockTime" : "ddRetentionLockTime",
"transactionLogBackup" : true
},
"traditional" : {
"enableDDRetentionLock" : true,
"revertToFullWhenSyntheticFullFails" : true,
"fileInactivityThresholdInDays" : 1,
"destinationPool" : "destinationPool",
"fileInactivityAlertThresholdPercentage" : 6,
"ddRetentionLockTime" : "ddRetentionLockTime",
"estimate" : true,
"timestampFormat" : "None",
"forceBackupLevel" : "forceBackupLevel",
"verifySyntheticFull" : true
},
"vmware" : {
"saveType" : "VMDK",
"useVbaInternalStorage" : true,
"destinationPool" : "destinationPool",
"vbaName" : "vbaName"
},
"snapshot" : {
"destinationPool" : "destinationPool",
"minimumRetentionPeriod" : "minimumRetentionPeriod",
"forceBackupLevel" : "forceBackupLevel"
}
},
"overrideRetentionPeriod" : true,
"retentionPeriod" : "retentionPeriod"
},
"vbaCheckpointBackup" : {
"destinationPool" : "destinationPool",
"retentionPeriod" : "retentionPeriod"
},
"expire" : { },
"clone" : {
"enableDDRetentionLock" : true,
"destinationPool" : "destinationPool",
"ddRetentionLockTime" : "ddRetentionLockTime",
"deleteSource" : true,
"sourceStorageNode" : "sourceStorageNode",
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"serverBackup" : {
"destinationPool" : "destinationPool",
"performBootstrap" : true,
"performClientFileIndexing" : true,
"destinationStorageNode" : "destinationStorageNode",
NetWorker 18.2 REST API Reference Guide 119
"retentionPeriod" : "retentionPeriod"
},
"probe" : {
"allProbsMustSucceed" : true,
"maxBackupIntervalInDays" : 5
},
"vbaCheckpointDiscover" : { }
},
"workItemFilter" : {
"timeRangeStart" : "2000-01-23T04:56:07.000+00:00",
"clients" : [ "clients", "clients" ],
"saveSetTypes" : [ "saveSetTypes", "saveSetTypes" ],
"excludeTimeRange" : "true",
"timeRangeEnd" : "2000-01-23T04:56:07.000+00:00",
"excludeClient" : "true",
"excludeLevel" : "true",
"excludeSaveSetType" : "true",
"levels" : [ "levels", "levels" ]
},
"completionNotification" : {
"executeOn" : "Completion",
"command" : "command"
},
"parallelism" : 7,
"concurrent" : true,
"retryDelayInSec" : 3,
"scheduleComment" : "scheduleComment",
"drivenBy" : "drivenBy",
"enabled" : true,
"scheduleActivities" : [ "scheduleActivities",
"scheduleActivities" ],
"disableActionStartTime" : true,
"retries" : 9,
"customTags" : [ "customTags", "customTags" ],
"newName" : "newName",
"name" : "name",
"inactivityTimeoutInMin" : 2,
"actionStartTime" : "actionStartTime",
"comment" : "comment",
"hardLimit" : "hardLimit",
"scheduleOverrides" : [ "scheduleOverrides",
"scheduleOverrides" ],
"schedulePeriod" : "Week",
"softLimit" : "softLimit"
}, {
"failureImpact" : "Continue",
"actionSpecificData" : {
"testConnectivity" : { },
"discover" : {
"discoverType" : "NAS snapshot"
NetWorker 18.2 REST API Reference Guide 120
},
"generateIndex" : {
"generateIndexType" : "NAS snapshot"
},
"backup" : {
"clientOverride" : "ClientCanNotOverride",
"destinationStorageNodes" : [ "destinationStorageNodes",
"destinationStorageNodes" ],
"overrideBackupSchedule" : true,
"successThreshold" : "Warning",
"backupSpecificData" : {
"vmwareVProxy" : {
"quiesceSystemAdminPassword" :
"quiesceSystemAdminPassword",
"enableDDRetentionLock" : true,
"proxyName" : "proxyName",
"destinationPool" : "destinationPool",
"quiesceTimeoutInMinutes" : 5,
"quiesceSystemAdminUsername" :
"quiesceSystemAdminUsername",
"appConsistentQuiesce" : "Basic",
"ddRetentionLockTime" : "ddRetentionLockTime",
"transactionLogBackup" : true
},
"traditional" : {
"enableDDRetentionLock" : true,
"revertToFullWhenSyntheticFullFails" : true,
"fileInactivityThresholdInDays" : 1,
"destinationPool" : "destinationPool",
"fileInactivityAlertThresholdPercentage" : 6,
"ddRetentionLockTime" : "ddRetentionLockTime",
"estimate" : true,
"timestampFormat" : "None",
"forceBackupLevel" : "forceBackupLevel",
"verifySyntheticFull" : true
},
"vmware" : {
"saveType" : "VMDK",
"useVbaInternalStorage" : true,
"destinationPool" : "destinationPool",
"vbaName" : "vbaName"
},
"snapshot" : {
"destinationPool" : "destinationPool",
"minimumRetentionPeriod" : "minimumRetentionPeriod",
"forceBackupLevel" : "forceBackupLevel"
}
},
"overrideRetentionPeriod" : true,
"retentionPeriod" : "retentionPeriod"
NetWorker 18.2 REST API Reference Guide 121
},
"vbaCheckpointBackup" : {
"destinationPool" : "destinationPool",
"retentionPeriod" : "retentionPeriod"
},
"expire" : { },
"clone" : {
"enableDDRetentionLock" : true,
"destinationPool" : "destinationPool",
"ddRetentionLockTime" : "ddRetentionLockTime",
"deleteSource" : true,
"sourceStorageNode" : "sourceStorageNode",
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"serverBackup" : {
"destinationPool" : "destinationPool",
"performBootstrap" : true,
"performClientFileIndexing" : true,
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"probe" : {
"allProbsMustSucceed" : true,
"maxBackupIntervalInDays" : 5
},
"vbaCheckpointDiscover" : { }
},
"workItemFilter" : {
"timeRangeStart" : "2000-01-23T04:56:07.000+00:00",
"clients" : [ "clients", "clients" ],
"saveSetTypes" : [ "saveSetTypes", "saveSetTypes" ],
"excludeTimeRange" : "true",
"timeRangeEnd" : "2000-01-23T04:56:07.000+00:00",
"excludeClient" : "true",
"excludeLevel" : "true",
"excludeSaveSetType" : "true",
"levels" : [ "levels", "levels" ]
},
"completionNotification" : {
"executeOn" : "Completion",
"command" : "command"
},
"parallelism" : 7,
"concurrent" : true,
"retryDelayInSec" : 3,
"scheduleComment" : "scheduleComment",
"drivenBy" : "drivenBy",
"enabled" : true,
NetWorker 18.2 REST API Reference Guide 122
"scheduleActivities" : [ "scheduleActivities",
"scheduleActivities" ],
"disableActionStartTime" : true,
"retries" : 9,
"customTags" : [ "customTags", "customTags" ],
"newName" : "newName",
"name" : "name",
"inactivityTimeoutInMin" : 2,
"actionStartTime" : "actionStartTime",
"comment" : "comment",
"hardLimit" : "hardLimit",
"scheduleOverrides" : [ "scheduleOverrides",
"scheduleOverrides" ],
"schedulePeriod" : "Week",
"softLimit" : "softLimit"
} ],
"autoStartEnabled" : true
}, {
"nextStartDate" : "2000-01-23T04:56:07.000+00:00",
"completionNotification" : {
"executeOn" : "Completion",
"command" : "command"
},
"description" : "description",
"enabled" : true,
"protectionGroups" : [ "protectionGroups", "protectionGroups"
],
"newName" : "newName",
"startInterval" : "startInterval",
"name" : "name",
"restartTimeWindow" : "restartTimeWindow",
"comment" : "comment",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"startTime" : "startTime",
"endTime" : "endTime",
"actions" : [ {
"failureImpact" : "Continue",
"actionSpecificData" : {
"testConnectivity" : { },
"discover" : {
NetWorker 18.2 REST API Reference Guide 123
"discoverType" : "NAS snapshot"
},
"generateIndex" : {
"generateIndexType" : "NAS snapshot"
},
"backup" : {
"clientOverride" : "ClientCanNotOverride",
"destinationStorageNodes" : [ "destinationStorageNodes",
"destinationStorageNodes" ],
"overrideBackupSchedule" : true,
"successThreshold" : "Warning",
"backupSpecificData" : {
"vmwareVProxy" : {
"quiesceSystemAdminPassword" :
"quiesceSystemAdminPassword",
"enableDDRetentionLock" : true,
"proxyName" : "proxyName",
"destinationPool" : "destinationPool",
"quiesceTimeoutInMinutes" : 5,
"quiesceSystemAdminUsername" :
"quiesceSystemAdminUsername",
"appConsistentQuiesce" : "Basic",
"ddRetentionLockTime" : "ddRetentionLockTime",
"transactionLogBackup" : true
},
"traditional" : {
"enableDDRetentionLock" : true,
"revertToFullWhenSyntheticFullFails" : true,
"fileInactivityThresholdInDays" : 1,
"destinationPool" : "destinationPool",
"fileInactivityAlertThresholdPercentage" : 6,
"ddRetentionLockTime" : "ddRetentionLockTime",
"estimate" : true,
"timestampFormat" : "None",
"forceBackupLevel" : "forceBackupLevel",
"verifySyntheticFull" : true
},
"vmware" : {
"saveType" : "VMDK",
"useVbaInternalStorage" : true,
"destinationPool" : "destinationPool",
"vbaName" : "vbaName"
},
"snapshot" : {
"destinationPool" : "destinationPool",
"minimumRetentionPeriod" : "minimumRetentionPeriod",
"forceBackupLevel" : "forceBackupLevel"
}
},
"overrideRetentionPeriod" : true,
NetWorker 18.2 REST API Reference Guide 124
"retentionPeriod" : "retentionPeriod"
},
"vbaCheckpointBackup" : {
"destinationPool" : "destinationPool",
"retentionPeriod" : "retentionPeriod"
},
"expire" : { },
"clone" : {
"enableDDRetentionLock" : true,
"destinationPool" : "destinationPool",
"ddRetentionLockTime" : "ddRetentionLockTime",
"deleteSource" : true,
"sourceStorageNode" : "sourceStorageNode",
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"serverBackup" : {
"destinationPool" : "destinationPool",
"performBootstrap" : true,
"performClientFileIndexing" : true,
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"probe" : {
"allProbsMustSucceed" : true,
"maxBackupIntervalInDays" : 5
},
"vbaCheckpointDiscover" : { }
},
"workItemFilter" : {
"timeRangeStart" : "2000-01-23T04:56:07.000+00:00",
"clients" : [ "clients", "clients" ],
"saveSetTypes" : [ "saveSetTypes", "saveSetTypes" ],
"excludeTimeRange" : "true",
"timeRangeEnd" : "2000-01-23T04:56:07.000+00:00",
"excludeClient" : "true",
"excludeLevel" : "true",
"excludeSaveSetType" : "true",
"levels" : [ "levels", "levels" ]
},
"completionNotification" : {
"executeOn" : "Completion",
"command" : "command"
},
"parallelism" : 7,
"concurrent" : true,
"retryDelayInSec" : 3,
"scheduleComment" : "scheduleComment",
"drivenBy" : "drivenBy",
"enabled" : true,
NetWorker 18.2 REST API Reference Guide 125
"scheduleActivities" : [ "scheduleActivities",
"scheduleActivities" ],
"disableActionStartTime" : true,
"retries" : 9,
"customTags" : [ "customTags", "customTags" ],
"newName" : "newName",
"name" : "name",
"inactivityTimeoutInMin" : 2,
"actionStartTime" : "actionStartTime",
"comment" : "comment",
"hardLimit" : "hardLimit",
"scheduleOverrides" : [ "scheduleOverrides",
"scheduleOverrides" ],
"schedulePeriod" : "Week",
"softLimit" : "softLimit"
}, {
"failureImpact" : "Continue",
"actionSpecificData" : {
"testConnectivity" : { },
"discover" : {
"discoverType" : "NAS snapshot"
},
"generateIndex" : {
"generateIndexType" : "NAS snapshot"
},
"backup" : {
"clientOverride" : "ClientCanNotOverride",
"destinationStorageNodes" : [ "destinationStorageNodes",
"destinationStorageNodes" ],
"overrideBackupSchedule" : true,
"successThreshold" : "Warning",
"backupSpecificData" : {
"vmwareVProxy" : {
"quiesceSystemAdminPassword" :
"quiesceSystemAdminPassword",
"enableDDRetentionLock" : true,
"proxyName" : "proxyName",
"destinationPool" : "destinationPool",
"quiesceTimeoutInMinutes" : 5,
"quiesceSystemAdminUsername" :
"quiesceSystemAdminUsername",
"appConsistentQuiesce" : "Basic",
"ddRetentionLockTime" : "ddRetentionLockTime",
"transactionLogBackup" : true
},
"traditional" : {
"enableDDRetentionLock" : true,
"revertToFullWhenSyntheticFullFails" : true,
"fileInactivityThresholdInDays" : 1,
"destinationPool" : "destinationPool",
"fileInactivityAlertThresholdPercentage" : 6,
NetWorker 18.2 REST API Reference Guide 126
"ddRetentionLockTime" : "ddRetentionLockTime",
"estimate" : true,
"timestampFormat" : "None",
"forceBackupLevel" : "forceBackupLevel",
"verifySyntheticFull" : true
},
"vmware" : {
"saveType" : "VMDK",
"useVbaInternalStorage" : true,
"destinationPool" : "destinationPool",
"vbaName" : "vbaName"
},
"snapshot" : {
"destinationPool" : "destinationPool",
"minimumRetentionPeriod" : "minimumRetentionPeriod",
"forceBackupLevel" : "forceBackupLevel"
}
},
"overrideRetentionPeriod" : true,
"retentionPeriod" : "retentionPeriod"
},
"vbaCheckpointBackup" : {
"destinationPool" : "destinationPool",
"retentionPeriod" : "retentionPeriod"
},
"expire" : { },
"clone" : {
"enableDDRetentionLock" : true,
"destinationPool" : "destinationPool",
"ddRetentionLockTime" : "ddRetentionLockTime",
"deleteSource" : true,
"sourceStorageNode" : "sourceStorageNode",
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"serverBackup" : {
"destinationPool" : "destinationPool",
"performBootstrap" : true,
"performClientFileIndexing" : true,
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"probe" : {
"allProbsMustSucceed" : true,
"maxBackupIntervalInDays" : 5
},
"vbaCheckpointDiscover" : { }
},
"workItemFilter" : {
"timeRangeStart" : "2000-01-23T04:56:07.000+00:00",
NetWorker 18.2 REST API Reference Guide 127
"clients" : [ "clients", "clients" ],
"saveSetTypes" : [ "saveSetTypes", "saveSetTypes" ],
"excludeTimeRange" : "true",
"timeRangeEnd" : "2000-01-23T04:56:07.000+00:00",
"excludeClient" : "true",
"excludeLevel" : "true",
"excludeSaveSetType" : "true",
"levels" : [ "levels", "levels" ]
},
"completionNotification" : {
"executeOn" : "Completion",
"command" : "command"
},
"parallelism" : 7,
"concurrent" : true,
"retryDelayInSec" : 3,
"scheduleComment" : "scheduleComment",
"drivenBy" : "drivenBy",
"enabled" : true,
"scheduleActivities" : [ "scheduleActivities",
"scheduleActivities" ],
"disableActionStartTime" : true,
"retries" : 9,
"customTags" : [ "customTags", "customTags" ],
"newName" : "newName",
"name" : "name",
"inactivityTimeoutInMin" : 2,
"actionStartTime" : "actionStartTime",
"comment" : "comment",
"hardLimit" : "hardLimit",
"scheduleOverrides" : [ "scheduleOverrides",
"scheduleOverrides" ],
"schedulePeriod" : "Week",
"softLimit" : "softLimit"
} ],
"autoStartEnabled" : true
} ],
"tenant" : "tenant"
} ],
"count" : 0,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
NetWorker 18.2 REST API Reference Guide 128
} ]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resources were retrieved successfully. PolicyList
Up GET /protectionpolicies/{policyId}
(getPolicy)
Returns the specific policy.
Path parameters
policyId (required) Path Parameter is the value of the name attribute in the protection policy object.
Return type
Policy
Example data
Content-Type: application/json
{
"summaryNotification" : {
"executeOn" : "Completion",
"command" : "command"
},
"policyProtectionEnable" : true,
"policyProtectionPeriod" : "policyProtectionPeriod",
"applyEntireWorkflow" : true,
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"allowManualSaves" : true,
"name" : "name",
"comment" : "comment",
NetWorker 18.2 REST API Reference Guide 129
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"workflows" : [ {
"nextStartDate" : "2000-01-23T04:56:07.000+00:00",
"completionNotification" : {
"executeOn" : "Completion",
"command" : "command"
},
"description" : "description",
"enabled" : true,
"protectionGroups" : [ "protectionGroups", "protectionGroups" ],
"newName" : "newName",
"startInterval" : "startInterval",
"name" : "name",
"restartTimeWindow" : "restartTimeWindow",
"comment" : "comment",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"startTime" : "startTime",
"endTime" : "endTime",
"actions" : [ {
"failureImpact" : "Continue",
"actionSpecificData" : {
"testConnectivity" : { },
"discover" : {
"discoverType" : "NAS snapshot"
},
"generateIndex" : {
"generateIndexType" : "NAS snapshot"
},
"backup" : {
"clientOverride" : "ClientCanNotOverride",
NetWorker 18.2 REST API Reference Guide 130
"destinationStorageNodes" : [ "destinationStorageNodes",
"destinationStorageNodes" ],
"overrideBackupSchedule" : true,
"successThreshold" : "Warning",
"backupSpecificData" : {
"vmwareVProxy" : {
"quiesceSystemAdminPassword" :
"quiesceSystemAdminPassword",
"enableDDRetentionLock" : true,
"proxyName" : "proxyName",
"destinationPool" : "destinationPool",
"quiesceTimeoutInMinutes" : 5,
"quiesceSystemAdminUsername" :
"quiesceSystemAdminUsername",
"appConsistentQuiesce" : "Basic",
"ddRetentionLockTime" : "ddRetentionLockTime",
"transactionLogBackup" : true
},
"traditional" : {
"enableDDRetentionLock" : true,
"revertToFullWhenSyntheticFullFails" : true,
"fileInactivityThresholdInDays" : 1,
"destinationPool" : "destinationPool",
"fileInactivityAlertThresholdPercentage" : 6,
"ddRetentionLockTime" : "ddRetentionLockTime",
"estimate" : true,
"timestampFormat" : "None",
"forceBackupLevel" : "forceBackupLevel",
"verifySyntheticFull" : true
},
"vmware" : {
"saveType" : "VMDK",
"useVbaInternalStorage" : true,
"destinationPool" : "destinationPool",
"vbaName" : "vbaName"
},
"snapshot" : {
"destinationPool" : "destinationPool",
"minimumRetentionPeriod" : "minimumRetentionPeriod",
"forceBackupLevel" : "forceBackupLevel"
}
},
"overrideRetentionPeriod" : true,
"retentionPeriod" : "retentionPeriod"
},
"vbaCheckpointBackup" : {
"destinationPool" : "destinationPool",
"retentionPeriod" : "retentionPeriod"
},
"expire" : { },
NetWorker 18.2 REST API Reference Guide 131
"clone" : {
"enableDDRetentionLock" : true,
"destinationPool" : "destinationPool",
"ddRetentionLockTime" : "ddRetentionLockTime",
"deleteSource" : true,
"sourceStorageNode" : "sourceStorageNode",
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"serverBackup" : {
"destinationPool" : "destinationPool",
"performBootstrap" : true,
"performClientFileIndexing" : true,
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"probe" : {
"allProbsMustSucceed" : true,
"maxBackupIntervalInDays" : 5
},
"vbaCheckpointDiscover" : { }
},
"workItemFilter" : {
"timeRangeStart" : "2000-01-23T04:56:07.000+00:00",
"clients" : [ "clients", "clients" ],
"saveSetTypes" : [ "saveSetTypes", "saveSetTypes" ],
"excludeTimeRange" : "true",
"timeRangeEnd" : "2000-01-23T04:56:07.000+00:00",
"excludeClient" : "true",
"excludeLevel" : "true",
"excludeSaveSetType" : "true",
"levels" : [ "levels", "levels" ]
},
"completionNotification" : {
"executeOn" : "Completion",
"command" : "command"
},
"parallelism" : 7,
"concurrent" : true,
"retryDelayInSec" : 3,
"scheduleComment" : "scheduleComment",
"drivenBy" : "drivenBy",
"enabled" : true,
"scheduleActivities" : [ "scheduleActivities",
"scheduleActivities" ],
"disableActionStartTime" : true,
"retries" : 9,
"customTags" : [ "customTags", "customTags" ],
"newName" : "newName",
"name" : "name",
NetWorker 18.2 REST API Reference Guide 132
"inactivityTimeoutInMin" : 2,
"actionStartTime" : "actionStartTime",
"comment" : "comment",
"hardLimit" : "hardLimit",
"scheduleOverrides" : [ "scheduleOverrides",
"scheduleOverrides" ],
"schedulePeriod" : "Week",
"softLimit" : "softLimit"
}, {
"failureImpact" : "Continue",
"actionSpecificData" : {
"testConnectivity" : { },
"discover" : {
"discoverType" : "NAS snapshot"
},
"generateIndex" : {
"generateIndexType" : "NAS snapshot"
},
"backup" : {
"clientOverride" : "ClientCanNotOverride",
"destinationStorageNodes" : [ "destinationStorageNodes",
"destinationStorageNodes" ],
"overrideBackupSchedule" : true,
"successThreshold" : "Warning",
"backupSpecificData" : {
"vmwareVProxy" : {
"quiesceSystemAdminPassword" :
"quiesceSystemAdminPassword",
"enableDDRetentionLock" : true,
"proxyName" : "proxyName",
"destinationPool" : "destinationPool",
"quiesceTimeoutInMinutes" : 5,
"quiesceSystemAdminUsername" :
"quiesceSystemAdminUsername",
"appConsistentQuiesce" : "Basic",
"ddRetentionLockTime" : "ddRetentionLockTime",
"transactionLogBackup" : true
},
"traditional" : {
"enableDDRetentionLock" : true,
"revertToFullWhenSyntheticFullFails" : true,
"fileInactivityThresholdInDays" : 1,
"destinationPool" : "destinationPool",
"fileInactivityAlertThresholdPercentage" : 6,
"ddRetentionLockTime" : "ddRetentionLockTime",
"estimate" : true,
"timestampFormat" : "None",
"forceBackupLevel" : "forceBackupLevel",
"verifySyntheticFull" : true
},
"vmware" : {
NetWorker 18.2 REST API Reference Guide 133
"saveType" : "VMDK",
"useVbaInternalStorage" : true,
"destinationPool" : "destinationPool",
"vbaName" : "vbaName"
},
"snapshot" : {
"destinationPool" : "destinationPool",
"minimumRetentionPeriod" : "minimumRetentionPeriod",
"forceBackupLevel" : "forceBackupLevel"
}
},
"overrideRetentionPeriod" : true,
"retentionPeriod" : "retentionPeriod"
},
"vbaCheckpointBackup" : {
"destinationPool" : "destinationPool",
"retentionPeriod" : "retentionPeriod"
},
"expire" : { },
"clone" : {
"enableDDRetentionLock" : true,
"destinationPool" : "destinationPool",
"ddRetentionLockTime" : "ddRetentionLockTime",
"deleteSource" : true,
"sourceStorageNode" : "sourceStorageNode",
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"serverBackup" : {
"destinationPool" : "destinationPool",
"performBootstrap" : true,
"performClientFileIndexing" : true,
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"probe" : {
"allProbsMustSucceed" : true,
"maxBackupIntervalInDays" : 5
},
"vbaCheckpointDiscover" : { }
},
"workItemFilter" : {
"timeRangeStart" : "2000-01-23T04:56:07.000+00:00",
"clients" : [ "clients", "clients" ],
"saveSetTypes" : [ "saveSetTypes", "saveSetTypes" ],
"excludeTimeRange" : "true",
"timeRangeEnd" : "2000-01-23T04:56:07.000+00:00",
"excludeClient" : "true",
"excludeLevel" : "true",
"excludeSaveSetType" : "true",
NetWorker 18.2 REST API Reference Guide 134
"levels" : [ "levels", "levels" ]
},
"completionNotification" : {
"executeOn" : "Completion",
"command" : "command"
},
"parallelism" : 7,
"concurrent" : true,
"retryDelayInSec" : 3,
"scheduleComment" : "scheduleComment",
"drivenBy" : "drivenBy",
"enabled" : true,
"scheduleActivities" : [ "scheduleActivities",
"scheduleActivities" ],
"disableActionStartTime" : true,
"retries" : 9,
"customTags" : [ "customTags", "customTags" ],
"newName" : "newName",
"name" : "name",
"inactivityTimeoutInMin" : 2,
"actionStartTime" : "actionStartTime",
"comment" : "comment",
"hardLimit" : "hardLimit",
"scheduleOverrides" : [ "scheduleOverrides",
"scheduleOverrides" ],
"schedulePeriod" : "Week",
"softLimit" : "softLimit"
} ],
"autoStartEnabled" : true
}, {
"nextStartDate" : "2000-01-23T04:56:07.000+00:00",
"completionNotification" : {
"executeOn" : "Completion",
"command" : "command"
},
"description" : "description",
"enabled" : true,
"protectionGroups" : [ "protectionGroups", "protectionGroups" ],
"newName" : "newName",
"startInterval" : "startInterval",
"name" : "name",
"restartTimeWindow" : "restartTimeWindow",
"comment" : "comment",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
NetWorker 18.2 REST API Reference Guide 135
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"startTime" : "startTime",
"endTime" : "endTime",
"actions" : [ {
"failureImpact" : "Continue",
"actionSpecificData" : {
"testConnectivity" : { },
"discover" : {
"discoverType" : "NAS snapshot"
},
"generateIndex" : {
"generateIndexType" : "NAS snapshot"
},
"backup" : {
"clientOverride" : "ClientCanNotOverride",
"destinationStorageNodes" : [ "destinationStorageNodes",
"destinationStorageNodes" ],
"overrideBackupSchedule" : true,
"successThreshold" : "Warning",
"backupSpecificData" : {
"vmwareVProxy" : {
"quiesceSystemAdminPassword" :
"quiesceSystemAdminPassword",
"enableDDRetentionLock" : true,
"proxyName" : "proxyName",
"destinationPool" : "destinationPool",
"quiesceTimeoutInMinutes" : 5,
"quiesceSystemAdminUsername" :
"quiesceSystemAdminUsername",
"appConsistentQuiesce" : "Basic",
"ddRetentionLockTime" : "ddRetentionLockTime",
"transactionLogBackup" : true
},
"traditional" : {
"enableDDRetentionLock" : true,
"revertToFullWhenSyntheticFullFails" : true,
"fileInactivityThresholdInDays" : 1,
"destinationPool" : "destinationPool",
"fileInactivityAlertThresholdPercentage" : 6,
"ddRetentionLockTime" : "ddRetentionLockTime",
"estimate" : true,
"timestampFormat" : "None",
"forceBackupLevel" : "forceBackupLevel",
"verifySyntheticFull" : true
},
"vmware" : {
"saveType" : "VMDK",
NetWorker 18.2 REST API Reference Guide 136
"useVbaInternalStorage" : true,
"destinationPool" : "destinationPool",
"vbaName" : "vbaName"
},
"snapshot" : {
"destinationPool" : "destinationPool",
"minimumRetentionPeriod" : "minimumRetentionPeriod",
"forceBackupLevel" : "forceBackupLevel"
}
},
"overrideRetentionPeriod" : true,
"retentionPeriod" : "retentionPeriod"
},
"vbaCheckpointBackup" : {
"destinationPool" : "destinationPool",
"retentionPeriod" : "retentionPeriod"
},
"expire" : { },
"clone" : {
"enableDDRetentionLock" : true,
"destinationPool" : "destinationPool",
"ddRetentionLockTime" : "ddRetentionLockTime",
"deleteSource" : true,
"sourceStorageNode" : "sourceStorageNode",
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"serverBackup" : {
"destinationPool" : "destinationPool",
"performBootstrap" : true,
"performClientFileIndexing" : true,
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"probe" : {
"allProbsMustSucceed" : true,
"maxBackupIntervalInDays" : 5
},
"vbaCheckpointDiscover" : { }
},
"workItemFilter" : {
"timeRangeStart" : "2000-01-23T04:56:07.000+00:00",
"clients" : [ "clients", "clients" ],
"saveSetTypes" : [ "saveSetTypes", "saveSetTypes" ],
"excludeTimeRange" : "true",
"timeRangeEnd" : "2000-01-23T04:56:07.000+00:00",
"excludeClient" : "true",
"excludeLevel" : "true",
"excludeSaveSetType" : "true",
"levels" : [ "levels", "levels" ]
NetWorker 18.2 REST API Reference Guide 137
},
"completionNotification" : {
"executeOn" : "Completion",
"command" : "command"
},
"parallelism" : 7,
"concurrent" : true,
"retryDelayInSec" : 3,
"scheduleComment" : "scheduleComment",
"drivenBy" : "drivenBy",
"enabled" : true,
"scheduleActivities" : [ "scheduleActivities",
"scheduleActivities" ],
"disableActionStartTime" : true,
"retries" : 9,
"customTags" : [ "customTags", "customTags" ],
"newName" : "newName",
"name" : "name",
"inactivityTimeoutInMin" : 2,
"actionStartTime" : "actionStartTime",
"comment" : "comment",
"hardLimit" : "hardLimit",
"scheduleOverrides" : [ "scheduleOverrides",
"scheduleOverrides" ],
"schedulePeriod" : "Week",
"softLimit" : "softLimit"
}, {
"failureImpact" : "Continue",
"actionSpecificData" : {
"testConnectivity" : { },
"discover" : {
"discoverType" : "NAS snapshot"
},
"generateIndex" : {
"generateIndexType" : "NAS snapshot"
},
"backup" : {
"clientOverride" : "ClientCanNotOverride",
"destinationStorageNodes" : [ "destinationStorageNodes",
"destinationStorageNodes" ],
"overrideBackupSchedule" : true,
"successThreshold" : "Warning",
"backupSpecificData" : {
"vmwareVProxy" : {
"quiesceSystemAdminPassword" :
"quiesceSystemAdminPassword",
"enableDDRetentionLock" : true,
"proxyName" : "proxyName",
"destinationPool" : "destinationPool",
"quiesceTimeoutInMinutes" : 5,
NetWorker 18.2 REST API Reference Guide 138
"quiesceSystemAdminUsername" :
"quiesceSystemAdminUsername",
"appConsistentQuiesce" : "Basic",
"ddRetentionLockTime" : "ddRetentionLockTime",
"transactionLogBackup" : true
},
"traditional" : {
"enableDDRetentionLock" : true,
"revertToFullWhenSyntheticFullFails" : true,
"fileInactivityThresholdInDays" : 1,
"destinationPool" : "destinationPool",
"fileInactivityAlertThresholdPercentage" : 6,
"ddRetentionLockTime" : "ddRetentionLockTime",
"estimate" : true,
"timestampFormat" : "None",
"forceBackupLevel" : "forceBackupLevel",
"verifySyntheticFull" : true
},
"vmware" : {
"saveType" : "VMDK",
"useVbaInternalStorage" : true,
"destinationPool" : "destinationPool",
"vbaName" : "vbaName"
},
"snapshot" : {
"destinationPool" : "destinationPool",
"minimumRetentionPeriod" : "minimumRetentionPeriod",
"forceBackupLevel" : "forceBackupLevel"
}
},
"overrideRetentionPeriod" : true,
"retentionPeriod" : "retentionPeriod"
},
"vbaCheckpointBackup" : {
"destinationPool" : "destinationPool",
"retentionPeriod" : "retentionPeriod"
},
"expire" : { },
"clone" : {
"enableDDRetentionLock" : true,
"destinationPool" : "destinationPool",
"ddRetentionLockTime" : "ddRetentionLockTime",
"deleteSource" : true,
"sourceStorageNode" : "sourceStorageNode",
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"serverBackup" : {
"destinationPool" : "destinationPool",
"performBootstrap" : true,
NetWorker 18.2 REST API Reference Guide 139
"performClientFileIndexing" : true,
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"probe" : {
"allProbsMustSucceed" : true,
"maxBackupIntervalInDays" : 5
},
"vbaCheckpointDiscover" : { }
},
"workItemFilter" : {
"timeRangeStart" : "2000-01-23T04:56:07.000+00:00",
"clients" : [ "clients", "clients" ],
"saveSetTypes" : [ "saveSetTypes", "saveSetTypes" ],
"excludeTimeRange" : "true",
"timeRangeEnd" : "2000-01-23T04:56:07.000+00:00",
"excludeClient" : "true",
"excludeLevel" : "true",
"excludeSaveSetType" : "true",
"levels" : [ "levels", "levels" ]
},
"completionNotification" : {
"executeOn" : "Completion",
"command" : "command"
},
"parallelism" : 7,
"concurrent" : true,
"retryDelayInSec" : 3,
"scheduleComment" : "scheduleComment",
"drivenBy" : "drivenBy",
"enabled" : true,
"scheduleActivities" : [ "scheduleActivities",
"scheduleActivities" ],
"disableActionStartTime" : true,
"retries" : 9,
"customTags" : [ "customTags", "customTags" ],
"newName" : "newName",
"name" : "name",
"inactivityTimeoutInMin" : 2,
"actionStartTime" : "actionStartTime",
"comment" : "comment",
"hardLimit" : "hardLimit",
"scheduleOverrides" : [ "scheduleOverrides",
"scheduleOverrides" ],
"schedulePeriod" : "Week",
"softLimit" : "softLimit"
} ],
"autoStartEnabled" : true
} ],
"tenant" : "tenant"
NetWorker 18.2 REST API Reference Guide 140
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resource was retrieved successfully. Policy
Up GET /protectionpolicies/{policyId}/jobgroups/{jobGroupId}
(getPolicyJobGroup)
Returns a list of jobs for a given job group.
Path parameters
policyId (required) Path Parameter is the value of the name attribute in the protection policy object.
jobGroupId (required) Path Parameter is the value of the id attribute in the job group object.
Return type
JobList
Example data
Content-Type: application/json
{
"jobs" : [ {
"vProxyMountTargetVmInvalidUser" : true,
"vProxyMountVCenterHostname" : "vProxyMountVCenterHostname",
"adhocJob" : true,
"vProxyMountSessionId" : "vProxyMountSessionId",
"vProxyFlrAgentInstallRequired" : true,
"type" : "type",
"vProxyMountTargetVmUserId" : "vProxyMountTargetVmUserId",
"vProxyMountTargetVmInvalidAdminUser" : true,
"vProxyHostname" : "vProxyHostname",
"exitCode" : 1,
"links" : [ {
"rel" : "create-form",
NetWorker 18.2 REST API Reference Guide 141
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"startTime" : "2000-01-23T04:56:07.000+00:00",
"id" : 5,
"siblingJobIds" : [ 2, 2 ],
"state" : "Unknown",
"itemIdLong" : 2,
"rootParentJobId" : 3,
"runOnHost" : "runOnHost",
"recoverAppItemStatus" : "recoverAppItemStatus",
"tenant" : "tenant",
"terminationReason" : "terminationReason",
"vProxyMountTargetVmName" : "vProxyMountTargetVmName",
"vProxyInspectDescriptor" : "vProxyInspectDescriptor",
"dependentJobIds" : [ 6, 6 ],
"stopped" : true,
"completionReport" : "completionReport",
"vProxyMountState" : "vProxyMountState",
"dataSize" : {
"unit" : "Byte",
"value" : 6
},
"saveSetId" : "saveSetId",
"ndmp" : true,
"vProxyErrorMessages" : [ "vProxyErrorMessages",
"vProxyErrorMessages" ],
"message" : "message",
"command" : "command",
"itemCount" : 5,
"vProxyRecoverSessionId" : "vProxyRecoverSessionId",
"clientHostname" : "clientHostname",
"vProxyMountTargetVmMoref" : "vProxyMountTargetVmMoref",
"previousJobId" : 9,
"parentJobId" : 7,
"disabledClients" : [ "disabledClients", "disabledClients" ],
"logFile" : "logFile",
"missedClients" : [ "missedClients", "missedClients" ],
"name" : "name",
"progress" : "progress",
"completionStatus" : "Unknown",
"endTime" : "2000-01-23T04:56:07.000+00:00"
}, {
"vProxyMountTargetVmInvalidUser" : true,
NetWorker 18.2 REST API Reference Guide 142
"vProxyMountVCenterHostname" : "vProxyMountVCenterHostname",
"adhocJob" : true,
"vProxyMountSessionId" : "vProxyMountSessionId",
"vProxyFlrAgentInstallRequired" : true,
"type" : "type",
"vProxyMountTargetVmUserId" : "vProxyMountTargetVmUserId",
"vProxyMountTargetVmInvalidAdminUser" : true,
"vProxyHostname" : "vProxyHostname",
"exitCode" : 1,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"startTime" : "2000-01-23T04:56:07.000+00:00",
"id" : 5,
"siblingJobIds" : [ 2, 2 ],
"state" : "Unknown",
"itemIdLong" : 2,
"rootParentJobId" : 3,
"runOnHost" : "runOnHost",
"recoverAppItemStatus" : "recoverAppItemStatus",
"tenant" : "tenant",
"terminationReason" : "terminationReason",
"vProxyMountTargetVmName" : "vProxyMountTargetVmName",
"vProxyInspectDescriptor" : "vProxyInspectDescriptor",
"dependentJobIds" : [ 6, 6 ],
"stopped" : true,
"completionReport" : "completionReport",
"vProxyMountState" : "vProxyMountState",
"dataSize" : {
"unit" : "Byte",
"value" : 6
},
"saveSetId" : "saveSetId",
"ndmp" : true,
"vProxyErrorMessages" : [ "vProxyErrorMessages",
"vProxyErrorMessages" ],
"message" : "message",
"command" : "command",
"itemCount" : 5,
"vProxyRecoverSessionId" : "vProxyRecoverSessionId",
"clientHostname" : "clientHostname",
"vProxyMountTargetVmMoref" : "vProxyMountTargetVmMoref",
NetWorker 18.2 REST API Reference Guide 143
"previousJobId" : 9,
"parentJobId" : 7,
"disabledClients" : [ "disabledClients", "disabledClients" ],
"logFile" : "logFile",
"missedClients" : [ "missedClients", "missedClients" ],
"name" : "name",
"progress" : "progress",
"completionStatus" : "Unknown",
"endTime" : "2000-01-23T04:56:07.000+00:00"
} ],
"count" : 0,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resource was retrieved successfully. JobList
Up GET /protectionpolicies/{policyId}/jobgroups
(getPolicyJobGroups)
Returns a list of job groups for a given policy.
Path parameters
policyId (required) Path Parameter is the value of the name attribute in the protection policy object.
Return type
NetWorker 18.2 REST API Reference Guide 144
JobList
Example data
Content-Type: application/json
{
"jobs" : [ {
"vProxyMountTargetVmInvalidUser" : true,
"vProxyMountVCenterHostname" : "vProxyMountVCenterHostname",
"adhocJob" : true,
"vProxyMountSessionId" : "vProxyMountSessionId",
"vProxyFlrAgentInstallRequired" : true,
"type" : "type",
"vProxyMountTargetVmUserId" : "vProxyMountTargetVmUserId",
"vProxyMountTargetVmInvalidAdminUser" : true,
"vProxyHostname" : "vProxyHostname",
"exitCode" : 1,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"startTime" : "2000-01-23T04:56:07.000+00:00",
"id" : 5,
"siblingJobIds" : [ 2, 2 ],
"state" : "Unknown",
"itemIdLong" : 2,
"rootParentJobId" : 3,
"runOnHost" : "runOnHost",
"recoverAppItemStatus" : "recoverAppItemStatus",
"tenant" : "tenant",
"terminationReason" : "terminationReason",
"vProxyMountTargetVmName" : "vProxyMountTargetVmName",
"vProxyInspectDescriptor" : "vProxyInspectDescriptor",
"dependentJobIds" : [ 6, 6 ],
"stopped" : true,
"completionReport" : "completionReport",
"vProxyMountState" : "vProxyMountState",
"dataSize" : {
"unit" : "Byte",
"value" : 6
},
"saveSetId" : "saveSetId",
"ndmp" : true,
NetWorker 18.2 REST API Reference Guide 145
"vProxyErrorMessages" : [ "vProxyErrorMessages",
"vProxyErrorMessages" ],
"message" : "message",
"command" : "command",
"itemCount" : 5,
"vProxyRecoverSessionId" : "vProxyRecoverSessionId",
"clientHostname" : "clientHostname",
"vProxyMountTargetVmMoref" : "vProxyMountTargetVmMoref",
"previousJobId" : 9,
"parentJobId" : 7,
"disabledClients" : [ "disabledClients", "disabledClients" ],
"logFile" : "logFile",
"missedClients" : [ "missedClients", "missedClients" ],
"name" : "name",
"progress" : "progress",
"completionStatus" : "Unknown",
"endTime" : "2000-01-23T04:56:07.000+00:00"
}, {
"vProxyMountTargetVmInvalidUser" : true,
"vProxyMountVCenterHostname" : "vProxyMountVCenterHostname",
"adhocJob" : true,
"vProxyMountSessionId" : "vProxyMountSessionId",
"vProxyFlrAgentInstallRequired" : true,
"type" : "type",
"vProxyMountTargetVmUserId" : "vProxyMountTargetVmUserId",
"vProxyMountTargetVmInvalidAdminUser" : true,
"vProxyHostname" : "vProxyHostname",
"exitCode" : 1,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"startTime" : "2000-01-23T04:56:07.000+00:00",
"id" : 5,
"siblingJobIds" : [ 2, 2 ],
"state" : "Unknown",
"itemIdLong" : 2,
"rootParentJobId" : 3,
"runOnHost" : "runOnHost",
"recoverAppItemStatus" : "recoverAppItemStatus",
"tenant" : "tenant",
"terminationReason" : "terminationReason",
"vProxyMountTargetVmName" : "vProxyMountTargetVmName",
NetWorker 18.2 REST API Reference Guide 146
"vProxyInspectDescriptor" : "vProxyInspectDescriptor",
"dependentJobIds" : [ 6, 6 ],
"stopped" : true,
"completionReport" : "completionReport",
"vProxyMountState" : "vProxyMountState",
"dataSize" : {
"unit" : "Byte",
"value" : 6
},
"saveSetId" : "saveSetId",
"ndmp" : true,
"vProxyErrorMessages" : [ "vProxyErrorMessages",
"vProxyErrorMessages" ],
"message" : "message",
"command" : "command",
"itemCount" : 5,
"vProxyRecoverSessionId" : "vProxyRecoverSessionId",
"clientHostname" : "clientHostname",
"vProxyMountTargetVmMoref" : "vProxyMountTargetVmMoref",
"previousJobId" : 9,
"parentJobId" : 7,
"disabledClients" : [ "disabledClients", "disabledClients" ],
"logFile" : "logFile",
"missedClients" : [ "missedClients", "missedClients" ],
"name" : "name",
"progress" : "progress",
"completionStatus" : "Unknown",
"endTime" : "2000-01-23T04:56:07.000+00:00"
} ],
"count" : 0,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
NetWorker 18.2 REST API Reference Guide 147
Responses
200 Resources were retrieved successfully. JobList
Up GET /protectionpolicies/{policyId}/workflows/{workflowId}
(getPolicyWorkflow)
Returns the specific workflow.
Path parameters
policyId (required) Path Parameter is the value of the name attribute in the protection policy object.
workflowId (required) Path Parameter is the value of the name attribute in the workflow object.
Return type
PolicyWorkflow
Example data
Content-Type: application/json
{
"nextStartDate" : "2000-01-23T04:56:07.000+00:00",
"completionNotification" : {
"executeOn" : "Completion",
"command" : "command"
},
"description" : "description",
"enabled" : true,
"protectionGroups" : [ "protectionGroups", "protectionGroups" ],
"newName" : "newName",
"startInterval" : "startInterval",
"name" : "name",
"restartTimeWindow" : "restartTimeWindow",
"comment" : "comment",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
NetWorker 18.2 REST API Reference Guide 148
"title" : "title"
} ],
"startTime" : "startTime",
"endTime" : "endTime",
"actions" : [ {
"failureImpact" : "Continue",
"actionSpecificData" : {
"testConnectivity" : { },
"discover" : {
"discoverType" : "NAS snapshot"
},
"generateIndex" : {
"generateIndexType" : "NAS snapshot"
},
"backup" : {
"clientOverride" : "ClientCanNotOverride",
"destinationStorageNodes" : [ "destinationStorageNodes",
"destinationStorageNodes" ],
"overrideBackupSchedule" : true,
"successThreshold" : "Warning",
"backupSpecificData" : {
"vmwareVProxy" : {
"quiesceSystemAdminPassword" :
"quiesceSystemAdminPassword",
"enableDDRetentionLock" : true,
"proxyName" : "proxyName",
"destinationPool" : "destinationPool",
"quiesceTimeoutInMinutes" : 5,
"quiesceSystemAdminUsername" :
"quiesceSystemAdminUsername",
"appConsistentQuiesce" : "Basic",
"ddRetentionLockTime" : "ddRetentionLockTime",
"transactionLogBackup" : true
},
"traditional" : {
"enableDDRetentionLock" : true,
"revertToFullWhenSyntheticFullFails" : true,
"fileInactivityThresholdInDays" : 1,
"destinationPool" : "destinationPool",
"fileInactivityAlertThresholdPercentage" : 6,
"ddRetentionLockTime" : "ddRetentionLockTime",
"estimate" : true,
"timestampFormat" : "None",
"forceBackupLevel" : "forceBackupLevel",
"verifySyntheticFull" : true
},
"vmware" : {
"saveType" : "VMDK",
"useVbaInternalStorage" : true,
"destinationPool" : "destinationPool",
NetWorker 18.2 REST API Reference Guide 149
"vbaName" : "vbaName"
},
"snapshot" : {
"destinationPool" : "destinationPool",
"minimumRetentionPeriod" : "minimumRetentionPeriod",
"forceBackupLevel" : "forceBackupLevel"
}
},
"overrideRetentionPeriod" : true,
"retentionPeriod" : "retentionPeriod"
},
"vbaCheckpointBackup" : {
"destinationPool" : "destinationPool",
"retentionPeriod" : "retentionPeriod"
},
"expire" : { },
"clone" : {
"enableDDRetentionLock" : true,
"destinationPool" : "destinationPool",
"ddRetentionLockTime" : "ddRetentionLockTime",
"deleteSource" : true,
"sourceStorageNode" : "sourceStorageNode",
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"serverBackup" : {
"destinationPool" : "destinationPool",
"performBootstrap" : true,
"performClientFileIndexing" : true,
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"probe" : {
"allProbsMustSucceed" : true,
"maxBackupIntervalInDays" : 5
},
"vbaCheckpointDiscover" : { }
},
"workItemFilter" : {
"timeRangeStart" : "2000-01-23T04:56:07.000+00:00",
"clients" : [ "clients", "clients" ],
"saveSetTypes" : [ "saveSetTypes", "saveSetTypes" ],
"excludeTimeRange" : "true",
"timeRangeEnd" : "2000-01-23T04:56:07.000+00:00",
"excludeClient" : "true",
"excludeLevel" : "true",
"excludeSaveSetType" : "true",
"levels" : [ "levels", "levels" ]
},
"completionNotification" : {
NetWorker 18.2 REST API Reference Guide 150
"executeOn" : "Completion",
"command" : "command"
},
"parallelism" : 7,
"concurrent" : true,
"retryDelayInSec" : 3,
"scheduleComment" : "scheduleComment",
"drivenBy" : "drivenBy",
"enabled" : true,
"scheduleActivities" : [ "scheduleActivities",
"scheduleActivities" ],
"disableActionStartTime" : true,
"retries" : 9,
"customTags" : [ "customTags", "customTags" ],
"newName" : "newName",
"name" : "name",
"inactivityTimeoutInMin" : 2,
"actionStartTime" : "actionStartTime",
"comment" : "comment",
"hardLimit" : "hardLimit",
"scheduleOverrides" : [ "scheduleOverrides", "scheduleOverrides"
],
"schedulePeriod" : "Week",
"softLimit" : "softLimit"
}, {
"failureImpact" : "Continue",
"actionSpecificData" : {
"testConnectivity" : { },
"discover" : {
"discoverType" : "NAS snapshot"
},
"generateIndex" : {
"generateIndexType" : "NAS snapshot"
},
"backup" : {
"clientOverride" : "ClientCanNotOverride",
"destinationStorageNodes" : [ "destinationStorageNodes",
"destinationStorageNodes" ],
"overrideBackupSchedule" : true,
"successThreshold" : "Warning",
"backupSpecificData" : {
"vmwareVProxy" : {
"quiesceSystemAdminPassword" :
"quiesceSystemAdminPassword",
"enableDDRetentionLock" : true,
"proxyName" : "proxyName",
"destinationPool" : "destinationPool",
"quiesceTimeoutInMinutes" : 5,
"quiesceSystemAdminUsername" :
"quiesceSystemAdminUsername",
"appConsistentQuiesce" : "Basic",
NetWorker 18.2 REST API Reference Guide 151
"ddRetentionLockTime" : "ddRetentionLockTime",
"transactionLogBackup" : true
},
"traditional" : {
"enableDDRetentionLock" : true,
"revertToFullWhenSyntheticFullFails" : true,
"fileInactivityThresholdInDays" : 1,
"destinationPool" : "destinationPool",
"fileInactivityAlertThresholdPercentage" : 6,
"ddRetentionLockTime" : "ddRetentionLockTime",
"estimate" : true,
"timestampFormat" : "None",
"forceBackupLevel" : "forceBackupLevel",
"verifySyntheticFull" : true
},
"vmware" : {
"saveType" : "VMDK",
"useVbaInternalStorage" : true,
"destinationPool" : "destinationPool",
"vbaName" : "vbaName"
},
"snapshot" : {
"destinationPool" : "destinationPool",
"minimumRetentionPeriod" : "minimumRetentionPeriod",
"forceBackupLevel" : "forceBackupLevel"
}
},
"overrideRetentionPeriod" : true,
"retentionPeriod" : "retentionPeriod"
},
"vbaCheckpointBackup" : {
"destinationPool" : "destinationPool",
"retentionPeriod" : "retentionPeriod"
},
"expire" : { },
"clone" : {
"enableDDRetentionLock" : true,
"destinationPool" : "destinationPool",
"ddRetentionLockTime" : "ddRetentionLockTime",
"deleteSource" : true,
"sourceStorageNode" : "sourceStorageNode",
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"serverBackup" : {
"destinationPool" : "destinationPool",
"performBootstrap" : true,
"performClientFileIndexing" : true,
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
NetWorker 18.2 REST API Reference Guide 152
},
"probe" : {
"allProbsMustSucceed" : true,
"maxBackupIntervalInDays" : 5
},
"vbaCheckpointDiscover" : { }
},
"workItemFilter" : {
"timeRangeStart" : "2000-01-23T04:56:07.000+00:00",
"clients" : [ "clients", "clients" ],
"saveSetTypes" : [ "saveSetTypes", "saveSetTypes" ],
"excludeTimeRange" : "true",
"timeRangeEnd" : "2000-01-23T04:56:07.000+00:00",
"excludeClient" : "true",
"excludeLevel" : "true",
"excludeSaveSetType" : "true",
"levels" : [ "levels", "levels" ]
},
"completionNotification" : {
"executeOn" : "Completion",
"command" : "command"
},
"parallelism" : 7,
"concurrent" : true,
"retryDelayInSec" : 3,
"scheduleComment" : "scheduleComment",
"drivenBy" : "drivenBy",
"enabled" : true,
"scheduleActivities" : [ "scheduleActivities",
"scheduleActivities" ],
"disableActionStartTime" : true,
"retries" : 9,
"customTags" : [ "customTags", "customTags" ],
"newName" : "newName",
"name" : "name",
"inactivityTimeoutInMin" : 2,
"actionStartTime" : "actionStartTime",
"comment" : "comment",
"hardLimit" : "hardLimit",
"scheduleOverrides" : [ "scheduleOverrides", "scheduleOverrides"
],
"schedulePeriod" : "Week",
"softLimit" : "softLimit"
} ],
"autoStartEnabled" : true
}
Produces
NetWorker 18.2 REST API Reference Guide 153
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resource was retrieved successfully. PolicyWorkflow
Up GET
/protectionpolicies/{policyId}/workflows/{workflowId}/jobgroups/{jobG
roupId}
(getPolicyWorkflowJobGroup)
Returns a list of jobs for a given job group.
Path parameters
policyId (required) Path Parameter is the value of the name attribute in the protection policy object.
workflowId (required) Path Parameter is the value of the name attribute in the workflow object.
jobGroupId (required) Path Parameter is the value of the id attribute in the job group object.
Return type
JobList
Example data
Content-Type: application/json
{
"jobs" : [ {
"vProxyMountTargetVmInvalidUser" : true,
"vProxyMountVCenterHostname" : "vProxyMountVCenterHostname",
"adhocJob" : true,
"vProxyMountSessionId" : "vProxyMountSessionId",
"vProxyFlrAgentInstallRequired" : true,
"type" : "type",
"vProxyMountTargetVmUserId" : "vProxyMountTargetVmUserId",
"vProxyMountTargetVmInvalidAdminUser" : true,
"vProxyHostname" : "vProxyHostname",
"exitCode" : 1,
"links" : [ {
NetWorker 18.2 REST API Reference Guide 154
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"startTime" : "2000-01-23T04:56:07.000+00:00",
"id" : 5,
"siblingJobIds" : [ 2, 2 ],
"state" : "Unknown",
"itemIdLong" : 2,
"rootParentJobId" : 3,
"runOnHost" : "runOnHost",
"recoverAppItemStatus" : "recoverAppItemStatus",
"tenant" : "tenant",
"terminationReason" : "terminationReason",
"vProxyMountTargetVmName" : "vProxyMountTargetVmName",
"vProxyInspectDescriptor" : "vProxyInspectDescriptor",
"dependentJobIds" : [ 6, 6 ],
"stopped" : true,
"completionReport" : "completionReport",
"vProxyMountState" : "vProxyMountState",
"dataSize" : {
"unit" : "Byte",
"value" : 6
},
"saveSetId" : "saveSetId",
"ndmp" : true,
"vProxyErrorMessages" : [ "vProxyErrorMessages",
"vProxyErrorMessages" ],
"message" : "message",
"command" : "command",
"itemCount" : 5,
"vProxyRecoverSessionId" : "vProxyRecoverSessionId",
"clientHostname" : "clientHostname",
"vProxyMountTargetVmMoref" : "vProxyMountTargetVmMoref",
"previousJobId" : 9,
"parentJobId" : 7,
"disabledClients" : [ "disabledClients", "disabledClients" ],
"logFile" : "logFile",
"missedClients" : [ "missedClients", "missedClients" ],
"name" : "name",
"progress" : "progress",
"completionStatus" : "Unknown",
"endTime" : "2000-01-23T04:56:07.000+00:00"
}, {
NetWorker 18.2 REST API Reference Guide 155
"vProxyMountTargetVmInvalidUser" : true,
"vProxyMountVCenterHostname" : "vProxyMountVCenterHostname",
"adhocJob" : true,
"vProxyMountSessionId" : "vProxyMountSessionId",
"vProxyFlrAgentInstallRequired" : true,
"type" : "type",
"vProxyMountTargetVmUserId" : "vProxyMountTargetVmUserId",
"vProxyMountTargetVmInvalidAdminUser" : true,
"vProxyHostname" : "vProxyHostname",
"exitCode" : 1,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"startTime" : "2000-01-23T04:56:07.000+00:00",
"id" : 5,
"siblingJobIds" : [ 2, 2 ],
"state" : "Unknown",
"itemIdLong" : 2,
"rootParentJobId" : 3,
"runOnHost" : "runOnHost",
"recoverAppItemStatus" : "recoverAppItemStatus",
"tenant" : "tenant",
"terminationReason" : "terminationReason",
"vProxyMountTargetVmName" : "vProxyMountTargetVmName",
"vProxyInspectDescriptor" : "vProxyInspectDescriptor",
"dependentJobIds" : [ 6, 6 ],
"stopped" : true,
"completionReport" : "completionReport",
"vProxyMountState" : "vProxyMountState",
"dataSize" : {
"unit" : "Byte",
"value" : 6
},
"saveSetId" : "saveSetId",
"ndmp" : true,
"vProxyErrorMessages" : [ "vProxyErrorMessages",
"vProxyErrorMessages" ],
"message" : "message",
"command" : "command",
"itemCount" : 5,
"vProxyRecoverSessionId" : "vProxyRecoverSessionId",
"clientHostname" : "clientHostname",
NetWorker 18.2 REST API Reference Guide 156
"vProxyMountTargetVmMoref" : "vProxyMountTargetVmMoref",
"previousJobId" : 9,
"parentJobId" : 7,
"disabledClients" : [ "disabledClients", "disabledClients" ],
"logFile" : "logFile",
"missedClients" : [ "missedClients", "missedClients" ],
"name" : "name",
"progress" : "progress",
"completionStatus" : "Unknown",
"endTime" : "2000-01-23T04:56:07.000+00:00"
} ],
"count" : 0,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resource was retrieved successfully. JobList
Up GET /protectionpolicies/{policyId}/workflows/{workflowId}/jobgroups
(getPolicyWorkflowJobGroups)
Returns a list of job groups for a given workflow.
Path parameters
policyId (required) Path Parameter is the value of the name attribute in the protection policy object.
workflowId (required)
NetWorker 18.2 REST API Reference Guide 157
Path Parameter is the value of the name attribute in the workflow object.
Return type
JobList
Example data
Content-Type: application/json
{
"jobs" : [ {
"vProxyMountTargetVmInvalidUser" : true,
"vProxyMountVCenterHostname" : "vProxyMountVCenterHostname",
"adhocJob" : true,
"vProxyMountSessionId" : "vProxyMountSessionId",
"vProxyFlrAgentInstallRequired" : true,
"type" : "type",
"vProxyMountTargetVmUserId" : "vProxyMountTargetVmUserId",
"vProxyMountTargetVmInvalidAdminUser" : true,
"vProxyHostname" : "vProxyHostname",
"exitCode" : 1,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"startTime" : "2000-01-23T04:56:07.000+00:00",
"id" : 5,
"siblingJobIds" : [ 2, 2 ],
"state" : "Unknown",
"itemIdLong" : 2,
"rootParentJobId" : 3,
"runOnHost" : "runOnHost",
"recoverAppItemStatus" : "recoverAppItemStatus",
"tenant" : "tenant",
"terminationReason" : "terminationReason",
"vProxyMountTargetVmName" : "vProxyMountTargetVmName",
"vProxyInspectDescriptor" : "vProxyInspectDescriptor",
"dependentJobIds" : [ 6, 6 ],
"stopped" : true,
"completionReport" : "completionReport",
"vProxyMountState" : "vProxyMountState",
"dataSize" : {
"unit" : "Byte",
NetWorker 18.2 REST API Reference Guide 158
"value" : 6
},
"saveSetId" : "saveSetId",
"ndmp" : true,
"vProxyErrorMessages" : [ "vProxyErrorMessages",
"vProxyErrorMessages" ],
"message" : "message",
"command" : "command",
"itemCount" : 5,
"vProxyRecoverSessionId" : "vProxyRecoverSessionId",
"clientHostname" : "clientHostname",
"vProxyMountTargetVmMoref" : "vProxyMountTargetVmMoref",
"previousJobId" : 9,
"parentJobId" : 7,
"disabledClients" : [ "disabledClients", "disabledClients" ],
"logFile" : "logFile",
"missedClients" : [ "missedClients", "missedClients" ],
"name" : "name",
"progress" : "progress",
"completionStatus" : "Unknown",
"endTime" : "2000-01-23T04:56:07.000+00:00"
}, {
"vProxyMountTargetVmInvalidUser" : true,
"vProxyMountVCenterHostname" : "vProxyMountVCenterHostname",
"adhocJob" : true,
"vProxyMountSessionId" : "vProxyMountSessionId",
"vProxyFlrAgentInstallRequired" : true,
"type" : "type",
"vProxyMountTargetVmUserId" : "vProxyMountTargetVmUserId",
"vProxyMountTargetVmInvalidAdminUser" : true,
"vProxyHostname" : "vProxyHostname",
"exitCode" : 1,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"startTime" : "2000-01-23T04:56:07.000+00:00",
"id" : 5,
"siblingJobIds" : [ 2, 2 ],
"state" : "Unknown",
"itemIdLong" : 2,
"rootParentJobId" : 3,
"runOnHost" : "runOnHost",
NetWorker 18.2 REST API Reference Guide 159
"recoverAppItemStatus" : "recoverAppItemStatus",
"tenant" : "tenant",
"terminationReason" : "terminationReason",
"vProxyMountTargetVmName" : "vProxyMountTargetVmName",
"vProxyInspectDescriptor" : "vProxyInspectDescriptor",
"dependentJobIds" : [ 6, 6 ],
"stopped" : true,
"completionReport" : "completionReport",
"vProxyMountState" : "vProxyMountState",
"dataSize" : {
"unit" : "Byte",
"value" : 6
},
"saveSetId" : "saveSetId",
"ndmp" : true,
"vProxyErrorMessages" : [ "vProxyErrorMessages",
"vProxyErrorMessages" ],
"message" : "message",
"command" : "command",
"itemCount" : 5,
"vProxyRecoverSessionId" : "vProxyRecoverSessionId",
"clientHostname" : "clientHostname",
"vProxyMountTargetVmMoref" : "vProxyMountTargetVmMoref",
"previousJobId" : 9,
"parentJobId" : 7,
"disabledClients" : [ "disabledClients", "disabledClients" ],
"logFile" : "logFile",
"missedClients" : [ "missedClients", "missedClients" ],
"name" : "name",
"progress" : "progress",
"completionStatus" : "Unknown",
"endTime" : "2000-01-23T04:56:07.000+00:00"
} ],
"count" : 0,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ]
}
Produces
NetWorker 18.2 REST API Reference Guide 160
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resources were retrieved successfully. JobList
Up GET /protectionpolicies/{policyId}/workflows
(getPolicyWorkflows)
Returns a list of workflows for a policy.
Path parameters
policyId (required) Path Parameter is the value of the name attribute in the protection policy object.
Return type
PolicyWorkflowList
Example data
Content-Type: application/json
{
"count" : 0,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"workflows" : [ {
"nextStartDate" : "2000-01-23T04:56:07.000+00:00",
"completionNotification" : {
"executeOn" : "Completion",
"command" : "command"
},
"description" : "description",
NetWorker 18.2 REST API Reference Guide 161
"enabled" : true,
"protectionGroups" : [ "protectionGroups", "protectionGroups" ],
"newName" : "newName",
"startInterval" : "startInterval",
"name" : "name",
"restartTimeWindow" : "restartTimeWindow",
"comment" : "comment",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"startTime" : "startTime",
"endTime" : "endTime",
"actions" : [ {
"failureImpact" : "Continue",
"actionSpecificData" : {
"testConnectivity" : { },
"discover" : {
"discoverType" : "NAS snapshot"
},
"generateIndex" : {
"generateIndexType" : "NAS snapshot"
},
"backup" : {
"clientOverride" : "ClientCanNotOverride",
"destinationStorageNodes" : [ "destinationStorageNodes",
"destinationStorageNodes" ],
"overrideBackupSchedule" : true,
"successThreshold" : "Warning",
"backupSpecificData" : {
"vmwareVProxy" : {
"quiesceSystemAdminPassword" :
"quiesceSystemAdminPassword",
"enableDDRetentionLock" : true,
"proxyName" : "proxyName",
"destinationPool" : "destinationPool",
"quiesceTimeoutInMinutes" : 5,
"quiesceSystemAdminUsername" :
"quiesceSystemAdminUsername",
"appConsistentQuiesce" : "Basic",
"ddRetentionLockTime" : "ddRetentionLockTime",
"transactionLogBackup" : true
},
NetWorker 18.2 REST API Reference Guide 162
"traditional" : {
"enableDDRetentionLock" : true,
"revertToFullWhenSyntheticFullFails" : true,
"fileInactivityThresholdInDays" : 1,
"destinationPool" : "destinationPool",
"fileInactivityAlertThresholdPercentage" : 6,
"ddRetentionLockTime" : "ddRetentionLockTime",
"estimate" : true,
"timestampFormat" : "None",
"forceBackupLevel" : "forceBackupLevel",
"verifySyntheticFull" : true
},
"vmware" : {
"saveType" : "VMDK",
"useVbaInternalStorage" : true,
"destinationPool" : "destinationPool",
"vbaName" : "vbaName"
},
"snapshot" : {
"destinationPool" : "destinationPool",
"minimumRetentionPeriod" : "minimumRetentionPeriod",
"forceBackupLevel" : "forceBackupLevel"
}
},
"overrideRetentionPeriod" : true,
"retentionPeriod" : "retentionPeriod"
},
"vbaCheckpointBackup" : {
"destinationPool" : "destinationPool",
"retentionPeriod" : "retentionPeriod"
},
"expire" : { },
"clone" : {
"enableDDRetentionLock" : true,
"destinationPool" : "destinationPool",
"ddRetentionLockTime" : "ddRetentionLockTime",
"deleteSource" : true,
"sourceStorageNode" : "sourceStorageNode",
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"serverBackup" : {
"destinationPool" : "destinationPool",
"performBootstrap" : true,
"performClientFileIndexing" : true,
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"probe" : {
"allProbsMustSucceed" : true,
NetWorker 18.2 REST API Reference Guide 163
"maxBackupIntervalInDays" : 5
},
"vbaCheckpointDiscover" : { }
},
"workItemFilter" : {
"timeRangeStart" : "2000-01-23T04:56:07.000+00:00",
"clients" : [ "clients", "clients" ],
"saveSetTypes" : [ "saveSetTypes", "saveSetTypes" ],
"excludeTimeRange" : "true",
"timeRangeEnd" : "2000-01-23T04:56:07.000+00:00",
"excludeClient" : "true",
"excludeLevel" : "true",
"excludeSaveSetType" : "true",
"levels" : [ "levels", "levels" ]
},
"completionNotification" : {
"executeOn" : "Completion",
"command" : "command"
},
"parallelism" : 7,
"concurrent" : true,
"retryDelayInSec" : 3,
"scheduleComment" : "scheduleComment",
"drivenBy" : "drivenBy",
"enabled" : true,
"scheduleActivities" : [ "scheduleActivities",
"scheduleActivities" ],
"disableActionStartTime" : true,
"retries" : 9,
"customTags" : [ "customTags", "customTags" ],
"newName" : "newName",
"name" : "name",
"inactivityTimeoutInMin" : 2,
"actionStartTime" : "actionStartTime",
"comment" : "comment",
"hardLimit" : "hardLimit",
"scheduleOverrides" : [ "scheduleOverrides",
"scheduleOverrides" ],
"schedulePeriod" : "Week",
"softLimit" : "softLimit"
}, {
"failureImpact" : "Continue",
"actionSpecificData" : {
"testConnectivity" : { },
"discover" : {
"discoverType" : "NAS snapshot"
},
"generateIndex" : {
"generateIndexType" : "NAS snapshot"
},
NetWorker 18.2 REST API Reference Guide 164
"backup" : {
"clientOverride" : "ClientCanNotOverride",
"destinationStorageNodes" : [ "destinationStorageNodes",
"destinationStorageNodes" ],
"overrideBackupSchedule" : true,
"successThreshold" : "Warning",
"backupSpecificData" : {
"vmwareVProxy" : {
"quiesceSystemAdminPassword" :
"quiesceSystemAdminPassword",
"enableDDRetentionLock" : true,
"proxyName" : "proxyName",
"destinationPool" : "destinationPool",
"quiesceTimeoutInMinutes" : 5,
"quiesceSystemAdminUsername" :
"quiesceSystemAdminUsername",
"appConsistentQuiesce" : "Basic",
"ddRetentionLockTime" : "ddRetentionLockTime",
"transactionLogBackup" : true
},
"traditional" : {
"enableDDRetentionLock" : true,
"revertToFullWhenSyntheticFullFails" : true,
"fileInactivityThresholdInDays" : 1,
"destinationPool" : "destinationPool",
"fileInactivityAlertThresholdPercentage" : 6,
"ddRetentionLockTime" : "ddRetentionLockTime",
"estimate" : true,
"timestampFormat" : "None",
"forceBackupLevel" : "forceBackupLevel",
"verifySyntheticFull" : true
},
"vmware" : {
"saveType" : "VMDK",
"useVbaInternalStorage" : true,
"destinationPool" : "destinationPool",
"vbaName" : "vbaName"
},
"snapshot" : {
"destinationPool" : "destinationPool",
"minimumRetentionPeriod" : "minimumRetentionPeriod",
"forceBackupLevel" : "forceBackupLevel"
}
},
"overrideRetentionPeriod" : true,
"retentionPeriod" : "retentionPeriod"
},
"vbaCheckpointBackup" : {
"destinationPool" : "destinationPool",
"retentionPeriod" : "retentionPeriod"
NetWorker 18.2 REST API Reference Guide 165
},
"expire" : { },
"clone" : {
"enableDDRetentionLock" : true,
"destinationPool" : "destinationPool",
"ddRetentionLockTime" : "ddRetentionLockTime",
"deleteSource" : true,
"sourceStorageNode" : "sourceStorageNode",
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"serverBackup" : {
"destinationPool" : "destinationPool",
"performBootstrap" : true,
"performClientFileIndexing" : true,
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"probe" : {
"allProbsMustSucceed" : true,
"maxBackupIntervalInDays" : 5
},
"vbaCheckpointDiscover" : { }
},
"workItemFilter" : {
"timeRangeStart" : "2000-01-23T04:56:07.000+00:00",
"clients" : [ "clients", "clients" ],
"saveSetTypes" : [ "saveSetTypes", "saveSetTypes" ],
"excludeTimeRange" : "true",
"timeRangeEnd" : "2000-01-23T04:56:07.000+00:00",
"excludeClient" : "true",
"excludeLevel" : "true",
"excludeSaveSetType" : "true",
"levels" : [ "levels", "levels" ]
},
"completionNotification" : {
"executeOn" : "Completion",
"command" : "command"
},
"parallelism" : 7,
"concurrent" : true,
"retryDelayInSec" : 3,
"scheduleComment" : "scheduleComment",
"drivenBy" : "drivenBy",
"enabled" : true,
"scheduleActivities" : [ "scheduleActivities",
"scheduleActivities" ],
"disableActionStartTime" : true,
"retries" : 9,
"customTags" : [ "customTags", "customTags" ],
NetWorker 18.2 REST API Reference Guide 166
"newName" : "newName",
"name" : "name",
"inactivityTimeoutInMin" : 2,
"actionStartTime" : "actionStartTime",
"comment" : "comment",
"hardLimit" : "hardLimit",
"scheduleOverrides" : [ "scheduleOverrides",
"scheduleOverrides" ],
"schedulePeriod" : "Week",
"softLimit" : "softLimit"
} ],
"autoStartEnabled" : true
}, {
"nextStartDate" : "2000-01-23T04:56:07.000+00:00",
"completionNotification" : {
"executeOn" : "Completion",
"command" : "command"
},
"description" : "description",
"enabled" : true,
"protectionGroups" : [ "protectionGroups", "protectionGroups" ],
"newName" : "newName",
"startInterval" : "startInterval",
"name" : "name",
"restartTimeWindow" : "restartTimeWindow",
"comment" : "comment",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"startTime" : "startTime",
"endTime" : "endTime",
"actions" : [ {
"failureImpact" : "Continue",
"actionSpecificData" : {
"testConnectivity" : { },
"discover" : {
"discoverType" : "NAS snapshot"
},
"generateIndex" : {
"generateIndexType" : "NAS snapshot"
},
"backup" : {
NetWorker 18.2 REST API Reference Guide 167
"clientOverride" : "ClientCanNotOverride",
"destinationStorageNodes" : [ "destinationStorageNodes",
"destinationStorageNodes" ],
"overrideBackupSchedule" : true,
"successThreshold" : "Warning",
"backupSpecificData" : {
"vmwareVProxy" : {
"quiesceSystemAdminPassword" :
"quiesceSystemAdminPassword",
"enableDDRetentionLock" : true,
"proxyName" : "proxyName",
"destinationPool" : "destinationPool",
"quiesceTimeoutInMinutes" : 5,
"quiesceSystemAdminUsername" :
"quiesceSystemAdminUsername",
"appConsistentQuiesce" : "Basic",
"ddRetentionLockTime" : "ddRetentionLockTime",
"transactionLogBackup" : true
},
"traditional" : {
"enableDDRetentionLock" : true,
"revertToFullWhenSyntheticFullFails" : true,
"fileInactivityThresholdInDays" : 1,
"destinationPool" : "destinationPool",
"fileInactivityAlertThresholdPercentage" : 6,
"ddRetentionLockTime" : "ddRetentionLockTime",
"estimate" : true,
"timestampFormat" : "None",
"forceBackupLevel" : "forceBackupLevel",
"verifySyntheticFull" : true
},
"vmware" : {
"saveType" : "VMDK",
"useVbaInternalStorage" : true,
"destinationPool" : "destinationPool",
"vbaName" : "vbaName"
},
"snapshot" : {
"destinationPool" : "destinationPool",
"minimumRetentionPeriod" : "minimumRetentionPeriod",
"forceBackupLevel" : "forceBackupLevel"
}
},
"overrideRetentionPeriod" : true,
"retentionPeriod" : "retentionPeriod"
},
"vbaCheckpointBackup" : {
"destinationPool" : "destinationPool",
"retentionPeriod" : "retentionPeriod"
},
NetWorker 18.2 REST API Reference Guide 168
"expire" : { },
"clone" : {
"enableDDRetentionLock" : true,
"destinationPool" : "destinationPool",
"ddRetentionLockTime" : "ddRetentionLockTime",
"deleteSource" : true,
"sourceStorageNode" : "sourceStorageNode",
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"serverBackup" : {
"destinationPool" : "destinationPool",
"performBootstrap" : true,
"performClientFileIndexing" : true,
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"probe" : {
"allProbsMustSucceed" : true,
"maxBackupIntervalInDays" : 5
},
"vbaCheckpointDiscover" : { }
},
"workItemFilter" : {
"timeRangeStart" : "2000-01-23T04:56:07.000+00:00",
"clients" : [ "clients", "clients" ],
"saveSetTypes" : [ "saveSetTypes", "saveSetTypes" ],
"excludeTimeRange" : "true",
"timeRangeEnd" : "2000-01-23T04:56:07.000+00:00",
"excludeClient" : "true",
"excludeLevel" : "true",
"excludeSaveSetType" : "true",
"levels" : [ "levels", "levels" ]
},
"completionNotification" : {
"executeOn" : "Completion",
"command" : "command"
},
"parallelism" : 7,
"concurrent" : true,
"retryDelayInSec" : 3,
"scheduleComment" : "scheduleComment",
"drivenBy" : "drivenBy",
"enabled" : true,
"scheduleActivities" : [ "scheduleActivities",
"scheduleActivities" ],
"disableActionStartTime" : true,
"retries" : 9,
"customTags" : [ "customTags", "customTags" ],
"newName" : "newName",
NetWorker 18.2 REST API Reference Guide 169
"name" : "name",
"inactivityTimeoutInMin" : 2,
"actionStartTime" : "actionStartTime",
"comment" : "comment",
"hardLimit" : "hardLimit",
"scheduleOverrides" : [ "scheduleOverrides",
"scheduleOverrides" ],
"schedulePeriod" : "Week",
"softLimit" : "softLimit"
}, {
"failureImpact" : "Continue",
"actionSpecificData" : {
"testConnectivity" : { },
"discover" : {
"discoverType" : "NAS snapshot"
},
"generateIndex" : {
"generateIndexType" : "NAS snapshot"
},
"backup" : {
"clientOverride" : "ClientCanNotOverride",
"destinationStorageNodes" : [ "destinationStorageNodes",
"destinationStorageNodes" ],
"overrideBackupSchedule" : true,
"successThreshold" : "Warning",
"backupSpecificData" : {
"vmwareVProxy" : {
"quiesceSystemAdminPassword" :
"quiesceSystemAdminPassword",
"enableDDRetentionLock" : true,
"proxyName" : "proxyName",
"destinationPool" : "destinationPool",
"quiesceTimeoutInMinutes" : 5,
"quiesceSystemAdminUsername" :
"quiesceSystemAdminUsername",
"appConsistentQuiesce" : "Basic",
"ddRetentionLockTime" : "ddRetentionLockTime",
"transactionLogBackup" : true
},
"traditional" : {
"enableDDRetentionLock" : true,
"revertToFullWhenSyntheticFullFails" : true,
"fileInactivityThresholdInDays" : 1,
"destinationPool" : "destinationPool",
"fileInactivityAlertThresholdPercentage" : 6,
"ddRetentionLockTime" : "ddRetentionLockTime",
"estimate" : true,
"timestampFormat" : "None",
"forceBackupLevel" : "forceBackupLevel",
"verifySyntheticFull" : true
},
NetWorker 18.2 REST API Reference Guide 170
"vmware" : {
"saveType" : "VMDK",
"useVbaInternalStorage" : true,
"destinationPool" : "destinationPool",
"vbaName" : "vbaName"
},
"snapshot" : {
"destinationPool" : "destinationPool",
"minimumRetentionPeriod" : "minimumRetentionPeriod",
"forceBackupLevel" : "forceBackupLevel"
}
},
"overrideRetentionPeriod" : true,
"retentionPeriod" : "retentionPeriod"
},
"vbaCheckpointBackup" : {
"destinationPool" : "destinationPool",
"retentionPeriod" : "retentionPeriod"
},
"expire" : { },
"clone" : {
"enableDDRetentionLock" : true,
"destinationPool" : "destinationPool",
"ddRetentionLockTime" : "ddRetentionLockTime",
"deleteSource" : true,
"sourceStorageNode" : "sourceStorageNode",
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"serverBackup" : {
"destinationPool" : "destinationPool",
"performBootstrap" : true,
"performClientFileIndexing" : true,
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"probe" : {
"allProbsMustSucceed" : true,
"maxBackupIntervalInDays" : 5
},
"vbaCheckpointDiscover" : { }
},
"workItemFilter" : {
"timeRangeStart" : "2000-01-23T04:56:07.000+00:00",
"clients" : [ "clients", "clients" ],
"saveSetTypes" : [ "saveSetTypes", "saveSetTypes" ],
"excludeTimeRange" : "true",
"timeRangeEnd" : "2000-01-23T04:56:07.000+00:00",
"excludeClient" : "true",
"excludeLevel" : "true",
NetWorker 18.2 REST API Reference Guide 171
"excludeSaveSetType" : "true",
"levels" : [ "levels", "levels" ]
},
"completionNotification" : {
"executeOn" : "Completion",
"command" : "command"
},
"parallelism" : 7,
"concurrent" : true,
"retryDelayInSec" : 3,
"scheduleComment" : "scheduleComment",
"drivenBy" : "drivenBy",
"enabled" : true,
"scheduleActivities" : [ "scheduleActivities",
"scheduleActivities" ],
"disableActionStartTime" : true,
"retries" : 9,
"customTags" : [ "customTags", "customTags" ],
"newName" : "newName",
"name" : "name",
"inactivityTimeoutInMin" : 2,
"actionStartTime" : "actionStartTime",
"comment" : "comment",
"hardLimit" : "hardLimit",
"scheduleOverrides" : [ "scheduleOverrides",
"scheduleOverrides" ],
"schedulePeriod" : "Week",
"softLimit" : "softLimit"
} ],
"autoStartEnabled" : true
} ]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resources were retrieved successfully. PolicyWorkflowList
Up POST /protectionpolicies
(postPolicy)
NetWorker 18.2 REST API Reference Guide 172
Creates a new policy.
Request body
policy Policy (required) Body Parameter Policy to be created.
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
201 Resource was created successfully.
Up POST /protectionpolicies/{policyId}/workflows
(postPolicyWorkflow)
Creates a new workflow.
Path parameters
policyId (required) Path Parameter is the value of the name attribute in the protection policy object.
Request body
workflow PolicyWorkflow (required) Body Parameter Workflow to be created.
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
201 Resource was created successfully.
NetWorker 18.2 REST API Reference Guide 173
Up POST /protectionpolicies/{policyId}/workflows/{workflowId}/op/backup
(postPolicyWorkflowOpBackup)
Starts the specified workflow.
Path parameters
policyId (required) Path Parameter is the value of the name attribute in the protection policy object.
workflowId (required) Path Parameter is the value of the name attribute in the workflow object.
Request body
policyWorkflowOpBackup PolicyWorkflowOpBackup (required) Body Parameter Parameters to start the workflow.
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
201 A job is created. The Job URI can be found in the location header of the response.
Up PUT /protectionpolicies/{policyId}
(putPolicy)
Updates the specific policy.
Path parameters
policyId (required) Path Parameter is the value of the name attribute in the protection policy object.
Request body
NetWorker 18.2 REST API Reference Guide 174
policy Policy (required) Body Parameter Policy data for update.
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
204 Resource was updated successfully.
Up PUT /protectionpolicies/{policyId}/workflows/{workflowId}
(putPolicyWorkflow)
Updates the specific workflow.
Path parameters
policyId (required) Path Parameter is the value of the name attribute in the protection policy object.
workflowId (required) Path Parameter is the value of the name attribute in the workflow object.
Request body
workflow PolicyWorkflow (required) Body Parameter Workflow data for update.
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
204 Resource was updated successfully.
NetWorker 18.2 REST API Reference Guide 175
Recovers
Up DELETE /recovers/{recoverId}
(deleteRecover)
Deletes the specific recovery resource.
Path parameters
recoverId (required) Path Parameter is the value of the id attribute of the recover object's resourceId.
Responses
204 Resource was retrieved successfully.
400 Bad request. ErrorResponse
401 Unauthorized. ErrorResponse
404 Not found. ErrorResponse
405 Method not allowed. ErrorResponse
500 Internal server error. ErrorResponse
Up GET /recovers/{recoverId}
(getRecover)
Returns the specific recovery resource.
Path parameters
recoverId (required) Path Parameter is the value of the id attribute of the recover object's resourceId.
Return type
Recover
Example data
Content-Type: application/json
{
NetWorker 18.2 REST API Reference Guide 176
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"NDMPOptions" : {
"useIPv4" : true,
"verifyIndexDB" : true
},
"itemsToRecover" : [ "itemsToRecover", "itemsToRecover" ],
"recoveryType" : "Filesystem",
"destinationClientResID" : "destinationClientResID",
"actionForDuplicateItems" : "Rename",
"poolForStaging" : "poolForStaging",
"timeStampBasedGranularRecover" : {
"timeStamp" : "timeStamp",
"sourceClientResID" : "sourceClientResID"
},
"targetVolume" : "targetVolume",
"recoveryDestination" : "recoveryDestination",
"namespace" : "backup",
"passphrase" : [ "passphrase", "passphrase" ],
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"recoveryStartTime" : "recoveryStartTime",
"backupInstance" : {
"instanceID" : "instanceID",
"backupID" : "backupID"
}
}
Responses
200 Resource was retrieved successfully. Recover
400 Bad request. ErrorResponse
401 Unauthorized. ErrorResponse
404 Not found. ErrorResponse
405
NetWorker 18.2 REST API Reference Guide 177
Method not allowed. ErrorResponse
500 Internal server error. ErrorResponse
Up GET /recovers
(getRecovers)
Returns a list of all recovery resources.
Return type
RecoverList
Example data
Content-Type: application/json
{
"recovers" : [ {
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"NDMPOptions" : {
"useIPv4" : true,
"verifyIndexDB" : true
},
"itemsToRecover" : [ "itemsToRecover", "itemsToRecover" ],
"recoveryType" : "Filesystem",
"destinationClientResID" : "destinationClientResID",
"actionForDuplicateItems" : "Rename",
"poolForStaging" : "poolForStaging",
"timeStampBasedGranularRecover" : {
"timeStamp" : "timeStamp",
"sourceClientResID" : "sourceClientResID"
},
"targetVolume" : "targetVolume",
"recoveryDestination" : "recoveryDestination",
"namespace" : "backup",
"passphrase" : [ "passphrase", "passphrase" ],
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
NetWorker 18.2 REST API Reference Guide 178
} ],
"recoveryStartTime" : "recoveryStartTime",
"backupInstance" : {
"instanceID" : "instanceID",
"backupID" : "backupID"
}
}, {
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"NDMPOptions" : {
"useIPv4" : true,
"verifyIndexDB" : true
},
"itemsToRecover" : [ "itemsToRecover", "itemsToRecover" ],
"recoveryType" : "Filesystem",
"destinationClientResID" : "destinationClientResID",
"actionForDuplicateItems" : "Rename",
"poolForStaging" : "poolForStaging",
"timeStampBasedGranularRecover" : {
"timeStamp" : "timeStamp",
"sourceClientResID" : "sourceClientResID"
},
"targetVolume" : "targetVolume",
"recoveryDestination" : "recoveryDestination",
"namespace" : "backup",
"passphrase" : [ "passphrase", "passphrase" ],
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"recoveryStartTime" : "recoveryStartTime",
"backupInstance" : {
"instanceID" : "instanceID",
"backupID" : "backupID"
}
} ],
"count" : 0
}
Produces
NetWorker 18.2 REST API Reference Guide 179
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resources were retrieved successfully. RecoverList
400 Bad request. ErrorResponse
401 Unauthorized. ErrorResponse
404 Not found. ErrorResponse
405 Method not allowed. ErrorResponse
500 Internal server error. ErrorResponse
Up POST /recovers
(postRecover)
Creates a new recovery resource and triggers a new just-in-time recovery.
Request body
recover Recover (required) Body Parameter Recovery resource to be created.
Responses
201 Resource was created successfully.
400 Bad request. ErrorResponse
401 Unauthorized. ErrorResponse
404 Not found. ErrorResponse
405 Method not allowed. ErrorResponse
500 Internal server error. ErrorResponse
NetWorker 18.2 REST API Reference Guide 180
Rules
Up DELETE /rules/{ruleName}
(deleteRule)
Deletes the specific rule.
Path parameters
ruleName (required) Path Parameter is the value of the name attribute in the rule object.
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
204 Resource was retrieved successfully.
Up GET /rules/{ruleName}
(getRule)
Returns the specific rule.
Path parameters
ruleName (required) Path Parameter is the value of the name attribute in the rule object.
Return type
Rule
Example data
Content-Type: application/json
{
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
NetWorker 18.2 REST API Reference Guide 181
"matchType" : "All",
"name" : "name",
"comment" : "comment",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"definitions" : [ {
"property" : "Name",
"type" : "VirtualMachine",
"value" : "value",
"operator" : "Equals"
}, {
"property" : "Name",
"type" : "VirtualMachine",
"value" : "value",
"operator" : "Equals"
} ],
"dataSourceType" : "VMware"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resource was retrieved successfully. Rule
Up GET /rules
(getRules)
Returns a list of rules.
Return type
RuleList
NetWorker 18.2 REST API Reference Guide 182
Example data
Content-Type: application/json
{
"count" : 0,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"rules" : [ {
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"matchType" : "All",
"name" : "name",
"comment" : "comment",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"definitions" : [ {
"property" : "Name",
"type" : "VirtualMachine",
"value" : "value",
"operator" : "Equals"
}, {
"property" : "Name",
"type" : "VirtualMachine",
"value" : "value",
"operator" : "Equals"
} ],
"dataSourceType" : "VMware"
}, {
"resourceId" : {
"sequence" : 1,
NetWorker 18.2 REST API Reference Guide 183
"id" : "id"
},
"matchType" : "All",
"name" : "name",
"comment" : "comment",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"definitions" : [ {
"property" : "Name",
"type" : "VirtualMachine",
"value" : "value",
"operator" : "Equals"
}, {
"property" : "Name",
"type" : "VirtualMachine",
"value" : "value",
"operator" : "Equals"
} ],
"dataSourceType" : "VMware"
} ]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resources were retrieved successfully. RuleList
Up POST /rules
(postRules)
Creates a new rule.
NetWorker 18.2 REST API Reference Guide 184
Request body
rule Rule (required) Body Parameter Rule to be created
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
201 Resource was created successfully.
Up PUT /rules/{ruleName}
(putRule)
Updates the specific rule.
Path parameters
ruleName (required) Path Parameter is the value of the name attribute in the rule object.
Request body
rule Rule (required) Body Parameter Rule data for the update
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
204 Resource was updated successfully.
Server
NetWorker 18.2 REST API Reference Guide 185
Up DELETE /usergroups/{userGroupId}
(deleteUserGroup)
Deletes the specific user group.
Path parameters
userGroupId (required) Path Parameter is the value of the name attribute in the user group object.
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
204 Resource was retrieved successfully.
Up GET /auditlogconfig
(getAuditLogConfig)
Returns the security audit log settings.
Return type
AuditLogConfiguration
Example data
Content-Type: application/json
{
"auditLogHostname" : "auditLogHostname",
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"auditLogMaxFileSizeInMB" : 0,
"auditLogFilePath" : "auditLogFilePath",
"auditLogMaxFileVersion" : 6,
"auditLogRenderedService" : "None",
"name" : "name",
"administrators" : [ "administrators", "administrators" ],
NetWorker 18.2 REST API Reference Guide 186
"auditLogRenderedLocale" : "auditLogRenderedLocale",
"auditLogSeverity" : "Information"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resources were retrieved successfully. AuditLogConfiguration
Up GET /serverconfig
(getServerConfig)
Returns the server configuration settings.
Return type
ServerConfiguration
Example data
Content-Type: application/json
{
"clpRefresh" : "clpRefresh",
"country" : "country",
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"saveSessionDistribution" : "MaxSessions",
"acceptNewRecoverSessions" : true,
"clpLicenseServer" : "clpLicenseServer",
"wormTapesOnlyInWormPools" : true,
"authenticationServicePort" : 6,
"deviceSharingMode" : "NoSharing",
"jobInactivityTimeout" : 5,
"emailAddress" : "emailAddress",
"fax" : "fax",
"administrators" : [ "administrators", "administrators" ],
"contactName" : "contactName",
"vmwsPort" : 7,
"clpLicenseServerPort" : 1,
NetWorker 18.2 REST API Reference Guide 187
"disableRpsClone" : true,
"datazonePassPhrase" : "datazonePassPhrase",
"acceptNewSessions" : true,
"supportEmailAddress" : "supportEmailAddress",
"productSerialNumber" : "productSerialNumber",
"stateOrProvince" : "stateOrProvince",
"vmwarePolicyAllowed" : true,
"phone" : "phone",
"aclPassthrough" : true,
"name" : "name",
"serverTimezone" : "serverTimezone",
"vmwsEnable" : true,
"solutionId" : "solutionId",
"manualSaves" : true,
"purchaseDate" : "purchaseDate",
"parallelism" : 2,
"licenseServers" : [ "licenseServers", "licenseServers" ],
"vmwsUserPassword" : "vmwsUserPassword",
"jobsdbRetentionInHours" : 5,
"company" : "company",
"clpSwid" : "clpSwid",
"keepIncompleteBackups" : true,
"authenticationProxyPort" : 0,
"nasDevicePolicyAllowed" : true,
"zipOrPostalCode" : "zipOrPostalCode",
"serverOSType" : "serverOSType",
"cityOrTown" : "cityOrTown",
"publicArchives" : true,
"vmwsUserName" : "vmwsUserName",
"volumePriority" : "NearLinePriority",
"wormPoolsOnlyHoldWormTapes" : true,
"streetAddress" : "streetAddress",
"authenticationServiceDatabase" : "authenticationServiceDatabase",
"clpUom" : "clpUom",
"siteId" : "siteId",
"comment" : "comment"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resources were retrieved successfully. ServerConfiguration
NetWorker 18.2 REST API Reference Guide 188
Up GET /servermessages
(getServerMessages)
Returns a list of server messages.
Return type
ServerMessageList
Example data
Content-Type: application/json
{
"serverMessages" : [ {
"id" : "id",
"source" : "source",
"category" : "category",
"message" : "message",
"priority" : "priority",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"id" : "id",
"source" : "source",
"category" : "category",
"message" : "message",
"priority" : "priority",
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ],
"count" : 0,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
NetWorker 18.2 REST API Reference Guide 189
application/json
Responses
200 Resources were retrieved successfully. ServerMessageList
Up GET /serverstatistics
(getServerStatistics)
Returns the server statistics.
Return type
ServerStatistics
Example data
Content-Type: application/json
{
"badRecovers" : 0,
"currentSaves" : 5,
"badSaves" : 6,
"upSince" : "2000-01-23T04:56:07.000+00:00",
"saveSize" : {
"unit" : "Byte",
"value" : 6
},
"version" : "version",
"recovers" : 7,
"maxRecovers" : 5,
"maxSaves" : 2,
"recoverSize" : {
"unit" : "Byte",
"value" : 6
},
"saves" : 9,
"currentRecovers" : 1,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ]
NetWorker 18.2 REST API Reference Guide 190
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resources were retrieved successfully. ServerStatistics
Up GET /usergroups/{userGroupId}
(getUserGroup)
Returns the specific user group.
Path parameters
userGroupId (required) Path Parameter is the value of the name attribute in the user group object.
Return type
UserGroup
Example data
Content-Type: application/json
{
"privileges" : [ "ChangeSecuriitySettings",
"ChangeSecuriitySettings" ],
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"name" : "name",
"externalRoles" : [ "externalRoles", "externalRoles" ],
"comment" : "comment",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
NetWorker 18.2 REST API Reference Guide 191
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"users" : [ "users", "users" ]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resource was retrieved successfully. UserGroup
Up GET /usergroups
(getUserGroups)
Returns a list of user groups.
Return type
UserGroupList
Example data
Content-Type: application/json
{
"userGroups" : [ {
"privileges" : [ "ChangeSecuriitySettings",
"ChangeSecuriitySettings" ],
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"name" : "name",
"externalRoles" : [ "externalRoles", "externalRoles" ],
"comment" : "comment",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
NetWorker 18.2 REST API Reference Guide 192
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"users" : [ "users", "users" ]
}, {
"privileges" : [ "ChangeSecuriitySettings",
"ChangeSecuriitySettings" ],
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"name" : "name",
"externalRoles" : [ "externalRoles", "externalRoles" ],
"comment" : "comment",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"users" : [ "users", "users" ]
} ],
"count" : 0,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
NetWorker 18.2 REST API Reference Guide 193
application/json
Responses
200 Resources were retrieved successfully. UserGroupList
Up POST /usergroups
(postUserGroups)
Creates a new user group.
Request body
usergroups UserGroup (required) Body Parameter User group to be created.
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
201 Resource was created successfully.
Up PUT /auditlogconfig
(putAuditLogConfig)
Updates the security audit log settings.
Request body
auditLogConfig AuditLogConfiguration (optional) Body Parameter Audit log settings for update.
Responses
204 Resource was updated successfully.
Up PUT /serverconfig
NetWorker 18.2 REST API Reference Guide 194
(putServerConfig)
Updates the server configuration settings.
Request body
serverConfig ServerConfiguration (optional) Body Parameter Server configuration settings for update.
Responses
204 Resource was updated successfully.
Up PUT /usergroups/{userGroupId}
(putUserGroups)
Updates the specific user group.
Path parameters
userGroupId (required) Path Parameter is the value of the name attribute in the user group object.
Request body
userGroup UserGroup (required) Body Parameter User group data for the update.
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
204 Resource was updated successfully.
Sessions
Up GET /sessions/{sessionId}
NetWorker 18.2 REST API Reference Guide 195
(getSession)
Returns the specific session.
Path parameters
sessionId (required) Path Parameter is the value of the id attribute in the session object.
Return type
Session
Example data
Content-Type: application/json
{
"saveSet" : "saveSet",
"totalRecoverVolumesNeeded" : 7,
"mode" : "Unknown",
"protectionGroup" : "protectionGroup",
"transferRate" : {
"unit" : "Byte/s",
"value" : 9
},
"extendedInformation" : "extendedInformation",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"startTime" : "2000-01-23T04:56:07.000+00:00",
"id" : 1,
"itemIdLong" : 5,
"rootJobId" : 2,
"tenant" : "tenant",
"deviceType" : "Data Domain",
"stopped" : true,
"pool" : "pool",
"saveSetId" : "saveSetId",
"completed" : true,
"deviceFamily" : "Tape",
"totalRecoverSize" : {
"unit" : "Byte",
"value" : 6
NetWorker 18.2 REST API Reference Guide 196
},
"volume" : "volume",
"clientHostname" : "clientHostname",
"compressionRatio" :
6.02745618307040320615897144307382404804229736328125,
"jobId" : 5,
"size" : {
"unit" : "Byte",
"value" : 6
},
"endTime" : "2000-01-23T04:56:07.000+00:00",
"device" : "device"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resource was retrieved successfully. Session
Up GET /sessions
(getSessions)
Returns a list of sessions.
Return type
SessionList
Example data
Content-Type: application/json
{
"sessions" : [ {
"saveSet" : "saveSet",
"totalRecoverVolumesNeeded" : 7,
"mode" : "Unknown",
"protectionGroup" : "protectionGroup",
"transferRate" : {
"unit" : "Byte/s",
"value" : 9
},
NetWorker 18.2 REST API Reference Guide 197
"extendedInformation" : "extendedInformation",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"startTime" : "2000-01-23T04:56:07.000+00:00",
"id" : 1,
"itemIdLong" : 5,
"rootJobId" : 2,
"tenant" : "tenant",
"deviceType" : "Data Domain",
"stopped" : true,
"pool" : "pool",
"saveSetId" : "saveSetId",
"completed" : true,
"deviceFamily" : "Tape",
"totalRecoverSize" : {
"unit" : "Byte",
"value" : 6
},
"volume" : "volume",
"clientHostname" : "clientHostname",
"compressionRatio" :
6.02745618307040320615897144307382404804229736328125,
"jobId" : 5,
"size" : {
"unit" : "Byte",
"value" : 6
},
"endTime" : "2000-01-23T04:56:07.000+00:00",
"device" : "device"
}, {
"saveSet" : "saveSet",
"totalRecoverVolumesNeeded" : 7,
"mode" : "Unknown",
"protectionGroup" : "protectionGroup",
"transferRate" : {
"unit" : "Byte/s",
"value" : 9
},
"extendedInformation" : "extendedInformation",
"links" : [ {
"rel" : "create-form",
NetWorker 18.2 REST API Reference Guide 198
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"startTime" : "2000-01-23T04:56:07.000+00:00",
"id" : 1,
"itemIdLong" : 5,
"rootJobId" : 2,
"tenant" : "tenant",
"deviceType" : "Data Domain",
"stopped" : true,
"pool" : "pool",
"saveSetId" : "saveSetId",
"completed" : true,
"deviceFamily" : "Tape",
"totalRecoverSize" : {
"unit" : "Byte",
"value" : 6
},
"volume" : "volume",
"clientHostname" : "clientHostname",
"compressionRatio" :
6.02745618307040320615897144307382404804229736328125,
"jobId" : 5,
"size" : {
"unit" : "Byte",
"value" : 6
},
"endTime" : "2000-01-23T04:56:07.000+00:00",
"device" : "device"
} ],
"count" : 0,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ]
}
NetWorker 18.2 REST API Reference Guide 199
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resources were retrieved successfully. SessionList
Up POST /sessions/{sessionId}/op/cancel
(postSessionOpCancel)
Cancels the specified session.
Path parameters
sessionId (required) Path Parameter is the value of the id attribute in the session object.
Request body
jobOpCancel JobOpCancel (required) Body Parameter Cancel parameters.
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
202 Accepted.
Storagenodes
Up DELETE /storagenodes/{storageNodeId}
(deleteStorageNode)
NetWorker 18.2 REST API Reference Guide 200
Deletes the specific storage node.
Path parameters
storageNodeId (required) Path Parameter is the value of the name attribute in the storage node object.
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
204 Resource was retrieved successfully.
Up GET /storagenodes/{storageNodeId}
(getStorageNode)
Returns the specific storage node.
Path parameters
storageNodeId (required) Path Parameter is the value of the name attribute in the storage node object.
Return type
StorageNode
Example data
Content-Type: application/json
{
"cloneStorageNodes" : [ "cloneStorageNodes", "cloneStorageNodes" ],
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"dateOfRegistration" : "2000-01-23T04:56:07.000+00:00",
"storageNodeIsConfigured" : true,
"deviceSharingMode" : "NoSharing",
"enabled" : true,
NetWorker 18.2 REST API Reference Guide 201
"configuredSiloTypes" : [ "configuredSiloTypes",
"configuredSiloTypes" ],
"searchAllLuns" : true,
"configuredDevices" : [ "configuredDevices", "configuredDevices" ],
"password" : "password",
"skipScsiTargets" : true,
"lastErrorNumber" : 6,
"ready" : true,
"usePersistentNames" : true,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"numberOfDevices" : 5,
"lastErrorMessages" : [ "lastErrorMessages", "lastErrorMessages" ],
"tenant" : "tenant",
"typeOfStorageNode" : "SCSI",
"configuredSilos" : [ "configuredSilos", "configuredSilos" ],
"remoteUser" : "remoteUser",
"configuredLibraryTypes" : [ "configuredLibraryTypes",
"configuredLibraryTypes" ],
"dedicatedStorageNode" : true,
"dynamicNsrmmds" : true,
"version" : "version",
"maxActiveDevices" : 1,
"aftdAllowedDirectories" : [ "aftdAllowedDirectories",
"aftdAllowedDirectories" ],
"dateOfLastScan" : "2000-01-23T04:56:07.000+00:00",
"daemonVersions" : [ "daemonVersions", "daemonVersions" ],
"name" : "name",
"comment" : "comment",
"numberOfLibraries" : 5,
"configuredLibraries" : [ "configuredLibraries",
"configuredLibraries" ],
"sharedDeviceCreation" : true
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
NetWorker 18.2 REST API Reference Guide 202
Responses
200 Resource was retrieved successfully. StorageNode
Up GET /storagenodes
(getStorageNodes)
Returns a list of storage nodes.
Return type
StorageNodeList
Example data
Content-Type: application/json
{
"count" : 0,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"storageNodes" : [ {
"cloneStorageNodes" : [ "cloneStorageNodes", "cloneStorageNodes"
],
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"dateOfRegistration" : "2000-01-23T04:56:07.000+00:00",
"storageNodeIsConfigured" : true,
"deviceSharingMode" : "NoSharing",
"enabled" : true,
"configuredSiloTypes" : [ "configuredSiloTypes",
"configuredSiloTypes" ],
"searchAllLuns" : true,
"configuredDevices" : [ "configuredDevices", "configuredDevices"
],
"password" : "password",
"skipScsiTargets" : true,
"lastErrorNumber" : 6,
"ready" : true,
NetWorker 18.2 REST API Reference Guide 203
"usePersistentNames" : true,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"numberOfDevices" : 5,
"lastErrorMessages" : [ "lastErrorMessages", "lastErrorMessages"
],
"tenant" : "tenant",
"typeOfStorageNode" : "SCSI",
"configuredSilos" : [ "configuredSilos", "configuredSilos" ],
"remoteUser" : "remoteUser",
"configuredLibraryTypes" : [ "configuredLibraryTypes",
"configuredLibraryTypes" ],
"dedicatedStorageNode" : true,
"dynamicNsrmmds" : true,
"version" : "version",
"maxActiveDevices" : 1,
"aftdAllowedDirectories" : [ "aftdAllowedDirectories",
"aftdAllowedDirectories" ],
"dateOfLastScan" : "2000-01-23T04:56:07.000+00:00",
"daemonVersions" : [ "daemonVersions", "daemonVersions" ],
"name" : "name",
"comment" : "comment",
"numberOfLibraries" : 5,
"configuredLibraries" : [ "configuredLibraries",
"configuredLibraries" ],
"sharedDeviceCreation" : true
}, {
"cloneStorageNodes" : [ "cloneStorageNodes", "cloneStorageNodes"
],
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"dateOfRegistration" : "2000-01-23T04:56:07.000+00:00",
"storageNodeIsConfigured" : true,
"deviceSharingMode" : "NoSharing",
"enabled" : true,
"configuredSiloTypes" : [ "configuredSiloTypes",
"configuredSiloTypes" ],
"searchAllLuns" : true,
"configuredDevices" : [ "configuredDevices", "configuredDevices"
],
NetWorker 18.2 REST API Reference Guide 204
"password" : "password",
"skipScsiTargets" : true,
"lastErrorNumber" : 6,
"ready" : true,
"usePersistentNames" : true,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"numberOfDevices" : 5,
"lastErrorMessages" : [ "lastErrorMessages", "lastErrorMessages"
],
"tenant" : "tenant",
"typeOfStorageNode" : "SCSI",
"configuredSilos" : [ "configuredSilos", "configuredSilos" ],
"remoteUser" : "remoteUser",
"configuredLibraryTypes" : [ "configuredLibraryTypes",
"configuredLibraryTypes" ],
"dedicatedStorageNode" : true,
"dynamicNsrmmds" : true,
"version" : "version",
"maxActiveDevices" : 1,
"aftdAllowedDirectories" : [ "aftdAllowedDirectories",
"aftdAllowedDirectories" ],
"dateOfLastScan" : "2000-01-23T04:56:07.000+00:00",
"daemonVersions" : [ "daemonVersions", "daemonVersions" ],
"name" : "name",
"comment" : "comment",
"numberOfLibraries" : 5,
"configuredLibraries" : [ "configuredLibraries",
"configuredLibraries" ],
"sharedDeviceCreation" : true
} ]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
NetWorker 18.2 REST API Reference Guide 205
Responses
200 Resources were retrieved successfully. StorageNodeList
Up POST /storagenodes
(postStorageNodes)
Creates a new storage node.
Request body
storageNode StorageNode (required) Body Parameter Storage node to be created.
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
201 Resource was created successfully.
Up PUT /storagenodes/{storageNodeId}
(putStorageNode)
Updates the specific storage node.
Path parameters
storageNodeId (required) Path Parameter is the value of the name attribute in the storage node object.
Request body
storageNode StorageNode (required) Body Parameter Storage node data for the update.
Produces
NetWorker 18.2 REST API Reference Guide 206
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
204 Resource was updated successfully.
Tenants
Up DELETE /tenants/{tenantId}
(deleteTenant)
Deletes the specific tenant.
Path parameters
tenantId (required) Path Parameter is the value of the id attribute of the tenant object's resourceId.
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
204 Resource was retrieved successfully.
Up GET /tenants/{tenantId}
(getTenant)
Returns the specific tenant.
Path parameters
tenantId (required)
NetWorker 18.2 REST API Reference Guide 207
Path Parameter is the value of the id attribute of the tenant object's resourceId.
Return type
Tenant
Example data
Content-Type: application/json
{
"privileges" : [ "ChangeSecuriitySettings",
"ChangeSecuriitySettings" ],
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"devices" : [ "devices", "devices" ],
"directives" : [ "directives", "directives" ],
"protectionPolicies" : [ "protectionPolicies", "protectionPolicies"
],
"numberOfJukeboxes" : 5,
"pools" : [ "pools", "pools" ],
"users" : [ "users", "users" ],
"labels" : [ "labels", "labels" ],
"protectionGroups" : [ "protectionGroups", "protectionGroups" ],
"numberOfClients" : 6,
"recovers" : [ "recovers", "recovers" ],
"clientHostnames" : [ "clientHostnames", "clientHostnames" ],
"jukeboxes" : [ "jukeboxes", "jukeboxes" ],
"name" : "name",
"externalRoles" : [ "externalRoles", "externalRoles" ],
"comment" : "comment",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"numberOfStorageNodes" : 5,
"storageNodes" : [ "storageNodes", "storageNodes" ],
"numberOfDevices" : 1
}
Produces
NetWorker 18.2 REST API Reference Guide 208
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resource was retrieved successfully. Tenant
Up GET /tenants
(getTenants)
Returns a list of tenants.
Return type
TenantList
Example data
Content-Type: application/json
{
"tenants" : [ {
"privileges" : [ "ChangeSecuriitySettings",
"ChangeSecuriitySettings" ],
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"devices" : [ "devices", "devices" ],
"directives" : [ "directives", "directives" ],
"protectionPolicies" : [ "protectionPolicies",
"protectionPolicies" ],
"numberOfJukeboxes" : 5,
"pools" : [ "pools", "pools" ],
"users" : [ "users", "users" ],
"labels" : [ "labels", "labels" ],
"protectionGroups" : [ "protectionGroups", "protectionGroups" ],
"numberOfClients" : 6,
"recovers" : [ "recovers", "recovers" ],
"clientHostnames" : [ "clientHostnames", "clientHostnames" ],
"jukeboxes" : [ "jukeboxes", "jukeboxes" ],
"name" : "name",
"externalRoles" : [ "externalRoles", "externalRoles" ],
"comment" : "comment",
"links" : [ {
"rel" : "create-form",
NetWorker 18.2 REST API Reference Guide 209
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"numberOfStorageNodes" : 5,
"storageNodes" : [ "storageNodes", "storageNodes" ],
"numberOfDevices" : 1
}, {
"privileges" : [ "ChangeSecuriitySettings",
"ChangeSecuriitySettings" ],
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"devices" : [ "devices", "devices" ],
"directives" : [ "directives", "directives" ],
"protectionPolicies" : [ "protectionPolicies",
"protectionPolicies" ],
"numberOfJukeboxes" : 5,
"pools" : [ "pools", "pools" ],
"users" : [ "users", "users" ],
"labels" : [ "labels", "labels" ],
"protectionGroups" : [ "protectionGroups", "protectionGroups" ],
"numberOfClients" : 6,
"recovers" : [ "recovers", "recovers" ],
"clientHostnames" : [ "clientHostnames", "clientHostnames" ],
"jukeboxes" : [ "jukeboxes", "jukeboxes" ],
"name" : "name",
"externalRoles" : [ "externalRoles", "externalRoles" ],
"comment" : "comment",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"numberOfStorageNodes" : 5,
"storageNodes" : [ "storageNodes", "storageNodes" ],
"numberOfDevices" : 1
} ],
NetWorker 18.2 REST API Reference Guide 210
"count" : 0,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resources were retrieved successfully. TenantList
Up POST /tenants
(postTenant)
Creates a new tenant.
Request body
tenant Tenant (required) Body Parameter Tenant to be created.
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
201 Resource was created successfully.
NetWorker 18.2 REST API Reference Guide 211
Up PUT /tenants/{tenantId}
(putTenant)
Updates the specific tenant.
Path parameters
tenantId (required) Path Parameter is the value of the id attribute of the tenant object's resourceId.
Request body
tenant Tenant (required) Body Parameter Tenant data for the update.
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
204 Resource was updated successfully.
Vmware
Up DELETE /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/op/vmmount/{vproxy-mount-session-
id}/vmbrowse/{vproxy-browse-session-id}
(deleteBackupVProxyVmBrowseSession)
Deletes the specific VM browse session.
Path parameters
vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter object.
vm-uuid (required)
NetWorker 18.2 REST API Reference Guide 212
Path Parameter is the value of the uuid attribute in the protected VM object.
backup-id (required) Path Parameter is the value of the id attribute in the backup object.
vproxy-mount-session-id (required) Path Parameter is the value of the vProxyMountSessionId attribute in the vproxy VM mount job object.
vproxy-browse-session-id (required) Path Parameter is the value of the sessionId attribute of the session's config object.
Responses
204 Resource was retrieved successfully.
400 Bad request. ErrorResponse
401 Unauthorized. ErrorResponse
404 Not found. ErrorResponse
405 Method not allowed. ErrorResponse
500 Internal server error. ErrorResponse
Up DELETE /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/instances/{instance-id}/op/vmmount/{vproxy-
mount-session-id}/vmbrowse/{vproxy-browse-session-id}
(deleteInstanceVProxyVmBrowseSession)
Deletes the specific VM browse session.
Path parameters
vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter object.
vm-uuid (required) Path Parameter is the value of the uuid attribute in the protected VM object.
backup-id (required) Path Parameter is the value of the id attribute in the backup object.
instance-id (required) Path Parameter is the value of the id attribute in the instance object.
vproxy-mount-session-id (required)
NetWorker 18.2 REST API Reference Guide 213
Path Parameter is the value of the vProxyMountSessionId attribute in the vproxy VM mount job object.
vproxy-browse-session-id (required) Path Parameter is the value of the sessionId attribute of the session's config object.
Responses
204 Resource was retrieved successfully.
400 Bad request. ErrorResponse
401 Unauthorized. ErrorResponse
404 Not found. ErrorResponse
405 Method not allowed. ErrorResponse
500 Internal server error. ErrorResponse
Up DELETE /vmware/vcenters/{vcenter-hostname}
(deleteVCenter)
Deletes the specific vCenter.
Path parameters
vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter object.
Responses
204 Resource was retrieved successfully.
Up DELETE /vmware/vproxies/{vproxy-hostname}
(deleteVProxy)
Deletes the specific vProxy.
Path parameters
vproxy-hostname (required) Path Parameter is the value of hostname attribute in the vProxy object.
NetWorker 18.2 REST API Reference Guide 214
Responses
204 Resource was retrieved successfully.
Up GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/op/vmmount/{vproxy-mount-session-
id}/vmbrowse/{vproxy-browse-session-id}/contents
(getBackupVProxyVmBrowseSessionContents)
Returns content of a single vmbrowse session.
Path parameters
vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter object.
vm-uuid (required) Path Parameter is the value of the uuid attribute in the protected VM object.
backup-id (required) Path Parameter is the value of the id attribute in the backup object.
vproxy-mount-session-id (required) Path Parameter is the value of the vProxyMountSessionId attribute in the vproxy VM mount job object.
vproxy-browse-session-id (required) Path Parameter is the value of the sessionId attribute of the session's config object.
Return type
XmlVmBrowseDirectoryContents
Example data
Content-Type: application/json
{
"noMoreData" : true,
"freeSpace" : 1,
"totalObjects" : 6,
"error" : {
"code" : 0,
"text" : "text"
},
"fileList" : [ {
"fileName" : "fileName",
"fileModificationTime" : "fileModificationTime",
"fileSize" : 5,
"fileType" : "fileType"
NetWorker 18.2 REST API Reference Guide 215
}, {
"fileName" : "fileName",
"fileModificationTime" : "fileModificationTime",
"fileSize" : 5,
"fileType" : "fileType"
} ]
}
Responses
200 Resource was retrieved successfully. XmlVmBrowseDirectoryContents
400 Bad request. ErrorResponse
401 Unauthorized. ErrorResponse
404 Not found. ErrorResponse
405 Method not allowed. ErrorResponse
500 Internal server error. ErrorResponse
Up GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/op/vmmount/{vproxy-mount-session-
id}/vmbrowse/{vproxy-browse-session-id}
(getBackupVProxyVmBrowseSessionResponse)
Returns the specific VM browse session.
Path parameters
vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter object.
vm-uuid (required) Path Parameter is the value of the uuid attribute in the protected VM object.
backup-id (required) Path Parameter is the value of the id attribute in the backup object.
vproxy-mount-session-id (required) Path Parameter is the value of the vProxyMountSessionId attribute in the vproxy VM mount job object.
vproxy-browse-session-id (required) Path Parameter is the value of the sessionId attribute of the session's config object.
Return type
NetWorker 18.2 REST API Reference Guide 216
VProxyVmBrowseSessionResponse
Example data
Content-Type: application/json
{
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"config" : {
"idleTimeout" : 6,
"cacheRetentionSeconds" : 1,
"sessionId" : "sessionId",
"currentWorkingDirectory" : "currentWorkingDirectory",
"browseDestination" : true
},
"status" : {
"description" : "description",
"state" : "state"
}
}
Responses
200 Resource was retrieved successfully. VProxyVmBrowseSessionResponse
400 Bad request. ErrorResponse
401 Unauthorized. ErrorResponse
404 Not found. ErrorResponse
405 Method not allowed. ErrorResponse
500 Internal server error. ErrorResponse
Up GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/op/vmmount/{vproxy-mount-session-
id}/vmbrowse
(getBackupVProxyVmBrowseSessionResponseList)
NetWorker 18.2 REST API Reference Guide 217
Returns a list of all vmbrowse sessions.
Path parameters
vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter object.
vm-uuid (required) Path Parameter is the value of the uuid attribute in the protected VM object.
backup-id (required) Path Parameter is the value of the id attribute in the backup object.
vproxy-mount-session-id (required) Path Parameter is the value of the vProxyMountSessionId attribute in the vproxy VM mount job object.
Return type
VProxyVmBrowseSessionResponseList
Example data
Content-Type: application/json
{
"sessions" : [ {
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"config" : {
"idleTimeout" : 6,
"cacheRetentionSeconds" : 1,
"sessionId" : "sessionId",
"currentWorkingDirectory" : "currentWorkingDirectory",
"browseDestination" : true
},
"status" : {
"description" : "description",
"state" : "state"
}
}, {
"links" : [ {
"rel" : "create-form",
NetWorker 18.2 REST API Reference Guide 218
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"config" : {
"idleTimeout" : 6,
"cacheRetentionSeconds" : 1,
"sessionId" : "sessionId",
"currentWorkingDirectory" : "currentWorkingDirectory",
"browseDestination" : true
},
"status" : {
"description" : "description",
"state" : "state"
}
} ],
"count" : 0,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resources were retrieved successfully. VProxyVmBrowseSessionResponseList
400 Bad request. ErrorResponse
401
NetWorker 18.2 REST API Reference Guide 219
Unauthorized. ErrorResponse
404 Not found. ErrorResponse
405 Method not allowed. ErrorResponse
500 Internal server error. ErrorResponse
Up GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/op/vmmount/{vproxy-mount-session-id}
(getBackupVProxyVmMountSessionResponse)
Returns the specific mount session.
Path parameters
vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter object.
vm-uuid (required) Path Parameter is the value of the uuid attribute in the protected VM object.
backup-id (required) Path Parameter is the value of the id attribute in the backup object.
vproxy-mount-session-id (required) Path Parameter is the value of the vProxyMountSessionId attribute in the vproxy VM mount job object.
Return type
VProxyVmMountSessionResponse
Example data
Content-Type: application/json
{
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"config" : {
"mountPointPath" : "mountPointPath",
NetWorker 18.2 REST API Reference Guide 220
"idleTimeout" : 0
},
"status" : {
"description" : "description",
"state" : "state"
}
}
Responses
200 Resource was retrieved successfully. VProxyVmMountSessionResponse
400 Bad request. ErrorResponse
401 Unauthorized. ErrorResponse
404 Not found. ErrorResponse
405 Method not allowed. ErrorResponse
500 Internal server error. ErrorResponse
Up GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/instances/{instance-id}/op/vmmount/{vproxy-
mount-session-id}/vmbrowse/{vproxy-browse-session-id}/contents
(getInstanceVProxyVmBrowseSessionContents)
Returns content of a single vmbrowse session.
Path parameters
vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter object.
vm-uuid (required) Path Parameter is the value of the uuid attribute in the protected VM object.
backup-id (required) Path Parameter is the value of the id attribute in the backup object.
instance-id (required) Path Parameter is the value of the id attribute in the instance object.
vproxy-mount-session-id (required) Path Parameter is the value of the vProxyMountSessionId attribute in the vproxy VM mount job object.
vproxy-browse-session-id (required) Path Parameter Specifies the ID of the vproxy vm browse session.
NetWorker 18.2 REST API Reference Guide 221
Return type
XmlVmBrowseDirectoryContents
Example data
Content-Type: application/json
{
"noMoreData" : true,
"freeSpace" : 1,
"totalObjects" : 6,
"error" : {
"code" : 0,
"text" : "text"
},
"fileList" : [ {
"fileName" : "fileName",
"fileModificationTime" : "fileModificationTime",
"fileSize" : 5,
"fileType" : "fileType"
}, {
"fileName" : "fileName",
"fileModificationTime" : "fileModificationTime",
"fileSize" : 5,
"fileType" : "fileType"
} ]
}
Responses
200 Resource was retrieved successfully. XmlVmBrowseDirectoryContents
400 Bad request. ErrorResponse
401 Unauthorized. ErrorResponse
404 Not found. ErrorResponse
405 Method not allowed. ErrorResponse
500 Internal server error. ErrorResponse
Up GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/instances/{instance-id}/op/vmmount/{vproxy-
mount-session-id}/vmbrowse/{vproxy-browse-session-id}
(getInstanceVProxyVmBrowseSessionResponse)
Returns the specific VM browse session.
NetWorker 18.2 REST API Reference Guide 222
Path parameters
vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter object.
vm-uuid (required) Path Parameter is the value of the uuid attribute in the protected VM object.
backup-id (required) Path Parameter is the value of the id attribute in the backup object.
instance-id (required) Path Parameter is the value of the id attribute in the instance object.
vproxy-mount-session-id (required) Path Parameter is the value of the vProxyMountSessionId attribute in the vproxy VM mount job object.
vproxy-browse-session-id (required) Path Parameter is the value of the sessionId attribute of the session's config object.
Return type
VProxyVmBrowseSessionResponse
Example data
Content-Type: application/json
{
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"config" : {
"idleTimeout" : 6,
"cacheRetentionSeconds" : 1,
"sessionId" : "sessionId",
"currentWorkingDirectory" : "currentWorkingDirectory",
"browseDestination" : true
},
"status" : {
"description" : "description",
"state" : "state"
}
NetWorker 18.2 REST API Reference Guide 223
}
Responses
200 Resource was retrieved successfully. VProxyVmBrowseSessionResponse
400 Bad request. ErrorResponse
401 Unauthorized. ErrorResponse
404 Not found. ErrorResponse
405 Method not allowed. ErrorResponse
500 Internal server error. ErrorResponse
Up GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/instances/{instance-id}/op/vmmount/{vproxy-
mount-session-id}/vmbrowse
(getInstanceVProxyVmBrowseSessionResponseList)
Returns a list of all vmbrowse sessions.
Path parameters
vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter object.
vm-uuid (required) Path Parameter is the value of the uuid attribute in the protected VM object.
backup-id (required) Path Parameter is the value of the id attribute in the backup object.
instance-id (required) Path Parameter is the value of the id attribute in the instance object.
vproxy-mount-session-id (required) Path Parameter is the value of the vProxyMountSessionId attribute in the vproxy VM mount job object.
Return type
VProxyVmBrowseSessionResponseList
Example data
Content-Type: application/json
{
"sessions" : [ {
NetWorker 18.2 REST API Reference Guide 224
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"config" : {
"idleTimeout" : 6,
"cacheRetentionSeconds" : 1,
"sessionId" : "sessionId",
"currentWorkingDirectory" : "currentWorkingDirectory",
"browseDestination" : true
},
"status" : {
"description" : "description",
"state" : "state"
}
}, {
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"config" : {
"idleTimeout" : 6,
"cacheRetentionSeconds" : 1,
"sessionId" : "sessionId",
"currentWorkingDirectory" : "currentWorkingDirectory",
"browseDestination" : true
},
"status" : {
"description" : "description",
"state" : "state"
}
} ],
"count" : 0,
"links" : [ {
"rel" : "create-form",
"href" : "href",
NetWorker 18.2 REST API Reference Guide 225
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resources were retrieved successfully. VProxyVmBrowseSessionResponseList
400 Bad request. ErrorResponse
401 Unauthorized. ErrorResponse
404 Not found. ErrorResponse
405 Method not allowed. ErrorResponse
500 Internal server error. ErrorResponse
Up GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/instances/{instance-id}/op/vmmount/{vproxy-
mount-session-id}
(getInstanceVProxyVmMountSessionResponse)
Returns the specific mount session.
Path parameters
vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter object.
vm-uuid (required) Path Parameter is the value of the uuid attribute in the protected VM object.
NetWorker 18.2 REST API Reference Guide 226
backup-id (required) Path Parameter is the value of the id attribute in the backup object.
instance-id (required) Path Parameter is the value of the id attribute in the instance object.
vproxy-mount-session-id (required) Path Parameter is the value of the vProxyMountSessionId attribute in the vproxy VM mount job object.
Return type
VProxyVmMountSessionResponse
Example data
Content-Type: application/json
{
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"config" : {
"mountPointPath" : "mountPointPath",
"idleTimeout" : 0
},
"status" : {
"description" : "description",
"state" : "state"
}
}
Responses
200 Resource was retrieved successfully. VProxyVmMountSessionResponse
400 Bad request. ErrorResponse
401 Unauthorized. ErrorResponse
404 Not found. ErrorResponse
405 Method not allowed. ErrorResponse
500
NetWorker 18.2 REST API Reference Guide 227
Internal server error. ErrorResponse
Up GET /vmware/vcenters/{vcenter-hostname}
(getVCenter)
Returns the specific vCenter.
Path parameters
vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter object.
Return type
VCenter
Example data
Content-Type: application/json
{
"hostname" : "hostname",
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"userPassword" : "userPassword",
"cloudDeployment" : true,
"comment" : "comment",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"userName" : "userName"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
NetWorker 18.2 REST API Reference Guide 228
application/json
Responses
200 Resource was retrieved successfully. VCenter
Up GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-uuid}
(getVCenterProtectedVm)
Returns a specific protected VM for a specific vCenter.
Path parameters
vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter object.
vm-uuid (required) Path Parameter is the value of the uuid attribute in the protected VM object.
Return type
VMwareProtectedVm
Example data
Content-Type: application/json
{
"hasAppConsistencyBackup" : true,
"hostname" : "hostname",
"ipAddress" : "ipAddress",
"name" : "name",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"morefId" : "morefId",
"osId" : "osId",
"vCenterHostname" : "vCenterHostname",
"osName" : "osName",
"uuid" : "uuid",
NetWorker 18.2 REST API Reference Guide 229
"version" : "version"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resource was retrieved successfully. VMwareProtectedVm
Up GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/instances
(getVCenterProtectedVmBackupInstances)
Returns a list of instances (clones) for a specific protected VM backup.
Path parameters
vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter object.
vm-uuid (required) Path Parameter is the value of the uuid attribute in the protected VM object.
backup-id (required) Path Parameter is the value of the id attribute in the backup object.
Return type
BackupInstanceList
Example data
Content-Type: application/json
{
"backupInstances" : [ {
"clone" : true,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
NetWorker 18.2 REST API Reference Guide 230
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"volumeIds" : [ "volumeIds", "volumeIds" ],
"id" : "id",
"status" : "Aborted"
}, {
"clone" : true,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"volumeIds" : [ "volumeIds", "volumeIds" ],
"id" : "id",
"status" : "Aborted"
} ],
"count" : 0,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200
NetWorker 18.2 REST API Reference Guide 231
Resource was retrieved successfully. BackupInstanceList
Up GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups
(getVCenterProtectedVmBackups)
Returns a list of backups (save sets) for a specific protected VM.
Path parameters
vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter object.
vm-uuid (required) Path Parameter is the value of the uuid attribute in the protected VM object.
Return type
BackupList
Example data
Content-Type: application/json
{
"count" : 5,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"backups" : [ {
"shortId" : "shortId",
"clientId" : "clientId",
"browseTime" : "2000-01-23T04:56:07.000+00:00",
"creationTime" : "2000-01-23T04:56:07.000+00:00",
"instances" : [ {
"clone" : true,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
NetWorker 18.2 REST API Reference Guide 232
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"volumeIds" : [ "volumeIds", "volumeIds" ],
"id" : "id",
"status" : "Aborted"
}, {
"clone" : true,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"volumeIds" : [ "volumeIds", "volumeIds" ],
"id" : "id",
"status" : "Aborted"
} ],
"level" : "1",
"retentionTime" : "2000-01-23T04:56:07.000+00:00",
"type" : "CoverSet",
"fileCount" : 0,
"clientHostname" : "clientHostname",
"completionTime" : "2000-01-23T04:56:07.000+00:00",
"size" : {
"unit" : "Byte",
"value" : 6
},
"name" : "name",
"attributes" : [ {
"values" : [ "values", "values" ],
"key" : "key"
}, {
"values" : [ "values", "values" ],
"key" : "key"
} ],
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
NetWorker 18.2 REST API Reference Guide 233
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"id" : "id",
"saveTime" : "2000-01-23T04:56:07.000+00:00",
"vmInformation" : {
"vmName" : "vmName",
"disks" : [ {
"datastoreMoref" : "datastoreMoref",
"name" : "name",
"thinProvisioned" : true,
"datastoreName" : "datastoreName",
"sizeInKb" : 1,
"key" : "key"
}, {
"datastoreMoref" : "datastoreMoref",
"name" : "name",
"thinProvisioned" : true,
"datastoreName" : "datastoreName",
"sizeInKb" : 1,
"key" : "key"
} ],
"hostMoref" : "hostMoref",
"datastoreMoref" : "datastoreMoref",
"vmMoref" : "vmMoref",
"vCenterHostname" : "vCenterHostname",
"morefPath" : "morefPath"
},
"tenant" : "tenant"
}, {
"shortId" : "shortId",
"clientId" : "clientId",
"browseTime" : "2000-01-23T04:56:07.000+00:00",
"creationTime" : "2000-01-23T04:56:07.000+00:00",
"instances" : [ {
"clone" : true,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"volumeIds" : [ "volumeIds", "volumeIds" ],
NetWorker 18.2 REST API Reference Guide 234
"id" : "id",
"status" : "Aborted"
}, {
"clone" : true,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"volumeIds" : [ "volumeIds", "volumeIds" ],
"id" : "id",
"status" : "Aborted"
} ],
"level" : "1",
"retentionTime" : "2000-01-23T04:56:07.000+00:00",
"type" : "CoverSet",
"fileCount" : 0,
"clientHostname" : "clientHostname",
"completionTime" : "2000-01-23T04:56:07.000+00:00",
"size" : {
"unit" : "Byte",
"value" : 6
},
"name" : "name",
"attributes" : [ {
"values" : [ "values", "values" ],
"key" : "key"
}, {
"values" : [ "values", "values" ],
"key" : "key"
} ],
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"id" : "id",
"saveTime" : "2000-01-23T04:56:07.000+00:00",
NetWorker 18.2 REST API Reference Guide 235
"vmInformation" : {
"vmName" : "vmName",
"disks" : [ {
"datastoreMoref" : "datastoreMoref",
"name" : "name",
"thinProvisioned" : true,
"datastoreName" : "datastoreName",
"sizeInKb" : 1,
"key" : "key"
}, {
"datastoreMoref" : "datastoreMoref",
"name" : "name",
"thinProvisioned" : true,
"datastoreName" : "datastoreName",
"sizeInKb" : 1,
"key" : "key"
} ],
"hostMoref" : "hostMoref",
"datastoreMoref" : "datastoreMoref",
"vmMoref" : "vmMoref",
"vCenterHostname" : "vCenterHostname",
"morefPath" : "morefPath"
},
"tenant" : "tenant"
} ]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resource was retrieved successfully. BackupList
Up GET /vmware/vcenters/{vcenter-hostname}/protectedvms
(getVCenterProtectedVms)
Returns a list of protected VMs for a specific vCenter.
Path parameters
vcenter-hostname (required)
NetWorker 18.2 REST API Reference Guide 236
Path Parameter is the value of the hostname attribute in the vCenter object.
Return type
VMwareProtectedVmList
Example data
Content-Type: application/json
{
"count" : 0,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"vms" : [ {
"hasAppConsistencyBackup" : true,
"hostname" : "hostname",
"ipAddress" : "ipAddress",
"name" : "name",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"morefId" : "morefId",
"osId" : "osId",
"vCenterHostname" : "vCenterHostname",
"osName" : "osName",
"uuid" : "uuid",
"version" : "version"
}, {
"hasAppConsistencyBackup" : true,
"hostname" : "hostname",
"ipAddress" : "ipAddress",
"name" : "name",
"links" : [ {
NetWorker 18.2 REST API Reference Guide 237
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"morefId" : "morefId",
"osId" : "osId",
"vCenterHostname" : "vCenterHostname",
"osName" : "osName",
"uuid" : "uuid",
"version" : "version"
} ]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resources were retrieved successfully. VMwareProtectedVmList
Up GET /vmware/vcenters/{vcenter-hostname}/vms/{vm-uuid}
(getVCenterVm)
Returns the specific VM for a specific vCenter.
Path parameters
vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter object.
vm-uuid (required) Path Parameter is the value of the uuid attribute in the VM object.
Return type
VMwareVm
Example data
NetWorker 18.2 REST API Reference Guide 238
Content-Type: application/json
{
"annotation" : "annotation",
"connectionState" : "connectionState",
"ipAddress" : "ipAddress",
"morefId" : "morefId",
"osId" : "osId",
"osName" : "osName",
"type" : "type",
"uuid" : "uuid",
"version" : "version",
"hostname" : "hostname",
"powerState" : "powerState",
"name" : "name",
"ipAddresses" : [ "ipAddresses", "ipAddresses" ],
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"state" : "state",
"vCenterHostname" : "vCenterHostname",
"status" : "status"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resource was retrieved successfully. VMwareVm
Up GET /vmware/vcenters/{vcenter-hostname}/vms
(getVCenterVms)
Returns a list of VMs for a specific vCenter.
NetWorker 18.2 REST API Reference Guide 239
Path parameters
vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter object.
Return type
VMwareVmList
Example data
Content-Type: application/json
{
"count" : 0,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"vms" : [ {
"annotation" : "annotation",
"connectionState" : "connectionState",
"ipAddress" : "ipAddress",
"morefId" : "morefId",
"osId" : "osId",
"osName" : "osName",
"type" : "type",
"uuid" : "uuid",
"version" : "version",
"hostname" : "hostname",
"powerState" : "powerState",
"name" : "name",
"ipAddresses" : [ "ipAddresses", "ipAddresses" ],
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
NetWorker 18.2 REST API Reference Guide 240
"state" : "state",
"vCenterHostname" : "vCenterHostname",
"status" : "status"
}, {
"annotation" : "annotation",
"connectionState" : "connectionState",
"ipAddress" : "ipAddress",
"morefId" : "morefId",
"osId" : "osId",
"osName" : "osName",
"type" : "type",
"uuid" : "uuid",
"version" : "version",
"hostname" : "hostname",
"powerState" : "powerState",
"name" : "name",
"ipAddresses" : [ "ipAddresses", "ipAddresses" ],
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"state" : "state",
"vCenterHostname" : "vCenterHostname",
"status" : "status"
} ]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resources were retrieved successfully. VMwareVmList
Up GET /vmware/vcenters
NetWorker 18.2 REST API Reference Guide 241
(getVCenters)
Returns a list of vCenters.
Return type
VCenterList
Example data
Content-Type: application/json
{
"vCenters" : [ {
"hostname" : "hostname",
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"userPassword" : "userPassword",
"cloudDeployment" : true,
"comment" : "comment",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"userName" : "userName"
}, {
"hostname" : "hostname",
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"userPassword" : "userPassword",
"cloudDeployment" : true,
"comment" : "comment",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
NetWorker 18.2 REST API Reference Guide 242
"title" : "title"
} ],
"userName" : "userName"
} ],
"count" : 0,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resources were retrieved successfully. VCenterList
Up GET /vmware/protectedvms
(getVMwareProtectedVms)
Returns a list of protected VMs.
Return type
VMwareProtectedVmList
Example data
Content-Type: application/json
{
"count" : 0,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
NetWorker 18.2 REST API Reference Guide 243
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"vms" : [ {
"hasAppConsistencyBackup" : true,
"hostname" : "hostname",
"ipAddress" : "ipAddress",
"name" : "name",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"morefId" : "morefId",
"osId" : "osId",
"vCenterHostname" : "vCenterHostname",
"osName" : "osName",
"uuid" : "uuid",
"version" : "version"
}, {
"hasAppConsistencyBackup" : true,
"hostname" : "hostname",
"ipAddress" : "ipAddress",
"name" : "name",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"morefId" : "morefId",
"osId" : "osId",
"vCenterHostname" : "vCenterHostname",
"osName" : "osName",
"uuid" : "uuid",
NetWorker 18.2 REST API Reference Guide 244
"version" : "version"
} ]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resources were retrieved successfully. VMwareProtectedVmList
Up GET /vmware/vcenters/{vcenter-hostname}/vms/{vm-
uuid}/protectiondetails
(getVMwareVCenterVmProtectionDetails)
Returns a list of protection details for a specific vCenter VM.
Path parameters
vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter object.
vm-uuid (required) Path Parameter is the value of the uuid attribute in the VM object.
Return type
VMwareVmProtectionDetailList
Example data
Content-Type: application/json
{
"protectionDetails" : [ {
"protectionGroup" : {
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"workItemQueries" : [ "workItemQueries", "workItemQueries" ],
"workItems" : [ "workItems", "workItems" ],
"workItemType" : "Client",
"vmwareWorkItemExclusion" : {
NetWorker 18.2 REST API Reference Guide 245
"containerMorefs" : [ "containerMorefs", "containerMorefs" ],
"vmdks" : [ {
"vmUuid" : "vmUuid",
"vmdkUuid" : "vmdkUuid"
}, {
"vmUuid" : "vmUuid",
"vmdkUuid" : "vmdkUuid"
} ],
"vmUuids" : [ "vmUuids", "vmUuids" ],
"vCenterHostname" : "vCenterHostname"
},
"backupOptimization" : "Capacity",
"rule" : "rule",
"dynamicAssociation" : true,
"workItemSubType" : "VirtualMachine",
"name" : "name",
"comment" : "comment",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"vmwareWorkItemSelection" : {
"containerMorefs" : [ "containerMorefs", "containerMorefs" ],
"vmdks" : [ {
"vmUuid" : "vmUuid",
"vmdkUuid" : "vmdkUuid"
}, {
"vmUuid" : "vmUuid",
"vmdkUuid" : "vmdkUuid"
} ],
"vmUuids" : [ "vmUuids", "vmUuids" ],
"vCenterHostname" : "vCenterHostname"
},
"tenant" : "tenant",
"workItemSource" : "Static"
},
"workflow" : {
"nextStartDate" : "2000-01-23T04:56:07.000+00:00",
"completionNotification" : {
"executeOn" : "Completion",
"command" : "command"
},
"description" : "description",
NetWorker 18.2 REST API Reference Guide 246
"enabled" : true,
"protectionGroups" : [ "protectionGroups", "protectionGroups"
],
"newName" : "newName",
"startInterval" : "startInterval",
"name" : "name",
"restartTimeWindow" : "restartTimeWindow",
"comment" : "comment",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"startTime" : "startTime",
"endTime" : "endTime",
"actions" : [ {
"failureImpact" : "Continue",
"actionSpecificData" : {
"testConnectivity" : { },
"discover" : {
"discoverType" : "NAS snapshot"
},
"generateIndex" : {
"generateIndexType" : "NAS snapshot"
},
"backup" : {
"clientOverride" : "ClientCanNotOverride",
"destinationStorageNodes" : [ "destinationStorageNodes",
"destinationStorageNodes" ],
"overrideBackupSchedule" : true,
"successThreshold" : "Warning",
"backupSpecificData" : {
"vmwareVProxy" : {
"quiesceSystemAdminPassword" :
"quiesceSystemAdminPassword",
"enableDDRetentionLock" : true,
"proxyName" : "proxyName",
"destinationPool" : "destinationPool",
"quiesceTimeoutInMinutes" : 5,
"quiesceSystemAdminUsername" :
"quiesceSystemAdminUsername",
"appConsistentQuiesce" : "Basic",
"ddRetentionLockTime" : "ddRetentionLockTime",
"transactionLogBackup" : true
},
NetWorker 18.2 REST API Reference Guide 247
"traditional" : {
"enableDDRetentionLock" : true,
"revertToFullWhenSyntheticFullFails" : true,
"fileInactivityThresholdInDays" : 1,
"destinationPool" : "destinationPool",
"fileInactivityAlertThresholdPercentage" : 6,
"ddRetentionLockTime" : "ddRetentionLockTime",
"estimate" : true,
"timestampFormat" : "None",
"forceBackupLevel" : "forceBackupLevel",
"verifySyntheticFull" : true
},
"vmware" : {
"saveType" : "VMDK",
"useVbaInternalStorage" : true,
"destinationPool" : "destinationPool",
"vbaName" : "vbaName"
},
"snapshot" : {
"destinationPool" : "destinationPool",
"minimumRetentionPeriod" : "minimumRetentionPeriod",
"forceBackupLevel" : "forceBackupLevel"
}
},
"overrideRetentionPeriod" : true,
"retentionPeriod" : "retentionPeriod"
},
"vbaCheckpointBackup" : {
"destinationPool" : "destinationPool",
"retentionPeriod" : "retentionPeriod"
},
"expire" : { },
"clone" : {
"enableDDRetentionLock" : true,
"destinationPool" : "destinationPool",
"ddRetentionLockTime" : "ddRetentionLockTime",
"deleteSource" : true,
"sourceStorageNode" : "sourceStorageNode",
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"serverBackup" : {
"destinationPool" : "destinationPool",
"performBootstrap" : true,
"performClientFileIndexing" : true,
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"probe" : {
"allProbsMustSucceed" : true,
NetWorker 18.2 REST API Reference Guide 248
"maxBackupIntervalInDays" : 5
},
"vbaCheckpointDiscover" : { }
},
"workItemFilter" : {
"timeRangeStart" : "2000-01-23T04:56:07.000+00:00",
"clients" : [ "clients", "clients" ],
"saveSetTypes" : [ "saveSetTypes", "saveSetTypes" ],
"excludeTimeRange" : "true",
"timeRangeEnd" : "2000-01-23T04:56:07.000+00:00",
"excludeClient" : "true",
"excludeLevel" : "true",
"excludeSaveSetType" : "true",
"levels" : [ "levels", "levels" ]
},
"completionNotification" : {
"executeOn" : "Completion",
"command" : "command"
},
"parallelism" : 7,
"concurrent" : true,
"retryDelayInSec" : 3,
"scheduleComment" : "scheduleComment",
"drivenBy" : "drivenBy",
"enabled" : true,
"scheduleActivities" : [ "scheduleActivities",
"scheduleActivities" ],
"disableActionStartTime" : true,
"retries" : 9,
"customTags" : [ "customTags", "customTags" ],
"newName" : "newName",
"name" : "name",
"inactivityTimeoutInMin" : 2,
"actionStartTime" : "actionStartTime",
"comment" : "comment",
"hardLimit" : "hardLimit",
"scheduleOverrides" : [ "scheduleOverrides",
"scheduleOverrides" ],
"schedulePeriod" : "Week",
"softLimit" : "softLimit"
}, {
"failureImpact" : "Continue",
"actionSpecificData" : {
"testConnectivity" : { },
"discover" : {
"discoverType" : "NAS snapshot"
},
"generateIndex" : {
"generateIndexType" : "NAS snapshot"
},
NetWorker 18.2 REST API Reference Guide 249
"backup" : {
"clientOverride" : "ClientCanNotOverride",
"destinationStorageNodes" : [ "destinationStorageNodes",
"destinationStorageNodes" ],
"overrideBackupSchedule" : true,
"successThreshold" : "Warning",
"backupSpecificData" : {
"vmwareVProxy" : {
"quiesceSystemAdminPassword" :
"quiesceSystemAdminPassword",
"enableDDRetentionLock" : true,
"proxyName" : "proxyName",
"destinationPool" : "destinationPool",
"quiesceTimeoutInMinutes" : 5,
"quiesceSystemAdminUsername" :
"quiesceSystemAdminUsername",
"appConsistentQuiesce" : "Basic",
"ddRetentionLockTime" : "ddRetentionLockTime",
"transactionLogBackup" : true
},
"traditional" : {
"enableDDRetentionLock" : true,
"revertToFullWhenSyntheticFullFails" : true,
"fileInactivityThresholdInDays" : 1,
"destinationPool" : "destinationPool",
"fileInactivityAlertThresholdPercentage" : 6,
"ddRetentionLockTime" : "ddRetentionLockTime",
"estimate" : true,
"timestampFormat" : "None",
"forceBackupLevel" : "forceBackupLevel",
"verifySyntheticFull" : true
},
"vmware" : {
"saveType" : "VMDK",
"useVbaInternalStorage" : true,
"destinationPool" : "destinationPool",
"vbaName" : "vbaName"
},
"snapshot" : {
"destinationPool" : "destinationPool",
"minimumRetentionPeriod" : "minimumRetentionPeriod",
"forceBackupLevel" : "forceBackupLevel"
}
},
"overrideRetentionPeriod" : true,
"retentionPeriod" : "retentionPeriod"
},
"vbaCheckpointBackup" : {
"destinationPool" : "destinationPool",
"retentionPeriod" : "retentionPeriod"
NetWorker 18.2 REST API Reference Guide 250
},
"expire" : { },
"clone" : {
"enableDDRetentionLock" : true,
"destinationPool" : "destinationPool",
"ddRetentionLockTime" : "ddRetentionLockTime",
"deleteSource" : true,
"sourceStorageNode" : "sourceStorageNode",
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"serverBackup" : {
"destinationPool" : "destinationPool",
"performBootstrap" : true,
"performClientFileIndexing" : true,
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"probe" : {
"allProbsMustSucceed" : true,
"maxBackupIntervalInDays" : 5
},
"vbaCheckpointDiscover" : { }
},
"workItemFilter" : {
"timeRangeStart" : "2000-01-23T04:56:07.000+00:00",
"clients" : [ "clients", "clients" ],
"saveSetTypes" : [ "saveSetTypes", "saveSetTypes" ],
"excludeTimeRange" : "true",
"timeRangeEnd" : "2000-01-23T04:56:07.000+00:00",
"excludeClient" : "true",
"excludeLevel" : "true",
"excludeSaveSetType" : "true",
"levels" : [ "levels", "levels" ]
},
"completionNotification" : {
"executeOn" : "Completion",
"command" : "command"
},
"parallelism" : 7,
"concurrent" : true,
"retryDelayInSec" : 3,
"scheduleComment" : "scheduleComment",
"drivenBy" : "drivenBy",
"enabled" : true,
"scheduleActivities" : [ "scheduleActivities",
"scheduleActivities" ],
"disableActionStartTime" : true,
"retries" : 9,
"customTags" : [ "customTags", "customTags" ],
NetWorker 18.2 REST API Reference Guide 251
"newName" : "newName",
"name" : "name",
"inactivityTimeoutInMin" : 2,
"actionStartTime" : "actionStartTime",
"comment" : "comment",
"hardLimit" : "hardLimit",
"scheduleOverrides" : [ "scheduleOverrides",
"scheduleOverrides" ],
"schedulePeriod" : "Week",
"softLimit" : "softLimit"
} ],
"autoStartEnabled" : true
},
"protectionPolicy" : {
"summaryNotification" : {
"executeOn" : "Completion",
"command" : "command"
},
"policyProtectionEnable" : true,
"policyProtectionPeriod" : "policyProtectionPeriod",
"applyEntireWorkflow" : true,
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"allowManualSaves" : true,
"name" : "name",
"comment" : "comment",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"workflows" : [ {
"nextStartDate" : "2000-01-23T04:56:07.000+00:00",
"completionNotification" : {
"executeOn" : "Completion",
"command" : "command"
},
"description" : "description",
"enabled" : true,
"protectionGroups" : [ "protectionGroups", "protectionGroups"
],
"newName" : "newName",
NetWorker 18.2 REST API Reference Guide 252
"startInterval" : "startInterval",
"name" : "name",
"restartTimeWindow" : "restartTimeWindow",
"comment" : "comment",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"startTime" : "startTime",
"endTime" : "endTime",
"actions" : [ {
"failureImpact" : "Continue",
"actionSpecificData" : {
"testConnectivity" : { },
"discover" : {
"discoverType" : "NAS snapshot"
},
"generateIndex" : {
"generateIndexType" : "NAS snapshot"
},
"backup" : {
"clientOverride" : "ClientCanNotOverride",
"destinationStorageNodes" : [
"destinationStorageNodes", "destinationStorageNodes" ],
"overrideBackupSchedule" : true,
"successThreshold" : "Warning",
"backupSpecificData" : {
"vmwareVProxy" : {
"quiesceSystemAdminPassword" :
"quiesceSystemAdminPassword",
"enableDDRetentionLock" : true,
"proxyName" : "proxyName",
"destinationPool" : "destinationPool",
"quiesceTimeoutInMinutes" : 5,
"quiesceSystemAdminUsername" :
"quiesceSystemAdminUsername",
"appConsistentQuiesce" : "Basic",
"ddRetentionLockTime" : "ddRetentionLockTime",
"transactionLogBackup" : true
},
"traditional" : {
"enableDDRetentionLock" : true,
"revertToFullWhenSyntheticFullFails" : true,
NetWorker 18.2 REST API Reference Guide 253
"fileInactivityThresholdInDays" : 1,
"destinationPool" : "destinationPool",
"fileInactivityAlertThresholdPercentage" : 6,
"ddRetentionLockTime" : "ddRetentionLockTime",
"estimate" : true,
"timestampFormat" : "None",
"forceBackupLevel" : "forceBackupLevel",
"verifySyntheticFull" : true
},
"vmware" : {
"saveType" : "VMDK",
"useVbaInternalStorage" : true,
"destinationPool" : "destinationPool",
"vbaName" : "vbaName"
},
"snapshot" : {
"destinationPool" : "destinationPool",
"minimumRetentionPeriod" :
"minimumRetentionPeriod",
"forceBackupLevel" : "forceBackupLevel"
}
},
"overrideRetentionPeriod" : true,
"retentionPeriod" : "retentionPeriod"
},
"vbaCheckpointBackup" : {
"destinationPool" : "destinationPool",
"retentionPeriod" : "retentionPeriod"
},
"expire" : { },
"clone" : {
"enableDDRetentionLock" : true,
"destinationPool" : "destinationPool",
"ddRetentionLockTime" : "ddRetentionLockTime",
"deleteSource" : true,
"sourceStorageNode" : "sourceStorageNode",
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"serverBackup" : {
"destinationPool" : "destinationPool",
"performBootstrap" : true,
"performClientFileIndexing" : true,
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"probe" : {
"allProbsMustSucceed" : true,
"maxBackupIntervalInDays" : 5
},
NetWorker 18.2 REST API Reference Guide 254
"vbaCheckpointDiscover" : { }
},
"workItemFilter" : {
"timeRangeStart" : "2000-01-23T04:56:07.000+00:00",
"clients" : [ "clients", "clients" ],
"saveSetTypes" : [ "saveSetTypes", "saveSetTypes" ],
"excludeTimeRange" : "true",
"timeRangeEnd" : "2000-01-23T04:56:07.000+00:00",
"excludeClient" : "true",
"excludeLevel" : "true",
"excludeSaveSetType" : "true",
"levels" : [ "levels", "levels" ]
},
"completionNotification" : {
"executeOn" : "Completion",
"command" : "command"
},
"parallelism" : 7,
"concurrent" : true,
"retryDelayInSec" : 3,
"scheduleComment" : "scheduleComment",
"drivenBy" : "drivenBy",
"enabled" : true,
"scheduleActivities" : [ "scheduleActivities",
"scheduleActivities" ],
"disableActionStartTime" : true,
"retries" : 9,
"customTags" : [ "customTags", "customTags" ],
"newName" : "newName",
"name" : "name",
"inactivityTimeoutInMin" : 2,
"actionStartTime" : "actionStartTime",
"comment" : "comment",
"hardLimit" : "hardLimit",
"scheduleOverrides" : [ "scheduleOverrides",
"scheduleOverrides" ],
"schedulePeriod" : "Week",
"softLimit" : "softLimit"
}, {
"failureImpact" : "Continue",
"actionSpecificData" : {
"testConnectivity" : { },
"discover" : {
"discoverType" : "NAS snapshot"
},
"generateIndex" : {
"generateIndexType" : "NAS snapshot"
},
"backup" : {
"clientOverride" : "ClientCanNotOverride",
NetWorker 18.2 REST API Reference Guide 255
"destinationStorageNodes" : [
"destinationStorageNodes", "destinationStorageNodes" ],
"overrideBackupSchedule" : true,
"successThreshold" : "Warning",
"backupSpecificData" : {
"vmwareVProxy" : {
"quiesceSystemAdminPassword" :
"quiesceSystemAdminPassword",
"enableDDRetentionLock" : true,
"proxyName" : "proxyName",
"destinationPool" : "destinationPool",
"quiesceTimeoutInMinutes" : 5,
"quiesceSystemAdminUsername" :
"quiesceSystemAdminUsername",
"appConsistentQuiesce" : "Basic",
"ddRetentionLockTime" : "ddRetentionLockTime",
"transactionLogBackup" : true
},
"traditional" : {
"enableDDRetentionLock" : true,
"revertToFullWhenSyntheticFullFails" : true,
"fileInactivityThresholdInDays" : 1,
"destinationPool" : "destinationPool",
"fileInactivityAlertThresholdPercentage" : 6,
"ddRetentionLockTime" : "ddRetentionLockTime",
"estimate" : true,
"timestampFormat" : "None",
"forceBackupLevel" : "forceBackupLevel",
"verifySyntheticFull" : true
},
"vmware" : {
"saveType" : "VMDK",
"useVbaInternalStorage" : true,
"destinationPool" : "destinationPool",
"vbaName" : "vbaName"
},
"snapshot" : {
"destinationPool" : "destinationPool",
"minimumRetentionPeriod" :
"minimumRetentionPeriod",
"forceBackupLevel" : "forceBackupLevel"
}
},
"overrideRetentionPeriod" : true,
"retentionPeriod" : "retentionPeriod"
},
"vbaCheckpointBackup" : {
"destinationPool" : "destinationPool",
"retentionPeriod" : "retentionPeriod"
},
"expire" : { },
NetWorker 18.2 REST API Reference Guide 256
"clone" : {
"enableDDRetentionLock" : true,
"destinationPool" : "destinationPool",
"ddRetentionLockTime" : "ddRetentionLockTime",
"deleteSource" : true,
"sourceStorageNode" : "sourceStorageNode",
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"serverBackup" : {
"destinationPool" : "destinationPool",
"performBootstrap" : true,
"performClientFileIndexing" : true,
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"probe" : {
"allProbsMustSucceed" : true,
"maxBackupIntervalInDays" : 5
},
"vbaCheckpointDiscover" : { }
},
"workItemFilter" : {
"timeRangeStart" : "2000-01-23T04:56:07.000+00:00",
"clients" : [ "clients", "clients" ],
"saveSetTypes" : [ "saveSetTypes", "saveSetTypes" ],
"excludeTimeRange" : "true",
"timeRangeEnd" : "2000-01-23T04:56:07.000+00:00",
"excludeClient" : "true",
"excludeLevel" : "true",
"excludeSaveSetType" : "true",
"levels" : [ "levels", "levels" ]
},
"completionNotification" : {
"executeOn" : "Completion",
"command" : "command"
},
"parallelism" : 7,
"concurrent" : true,
"retryDelayInSec" : 3,
"scheduleComment" : "scheduleComment",
"drivenBy" : "drivenBy",
"enabled" : true,
"scheduleActivities" : [ "scheduleActivities",
"scheduleActivities" ],
"disableActionStartTime" : true,
"retries" : 9,
"customTags" : [ "customTags", "customTags" ],
"newName" : "newName",
"name" : "name",
NetWorker 18.2 REST API Reference Guide 257
"inactivityTimeoutInMin" : 2,
"actionStartTime" : "actionStartTime",
"comment" : "comment",
"hardLimit" : "hardLimit",
"scheduleOverrides" : [ "scheduleOverrides",
"scheduleOverrides" ],
"schedulePeriod" : "Week",
"softLimit" : "softLimit"
} ],
"autoStartEnabled" : true
}, {
"nextStartDate" : "2000-01-23T04:56:07.000+00:00",
"completionNotification" : {
"executeOn" : "Completion",
"command" : "command"
},
"description" : "description",
"enabled" : true,
"protectionGroups" : [ "protectionGroups", "protectionGroups"
],
"newName" : "newName",
"startInterval" : "startInterval",
"name" : "name",
"restartTimeWindow" : "restartTimeWindow",
"comment" : "comment",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"startTime" : "startTime",
"endTime" : "endTime",
"actions" : [ {
"failureImpact" : "Continue",
"actionSpecificData" : {
"testConnectivity" : { },
"discover" : {
"discoverType" : "NAS snapshot"
},
"generateIndex" : {
"generateIndexType" : "NAS snapshot"
},
"backup" : {
"clientOverride" : "ClientCanNotOverride",
NetWorker 18.2 REST API Reference Guide 258
"destinationStorageNodes" : [
"destinationStorageNodes", "destinationStorageNodes" ],
"overrideBackupSchedule" : true,
"successThreshold" : "Warning",
"backupSpecificData" : {
"vmwareVProxy" : {
"quiesceSystemAdminPassword" :
"quiesceSystemAdminPassword",
"enableDDRetentionLock" : true,
"proxyName" : "proxyName",
"destinationPool" : "destinationPool",
"quiesceTimeoutInMinutes" : 5,
"quiesceSystemAdminUsername" :
"quiesceSystemAdminUsername",
"appConsistentQuiesce" : "Basic",
"ddRetentionLockTime" : "ddRetentionLockTime",
"transactionLogBackup" : true
},
"traditional" : {
"enableDDRetentionLock" : true,
"revertToFullWhenSyntheticFullFails" : true,
"fileInactivityThresholdInDays" : 1,
"destinationPool" : "destinationPool",
"fileInactivityAlertThresholdPercentage" : 6,
"ddRetentionLockTime" : "ddRetentionLockTime",
"estimate" : true,
"timestampFormat" : "None",
"forceBackupLevel" : "forceBackupLevel",
"verifySyntheticFull" : true
},
"vmware" : {
"saveType" : "VMDK",
"useVbaInternalStorage" : true,
"destinationPool" : "destinationPool",
"vbaName" : "vbaName"
},
"snapshot" : {
"destinationPool" : "destinationPool",
"minimumRetentionPeriod" :
"minimumRetentionPeriod",
"forceBackupLevel" : "forceBackupLevel"
}
},
"overrideRetentionPeriod" : true,
"retentionPeriod" : "retentionPeriod"
},
"vbaCheckpointBackup" : {
"destinationPool" : "destinationPool",
"retentionPeriod" : "retentionPeriod"
},
"expire" : { },
NetWorker 18.2 REST API Reference Guide 259
"clone" : {
"enableDDRetentionLock" : true,
"destinationPool" : "destinationPool",
"ddRetentionLockTime" : "ddRetentionLockTime",
"deleteSource" : true,
"sourceStorageNode" : "sourceStorageNode",
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"serverBackup" : {
"destinationPool" : "destinationPool",
"performBootstrap" : true,
"performClientFileIndexing" : true,
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"probe" : {
"allProbsMustSucceed" : true,
"maxBackupIntervalInDays" : 5
},
"vbaCheckpointDiscover" : { }
},
"workItemFilter" : {
"timeRangeStart" : "2000-01-23T04:56:07.000+00:00",
"clients" : [ "clients", "clients" ],
"saveSetTypes" : [ "saveSetTypes", "saveSetTypes" ],
"excludeTimeRange" : "true",
"timeRangeEnd" : "2000-01-23T04:56:07.000+00:00",
"excludeClient" : "true",
"excludeLevel" : "true",
"excludeSaveSetType" : "true",
"levels" : [ "levels", "levels" ]
},
"completionNotification" : {
"executeOn" : "Completion",
"command" : "command"
},
"parallelism" : 7,
"concurrent" : true,
"retryDelayInSec" : 3,
"scheduleComment" : "scheduleComment",
"drivenBy" : "drivenBy",
"enabled" : true,
"scheduleActivities" : [ "scheduleActivities",
"scheduleActivities" ],
"disableActionStartTime" : true,
"retries" : 9,
"customTags" : [ "customTags", "customTags" ],
"newName" : "newName",
"name" : "name",
NetWorker 18.2 REST API Reference Guide 260
"inactivityTimeoutInMin" : 2,
"actionStartTime" : "actionStartTime",
"comment" : "comment",
"hardLimit" : "hardLimit",
"scheduleOverrides" : [ "scheduleOverrides",
"scheduleOverrides" ],
"schedulePeriod" : "Week",
"softLimit" : "softLimit"
}, {
"failureImpact" : "Continue",
"actionSpecificData" : {
"testConnectivity" : { },
"discover" : {
"discoverType" : "NAS snapshot"
},
"generateIndex" : {
"generateIndexType" : "NAS snapshot"
},
"backup" : {
"clientOverride" : "ClientCanNotOverride",
"destinationStorageNodes" : [
"destinationStorageNodes", "destinationStorageNodes" ],
"overrideBackupSchedule" : true,
"successThreshold" : "Warning",
"backupSpecificData" : {
"vmwareVProxy" : {
"quiesceSystemAdminPassword" :
"quiesceSystemAdminPassword",
"enableDDRetentionLock" : true,
"proxyName" : "proxyName",
"destinationPool" : "destinationPool",
"quiesceTimeoutInMinutes" : 5,
"quiesceSystemAdminUsername" :
"quiesceSystemAdminUsername",
"appConsistentQuiesce" : "Basic",
"ddRetentionLockTime" : "ddRetentionLockTime",
"transactionLogBackup" : true
},
"traditional" : {
"enableDDRetentionLock" : true,
"revertToFullWhenSyntheticFullFails" : true,
"fileInactivityThresholdInDays" : 1,
"destinationPool" : "destinationPool",
"fileInactivityAlertThresholdPercentage" : 6,
"ddRetentionLockTime" : "ddRetentionLockTime",
"estimate" : true,
"timestampFormat" : "None",
"forceBackupLevel" : "forceBackupLevel",
"verifySyntheticFull" : true
},
"vmware" : {
NetWorker 18.2 REST API Reference Guide 261
"saveType" : "VMDK",
"useVbaInternalStorage" : true,
"destinationPool" : "destinationPool",
"vbaName" : "vbaName"
},
"snapshot" : {
"destinationPool" : "destinationPool",
"minimumRetentionPeriod" :
"minimumRetentionPeriod",
"forceBackupLevel" : "forceBackupLevel"
}
},
"overrideRetentionPeriod" : true,
"retentionPeriod" : "retentionPeriod"
},
"vbaCheckpointBackup" : {
"destinationPool" : "destinationPool",
"retentionPeriod" : "retentionPeriod"
},
"expire" : { },
"clone" : {
"enableDDRetentionLock" : true,
"destinationPool" : "destinationPool",
"ddRetentionLockTime" : "ddRetentionLockTime",
"deleteSource" : true,
"sourceStorageNode" : "sourceStorageNode",
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"serverBackup" : {
"destinationPool" : "destinationPool",
"performBootstrap" : true,
"performClientFileIndexing" : true,
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"probe" : {
"allProbsMustSucceed" : true,
"maxBackupIntervalInDays" : 5
},
"vbaCheckpointDiscover" : { }
},
"workItemFilter" : {
"timeRangeStart" : "2000-01-23T04:56:07.000+00:00",
"clients" : [ "clients", "clients" ],
"saveSetTypes" : [ "saveSetTypes", "saveSetTypes" ],
"excludeTimeRange" : "true",
"timeRangeEnd" : "2000-01-23T04:56:07.000+00:00",
"excludeClient" : "true",
"excludeLevel" : "true",
NetWorker 18.2 REST API Reference Guide 262
"excludeSaveSetType" : "true",
"levels" : [ "levels", "levels" ]
},
"completionNotification" : {
"executeOn" : "Completion",
"command" : "command"
},
"parallelism" : 7,
"concurrent" : true,
"retryDelayInSec" : 3,
"scheduleComment" : "scheduleComment",
"drivenBy" : "drivenBy",
"enabled" : true,
"scheduleActivities" : [ "scheduleActivities",
"scheduleActivities" ],
"disableActionStartTime" : true,
"retries" : 9,
"customTags" : [ "customTags", "customTags" ],
"newName" : "newName",
"name" : "name",
"inactivityTimeoutInMin" : 2,
"actionStartTime" : "actionStartTime",
"comment" : "comment",
"hardLimit" : "hardLimit",
"scheduleOverrides" : [ "scheduleOverrides",
"scheduleOverrides" ],
"schedulePeriod" : "Week",
"softLimit" : "softLimit"
} ],
"autoStartEnabled" : true
} ],
"tenant" : "tenant"
}
}, {
"protectionGroup" : {
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"workItemQueries" : [ "workItemQueries", "workItemQueries" ],
"workItems" : [ "workItems", "workItems" ],
"workItemType" : "Client",
"vmwareWorkItemExclusion" : {
"containerMorefs" : [ "containerMorefs", "containerMorefs" ],
"vmdks" : [ {
"vmUuid" : "vmUuid",
"vmdkUuid" : "vmdkUuid"
}, {
"vmUuid" : "vmUuid",
"vmdkUuid" : "vmdkUuid"
NetWorker 18.2 REST API Reference Guide 263
} ],
"vmUuids" : [ "vmUuids", "vmUuids" ],
"vCenterHostname" : "vCenterHostname"
},
"backupOptimization" : "Capacity",
"rule" : "rule",
"dynamicAssociation" : true,
"workItemSubType" : "VirtualMachine",
"name" : "name",
"comment" : "comment",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"vmwareWorkItemSelection" : {
"containerMorefs" : [ "containerMorefs", "containerMorefs" ],
"vmdks" : [ {
"vmUuid" : "vmUuid",
"vmdkUuid" : "vmdkUuid"
}, {
"vmUuid" : "vmUuid",
"vmdkUuid" : "vmdkUuid"
} ],
"vmUuids" : [ "vmUuids", "vmUuids" ],
"vCenterHostname" : "vCenterHostname"
},
"tenant" : "tenant",
"workItemSource" : "Static"
},
"workflow" : {
"nextStartDate" : "2000-01-23T04:56:07.000+00:00",
"completionNotification" : {
"executeOn" : "Completion",
"command" : "command"
},
"description" : "description",
"enabled" : true,
"protectionGroups" : [ "protectionGroups", "protectionGroups"
],
"newName" : "newName",
"startInterval" : "startInterval",
"name" : "name",
"restartTimeWindow" : "restartTimeWindow",
NetWorker 18.2 REST API Reference Guide 264
"comment" : "comment",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"startTime" : "startTime",
"endTime" : "endTime",
"actions" : [ {
"failureImpact" : "Continue",
"actionSpecificData" : {
"testConnectivity" : { },
"discover" : {
"discoverType" : "NAS snapshot"
},
"generateIndex" : {
"generateIndexType" : "NAS snapshot"
},
"backup" : {
"clientOverride" : "ClientCanNotOverride",
"destinationStorageNodes" : [ "destinationStorageNodes",
"destinationStorageNodes" ],
"overrideBackupSchedule" : true,
"successThreshold" : "Warning",
"backupSpecificData" : {
"vmwareVProxy" : {
"quiesceSystemAdminPassword" :
"quiesceSystemAdminPassword",
"enableDDRetentionLock" : true,
"proxyName" : "proxyName",
"destinationPool" : "destinationPool",
"quiesceTimeoutInMinutes" : 5,
"quiesceSystemAdminUsername" :
"quiesceSystemAdminUsername",
"appConsistentQuiesce" : "Basic",
"ddRetentionLockTime" : "ddRetentionLockTime",
"transactionLogBackup" : true
},
"traditional" : {
"enableDDRetentionLock" : true,
"revertToFullWhenSyntheticFullFails" : true,
"fileInactivityThresholdInDays" : 1,
"destinationPool" : "destinationPool",
"fileInactivityAlertThresholdPercentage" : 6,
NetWorker 18.2 REST API Reference Guide 265
"ddRetentionLockTime" : "ddRetentionLockTime",
"estimate" : true,
"timestampFormat" : "None",
"forceBackupLevel" : "forceBackupLevel",
"verifySyntheticFull" : true
},
"vmware" : {
"saveType" : "VMDK",
"useVbaInternalStorage" : true,
"destinationPool" : "destinationPool",
"vbaName" : "vbaName"
},
"snapshot" : {
"destinationPool" : "destinationPool",
"minimumRetentionPeriod" : "minimumRetentionPeriod",
"forceBackupLevel" : "forceBackupLevel"
}
},
"overrideRetentionPeriod" : true,
"retentionPeriod" : "retentionPeriod"
},
"vbaCheckpointBackup" : {
"destinationPool" : "destinationPool",
"retentionPeriod" : "retentionPeriod"
},
"expire" : { },
"clone" : {
"enableDDRetentionLock" : true,
"destinationPool" : "destinationPool",
"ddRetentionLockTime" : "ddRetentionLockTime",
"deleteSource" : true,
"sourceStorageNode" : "sourceStorageNode",
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"serverBackup" : {
"destinationPool" : "destinationPool",
"performBootstrap" : true,
"performClientFileIndexing" : true,
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"probe" : {
"allProbsMustSucceed" : true,
"maxBackupIntervalInDays" : 5
},
"vbaCheckpointDiscover" : { }
},
"workItemFilter" : {
"timeRangeStart" : "2000-01-23T04:56:07.000+00:00",
NetWorker 18.2 REST API Reference Guide 266
"clients" : [ "clients", "clients" ],
"saveSetTypes" : [ "saveSetTypes", "saveSetTypes" ],
"excludeTimeRange" : "true",
"timeRangeEnd" : "2000-01-23T04:56:07.000+00:00",
"excludeClient" : "true",
"excludeLevel" : "true",
"excludeSaveSetType" : "true",
"levels" : [ "levels", "levels" ]
},
"completionNotification" : {
"executeOn" : "Completion",
"command" : "command"
},
"parallelism" : 7,
"concurrent" : true,
"retryDelayInSec" : 3,
"scheduleComment" : "scheduleComment",
"drivenBy" : "drivenBy",
"enabled" : true,
"scheduleActivities" : [ "scheduleActivities",
"scheduleActivities" ],
"disableActionStartTime" : true,
"retries" : 9,
"customTags" : [ "customTags", "customTags" ],
"newName" : "newName",
"name" : "name",
"inactivityTimeoutInMin" : 2,
"actionStartTime" : "actionStartTime",
"comment" : "comment",
"hardLimit" : "hardLimit",
"scheduleOverrides" : [ "scheduleOverrides",
"scheduleOverrides" ],
"schedulePeriod" : "Week",
"softLimit" : "softLimit"
}, {
"failureImpact" : "Continue",
"actionSpecificData" : {
"testConnectivity" : { },
"discover" : {
"discoverType" : "NAS snapshot"
},
"generateIndex" : {
"generateIndexType" : "NAS snapshot"
},
"backup" : {
"clientOverride" : "ClientCanNotOverride",
"destinationStorageNodes" : [ "destinationStorageNodes",
"destinationStorageNodes" ],
"overrideBackupSchedule" : true,
"successThreshold" : "Warning",
NetWorker 18.2 REST API Reference Guide 267
"backupSpecificData" : {
"vmwareVProxy" : {
"quiesceSystemAdminPassword" :
"quiesceSystemAdminPassword",
"enableDDRetentionLock" : true,
"proxyName" : "proxyName",
"destinationPool" : "destinationPool",
"quiesceTimeoutInMinutes" : 5,
"quiesceSystemAdminUsername" :
"quiesceSystemAdminUsername",
"appConsistentQuiesce" : "Basic",
"ddRetentionLockTime" : "ddRetentionLockTime",
"transactionLogBackup" : true
},
"traditional" : {
"enableDDRetentionLock" : true,
"revertToFullWhenSyntheticFullFails" : true,
"fileInactivityThresholdInDays" : 1,
"destinationPool" : "destinationPool",
"fileInactivityAlertThresholdPercentage" : 6,
"ddRetentionLockTime" : "ddRetentionLockTime",
"estimate" : true,
"timestampFormat" : "None",
"forceBackupLevel" : "forceBackupLevel",
"verifySyntheticFull" : true
},
"vmware" : {
"saveType" : "VMDK",
"useVbaInternalStorage" : true,
"destinationPool" : "destinationPool",
"vbaName" : "vbaName"
},
"snapshot" : {
"destinationPool" : "destinationPool",
"minimumRetentionPeriod" : "minimumRetentionPeriod",
"forceBackupLevel" : "forceBackupLevel"
}
},
"overrideRetentionPeriod" : true,
"retentionPeriod" : "retentionPeriod"
},
"vbaCheckpointBackup" : {
"destinationPool" : "destinationPool",
"retentionPeriod" : "retentionPeriod"
},
"expire" : { },
"clone" : {
"enableDDRetentionLock" : true,
"destinationPool" : "destinationPool",
"ddRetentionLockTime" : "ddRetentionLockTime",
NetWorker 18.2 REST API Reference Guide 268
"deleteSource" : true,
"sourceStorageNode" : "sourceStorageNode",
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"serverBackup" : {
"destinationPool" : "destinationPool",
"performBootstrap" : true,
"performClientFileIndexing" : true,
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"probe" : {
"allProbsMustSucceed" : true,
"maxBackupIntervalInDays" : 5
},
"vbaCheckpointDiscover" : { }
},
"workItemFilter" : {
"timeRangeStart" : "2000-01-23T04:56:07.000+00:00",
"clients" : [ "clients", "clients" ],
"saveSetTypes" : [ "saveSetTypes", "saveSetTypes" ],
"excludeTimeRange" : "true",
"timeRangeEnd" : "2000-01-23T04:56:07.000+00:00",
"excludeClient" : "true",
"excludeLevel" : "true",
"excludeSaveSetType" : "true",
"levels" : [ "levels", "levels" ]
},
"completionNotification" : {
"executeOn" : "Completion",
"command" : "command"
},
"parallelism" : 7,
"concurrent" : true,
"retryDelayInSec" : 3,
"scheduleComment" : "scheduleComment",
"drivenBy" : "drivenBy",
"enabled" : true,
"scheduleActivities" : [ "scheduleActivities",
"scheduleActivities" ],
"disableActionStartTime" : true,
"retries" : 9,
"customTags" : [ "customTags", "customTags" ],
"newName" : "newName",
"name" : "name",
"inactivityTimeoutInMin" : 2,
"actionStartTime" : "actionStartTime",
"comment" : "comment",
"hardLimit" : "hardLimit",
NetWorker 18.2 REST API Reference Guide 269
"scheduleOverrides" : [ "scheduleOverrides",
"scheduleOverrides" ],
"schedulePeriod" : "Week",
"softLimit" : "softLimit"
} ],
"autoStartEnabled" : true
},
"protectionPolicy" : {
"summaryNotification" : {
"executeOn" : "Completion",
"command" : "command"
},
"policyProtectionEnable" : true,
"policyProtectionPeriod" : "policyProtectionPeriod",
"applyEntireWorkflow" : true,
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"allowManualSaves" : true,
"name" : "name",
"comment" : "comment",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"workflows" : [ {
"nextStartDate" : "2000-01-23T04:56:07.000+00:00",
"completionNotification" : {
"executeOn" : "Completion",
"command" : "command"
},
"description" : "description",
"enabled" : true,
"protectionGroups" : [ "protectionGroups", "protectionGroups"
],
"newName" : "newName",
"startInterval" : "startInterval",
"name" : "name",
"restartTimeWindow" : "restartTimeWindow",
"comment" : "comment",
"links" : [ {
"rel" : "create-form",
NetWorker 18.2 REST API Reference Guide 270
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"startTime" : "startTime",
"endTime" : "endTime",
"actions" : [ {
"failureImpact" : "Continue",
"actionSpecificData" : {
"testConnectivity" : { },
"discover" : {
"discoverType" : "NAS snapshot"
},
"generateIndex" : {
"generateIndexType" : "NAS snapshot"
},
"backup" : {
"clientOverride" : "ClientCanNotOverride",
"destinationStorageNodes" : [
"destinationStorageNodes", "destinationStorageNodes" ],
"overrideBackupSchedule" : true,
"successThreshold" : "Warning",
"backupSpecificData" : {
"vmwareVProxy" : {
"quiesceSystemAdminPassword" :
"quiesceSystemAdminPassword",
"enableDDRetentionLock" : true,
"proxyName" : "proxyName",
"destinationPool" : "destinationPool",
"quiesceTimeoutInMinutes" : 5,
"quiesceSystemAdminUsername" :
"quiesceSystemAdminUsername",
"appConsistentQuiesce" : "Basic",
"ddRetentionLockTime" : "ddRetentionLockTime",
"transactionLogBackup" : true
},
"traditional" : {
"enableDDRetentionLock" : true,
"revertToFullWhenSyntheticFullFails" : true,
"fileInactivityThresholdInDays" : 1,
"destinationPool" : "destinationPool",
"fileInactivityAlertThresholdPercentage" : 6,
"ddRetentionLockTime" : "ddRetentionLockTime",
"estimate" : true,
"timestampFormat" : "None",
NetWorker 18.2 REST API Reference Guide 271
"forceBackupLevel" : "forceBackupLevel",
"verifySyntheticFull" : true
},
"vmware" : {
"saveType" : "VMDK",
"useVbaInternalStorage" : true,
"destinationPool" : "destinationPool",
"vbaName" : "vbaName"
},
"snapshot" : {
"destinationPool" : "destinationPool",
"minimumRetentionPeriod" :
"minimumRetentionPeriod",
"forceBackupLevel" : "forceBackupLevel"
}
},
"overrideRetentionPeriod" : true,
"retentionPeriod" : "retentionPeriod"
},
"vbaCheckpointBackup" : {
"destinationPool" : "destinationPool",
"retentionPeriod" : "retentionPeriod"
},
"expire" : { },
"clone" : {
"enableDDRetentionLock" : true,
"destinationPool" : "destinationPool",
"ddRetentionLockTime" : "ddRetentionLockTime",
"deleteSource" : true,
"sourceStorageNode" : "sourceStorageNode",
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"serverBackup" : {
"destinationPool" : "destinationPool",
"performBootstrap" : true,
"performClientFileIndexing" : true,
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"probe" : {
"allProbsMustSucceed" : true,
"maxBackupIntervalInDays" : 5
},
"vbaCheckpointDiscover" : { }
},
"workItemFilter" : {
"timeRangeStart" : "2000-01-23T04:56:07.000+00:00",
"clients" : [ "clients", "clients" ],
"saveSetTypes" : [ "saveSetTypes", "saveSetTypes" ],
NetWorker 18.2 REST API Reference Guide 272
"excludeTimeRange" : "true",
"timeRangeEnd" : "2000-01-23T04:56:07.000+00:00",
"excludeClient" : "true",
"excludeLevel" : "true",
"excludeSaveSetType" : "true",
"levels" : [ "levels", "levels" ]
},
"completionNotification" : {
"executeOn" : "Completion",
"command" : "command"
},
"parallelism" : 7,
"concurrent" : true,
"retryDelayInSec" : 3,
"scheduleComment" : "scheduleComment",
"drivenBy" : "drivenBy",
"enabled" : true,
"scheduleActivities" : [ "scheduleActivities",
"scheduleActivities" ],
"disableActionStartTime" : true,
"retries" : 9,
"customTags" : [ "customTags", "customTags" ],
"newName" : "newName",
"name" : "name",
"inactivityTimeoutInMin" : 2,
"actionStartTime" : "actionStartTime",
"comment" : "comment",
"hardLimit" : "hardLimit",
"scheduleOverrides" : [ "scheduleOverrides",
"scheduleOverrides" ],
"schedulePeriod" : "Week",
"softLimit" : "softLimit"
}, {
"failureImpact" : "Continue",
"actionSpecificData" : {
"testConnectivity" : { },
"discover" : {
"discoverType" : "NAS snapshot"
},
"generateIndex" : {
"generateIndexType" : "NAS snapshot"
},
"backup" : {
"clientOverride" : "ClientCanNotOverride",
"destinationStorageNodes" : [
"destinationStorageNodes", "destinationStorageNodes" ],
"overrideBackupSchedule" : true,
"successThreshold" : "Warning",
"backupSpecificData" : {
"vmwareVProxy" : {
NetWorker 18.2 REST API Reference Guide 273
"quiesceSystemAdminPassword" :
"quiesceSystemAdminPassword",
"enableDDRetentionLock" : true,
"proxyName" : "proxyName",
"destinationPool" : "destinationPool",
"quiesceTimeoutInMinutes" : 5,
"quiesceSystemAdminUsername" :
"quiesceSystemAdminUsername",
"appConsistentQuiesce" : "Basic",
"ddRetentionLockTime" : "ddRetentionLockTime",
"transactionLogBackup" : true
},
"traditional" : {
"enableDDRetentionLock" : true,
"revertToFullWhenSyntheticFullFails" : true,
"fileInactivityThresholdInDays" : 1,
"destinationPool" : "destinationPool",
"fileInactivityAlertThresholdPercentage" : 6,
"ddRetentionLockTime" : "ddRetentionLockTime",
"estimate" : true,
"timestampFormat" : "None",
"forceBackupLevel" : "forceBackupLevel",
"verifySyntheticFull" : true
},
"vmware" : {
"saveType" : "VMDK",
"useVbaInternalStorage" : true,
"destinationPool" : "destinationPool",
"vbaName" : "vbaName"
},
"snapshot" : {
"destinationPool" : "destinationPool",
"minimumRetentionPeriod" :
"minimumRetentionPeriod",
"forceBackupLevel" : "forceBackupLevel"
}
},
"overrideRetentionPeriod" : true,
"retentionPeriod" : "retentionPeriod"
},
"vbaCheckpointBackup" : {
"destinationPool" : "destinationPool",
"retentionPeriod" : "retentionPeriod"
},
"expire" : { },
"clone" : {
"enableDDRetentionLock" : true,
"destinationPool" : "destinationPool",
"ddRetentionLockTime" : "ddRetentionLockTime",
"deleteSource" : true,
NetWorker 18.2 REST API Reference Guide 274
"sourceStorageNode" : "sourceStorageNode",
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"serverBackup" : {
"destinationPool" : "destinationPool",
"performBootstrap" : true,
"performClientFileIndexing" : true,
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"probe" : {
"allProbsMustSucceed" : true,
"maxBackupIntervalInDays" : 5
},
"vbaCheckpointDiscover" : { }
},
"workItemFilter" : {
"timeRangeStart" : "2000-01-23T04:56:07.000+00:00",
"clients" : [ "clients", "clients" ],
"saveSetTypes" : [ "saveSetTypes", "saveSetTypes" ],
"excludeTimeRange" : "true",
"timeRangeEnd" : "2000-01-23T04:56:07.000+00:00",
"excludeClient" : "true",
"excludeLevel" : "true",
"excludeSaveSetType" : "true",
"levels" : [ "levels", "levels" ]
},
"completionNotification" : {
"executeOn" : "Completion",
"command" : "command"
},
"parallelism" : 7,
"concurrent" : true,
"retryDelayInSec" : 3,
"scheduleComment" : "scheduleComment",
"drivenBy" : "drivenBy",
"enabled" : true,
"scheduleActivities" : [ "scheduleActivities",
"scheduleActivities" ],
"disableActionStartTime" : true,
"retries" : 9,
"customTags" : [ "customTags", "customTags" ],
"newName" : "newName",
"name" : "name",
"inactivityTimeoutInMin" : 2,
"actionStartTime" : "actionStartTime",
"comment" : "comment",
"hardLimit" : "hardLimit",
NetWorker 18.2 REST API Reference Guide 275
"scheduleOverrides" : [ "scheduleOverrides",
"scheduleOverrides" ],
"schedulePeriod" : "Week",
"softLimit" : "softLimit"
} ],
"autoStartEnabled" : true
}, {
"nextStartDate" : "2000-01-23T04:56:07.000+00:00",
"completionNotification" : {
"executeOn" : "Completion",
"command" : "command"
},
"description" : "description",
"enabled" : true,
"protectionGroups" : [ "protectionGroups", "protectionGroups"
],
"newName" : "newName",
"startInterval" : "startInterval",
"name" : "name",
"restartTimeWindow" : "restartTimeWindow",
"comment" : "comment",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"startTime" : "startTime",
"endTime" : "endTime",
"actions" : [ {
"failureImpact" : "Continue",
"actionSpecificData" : {
"testConnectivity" : { },
"discover" : {
"discoverType" : "NAS snapshot"
},
"generateIndex" : {
"generateIndexType" : "NAS snapshot"
},
"backup" : {
"clientOverride" : "ClientCanNotOverride",
"destinationStorageNodes" : [
"destinationStorageNodes", "destinationStorageNodes" ],
"overrideBackupSchedule" : true,
"successThreshold" : "Warning",
NetWorker 18.2 REST API Reference Guide 276
"backupSpecificData" : {
"vmwareVProxy" : {
"quiesceSystemAdminPassword" :
"quiesceSystemAdminPassword",
"enableDDRetentionLock" : true,
"proxyName" : "proxyName",
"destinationPool" : "destinationPool",
"quiesceTimeoutInMinutes" : 5,
"quiesceSystemAdminUsername" :
"quiesceSystemAdminUsername",
"appConsistentQuiesce" : "Basic",
"ddRetentionLockTime" : "ddRetentionLockTime",
"transactionLogBackup" : true
},
"traditional" : {
"enableDDRetentionLock" : true,
"revertToFullWhenSyntheticFullFails" : true,
"fileInactivityThresholdInDays" : 1,
"destinationPool" : "destinationPool",
"fileInactivityAlertThresholdPercentage" : 6,
"ddRetentionLockTime" : "ddRetentionLockTime",
"estimate" : true,
"timestampFormat" : "None",
"forceBackupLevel" : "forceBackupLevel",
"verifySyntheticFull" : true
},
"vmware" : {
"saveType" : "VMDK",
"useVbaInternalStorage" : true,
"destinationPool" : "destinationPool",
"vbaName" : "vbaName"
},
"snapshot" : {
"destinationPool" : "destinationPool",
"minimumRetentionPeriod" :
"minimumRetentionPeriod",
"forceBackupLevel" : "forceBackupLevel"
}
},
"overrideRetentionPeriod" : true,
"retentionPeriod" : "retentionPeriod"
},
"vbaCheckpointBackup" : {
"destinationPool" : "destinationPool",
"retentionPeriod" : "retentionPeriod"
},
"expire" : { },
"clone" : {
"enableDDRetentionLock" : true,
"destinationPool" : "destinationPool",
NetWorker 18.2 REST API Reference Guide 277
"ddRetentionLockTime" : "ddRetentionLockTime",
"deleteSource" : true,
"sourceStorageNode" : "sourceStorageNode",
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"serverBackup" : {
"destinationPool" : "destinationPool",
"performBootstrap" : true,
"performClientFileIndexing" : true,
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"probe" : {
"allProbsMustSucceed" : true,
"maxBackupIntervalInDays" : 5
},
"vbaCheckpointDiscover" : { }
},
"workItemFilter" : {
"timeRangeStart" : "2000-01-23T04:56:07.000+00:00",
"clients" : [ "clients", "clients" ],
"saveSetTypes" : [ "saveSetTypes", "saveSetTypes" ],
"excludeTimeRange" : "true",
"timeRangeEnd" : "2000-01-23T04:56:07.000+00:00",
"excludeClient" : "true",
"excludeLevel" : "true",
"excludeSaveSetType" : "true",
"levels" : [ "levels", "levels" ]
},
"completionNotification" : {
"executeOn" : "Completion",
"command" : "command"
},
"parallelism" : 7,
"concurrent" : true,
"retryDelayInSec" : 3,
"scheduleComment" : "scheduleComment",
"drivenBy" : "drivenBy",
"enabled" : true,
"scheduleActivities" : [ "scheduleActivities",
"scheduleActivities" ],
"disableActionStartTime" : true,
"retries" : 9,
"customTags" : [ "customTags", "customTags" ],
"newName" : "newName",
"name" : "name",
"inactivityTimeoutInMin" : 2,
"actionStartTime" : "actionStartTime",
"comment" : "comment",
NetWorker 18.2 REST API Reference Guide 278
"hardLimit" : "hardLimit",
"scheduleOverrides" : [ "scheduleOverrides",
"scheduleOverrides" ],
"schedulePeriod" : "Week",
"softLimit" : "softLimit"
}, {
"failureImpact" : "Continue",
"actionSpecificData" : {
"testConnectivity" : { },
"discover" : {
"discoverType" : "NAS snapshot"
},
"generateIndex" : {
"generateIndexType" : "NAS snapshot"
},
"backup" : {
"clientOverride" : "ClientCanNotOverride",
"destinationStorageNodes" : [
"destinationStorageNodes", "destinationStorageNodes" ],
"overrideBackupSchedule" : true,
"successThreshold" : "Warning",
"backupSpecificData" : {
"vmwareVProxy" : {
"quiesceSystemAdminPassword" :
"quiesceSystemAdminPassword",
"enableDDRetentionLock" : true,
"proxyName" : "proxyName",
"destinationPool" : "destinationPool",
"quiesceTimeoutInMinutes" : 5,
"quiesceSystemAdminUsername" :
"quiesceSystemAdminUsername",
"appConsistentQuiesce" : "Basic",
"ddRetentionLockTime" : "ddRetentionLockTime",
"transactionLogBackup" : true
},
"traditional" : {
"enableDDRetentionLock" : true,
"revertToFullWhenSyntheticFullFails" : true,
"fileInactivityThresholdInDays" : 1,
"destinationPool" : "destinationPool",
"fileInactivityAlertThresholdPercentage" : 6,
"ddRetentionLockTime" : "ddRetentionLockTime",
"estimate" : true,
"timestampFormat" : "None",
"forceBackupLevel" : "forceBackupLevel",
"verifySyntheticFull" : true
},
"vmware" : {
"saveType" : "VMDK",
"useVbaInternalStorage" : true,
"destinationPool" : "destinationPool",
NetWorker 18.2 REST API Reference Guide 279
"vbaName" : "vbaName"
},
"snapshot" : {
"destinationPool" : "destinationPool",
"minimumRetentionPeriod" :
"minimumRetentionPeriod",
"forceBackupLevel" : "forceBackupLevel"
}
},
"overrideRetentionPeriod" : true,
"retentionPeriod" : "retentionPeriod"
},
"vbaCheckpointBackup" : {
"destinationPool" : "destinationPool",
"retentionPeriod" : "retentionPeriod"
},
"expire" : { },
"clone" : {
"enableDDRetentionLock" : true,
"destinationPool" : "destinationPool",
"ddRetentionLockTime" : "ddRetentionLockTime",
"deleteSource" : true,
"sourceStorageNode" : "sourceStorageNode",
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"serverBackup" : {
"destinationPool" : "destinationPool",
"performBootstrap" : true,
"performClientFileIndexing" : true,
"destinationStorageNode" : "destinationStorageNode",
"retentionPeriod" : "retentionPeriod"
},
"probe" : {
"allProbsMustSucceed" : true,
"maxBackupIntervalInDays" : 5
},
"vbaCheckpointDiscover" : { }
},
"workItemFilter" : {
"timeRangeStart" : "2000-01-23T04:56:07.000+00:00",
"clients" : [ "clients", "clients" ],
"saveSetTypes" : [ "saveSetTypes", "saveSetTypes" ],
"excludeTimeRange" : "true",
"timeRangeEnd" : "2000-01-23T04:56:07.000+00:00",
"excludeClient" : "true",
"excludeLevel" : "true",
"excludeSaveSetType" : "true",
"levels" : [ "levels", "levels" ]
},
NetWorker 18.2 REST API Reference Guide 280
"completionNotification" : {
"executeOn" : "Completion",
"command" : "command"
},
"parallelism" : 7,
"concurrent" : true,
"retryDelayInSec" : 3,
"scheduleComment" : "scheduleComment",
"drivenBy" : "drivenBy",
"enabled" : true,
"scheduleActivities" : [ "scheduleActivities",
"scheduleActivities" ],
"disableActionStartTime" : true,
"retries" : 9,
"customTags" : [ "customTags", "customTags" ],
"newName" : "newName",
"name" : "name",
"inactivityTimeoutInMin" : 2,
"actionStartTime" : "actionStartTime",
"comment" : "comment",
"hardLimit" : "hardLimit",
"scheduleOverrides" : [ "scheduleOverrides",
"scheduleOverrides" ],
"schedulePeriod" : "Week",
"softLimit" : "softLimit"
} ],
"autoStartEnabled" : true
} ],
"tenant" : "tenant"
}
} ],
"count" : 0,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
NetWorker 18.2 REST API Reference Guide 281
application/json
Responses
200 Resources were retrieved successfully. VMwareVmProtectionDetailList
Up GET /vmware/vms
(getVMwareVms)
Returns a list of active VMs.
Return type
VMwareVmList
Example data
Content-Type: application/json
{
"count" : 0,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"vms" : [ {
"annotation" : "annotation",
"connectionState" : "connectionState",
"ipAddress" : "ipAddress",
"morefId" : "morefId",
"osId" : "osId",
"osName" : "osName",
"type" : "type",
"uuid" : "uuid",
"version" : "version",
"hostname" : "hostname",
"powerState" : "powerState",
"name" : "name",
"ipAddresses" : [ "ipAddresses", "ipAddresses" ],
"links" : [ {
"rel" : "create-form",
"href" : "href",
NetWorker 18.2 REST API Reference Guide 282
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"state" : "state",
"vCenterHostname" : "vCenterHostname",
"status" : "status"
}, {
"annotation" : "annotation",
"connectionState" : "connectionState",
"ipAddress" : "ipAddress",
"morefId" : "morefId",
"osId" : "osId",
"osName" : "osName",
"type" : "type",
"uuid" : "uuid",
"version" : "version",
"hostname" : "hostname",
"powerState" : "powerState",
"name" : "name",
"ipAddresses" : [ "ipAddresses", "ipAddresses" ],
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"state" : "state",
"vCenterHostname" : "vCenterHostname",
"status" : "status"
} ]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
NetWorker 18.2 REST API Reference Guide 283
Responses
200 Resources were retrieved successfully. VMwareVmList
Up GET /vmware/vproxies
(getVProxies)
Returns a list of vProxies.
Return type
VProxyList
Example data
Content-Type: application/json
{
"count" : 0,
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"vProxies" : [ {
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"maxHotaddDisks" : 6,
"datastores" : [ "datastores", "datastores" ],
"userName" : "userName",
"version" : "version",
"enabled" : true,
"hostname" : "hostname",
"maxNbdSessions" : 5,
"password" : "password",
"vProxyPort" : 5,
"encryptNbdSessions" : true,
"comment" : "comment",
"links" : [ {
"rel" : "create-form",
"href" : "href",
NetWorker 18.2 REST API Reference Guide 284
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"maxHotaddSessions" : 1,
"vCenterHostname" : "vCenterHostname",
"forceRegister" : true
}, {
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"maxHotaddDisks" : 6,
"datastores" : [ "datastores", "datastores" ],
"userName" : "userName",
"version" : "version",
"enabled" : true,
"hostname" : "hostname",
"maxNbdSessions" : 5,
"password" : "password",
"vProxyPort" : 5,
"encryptNbdSessions" : true,
"comment" : "comment",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"maxHotaddSessions" : 1,
"vCenterHostname" : "vCenterHostname",
"forceRegister" : true
} ]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
NetWorker 18.2 REST API Reference Guide 285
application/json
Responses
200 Resources were retrieved successfully. VProxyList
Up GET /vmware/vproxies/{vproxy-hostname}
(getVProxy)
Returns the specific vProxy.
Path parameters
vproxy-hostname (required) Path Parameter is the value of hostname attribute in the vProxy object.
Return type
VProxy
Example data
Content-Type: application/json
{
"resourceId" : {
"sequence" : 1,
"id" : "id"
},
"maxHotaddDisks" : 6,
"datastores" : [ "datastores", "datastores" ],
"userName" : "userName",
"version" : "version",
"enabled" : true,
"hostname" : "hostname",
"maxNbdSessions" : 5,
"password" : "password",
"vProxyPort" : 5,
"encryptNbdSessions" : true,
"comment" : "comment",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
NetWorker 18.2 REST API Reference Guide 286
"title" : "title"
} ],
"maxHotaddSessions" : 1,
"vCenterHostname" : "vCenterHostname",
"forceRegister" : true
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resource was retrieved successfully. VProxy
Up POST /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/op/vmmount/{vproxy-mount-session-
id}/vmbrowse
(postBackupVProxyVmBrowseSessionRequest)
Creates a new vmbrowse session.
Path parameters
vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter object.
vm-uuid (required) Path Parameter is the value of the uuid attribute in the protected VM object.
backup-id (required) Path Parameter is the value of the id attribute in the backup object.
vproxy-mount-session-id (required) Path Parameter is the value of the vProxyMountSessionId attribute in the vproxy VM mount job object.
Request body
VProxyVmBrowseSessionRequest VProxyVmBrowseSessionRequest (required) Body Parameter The vmbrowse session details to be created.
Return type
VProxyVmBrowseSessionPutOrPostResponse
NetWorker 18.2 REST API Reference Guide 287
Example data
Content-Type: application/json
{
"config" : {
"idleTimeout" : 6,
"cacheRetentionSeconds" : 1,
"sessionId" : "sessionId",
"currentWorkingDirectory" : "currentWorkingDirectory",
"browseDestination" : true
},
"status" : {
"description" : "description",
"state" : "state"
}
}
Responses
201 Resource was created successfully. VProxyVmBrowseSessionPutOrPostResponse
400 Bad request. VProxyVmBrowseSessionPutOrPostResponse
401 Unauthorized. VProxyVmBrowseSessionPutOrPostResponse
404 Not found. VProxyVmBrowseSessionPutOrPostResponse
405 Method not allowed. VProxyVmBrowseSessionPutOrPostResponse
500 Internal server error. VProxyVmBrowseSessionPutOrPostResponse
Up POST /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/instances/{instance-id}/op/vmmount/{vproxy-
mount-session-id}/vmbrowse
(postInstanceVProxyVmBrowseSessionRequest)
Creates a new vmbrowse session.
Path parameters
vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter object.
vm-uuid (required) Path Parameter is the value of the uuid attribute in the protected VM object.
backup-id (required)
NetWorker 18.2 REST API Reference Guide 288
Path Parameter is the value of the id attribute in the backup object. instance-id (required)
Path Parameter is the value of the id attribute in the instance object. vproxy-mount-session-id (required)
Path Parameter is the value of the vProxyMountSessionId attribute in the vproxy VM mount job object.
Request body
VProxyVmBrowseSessionRequest VProxyVmBrowseSessionRequest (required) Body Parameter The vmbrowse session details to be created.
Return type
VProxyVmBrowseSessionPutOrPostResponse
Example data
Content-Type: application/json
{
"config" : {
"idleTimeout" : 6,
"cacheRetentionSeconds" : 1,
"sessionId" : "sessionId",
"currentWorkingDirectory" : "currentWorkingDirectory",
"browseDestination" : true
},
"status" : {
"description" : "description",
"state" : "state"
}
}
Responses
201 Resource was created successfully. VProxyVmBrowseSessionPutOrPostResponse
400 Bad request. VProxyVmBrowseSessionPutOrPostResponse
401 Unauthorized. VProxyVmBrowseSessionPutOrPostResponse
404 Not found. VProxyVmBrowseSessionPutOrPostResponse
405 Method not allowed. VProxyVmBrowseSessionPutOrPostResponse
500 Internal server error. VProxyVmBrowseSessionPutOrPostResponse
Up POST /vmware/vproxies/op/register
NetWorker 18.2 REST API Reference Guide 289
(postOpRegisterVProxy)
Create and register a vProxy.
Request body
VProxy VProxy (required) Body Parameter Requst body to create and register a single vProxy
Responses
201 Resource was created successfully.
400 Bad request. ErrorResponse
401 Unauthorized. ErrorResponse
404 Not found. ErrorResponse
405 Method not allowed. ErrorResponse
500 Internal server error. ErrorResponse
Up POST /vmware/vcenters
(postVCenter)
Creates a new vCenter.
Request body
vcenter VCenter (required) Body Parameter vCenter to be created.
Responses
201 Resource was created successfully.
Up POST /vmware/vcenters/{vcenter-hostname}/op/refresh
(postVCenterOpRefresh)
Refreshes NetWorker information for the specific vCenter.
Path parameters
vcenter-hostname (required)
NetWorker 18.2 REST API Reference Guide 290
Path Parameter is the value of the hostname attribute in the vCenter object.
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
201 Operation started successfully, location header contains a job URI to be monitored.
Up POST /vmware/vcenters/{vcenter-hostname}/plugins
(postVCenterPlugin)
Install NetWorker plug-ins for the specific vCenter.
Path parameters
vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter object.
Request body
vCenterPlugin VCenterPlugin (required) Body Parameter Parameters to install the plug-in.
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Operation completed successfully.
400 Bad request. ErrorResponse
401
NetWorker 18.2 REST API Reference Guide 291
Unauthorized. ErrorResponse
404 Not found. ErrorResponse
405 Method not allowed. ErrorResponse
500 Internal server error. ErrorResponse
Up POST /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/op/inspectbackup
(postVCenterProtectedVmBackupInspectBackup)
Inspect an app consistent VM backup for purposes of catalog retrieval.
Path parameters
vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter object.
vm-uuid (required) Path Parameter is the value of the uuid attribute in the protected VM object.
backup-id (required) Path Parameter is the value of the id attribute in the backup object.
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
201 A job is created. The Job URI can be found in the location header of the response.
Up POST /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/instances/{instance-id}/op/inspectbackup
(postVCenterProtectedVmBackupInstanceInspectBackup)
Inspects an app consistent VM backup instance for catalog retrieval.
Path parameters
NetWorker 18.2 REST API Reference Guide 292
vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter object.
vm-uuid (required) Path Parameter is the value of the uuid attribute in the protected VM object.
backup-id (required) Path Parameter is the value of the id attribute in the backup object.
instance-id (required) Path Parameter is the value of the id attribute in the instance object.
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
201 A job is created. The Job URI can be found in the location header of the response.
Up POST /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/instances/{instance-id}/op/recover
(postVCenterProtectedVmBackupInstanceRecover)
Starts a recovery of a selected protected VM backup instance.
Path parameters
vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter object.
vm-uuid (required) Path Parameter is the value of the uuid attribute in the protected VM object.
backup-id (required) Path Parameter is the value of the id attribute in the backup object.
instance-id (required) Path Parameter is the value of the id attribute in the instance object.
Request body
vmwareVmOpRecover VMwareVmOpRecover (required) Body Parameter Parameters to start the recovery.
NetWorker 18.2 REST API Reference Guide 293
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
201 Resource was created successfully.
202 Accepted.
400 Bad request. ErrorResponse
401 Unauthorized. ErrorResponse
404 Not found. ErrorResponse
405 Method not allowed. ErrorResponse
500 Internal server error. ErrorResponse
Up POST /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/instances/{instance-id}/op/vmmount
(postVCenterProtectedVmBackupInstanceVmMount)
Mounts a selected protected VM backup instance for purposes of FLR.
Path parameters
vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter object.
vm-uuid (required) Path Parameter is the value of the uuid attribute in the protected VM object.
backup-id (required) Path Parameter is the value of the id attribute in the backup object.
instance-id (required) Path Parameter is the value of the id attribute in the instance object.
Request body
backupOpVmMount BackupOpVmMount (required) Body Parameter Parameters to start the mount.
NetWorker 18.2 REST API Reference Guide 294
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
201 A job is created. The Job URI can be found in the location header of the response.
Up POST /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/op/recover
(postVCenterProtectedVmBackupRecover)
Starts a recovery of a selected protected VM backup.
Path parameters
vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter object.
vm-uuid (required) Path Parameter is the value of the uuid attribute in the protected VM object.
backup-id (required) Path Parameter is the value of the id attribute in the backup object.
Request body
vmwareVmOpRecover VMwareVmOpRecover (required) Body Parameter Parameters to start the recovery.
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
201 Resource was created successfully.
NetWorker 18.2 REST API Reference Guide 295
202 Accepted.
400 Bad request. ErrorResponse
401 Unauthorized. ErrorResponse
404 Not found. ErrorResponse
405 Method not allowed. ErrorResponse
500 Internal server error. ErrorResponse
Up POST /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/op/vmmount
(postVCenterProtectedVmBackupVmMount)
Mounts a selected protected VM backup for purposes of FLR.
Path parameters
vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter object.
vm-uuid (required) Path Parameter is the value of the uuid attribute in the protected VM object.
backup-id (required) Path Parameter is the value of the id attribute in the backup object.
Request body
backupOpVmMount BackupOpVmMount (required) Body Parameter Parameters to start the mount.
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
201 A job is created. The Job URI can be found in the location header of the response.
NetWorker 18.2 REST API Reference Guide 296
Up POST /vmware/op/refreshvcenters
(postVMwareOpRefreshVCenters)
Refreshes the NetWorker information for all the vCenters.
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
201 Operation started successfully, location header contains a job URI to be monitored.
Up POST /vmware/vcenters/{vcenter-hostname}/vms/{vm-uuid}/op/backup
(postVMwareVCenterVmOpBackup)
Starts a backup for a specific vC/vms/{vm-uuid}/enter VM.
Path parameters
vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter object.
vm-uuid (required) Path Parameter is the value of the uuid attribute in the VM object.
Request body
vmwareVmOpBackup VMwareVmOpBackup (required) Body Parameter Parameters to start the backup.
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
NetWorker 18.2 REST API Reference Guide 297
201 A job is created. The Job URI can be found in the location header of the response.
Up POST /vmware/vproxies
(postVProxy)
Create a vProxy.
Request body
vproxy VProxy (required) Body Parameter vProxy to create
Responses
201 Resource was created successfully.
202 Accepted.
400 Bad request. ErrorResponse
401 Unauthorized. ErrorResponse
404 Not found. ErrorResponse
405 Method not allowed. ErrorResponse
500 Internal server error. ErrorResponse
Up PUT /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/op/vmmount/{vproxy-mount-session-
id}/vmbrowse/{vproxy-browse-session-id}
(putBackupVProxyVmBrowseSessionRequest)
Updates the specific VM browse session.
Path parameters
vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter object.
vm-uuid (required) Path Parameter is the value of the uuid attribute in the protected VM object.
backup-id (required)
NetWorker 18.2 REST API Reference Guide 298
Path Parameter is the value of the id attribute in the backup object. vproxy-mount-session-id (required)
Path Parameter is the value of the vProxyMountSessionId attribute in the vproxy VM mount job object.
vproxy-browse-session-id (required) Path Parameter is the value of the sessionId attribute of the session's config object.
Request body
VProxyVmBrowseSessionRequest VProxyVmBrowseSessionRequest (required) Body Parameter The vmbrowse session details to be updated.
Return type
VProxyVmBrowseSessionPutOrPostResponse
Example data
Content-Type: application/json
{
"config" : {
"idleTimeout" : 6,
"cacheRetentionSeconds" : 1,
"sessionId" : "sessionId",
"currentWorkingDirectory" : "currentWorkingDirectory",
"browseDestination" : true
},
"status" : {
"description" : "description",
"state" : "state"
}
}
Responses
202 Accepted. VProxyVmBrowseSessionPutOrPostResponse
400 Bad request. VProxyVmBrowseSessionPutOrPostResponse
401 Unauthorized. VProxyVmBrowseSessionPutOrPostResponse
404 Not found. ErrorResponse
405 Method not allowed. VProxyVmBrowseSessionPutOrPostResponse
409 Conflict. VProxyVmBrowseSessionPutOrPostResponse
500 Internal server error. VProxyVmBrowseSessionPutOrPostResponse
NetWorker 18.2 REST API Reference Guide 299
Up PUT /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/instances/{instance-id}/op/vmmount/{vproxy-
mount-session-id}/vmbrowse/{vproxy-browse-session-id}
(putInstanceVProxyVmBrowseSessionRequest)
Updates the specific VM browse session.
Path parameters
vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter object.
vm-uuid (required) Path Parameter is the value of the uuid attribute in the protected VM object.
backup-id (required) Path Parameter is the value of the id attribute in the backup object.
instance-id (required) Path Parameter is the value of the id attribute in the instance object.
vproxy-mount-session-id (required) Path Parameter is the value of the vProxyMountSessionId attribute in the vproxy VM mount job object.
vproxy-browse-session-id (required) Path Parameter is the value of the sessionId attribute of the session's config object.
Request body
VProxyVmBrowseSessionRequest VProxyVmBrowseSessionRequest (required) Body Parameter The vmbrowse session details to be updated.
Return type
VProxyVmBrowseSessionPutOrPostResponse
Example data
Content-Type: application/json
{
"config" : {
"idleTimeout" : 6,
"cacheRetentionSeconds" : 1,
"sessionId" : "sessionId",
"currentWorkingDirectory" : "currentWorkingDirectory",
"browseDestination" : true
},
"status" : {
"description" : "description",
NetWorker 18.2 REST API Reference Guide 300
"state" : "state"
}
}
Responses
202 Accepted. VProxyVmBrowseSessionPutOrPostResponse
400 Bad request. VProxyVmBrowseSessionPutOrPostResponse
401 Unauthorized. VProxyVmBrowseSessionPutOrPostResponse
404 Not found. VProxyVmBrowseSessionPutOrPostResponse
405 Method not allowed. VProxyVmBrowseSessionPutOrPostResponse
409 Conflict. VProxyVmBrowseSessionPutOrPostResponse
500 Internal server error. VProxyVmBrowseSessionPutOrPostResponse
Up PUT /vmware/vcenters/{vcenter-hostname}
(putVCenter)
Updates the specific vCenter.
Path parameters
vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter object.
Request body
vcenter VCenter (required) Body Parameter vCenter to modify.
Responses
204 Resource was updated successfully.
Up PUT /vmware/vproxies/{vproxy-hostname}
(putVProxy)
Updates the specific vProxy.
NetWorker 18.2 REST API Reference Guide 301
Path parameters
vproxy-hostname (required) Path Parameter is the value of hostname attribute in the vProxy object.
Request body
vproxy VProxy (required) Body Parameter vProxy to modify
Responses
204 Resource was updated successfully.
Volumes
Up DELETE /volumes/{volumeId}
(deleteVolume)
Deletes the specific volume.
Path parameters
volumeId (required) Path Parameter is the value of the name attribute in the volume object.
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
204 Resource was retrieved successfully.
Up GET /volumes/{volumeId}
(getVolume)
Returns the specific volume.
NetWorker 18.2 REST API Reference Guide 302
Path parameters
volumeId (required) Path Parameter is the value of the name attribute in the volume object.
Return type
Volume
Example data
Content-Type: application/json
{
"saveSetIds" : [ "saveSetIds", "saveSetIds" ],
"recover" : {
"unit" : "Byte",
"value" : 6
},
"availabilityFlags" : [ "Nearline", "Nearline" ],
"flags" : [ "Dirty", "Dirty" ],
"pool" : "pool",
"mounts" : 6,
"type" : "type",
"capacity" : {
"unit" : "Byte",
"value" : 6
},
"states" : [ "Archive", "Archive" ],
"latestLabelTime" : "2000-01-23T04:56:07.000+00:00",
"recycled" : 1,
"originalLabelTime" : "2000-01-23T04:56:07.000+00:00",
"expirationTime" : "2000-01-23T04:56:07.000+00:00",
"name" : "name",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"location" : "location",
"id" : "id",
"written" : {
"unit" : "Byte",
"value" : 6
},
"family" : "family",
NetWorker 18.2 REST API Reference Guide 303
"barcode" : "barcode",
"saveSetExpirationTime" : "2000-01-23T04:56:07.000+00:00",
"tenant" : "tenant",
"accessTime" : "2000-01-23T04:56:07.000+00:00"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resource was retrieved successfully. Volume
Up GET /volumes
(getVolumes)
Returns a list of volumes.
Return type
VolumeList
Example data
Content-Type: application/json
{
"count" : 0,
"volumes" : [ {
"saveSetIds" : [ "saveSetIds", "saveSetIds" ],
"recover" : {
"unit" : "Byte",
"value" : 6
},
"availabilityFlags" : [ "Nearline", "Nearline" ],
"flags" : [ "Dirty", "Dirty" ],
"pool" : "pool",
"mounts" : 6,
"type" : "type",
"capacity" : {
"unit" : "Byte",
"value" : 6
},
"states" : [ "Archive", "Archive" ],
NetWorker 18.2 REST API Reference Guide 304
"latestLabelTime" : "2000-01-23T04:56:07.000+00:00",
"recycled" : 1,
"originalLabelTime" : "2000-01-23T04:56:07.000+00:00",
"expirationTime" : "2000-01-23T04:56:07.000+00:00",
"name" : "name",
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"location" : "location",
"id" : "id",
"written" : {
"unit" : "Byte",
"value" : 6
},
"family" : "family",
"barcode" : "barcode",
"saveSetExpirationTime" : "2000-01-23T04:56:07.000+00:00",
"tenant" : "tenant",
"accessTime" : "2000-01-23T04:56:07.000+00:00"
}, {
"saveSetIds" : [ "saveSetIds", "saveSetIds" ],
"recover" : {
"unit" : "Byte",
"value" : 6
},
"availabilityFlags" : [ "Nearline", "Nearline" ],
"flags" : [ "Dirty", "Dirty" ],
"pool" : "pool",
"mounts" : 6,
"type" : "type",
"capacity" : {
"unit" : "Byte",
"value" : 6
},
"states" : [ "Archive", "Archive" ],
"latestLabelTime" : "2000-01-23T04:56:07.000+00:00",
"recycled" : 1,
"originalLabelTime" : "2000-01-23T04:56:07.000+00:00",
"expirationTime" : "2000-01-23T04:56:07.000+00:00",
"name" : "name",
"links" : [ {
"rel" : "create-form",
NetWorker 18.2 REST API Reference Guide 305
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ],
"location" : "location",
"id" : "id",
"written" : {
"unit" : "Byte",
"value" : 6
},
"family" : "family",
"barcode" : "barcode",
"saveSetExpirationTime" : "2000-01-23T04:56:07.000+00:00",
"tenant" : "tenant",
"accessTime" : "2000-01-23T04:56:07.000+00:00"
} ],
"links" : [ {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
}, {
"rel" : "create-form",
"href" : "href",
"id" : "id",
"title" : "title"
} ]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Resources were retrieved successfully. VolumeList
Models
NetWorker 18.2 REST API Reference Guide 306
[ Jump to Methods ]
Table of Contents
1. Alert -
2. AlertList -
3. Attr -
4. AuditLogConfiguration -
5. Backup -
6. BackupInstance -
7. BackupInstanceList -
8. BackupList -
9. BackupOpVmMount -
10. BitRate -
11. Client -
12. ClientList -
13. ClientOpBackup -
14. CloudboostAppliance -
15. CloudboostApplianceList -
16. Device -
17. DeviceList -
18. DeviceOpLabel -
19. DeviceOpMount -
20. DeviceOpStatus -
21. Directive -
22. DirectiveList -
23. ErrorResponse -
24. HttpHeader -
25. HttpRequest -
26. HttpStatus -
27. Index -
28. IndexList -
29. Job -
30. JobIndication -
31. JobIndicationList -
32. JobList -
33. JobOpCancel -
34. Label -
35. LabelList -
36. License -
37. LicenseList -
38. Link -
39. Notification -
40. NotificationList -
41. Policy -
42. PolicyAction -
NetWorker 18.2 REST API Reference Guide 307
43. PolicyActionBackup -
44. PolicyActionBackupSnapshot -
45. PolicyActionBackupSpecificData -
46. PolicyActionBackupTraditional -
47. PolicyActionBackupVMwareVProxy -
48. PolicyActionBackupVMwareVba -
49. PolicyActionCheckConnectivity -
50. PolicyActionClone -
51. PolicyActionDiscover -
52. PolicyActionExpire -
53. PolicyActionGenerateIndex -
54. PolicyActionProbe -
55. PolicyActionServerBackup -
56. PolicyActionSettingOverride -
57. PolicyActionSpecificData -
58. PolicyActionVbaCheckpointBackup -
59. PolicyActionVbaCheckpointDiscover -
60. PolicyActionWorkItemFilter -
61. PolicyList -
62. PolicyNotification -
63. PolicyWorkflow -
64. PolicyWorkflowList -
65. PolicyWorkflowOpBackup -
66. Pool -
67. PoolList -
68. Probe -
69. ProbeList -
70. ProtectionGroup -
71. ProtectionGroupList -
72. Recover -
73. RecoverBackupInstance -
74. RecoverList -
75. RecoverNDMPOptions -
76. ResourceId -
77. Rule -
78. RuleItemDefinition -
79. RuleList -
80. ServerConfiguration -
81. ServerMessage -
82. ServerMessageList -
83. ServerStatistics -
84. Session -
85. SessionList -
86. Size -
87. StorageNode -
88. StorageNodeList -
NetWorker 18.2 REST API Reference Guide 308
89. Tenant -
90. TenantList -
91. TimeStampBasedGranularRecover -
92. UserGroup -
93. UserGroupList -
94. VCenter -
95. VCenterList -
96. VCenterPlugin -
97. VMwareApplicationRecoverSavesetInfo -
98. VMwareProtectedVm -
99. VMwareProtectedVmList -
100. VMwareVm -
101. VMwareVmBackupInfo -
102. VMwareVmEmergencyRecoverCleanupOptions -
103. VMwareVmFlrOptions -
104. VMwareVmGuestInfo -
105. VMwareVmList -
106. VMwareVmOpBackup -
107. VMwareVmOpRecover -
108. VMwareVmProtectionDetail -
109. VMwareVmProtectionDetailList -
110. VMwareVmdkBackupInfo -
111. VMwareVmdkRecoverInfo -
112. VMwareVmdkWorkItem -
113. VMwareWorkItemOpUpdate -
114. VMwareWorkItemSelection -
115. VProxy -
116. VProxyList -
117. VProxyVmBrowseSessionPutOrPostResponse -
118. VProxyVmBrowseSessionRequest -
119. VProxyVmBrowseSessionResponse -
120. VProxyVmBrowseSessionResponseConfig -
121. VProxyVmBrowseSessionResponseList -
122. VProxyVmBrowseSessionResponseStatus -
123. VProxyVmMountSessionResponse -
124. VProxyVmMountSessionResponseConfig -
125. VProxyVmMountSessionResponseStatus -
126. Volume -
127. VolumeList -
128. XmlError -
129. XmlFile -
130. XmlVmBrowseDirectoryContents -
Alert - Up
category (optional) String
NetWorker 18.2 REST API Reference Guide 309
message (optional) String priority (optional) String timestamp (optional) Date format: date-time
AlertList - Up
count (optional) Integer format: int32 alerts (optional) array[Alert] links (optional) array[Link]
Attr - Up
key (optional) String values (optional) array[String]
AuditLogConfiguration - Up
Audit Log Configuration model administrators (optional) array[String] auditLogFilePath (optional) String auditLogHostname (optional) String auditLogMaxFileSizeInMB (optional) Integer format: int32 auditLogMaxFileVersion (optional) Integer format: int32 auditLogRenderedLocale (optional) String auditLogRenderedService (optional) String AuditLogRenderedService
Enum: None Local Syslog Eventlog auditLogSeverity (optional) String AuditLogSeverity
Enum:
NetWorker 18.2 REST API Reference Guide 310
Information Notice Warning Error Severe Critical
name (optional) String resourceId (optional) ResourceId
Backup - Up
Backup model attributes (optional) array[Attr] browseTime (optional) Date format: date-time clientHostname (optional) String clientId (optional) String completionTime (optional) Date format: date-time creationTime (optional) Date format: date-time fileCount (optional) Long format: int64 id (optional) String instances (optional) array[BackupInstance] level (optional) String BackupLevel
Enum: 1 2 3 4 5 6 7 8 9 Consolidate Full Incr IncrSynthFull
NetWorker 18.2 REST API Reference Guide 311
Manual Migration Skip SynthFull TxnLog
links (optional) array[Link] name (optional) String retentionTime (optional) Date format: date-time saveTime (optional) Date format: date-time shortId (optional) String size (optional) Size tenant (optional) String type (optional) String BackupType
Enum: CoverSet DSA File NDMP Raw Snapshot Unknown
vmInformation (optional) VMwareVmBackupInfo
BackupInstance - Up
Backup Instance model clone (optional) Boolean id (optional) String links (optional) array[Link] status (optional) String Status
Enum: Aborted Browsable InProgress Recoverable
NetWorker 18.2 REST API Reference Guide 312
Recyclable Unknown
volumeIds (optional) array[String]
BackupInstanceList - Up
backupInstances (optional) array[BackupInstance] count (optional) Integer format: int32 links (optional) array[Link]
BackupList - Up
backups (optional) array[Backup] count (optional) Integer format: int32 links (optional) array[Link]
BackupOpVmMount - Up
backupDeviceExportPath (optional) String installFlrAgent (optional) Boolean targetVCenterHostname (optional) String targetVmAdminUserId (optional) String targetVmAdminUserPassword (optional) String targetVmMoref (optional) String targetVmName (optional) String targetVmUserId (optional) String targetVmUserPassword (optional) String uninstallFlrAgent (optional) Boolean vProxy (optional) String
NetWorker 18.2 REST API Reference Guide 313
BitRate - Up
unit (optional) String BitRate
Enum: Byte/s KB/s
value (optional) Long format: int64
Client - Up
Client model aliases (optional) array[String] This is a list of aliases (nicknames) for the client machine that queries can match. If this list is empty, match on client name alone. applicationInformation (optional) array[String] This attribute contains client application information. backupCommand (optional) String The remote command to run to backup data for this client and save sets. This command can be used to perform pre and post backup processing and defaults to the ''save'' command. The value must not include a path and must start with the prefix ''save'' or ''nsr''. backupType (optional) String This attribute specifies the client backup type. blockBasedBackup (optional) Boolean Select this attribute to enable the image backups. Refer to the NetWorker Administration Guide for additional information about configuring block based backups. checkpointEnabled (optional) Boolean This attribute enables the support for checkpoint restart during scheduled backups. The save program performs a backup in an ordered manner and keeps track of the files saved. If save fails, it can be restarted from the point of interruption (file or directory). The ordering of the filesystems during backup may cause performance impact. clientId (optional) String This attribute is the client's identifier and cannot be changed. clientDirectEnabled (optional) Boolean This attribute indicates if this client is enabled to bypass the storage node and write directly to the target disk device during a scheduled backup of the client. comment (optional) String This attribute specifies any user-defined description of this client or other explanatory remarks. dataDomainBackup (optional) Boolean This attribute specifies whether the backup destination for this client is a Data Domain device. dataDomainInterface (optional)
NetWorker 18.2 REST API Reference Guide 314
String This attribute specifies the client interface over which a Client Direct backup to a Data Domain device should occur. This attribute has two values, IP and Fibre Channel. The default value is IP. This attribute has meaning only when the Data Domain Backup and Client Direct attributes are enabled.
Enum: Any IP Fibre Channel
directive (optional) String Directives tell the client how to back up certain files. The choices are defined by the set of existing directives. executablePath (optional) String The path to the NSR executables on this client. hostname (optional) String This attribute is the hostname of the NSR client. indexBackupContent (optional) Boolean This attribute specifies index files and directories on the snapshot. jobControl (optional) array[String] This attribute is intended to be used with custom backup scripts. It controls how savegrp and nsrjobd interpret the end of a job and its status. links (optional) array[Link] nasDevice (optional) Boolean Indicates client is a NAS device. nasDeviceManagementName (optional) String In NAS device configurations, the management name of the device. nasFileAccessPassword (optional) String This password is used to access the file services on a NAS device. If a password is specified, then the NAS file server user attribute for the client resource must also be defined. Each instance of a client can have a different password. This field is only used with Windows clients. This field is ignored with other client types. nasFileAccessUser (optional) String This user accesses the file services on a NAS device. Each instance of a client can have a different value for the NAS management user. This field is only used with Windows clients. This field is ignored with other client types. nasManagementPassword (optional) String This password is used to perform management actions on a NAS device. If a password is given, then the ''NAS management user'' attribute for the client resource must also be defined. Each instance of a client can have a different password. nasManagementUser (optional) String The user as which to run remote management commands on this NAS device. Each instance of a client can have a different value for the ''NAS management user''. ndmp (optional) Boolean Indicates client is a NDMP client. ndmpArrayName (optional)
NetWorker 18.2 REST API Reference Guide 315
String In NDMP NAS array configurations, the logical name assigned to the array. ndmpMultiStreamsEnabled (optional) Boolean ndmpVendorInformation (optional) array[String] networkerVersion (optional) String This attribute contains the NetWorker version that is running on the client machine. By default, this field is blank. This attribute is updated when the backup is performed. parallelSaveStreamsPerSaveSet (optional) Boolean Parallel save streams per save set - Enable parallel save streams per client resource save set during scheduled backup. Large save set backup time could be significantly reduced. Each save set will be backed up with four parallel save streams by default. The default four can be changed by setting the ''PSS:streams_per_ss'' parameter in the client's save operations attribute. For example, ''PSS:streams_per_ss=1,*, 2,/data[1-3], 8,/data[45]'' will use one stream per UNIX client save set entry by default but two streams for each of /data1, /data2 & /data3 and eight streams for each of /data4 & /data5. Client- supported wildcard characters can be used. The total number of active streams from all save sets at any one point in time will not exceed the client's parallelism, which is recommended to be a multiple of the default four or the largest ''PSS:streams_per_ss'' integer value if set. parallelism (optional) Integer The number of save sets to run in parallel. format: int32 password (optional) String The commands save and savefs use the password to gain access to the files being backed up, and other backup commands may use it to access application data. If a password is given, then the remote user attribute for the client resource must also be defined. This attribute is not used for UNIX file system clients. Each instance of a client can have a different password. pool (optional) String This attribute specifies the media pool used for data target selection during a scheduled backup of the save sets specified in this client. postCommand (optional) String The command that is specified here runs after the save sets are completed for this client. The value must not include a path and must start with the prefix 'save' or 'nsr'. preCommand (optional) String The command that is specified here runs before the save sets for this client. The value must not include a path and must start with the prefix 'save' or 'nsr'. probeResourceName (optional) String Probe resource name. protectionGroups (optional) array[String] remoteAccessUsers (optional) array[String] A list of remote users that are allowed to recover this client's files. If empty, only users logged into this machine are valid. Examples: sam@jupiter
NetWorker 18.2 REST API Reference Guide 316
or user=sam,host=jupiter (user sam on machine jupiter), group=wheel,host=jupiter (any user in group wheel on host jupiter), jupiter or host=jupiter (any user on machine jupiter). Warning: If using the Restricted Data Zones feature it is possible to give access to someone not explicitly in the associated Restricted Data Zone. Use caution with wildcard characters. remoteUser (optional) String The user that runs remote commands on this client or accesses the application-specific data. Each instance of a client can have a different value for the 'remote user'. resourceId (optional) ResourceId retentionPolicy (optional) String Retention setting for client resource. saveOperations (optional) String This attribute specifies the save operation instructions in the format: KEYWORD:TOKEN=STATE[;KEYWORD:TOKEN=STATE;...]. This attribute is required if save set attribute of this client contains non-ASCII names. This attribute can also be used to configure VSS saves on the Windows OS. saveSets (optional) array[String] A list of the save sets to be backed up for this client with this schedule. schedule (optional) String Backup schedule for client resource. scheduledBackup (optional) Boolean This attribute indicates if this client is enabled for scheduled backups. serverNetworkInterface (optional) String This attribute specifies the name of the network interface on the server to be used for saves and recoveries. storageNodes (optional) array[String] An ordered list of storage nodes for the client to use when saving its data. storageReplicationPolicyName (optional) String The storage replication policy used during backup. tags (optional) array[String] This attribute contains tags for the clients. tenant (optional) String The Restricted Data Zone this resource belongs to if it belongs to one.
ClientList - Up
clients (optional) array[Client] count (optional) Integer format: int32 links (optional) array[Link]
ClientOpBackup - Up
NetWorker 18.2 REST API Reference Guide 317
Client backup operation model. actionOverrides (optional) array[PolicyActionSettingOverride] policy (optional) String workflow (optional) String
CloudboostAppliance - Up
host (optional) String Specifies the cloudboost hostname. name (optional) String Specifies the cloudboost name. username (optional) String Specifies the username used to connect to cloudboost appliance. password (optional) String Specifies the password used to connect to cloudboost appliance. resourceId (optional) ResourceId
CloudboostApplianceList - Up
count (optional) Integer format: int32 cloudBoostAppliances (optional) array[CloudboostAppliance]
Device - Up
autoMediaManagement (optional) Boolean cdi (optional) String CDI
Enum: NotUsed SCSI
cleaningInterval (optional) String cleaningRequired (optional) Boolean cloudBandwidthThrottlingSettings (optional) array[String] cloudBandwithThrottlingEnabled (optional) Boolean cloudCACertificate (optional) String cloudCompression (optional)
NetWorker 18.2 REST API Reference Guide 318
String CloudCompression Enum:
None SpeedVerySlow SpeedSlow SpeedMedium SpeedFast
cloudEncryption (optional) String CloudEncryption
Enum: None AES256
cloudNetworkFailureRetryInMin (optional) Integer format: int32 cloudNumberOfRetries (optional) Integer format: int32 cloudServer (optional) String cloudTimeout (optional) Integer format: int32 cloudWriteSizeInKB (optional) Integer format: int32 comment (optional) String dataDomainFibreChannel (optional) Boolean dataDomainFibreChannelHostname (optional) String dataDomainHost (optional) String dataDomainRetentionLockMode (optional) String This attribute enables or disables the Data Domain retention lock.
Enum: None Governance Compliance
dataDomainRetentionLockPeriodMin (optional) String dataDomainRetentionLockPeriodMax (optional) String dateLastCleaned (optional) Date format: date-time description (optional) String deviceAccessInfo (optional) String deviceSerialNumber (optional) String
NetWorker 18.2 REST API Reference Guide 319
dltWormCapable (optional) Boolean hardwareId (optional) String links (optional) array[Link] maxNsrmmdCount (optional) Integer format: int32 maxSession (optional) Integer format: int32 mediaFamily (optional) String MediaFamily
Enum: Tape Disk Cloud Logical
mediaType (optional) String MediaType
Enum: Data Domain DD Cloud Tier protectpoint objstr Atmos COS adv_file Cloud Boost file logical Auto Detected LTO Ultrium-8 LTO Ultrium-7 LTO Ultrium-6 LTO Ultrium-5 LTO Ultrium-4 LTO Ultrium-3 LTO Ultrium-2 LTO Ultrium LTO Accelis TS1140 TS1130 TS1120 T10000D T10000C T10000B T10000 9940B 9940
NetWorker 18.2 REST API Reference Guide 320
9840D 9840C 9840b 9840 9490 4890 3592 3590 3570 3480 optical dtf2 dtf dst dst (NT) VXA-320 VXA-172 VXA-2 VXA sdlt600 sdlt320 sdlt dlt-v4 dlt-s4 dlt 20GB dlt vs160 dlt8000 dlt7000 dlt1 dlt tzs20 tz90 tz89 tz88 tz87 tz86 tz85 tkz90 tk70 tk50 4mm DAT160 4mm DAT72 4mm 20GB 4mm 12GB 4mm 8GB 4mm 4GB 4mm 8mm Mammoth-3
NetWorker 18.2 REST API Reference Guide 321
8mm Mammoth-2 SAIT-2 SAIT-1 8mm AIT-5 8mm AIT-4 8mm AIT-3 8mm AIT-2 8mm AIT 8mm 20GB 8mm 7GB 8mm 5GB 8mm SD3 SLR qic travan10 generic256 generic128 generic CentricStor vhs himt
message (optional) String mountedVolume (optional) String name (optional) String ndmp (optional) Boolean parentJukebox (optional) String password (optional) String pathId (optional) String readOnly (optional) Boolean remoteUser (optional) String resourceId (optional) ResourceId status (optional) String Status
Enum: Enabled Disabled Service
NetWorker 18.2 REST API Reference Guide 322
suspectedDevice (optional) Boolean tapeAlertsWarning (optional) array[String] tapeAlertsCritical (optional) array[String] tapeAlertsInformation (optional) array[String] targetSession (optional) Integer format: int32 tenant (optional) String verifyLabelOnEject (optional) Boolean volumeId (optional) String volumePool (optional) String warnOnSuspectVolumesInPercent (optional) Integer format: int32 wormCapable (optional) Boolean wormCartridgePresent (optional) Boolean writeEnabled (optional) Boolean
DeviceList - Up
count (optional) Integer format: int32 devices (optional) array[Device] links (optional) array[Link]
DeviceOpLabel - Up
capacity (optional) String labelWithoutMount (optional) Boolean manualRecycleOnly (optional) Boolean pool (optional) String relabel (optional) Boolean
NetWorker 18.2 REST API Reference Guide 323
verifyUnlabeledVolume (optional) Boolean volumeLabel (optional) String
DeviceOpMount - Up
volume (optional) String writeEnabled (optional) Boolean
DeviceOpStatus - Up
error (optional) String message (optional) String operation (optional) String Operation
Enum: Unmount Mount VerifyLabel Label LabelWithoutMount Eject VerifyWriteTime MonitorDevice RecoverSpace CheckFileSystem Check Erase CheckMedia
operationInProgress (optional) Boolean resourceId (optional) ResourceId volumeLabel (optional) String
Directive - Up
comment (optional) String directive (optional) String links (optional)
NetWorker 18.2 REST API Reference Guide 324
array[Link] name (optional) String resourceId (optional) ResourceId tenant (optional) String
DirectiveList - Up
count (optional) Integer format: int32 directives (optional) array[Directive] links (optional) array[Link]
ErrorResponse - Up
message (optional) String status (optional) HttpStatus timestamp (optional) Date format: date-time userAgentRequest (optional) HttpRequest version (optional) String
HttpHeader - Up
name (optional) String value (optional) String
HttpRequest - Up
contentLength (optional) Long format: int64 headers (optional) array[HttpHeader] method (optional) String query (optional) String url (optional) String
NetWorker 18.2 REST API Reference Guide 325
HttpStatus - Up
code (optional) Integer format: int32 codeClass (optional) String reasonPhrase (optional) String
Index - Up
clientFileId (optional) String fileName (optional) String fileSizeInBytes (optional) Long format: int64 namespace (optional) String
Enum: backup migrated archive nsr ccmail informix msexch msmail mssql notes sapmssql saporacle saphana sybase db2 mysql oracle nmcasa actdir medi MOSS bbb nmm nmm_bbb msapp_pp msapp_bbb fsagent fsagent_scan
NetWorker 18.2 REST API Reference Guide 326
iq msvmapp
offset (optional) Long format: int64 saveTime (optional) String Save time in UTC format.
IndexList - Up
count (optional) Integer format: int32 items (optional) array[Index]
Job - Up
adhocJob (optional) Boolean clientHostname (optional) String command (optional) String completionStatus (optional) String CompletionStatus
Enum: Unknown NoStart Succeeded Failed Cancelled Abandoned MissedTheSchedule
dataSize (optional) Size dependentJobIds (optional) array[Long] format: int64 endTime (optional) Date format: date-time exitCode (optional) Long format: int64 id (optional) Long format: int64 itemCount (optional) Long format: int64 itemIdLong (optional) Integer links (optional) array[Link]
NetWorker 18.2 REST API Reference Guide 327
logFile (optional) String message (optional) String name (optional) String ndmp (optional) Boolean parentJobId (optional) Long format: int64 previousJobId (optional) Long format: int64 progress (optional) String recoverAppItemStatus (optional) String rootParentJobId (optional) Long format: int64 runOnHost (optional) String saveSetId (optional) String siblingJobIds (optional) array[Long] format: int64 startTime (optional) Date format: date-time state (optional) String JobState
Enum: Unknown Created Queued Started Active SessionActive Cancelled Completed
stopped (optional) Boolean tenant (optional) String terminationReason (optional) String type (optional) String missedClients (optional) array[String] disabledClients (optional)
NetWorker 18.2 REST API Reference Guide 328
array[String] completionReport (optional) String vProxyErrorMessages (optional) array[String] vProxyFlrAgentInstallRequired (optional) Boolean vProxyHostname (optional) String vProxyMountSessionId (optional) String vProxyMountState (optional) String vProxyMountTargetVmInvalidAdminUser (optional) Boolean vProxyMountTargetVmInvalidUser (optional) Boolean vProxyMountTargetVmMoref (optional) String vProxyMountTargetVmName (optional) String vProxyMountTargetVmUserId (optional) String vProxyMountVCenterHostname (optional) String vProxyInspectDescriptor (optional) String vProxyRecoverSessionId (optional) String
JobIndication - Up
catalogId (optional) String jobId (optional) Long format: int64 links (optional) array[Link] message (optional) String messageCatalogNumber (optional) String messageId (optional) String originComponent (optional) String severity (optional) String JobIndicationSeverity
NetWorker 18.2 REST API Reference Guide 329
Enum: Invalid Debug Information Notice Warning Intervention Error Severe Critical Alert Emergency
tenant (optional) String timestamp (optional) Date format: date-time
JobIndicationList - Up
count (optional) Integer format: int32 jobIndications (optional) array[JobIndication] links (optional) array[Link]
JobList - Up
count (optional) Integer format: int32 jobs (optional) array[Job] links (optional) array[Link]
JobOpCancel - Up
reason (optional) String timeoutInSec (optional) Integer format: int32
Label - Up
comment (optional) String fields (optional) array[String] links (optional)
NetWorker 18.2 REST API Reference Guide 330
array[Link] name (optional) String next (optional) String resourceId (optional) ResourceId separator (optional) String LabelSeparator
Enum: . _ : -
tenant (optional) String
LabelList - Up
count (optional) Integer format: int32 labels (optional) array[Label] links (optional) array[Link]
License - Up
name (optional) String Specifies name of the license. comment (optional) String Specifies comment of the license. enablerCode (optional) String An enabler code is a unique code that activates the software, also called an enabler key or license enabler. hostId (optional) String Specifies host identifier of the license. expirationDate (optional) String Specifies expiration date of the license. authCode (optional) String An authorization code is a unique code that in combination with an associated enabler code unlocks the software for permanent use on a specific host computer. licenseType (optional) String Specifies type of the license. resourceId (optional) ResourceId
NetWorker 18.2 REST API Reference Guide 331
LicenseList - Up
count (optional) Integer format: int32 licenses (optional) array[License] links (optional) array[Link]
Link - Up
href (optional) String id (optional) String rel (optional) String
Enum: create-form item related
title (optional) String
Notification - Up
action (optional) String additionalEmailRecipient (optional) String comment (optional) String enabled (optional) Boolean events (optional) array[String]
Enum: links (optional) array[Link] name (optional) String priorities (optional) array[String]
Enum: resourceId (optional) ResourceId
NotificationList - Up
NetWorker 18.2 REST API Reference Guide 332
count (optional) Integer format: int32 links (optional) array[Link] notifications (optional) array[Notification]
Policy - Up
allowManualSaves (optional) Boolean applyEntireWorkflow (optional) Boolean comment (optional) String links (optional) array[Link] name (optional) String resourceId (optional) ResourceId summaryNotification (optional) PolicyNotification policyProtectionEnable (optional) Boolean policyProtectionPeriod (optional) String tenant (optional) String workflows (optional) array[PolicyWorkflow]
PolicyAction - Up
actionSpecificData (optional) PolicyActionSpecificData actionStartTime (optional) String comment (optional) String completionNotification (optional) PolicyNotification concurrent (optional) Boolean customTags (optional) array[String] drivenBy (optional) String
NetWorker 18.2 REST API Reference Guide 333
disableActionStartTime (optional) Boolean enabled (optional) Boolean failureImpact (optional) String PolicyActionFailureImpact
Enum: Continue AbortAction AbortWorkflow
hardLimit (optional) String inactivityTimeoutInMin (optional) Integer format: int32 name (optional) String newName (optional) String parallelism (optional) Integer format: int32 retries (optional) Integer format: int32 retryDelayInSec (optional) Integer format: int32 scheduleActivities (optional) array[String] scheduleComment (optional) String scheduleOverrides (optional) array[String] schedulePeriod (optional) String SchedulePeriod
Enum: Week Month
softLimit (optional) String workItemFilter (optional) PolicyActionWorkItemFilter
PolicyActionBackup - Up
backupSpecificData (optional) PolicyActionBackupSpecificData clientOverride (optional) String PolicyActionClientOverrideType
Enum: ClientCanNotOverride
NetWorker 18.2 REST API Reference Guide 334
ClientCanOverride LegacyBackupRules
destinationStorageNodes (optional) array[String] overrideBackupSchedule (optional) Boolean overrideRetentionPeriod (optional) Boolean retentionPeriod (optional) String successThreshold (optional) String PolicySuccessThreshold
Enum: Warning Success
PolicyActionBackupSnapshot - Up
destinationPool (optional) String forceBackupLevel (optional) String minimumRetentionPeriod (optional) String
PolicyActionBackupSpecificData - Up
One and only one of those properties can be present at any time snapshot (optional) PolicyActionBackupSnapshot traditional (optional) PolicyActionBackupTraditional vmware (optional) PolicyActionBackupVMwareVba vmwareVProxy (optional) PolicyActionBackupVMwareVProxy
PolicyActionBackupTraditional - Up
enableDDRetentionLock (optional) Boolean ddRetentionLockTime (optional) String destinationPool (optional) String estimate (optional) Boolean forceBackupLevel (optional)
NetWorker 18.2 REST API Reference Guide 335
String fileInactivityAlertThresholdPercentage (optional) Integer format: int32 fileInactivityThresholdInDays (optional) Integer format: int32 revertToFullWhenSyntheticFullFails (optional) Boolean timestampFormat (optional) String PolicyTimestampFormat
Enum: None ISO Unix
verifySyntheticFull (optional) Boolean
PolicyActionBackupVMwareVProxy - Up
destinationPool (optional) String proxyName (optional) String appConsistentQuiesce (optional) String
Enum: Basic Advanced None
transactionLogBackup (optional) Boolean quiesceTimeoutInMinutes (optional) Integer quiesceSystemAdminUsername (optional) String quiesceSystemAdminPassword (optional) String enableDDRetentionLock (optional) Boolean ddRetentionLockTime (optional) String
PolicyActionBackupVMwareVba - Up
destinationPool (optional) String saveType (optional) String PolicyVbaSaveType
Enum:
NetWorker 18.2 REST API Reference Guide 336
VMDK VirtualMachine
useVbaInternalStorage (optional) Boolean vbaName (optional) String
PolicyActionCheckConnectivity - Up
PolicyActionClone - Up
enableDDRetentionLock (optional) Boolean ddRetentionLockTime (optional) String deleteSource (optional) Boolean destinationPool (optional) String destinationStorageNode (optional) String retentionPeriod (optional) String sourceStorageNode (optional) String
PolicyActionDiscover - Up
discoverType (optional) String DiscoverType
Enum: NAS snapshot
PolicyActionExpire - Up
PolicyActionGenerateIndex - Up
generateIndexType (optional) String GenerateIndexType
Enum: NAS snapshot
PolicyActionProbe - Up
allProbsMustSucceed (optional) Boolean maxBackupIntervalInDays (optional)
NetWorker 18.2 REST API Reference Guide 337
Integer format: int32
PolicyActionServerBackup - Up
destinationPool (optional) String destinationStorageNode (optional) String performBootstrap (optional) Boolean performClientFileIndexing (optional) Boolean retentionPeriod (optional) String
PolicyActionSettingOverride - Up
action String commandLineArguments String
PolicyActionSpecificData - Up
One and only one of those properties can be present at any time backup (optional) PolicyActionBackup testConnectivity (optional) PolicyActionCheckConnectivity clone (optional) PolicyActionClone discover (optional) PolicyActionDiscover expire (optional) PolicyActionExpire generateIndex (optional) PolicyActionGenerateIndex probe (optional) PolicyActionProbe serverBackup (optional) PolicyActionServerBackup vbaCheckpointBackup (optional) PolicyActionVbaCheckpointBackup vbaCheckpointDiscover (optional) PolicyActionVbaCheckpointDiscover
PolicyActionVbaCheckpointBackup - Up
destinationPool (optional)
NetWorker 18.2 REST API Reference Guide 338
String retentionPeriod (optional) String
PolicyActionVbaCheckpointDiscover - Up
PolicyActionWorkItemFilter - Up
clients (optional) array[String] levels (optional) array[String] saveSetTypes (optional) array[String] timeRangeEnd (optional) Date format: date-time timeRangeStart (optional) Date format: date-time excludeClient (optional) String
Enum: true false none
excludeLevel (optional) String
Enum: true false none
excludeTimeRange (optional) String
Enum: true false none
excludeSaveSetType (optional) String
Enum: true false none
PolicyList - Up
count (optional) Integer format: int32
NetWorker 18.2 REST API Reference Guide 339
links (optional) array[Link] protectionPolicies (optional) array[Policy]
PolicyNotification - Up
command (optional) String executeOn (optional) String PolicyNotificationTrigger
Enum: Completion Failure Ignore
PolicyWorkflow - Up
actions (optional) array[PolicyAction] autoStartEnabled (optional) Boolean comment (optional) String completionNotification (optional) PolicyNotification description (optional) String enabled (optional) Boolean endTime (optional) String links (optional) array[Link] name (optional) String newName (optional) String nextStartDate (optional) Date format: date-time protectionGroups (optional) array[String] restartTimeWindow (optional) String startInterval (optional) String startTime (optional) String
NetWorker 18.2 REST API Reference Guide 340
PolicyWorkflowList - Up
count (optional) Integer format: int32 links (optional) array[Link] workflows (optional) array[PolicyWorkflow]
PolicyWorkflowOpBackup - Up
actionOverrides (optional) array[PolicyActionSettingOverride] clients (optional) array[String] restart (optional) Boolean vmwareWorkItemSelection (optional) VMwareWorkItemSelection
Pool - Up
autoMediaVerify (optional) Boolean barcodePrefix (optional) String comment (optional) String createDltWorm (optional) Boolean devices (optional) array[String] enabled (optional) Boolean labelTemplate (optional) String links (optional) array[Link] maxParallelism (optional) Integer format: int32 maxVolumesToRecycle (optional) Integer format: int32 mediaTypeRequired (optional) String MediaTypeRequired
Enum: Data Domain DD Cloud Tier protectpoint
NetWorker 18.2 REST API Reference Guide 341
objstr Atmos COS adv_file Cloud Boost file logical Auto Detected LTO Ultrium-8 LTO Ultrium-7 LTO Ultrium-6 LTO Ultrium-5 LTO Ultrium-4 LTO Ultrium-3 LTO Ultrium-2 LTO Ultrium LTO Accelis TS1140 TS1130 TS1120 T10000D T10000C T10000B T10000 9940B 9940 9840D 9840C 9840b 9840 9490 4890 3592 3590 3570 3480 optical dtf2 dtf dst dst (NT) VXA-320 VXA-172 VXA-2 VXA sdlt600 sdlt320 sdlt dlt-v4
NetWorker 18.2 REST API Reference Guide 342
dlt-s4 dlt 20GB dlt vs160 dlt8000 dlt7000 dlt1 dlt tzs20 tz90 tz89 tz88 tz87 tz86 tz85 tkz90 tk70 tk50 4mm DAT160 4mm DAT72 4mm 20GB 4mm 12GB 4mm 8GB 4mm 4GB 4mm 8mm Mammoth-3 8mm Mammoth-2 SAIT-2 SAIT-1 8mm AIT-5 8mm AIT-4 8mm AIT-3 8mm AIT-2 8mm AIT 8mm 20GB 8mm 7GB 8mm 5GB 8mm SD3 SLR qic travan10 generic256 generic128 generic CentricStor vhs himt
name (optional)
NetWorker 18.2 REST API Reference Guide 343
String poolType (optional) String PoolType
Enum: Backup BackupClone Archive ArchiveClone
recycleFromOtherPools (optional) Boolean recycleInterval (optional) String recycleStart (optional) String recycleToOtherPools (optional) Boolean resourceId (optional) ResourceId storeIndexEntries (optional) Boolean tenant (optional) String volumeTypePreference (optional) String VolumeTypePreference
Enum: Data Domain DD Cloud Tier protectpoint objstr Atmos COS adv_file Cloud Boost file logical Auto Detected LTO Ultrium-8 LTO Ultrium-7 LTO Ultrium-6 LTO Ultrium-5 LTO Ultrium-4 LTO Ultrium-3 LTO Ultrium-2 LTO Ultrium LTO Accelis TS1140 TS1130 TS1120 T10000D
NetWorker 18.2 REST API Reference Guide 344
T10000C T10000B T10000 9940B 9940 9840D 9840C 9840b 9840 9490 4890 3592 3590 3570 3480 optical dtf2 dtf dst dst (NT) VXA-320 VXA-172 VXA-2 VXA sdlt600 sdlt320 sdlt dlt-v4 dlt-s4 dlt 20GB dlt vs160 dlt8000 dlt7000 dlt1 dlt tzs20 tz90 tz89 tz88 tz87 tz86 tz85 tkz90 tk70 tk50 4mm DAT160 4mm DAT72 4mm 20GB
NetWorker 18.2 REST API Reference Guide 345
4mm 12GB 4mm 8GB 4mm 4GB 4mm 8mm Mammoth-3 8mm Mammoth-2 SAIT-2 SAIT-1 8mm AIT-5 8mm AIT-4 8mm AIT-3 8mm AIT-2 8mm AIT 8mm 20GB 8mm 7GB 8mm 5GB 8mm SD3 SLR qic travan10 generic256 generic128 generic CentricStor vhs himt
wormPool (optional) Boolean
PoolList - Up
count (optional) Integer format: int32 links (optional) array[Link] pools (optional) array[Pool]
Probe - Up
commandOptions (optional) String comment (optional) String links (optional) array[Link] name (optional)
NetWorker 18.2 REST API Reference Guide 346
String probeCommand (optional) String resourceId (optional) ResourceId
ProbeList - Up
count (optional) Integer format: int32 links (optional) array[Link] probes (optional) array[Probe]
ProtectionGroup - Up
comment (optional) String links (optional) array[Link] name (optional) String resourceId (optional) ResourceId tenant (optional) String workItemQueries (optional) array[String] workItemSource (optional) String WorkItemSource
Enum: Static Dynamic
workItemSubType (optional) String WorkItemSubType
Enum: VirtualMachine VMDK All None
workItemType (optional) String WorkItemType
Enum: Client SaveSetId VMware NASDevice
NetWorker 18.2 REST API Reference Guide 347
workItems (optional) array[String] vmwareWorkItemSelection (optional) VMwareWorkItemSelection vmwareWorkItemExclusion (optional) VMwareWorkItemSelection rule (optional) String Name of the rule backupOptimization (optional) String Backup Optimization
Enum: Capacity Performance
dynamicAssociation (optional) Boolean
ProtectionGroupList - Up
count (optional) Integer format: int32 links (optional) array[Link] protectionGroups (optional) array[ProtectionGroup]
Recover - Up
recoveryType (optional) String Specifies the type of recovery.
Enum: Filesystem BBB NDMP VM File Level Recover
recoveryDestination (optional) String Specifies the destination location to which the recovery is performed, as the directory pathname of the file system, NDMP backup, or block based backup. itemsToRecover (optional) array[String] Specifies the list of items to be recovered. For a file system, NDMP backup, or block based backup, specifies the list of full file pathnames. destinationClientResID (optional) String Specifies the destination client ID of the remote machine to direct the recovery. The client ID can be obtained from URI /global/clients. If destination client ID is not provided, the client information from the backup instance is considered for recovery. backupInstance (optional) RecoverBackupInstance
NetWorker 18.2 REST API Reference Guide 348
timeStampBasedGranularRecover (optional) TimeStampBasedGranularRecover actionForDuplicateItems (optional) String Specifies the action to perform during recovery of the files that are already present at the recovery location.
Enum: Rename Overwrite Skip
targetVolume (optional) String Specifies the target volume to use for the image level recovery of block based backups. poolForStaging (optional) String Specifies the pool for staging that is used for Client Direct disabled devices. Currently used for block based backups. passphrase (optional) array[String] Specifies the additional passphrase to use for recovery of files that were backed up by using the AES directive. recoveryStartTime (optional) String Specifies the time when the recovery started on the NetWorker server. Not supported for an HTTP-POST request. namespace (optional) String Specifies the file index namespace from which to recover the files.
Enum: backup archive bbb
NDMPOptions (optional) RecoverNDMPOptions links (optional) array[Link] Specifies a link to the recovery job. resourceId (optional) ResourceId
RecoverBackupInstance - Up
Specifies the backup instance ID and optional clone ID to identify the backup for recovery. backupID (optional) String Specifies the instance backup ID, as either a long ID or short ID. For the HTTP-POST request, the instance backup ID can be retrieved from URI /global/backups. instanceID (optional) String Specifies the instance ID. For the HTTP-POST request, the instance ID can be retrieved from URI /global/backups.
RecoverList - Up
NetWorker 18.2 REST API Reference Guide 349
count (optional) Integer format: int32 recovers (optional) array[Recover]
RecoverNDMPOptions - Up
Supported for NDMP recovery only. verifyIndexDB (optional) Boolean Specifies to not verify the existence of files in the index database. By default, the files are verified in the index database prior to recovery. useIPv4 (optional) Boolean Specifies to use the IPv4 addresses for the NDMP data connection during recovery.
ResourceId - Up
id (optional) String sequence (optional) Long format: int64
Rule - Up
dataSourceType (optional) String
Enum: VMware MSSQL
comment (optional) String definitions (optional) array[RuleItemDefinition] links (optional) array[Link] name (optional) String matchType (optional) String
Enum: All Any
resourceId (optional) ResourceId
RuleItemDefinition - Up
operator (optional) String
NetWorker 18.2 REST API Reference Guide 350
Enum: Equals DoesNotEquals Contains DoesNotContains StartsWith DoesNotStartsWith EndsWith DoesNotEndsWith RegExp
property (optional) String
Enum: Name Path Tag
type (optional) String
Enum: VirtualMachine Cluster vApp VmFolder Datacenter ResourcePool Database
value (optional) String
RuleList - Up
count (optional) Integer format: int32 links (optional) array[Link] rules (optional) array[Rule]
ServerConfiguration - Up
acceptNewRecoverSessions (optional) Boolean acceptNewSessions (optional) Boolean aclPassthrough (optional) Boolean administrators (optional) array[String]
NetWorker 18.2 REST API Reference Guide 351
authenticationProxyPort (optional) Integer format: int32 authenticationServiceDatabase (optional) String authenticationServicePort (optional) Integer format: int32 cityOrTown (optional) String clpLicenseServer (optional) String clpLicenseServerPort (optional) Integer format: int32 clpRefresh (optional) String clpSwid (optional) String clpUom (optional) String comment (optional) String company (optional) String contactName (optional) String country (optional) String datazonePassPhrase (optional) String deviceSharingMode (optional) String DeviceSharingMode
Enum: NoSharing MaximalSharing ServerDefault
disableRpsClone (optional) Boolean emailAddress (optional) String fax (optional) String jobInactivityTimeout (optional) Integer format: int32 jobsdbRetentionInHours (optional) Integer format: int32 keepIncompleteBackups (optional) Boolean licenseServers (optional) array[String]
NetWorker 18.2 REST API Reference Guide 352
manualSaves (optional) Boolean name (optional) String nasDevicePolicyAllowed (optional) Boolean parallelism (optional) Integer format: int32 phone (optional) String productSerialNumber (optional) String publicArchives (optional) Boolean purchaseDate (optional) String resourceId (optional) ResourceId saveSessionDistribution (optional) String SaveSessionDistribution
Enum: MaxSessions TargetSessions
serverOSType (optional) String serverTimezone (optional) String siteId (optional) String solutionId (optional) String stateOrProvince (optional) String streetAddress (optional) String supportEmailAddress (optional) String vmwarePolicyAllowed (optional) Boolean vmwsEnable (optional) Boolean vmwsPort (optional) Integer format: int32 vmwsUserName (optional) String vmwsUserPassword (optional) String volumePriority (optional)
NetWorker 18.2 REST API Reference Guide 353
String VolumePriority Enum:
NearLinePriority SmartMediaPriority
wormPoolsOnlyHoldWormTapes (optional) Boolean wormTapesOnlyInWormPools (optional) Boolean zipOrPostalCode (optional) String
ServerMessage - Up
category (optional) String id (optional) String message (optional) String priority (optional) String source (optional) String timestamp (optional) Date format: date-time
ServerMessageList - Up
count (optional) Integer format: int32 links (optional) array[Link] serverMessages (optional) array[ServerMessage]
ServerStatistics - Up
badRecovers (optional) Long format: int64 badSaves (optional) Long format: int64 currentRecovers (optional) Long format: int64 currentSaves (optional) Long format: int64 links (optional) array[Link] maxRecovers (optional)
NetWorker 18.2 REST API Reference Guide 354
Long format: int64 maxSaves (optional) Long format: int64 recoverSize (optional) Size recovers (optional) Long format: int64 saveSize (optional) Size saves (optional) Long format: int64 upSince (optional) Date format: date-time version (optional) String
Session - Up
clientHostname (optional) String completed (optional) Boolean compressionRatio (optional) BigDecimal format: int64 device (optional) String deviceFamily (optional) String DeviceFamily
Enum: Tape Disk Cloud Logical
deviceType (optional) String DeviceType
Enum: Data Domain DD Cloud Tier protectpoint objstr Atmos COS adv_file Cloud Boost file logical Auto Detected LTO Ultrium-8 LTO Ultrium-7
NetWorker 18.2 REST API Reference Guide 355
LTO Ultrium-6 LTO Ultrium-5 LTO Ultrium-4 LTO Ultrium-3 LTO Ultrium-2 LTO Ultrium LTO Accelis TS1140 TS1130 TS1120 T10000D T10000C T10000B T10000 9940B 9940 9840D 9840C 9840b 9840 9490 4890 3592 3590 3570 3480 optical dtf2 dtf dst dst (NT) VXA-320 VXA-172 VXA-2 VXA sdlt600 sdlt320 sdlt dlt-v4 dlt-s4 dlt 20GB dlt vs160 dlt8000 dlt7000 dlt1 dlt tzs20 tz90
NetWorker 18.2 REST API Reference Guide 356
tz89 tz88 tz87 tz86 tz85 tkz90 tk70 tk50 4mm DAT160 4mm DAT72 4mm 20GB 4mm 12GB 4mm 8GB 4mm 4GB 4mm 8mm Mammoth-3 8mm Mammoth-2 SAIT-2 SAIT-1 8mm AIT-5 8mm AIT-4 8mm AIT-3 8mm AIT-2 8mm AIT 8mm 20GB 8mm 7GB 8mm 5GB 8mm SD3 SLR qic travan10 generic256 generic128 generic CentricStor vhs himt
endTime (optional) Date format: date-time extendedInformation (optional) String id (optional) Integer itemIdLong (optional) Long format: int64 jobId (optional) Long format: int64
NetWorker 18.2 REST API Reference Guide 357
links (optional) array[Link] mode (optional) String Mode
Enum: Unknown Saving Recovering Browsing
pool (optional) String protectionGroup (optional) String rootJobId (optional) Long format: int64 saveSet (optional) String saveSetId (optional) String size (optional) Size startTime (optional) Date format: date-time stopped (optional) Boolean tenant (optional) String totalRecoverSize (optional) Size totalRecoverVolumesNeeded (optional) Long format: int64 transferRate (optional) BitRate volume (optional) String
SessionList - Up
count (optional) Integer format: int32 links (optional) array[Link] sessions (optional) array[Session]
Size - Up
unit (optional)
NetWorker 18.2 REST API Reference Guide 358
String Unit Enum:
Byte KB
value (optional) Long format: int64
StorageNode - Up
aftdAllowedDirectories (optional) array[String] cloneStorageNodes (optional) array[String] comment (optional) String configuredDevices (optional) array[String] configuredLibraries (optional) array[String] configuredLibraryTypes (optional) array[String] configuredSilos (optional) array[String] configuredSiloTypes (optional) array[String] daemonVersions (optional) array[String] dateOfLastScan (optional) Date format: date-time dateOfRegistration (optional) Date format: date-time dedicatedStorageNode (optional) Boolean deviceSharingMode (optional) String DeviceSharingMode
Enum: NoSharing MaximalSharing ServerDefault
dynamicNsrmmds (optional) Boolean enabled (optional) Boolean lastErrorMessages (optional) array[String] lastErrorNumber (optional) Integer format: int32 links (optional)
NetWorker 18.2 REST API Reference Guide 359
array[Link] maxActiveDevices (optional) Integer format: int32 name (optional) String numberOfDevices (optional) Integer format: int32 numberOfLibraries (optional) Integer format: int32 password (optional) String ready (optional) Boolean remoteUser (optional) String resourceId (optional) ResourceId searchAllLuns (optional) Boolean sharedDeviceCreation (optional) Boolean skipScsiTargets (optional) Boolean storageNodeIsConfigured (optional) Boolean tenant (optional) String typeOfStorageNode (optional) String TypeOfStorageNode
Enum: SCSI NDMP SILO
usePersistentNames (optional) Boolean version (optional) String
StorageNodeList - Up
count (optional) Integer format: int32 links (optional) array[Link] storageNodes (optional) array[StorageNode]
Tenant - Up
NetWorker 18.2 REST API Reference Guide 360
clientHostnames (optional) array[String] comment (optional) String devices (optional) array[String] directives (optional) array[String] externalRoles (optional) array[String] jukeboxes (optional) array[String] labels (optional) array[String] links (optional) array[Link] name (optional) String numberOfClients (optional) Integer format: int32 numberOfDevices (optional) Integer format: int32 numberOfJukeboxes (optional) Integer format: int32 numberOfStorageNodes (optional) Integer format: int32 pools (optional) array[String] privileges (optional) array[String]
Enum: protectionGroups (optional) array[String] protectionPolicies (optional) array[String] recovers (optional) array[String] resourceId (optional) ResourceId storageNodes (optional) array[String] users (optional) array[String]
TenantList - Up
count (optional) Integer format: int32
NetWorker 18.2 REST API Reference Guide 361
links (optional) array[Link] tenants (optional) array[Tenant]
TimeStampBasedGranularRecover - Up
Specifies the source client resource ID and timestamp to identify the backup for recovery. sourceClientResID (optional) String Specifies the resource ID to uniquely identify the source client. timeStamp (optional) String Specifies the backup savetime in the format yyyy-mm-ddThh:mm:ssXXX (2017-10-07T21:00:13+05:30) or in epoch time format (1507237222).
UserGroup - Up
comment (optional) String externalRoles (optional) array[String] links (optional) array[Link] name (optional) String privileges (optional) array[String]
Enum: resourceId (optional) ResourceId users (optional) array[String]
UserGroupList - Up
count (optional) Integer format: int32 links (optional) array[Link] userGroups (optional) array[UserGroup]
VCenter - Up
cloudDeployment (optional) Boolean comment (optional) String hostname (optional)
NetWorker 18.2 REST API Reference Guide 362
String links (optional) array[Link] resourceId (optional) ResourceId userName (optional) String userPassword (optional) String
VCenterList - Up
count (optional) Integer links (optional) array[Link] vCenters (optional) array[VCenter]
VCenterPlugin - Up
pluginType (optional) String Specifies the type of plugin to install.
Enum: VC EBR
nwUserId (optional) String Specifies the NetWorker adminstrator username used to connect to VC or EBR REST API's. nwPassword (optional) String Specifies the NetWorker administrator password used to connect to VC or EBR REST API's. httpsPort (optional) Integer Specifies the vCenter https port number, the default value is 443. httpPort (optional) Integer Specifies the vCenter http port number, the default value is 80. authcIp (optional) String Specifies the authc ip or hostname. authcPort (optional) Integer Specifies the authc port number.
VMwareApplicationRecoverSavesetInfo - Up
applicationData (optional) String backupId (optional) String instanceId (optional)
NetWorker 18.2 REST API Reference Guide 363
String
VMwareProtectedVm - Up
hasAppConsistencyBackup (optional) Boolean hostname (optional) String ipAddress (optional) String links (optional) array[Link] morefId (optional) String name (optional) String osId (optional) String osName (optional) String uuid (optional) String vCenterHostname (optional) String version (optional) String
VMwareProtectedVmList - Up
count (optional) Integer links (optional) array[Link] vms (optional) array[VMwareProtectedVm]
VMwareVm - Up
annotation (optional) String connectionState (optional) String hostname (optional) String ipAddress (optional) String ipAddresses (optional) array[String]
NetWorker 18.2 REST API Reference Guide 364
links (optional) array[Link] morefId (optional) String name (optional) String osId (optional) String osName (optional) String powerState (optional) String state (optional) String status (optional) String type (optional) String uuid (optional) String vCenterHostname (optional) String version (optional) String
VMwareVmBackupInfo - Up
datastoreMoref (optional) String disks (optional) array[VMwareVmdkBackupInfo] hostMoref (optional) String morefPath (optional) String vCenterHostname (optional) String vmMoref (optional) String vmName (optional) String
VMwareVmEmergencyRecoverCleanupOptions - Up
Mandatory when recoverMode is set to Emergency. Not supported otherwise. Specifies the options for cleaning up ESX, proxy, and client resources at the end of the emergency recovery. deleteEsxClient (optional)
NetWorker 18.2 REST API Reference Guide 365
Boolean Specifies whether the ESX client must be deleted at the end of emergency recovery. deleteEsxHypervisor (optional) Boolean Specifies whether the ESX hypervisor resource must be deleted at the end of emergency recovery. deleteVproxy (optional) Boolean Specifies whether the vProxy resource must be deleted at the end of emergency recovery. vCenterHostnameForVproxy (optional) String Specifies the vCenter to which the vProxy must be associated to at the end of emergency recovery. Used only if the deleteVproxy option is unset or set to false.
VMwareVmFlrOptions - Up
Mandatory when recoverMode is set to FLR. Not supported otherwise. Specifies the target guest VM where the application recovery will be performed. recoveryDestination (optional) String Specifies the destination on the target VM to which the recovered files will be copied. elevateUser (optional) String Specifies whether the recover has to be performed with elevated(administrator) authority. itemsToRecover (optional) array[String] Specifies the list of items to be recovered. terminateMountSession (optional) Boolean Specifies whether the mount session should be terminated at the end of recovery. overwrite (optional) Boolean Specifies whether the files should be forcefully overwritten if they are present in the destination directory.
VMwareVmGuestInfo - Up
Mandatory when recoverMode is set to Application. Not supported otherwise. Specifies the target guest VM where the application recovery will be performed. installAppAgent (optional) Boolean targetVmAdminUserId (optional) String targetVmAdminUserPassword (optional) String targetVmUserId (optional) String targetVmUserPassword (optional) String uninstallAppAgent (optional) Boolean
NetWorker 18.2 REST API Reference Guide 366
VMwareVmList - Up
count (optional) Integer links (optional) array[Link] vms (optional) array[VMwareVm]
VMwareVmOpBackup - Up
policy (optional) String workflow (optional) String
VMwareVmOpRecover - Up
applicationData (optional) String Optional when recoverMode is set to Application. Not supported otherwise. Specifies the JSON data to be passed to application agent for restore. applicationName (optional) String Mandatory when recoverMode is set to Application. Not supported otherwise. Specifies the application name to be restored. applicationRestoreSavesets (optional) array[VMwareApplicationRecoverSavesetInfo] Optional when recoverMode is set to Application. Not supported otherwise. Speicifies the list of savesets to be restored in sequence. clusterComputeResourceMoref (optional) String Optional when recoverMode is set to New or Instant. Not supported otherwise. Either clusterComputeResourceMoref or computeResourceMoref needs to be set to specify which host or cluster under which the VM will be restored. computeResourceMoref (optional) String Optional when recoverMode is set to New or Instant. Not supported otherwise. Either clusterComputeResourceMoref or computeResourceMoref needs to be set to specify which host or cluster under which the VM will be restored. datacenterMoref (optional) String Mandatory when recoverMode is set to New or Instant. Not supported otherwise. Specifies to which datacenter the VM is restored. datastoreMoref (optional) String Mandatory when recoverMode is set to New or Emergency. Not supported otherwise. Specifies to which datastore VM files are restored. debugLevel (optional) Integer Specifies the debug level to be used during resore. deleteExistingBackingFile (optional)
NetWorker 18.2 REST API Reference Guide 367
Boolean Mandatory when recoverMode is set to Revert and also when the configuration recovery is also set. Not supported otherwise. Specifies whether the existing disk will be deleted in case of disk configuration mismatch. disks (optional) array[VMwareVmdkRecoverInfo] Mandatory when recoverMode is set to New or Disk or Emergency. Optional when recover mode is set to Revert. Not supported otherwise. Speicifies which disks will be restored and to which datastore. If not set and recoverMode is set to Revert, then all disks will be reverted. hostMoref (optional) String Optional when recoverMode is set to New or Instant. Not supported otherwise. Specifies which host the VM is restored to. Not required when restoring to a DRS-enabled clusters. jobName (optional) String Optional for all recoverMode values. Specifies the name of the job that will be created. mountJobId (optional) String Mandatory when recoverMode is set to Application. Not supported otherwise. Specifies the mount job ID to be used by the restore session. powerOn (optional) Boolean Mandatory when recoverMode is set to Revert, Instant, New, Disk or Emergency. Not supported otherwise. Specifies whether to power on the VM at the end of the restore. reconnectNic (optional) Boolean Mandatory when recoverMode is set to Revert, Instant, New, Disk or Emergency. Not supported otherwise. Specifies whether to reconnect the NIC of the VM at the end of the restore. recoverMode (optional) String Required. Specifies the type of the restore.
Enum: Revert Instant New Disk Application FLR Emergency
resourcePoolMoref (optional) String Optional when recoverMode is set to New or Instant. Not supported otherwise. Specifies the resource pool to which the VM will be restored. revertConfiguration (optional) Boolean Mandatory when recoverMode is set to Revert. Not supported otherwise. Specifies whether to revert the VM configuration. stagingPool (optional) String Optional for all recoverMode values. Specifies which staging pool to use on the DD device when restoring from a clone. vCenterHostname (optional)
NetWorker 18.2 REST API Reference Guide 368
String Mandatory when recoverMode is set to New, Instant, Disk or Emergency. Not supported otherwise. Specifies to which vCenter/ESX the VM or disk is restored. vmEmergencyRecoverCleanupOptions (optional) VMwareVmEmergencyRecoverCleanupOptions vmFolderMoref (optional) String Required when recoverMode is set to New. Not supported otherwise. Specifies the VM folder under which the VM will be recovered. vmGuestLogin (optional) VMwareVmGuestInfo vmMoref (optional) String Mandatory when recoverMode is set to Disk or Application. Not supported otherwise. Specifies to which VM the restored disk will be attached. vmName (optional) String Mandatory when recoverMode is set to New, Instant, Disk, Application or Emergency. Not supported otherwise. Specifies either the restored VM name or, when recoverMode is Disk or Application, the existing VM name to which the restored disk will be attached. vmwareVmFlrOptions (optional) VMwareVmFlrOptions vProxyHostname (optional) String Mandatory when recoverMode is set to Emergency. Optional when recoverMode is set to Revert, New, Instant, Disk, or Application. Not supported otherwise. Specifies the vProxy to be used for recovery.
VMwareVmProtectionDetail - Up
protectionGroup (optional) ProtectionGroup protectionPolicy (optional) Policy workflow (optional) PolicyWorkflow
VMwareVmProtectionDetailList - Up
count (optional) Integer links (optional) array[Link] protectionDetails (optional) array[VMwareVmProtectionDetail]
VMwareVmdkBackupInfo - Up
datastoreMoref (optional) String datastoreName (optional)
NetWorker 18.2 REST API Reference Guide 369
String key (optional) String name (optional) String sizeInKb (optional) Integer thinProvisioned (optional) Boolean
VMwareVmdkRecoverInfo - Up
datastoreMoref (optional) String Required. The destination datastore for this disk. key (optional) String Required. The key of the disk, can be retrieved from the vmInformation property of a backup. name (optional) String Mandatory. Specifies the name of the disk, which can be retrieved from the vmInformation property of a backup.
VMwareVmdkWorkItem - Up
vmUuid (optional) String vmdkUuid (optional) String
VMwareWorkItemOpUpdate - Up
addWorkItems (optional) VMwareWorkItemSelection deleteWorkItems (optional) VMwareWorkItemSelection
VMwareWorkItemSelection - Up
vCenterHostname (optional) String containerMorefs (optional) array[String] vmUuids (optional) array[String] vmdks (optional) array[VMwareVmdkWorkItem]
VProxy - Up
comment (optional)
NetWorker 18.2 REST API Reference Guide 370
String datastores (optional) array[String] enabled (optional) Boolean encryptNbdSessions (optional) Boolean forceRegister (optional) Boolean hostname (optional) String links (optional) array[Link] maxHotaddDisks (optional) Integer maxHotaddSessions (optional) Integer maxNbdSessions (optional) Integer password (optional) String resourceId (optional) ResourceId userName (optional) String version (optional) String vCenterHostname (optional) String vProxyPort (optional) Integer
VProxyList - Up
count (optional) Integer links (optional) array[Link] vProxies (optional) array[VProxy]
VProxyVmBrowseSessionPutOrPostResponse - Up
config (optional) VProxyVmBrowseSessionResponseConfig status (optional) VProxyVmBrowseSessionResponseStatus
NetWorker 18.2 REST API Reference Guide 371
VProxyVmBrowseSessionRequest - Up
currentWorkingDirectory (optional) String Specifies the path relative to the mount point or absolute path within the mounted backup location. idleTimeout (optional) Integer Idle timeout in seconds for the browse session. cacheRetentionSeconds (optional) Integer The time in seconds after which cached contents of the currentWorkingDirectory will be considered stale. browseDestination (optional) Boolean Specifies whether the destination VM should be browsed, the default value is false. osType (optional) String Specifies the destination VM OS type.
Enum: Windows Linux
elevateUser (optional) Boolean Specifies whether the browse has to be performed with elevated(administrator) authority.
VProxyVmBrowseSessionResponse - Up
config (optional) VProxyVmBrowseSessionResponseConfig status (optional) VProxyVmBrowseSessionResponseStatus links (optional) array[Link]
VProxyVmBrowseSessionResponseConfig - Up
sessionId (optional) String Browse session identifier. currentWorkingDirectory (optional) String Specifies the path relative to the mount point or absolute path within the mounted backup location. idleTimeout (optional) Integer Idle timeout in seconds for the browse session. cacheRetentionSeconds (optional) Integer The time in seconds after which cached contents of the currentWorkingDirectory will be considered stale. browseDestination (optional) Boolean Specifies whether the destination VM should be browsed.
VProxyVmBrowseSessionResponseList - Up
count (optional)
NetWorker 18.2 REST API Reference Guide 372
Integer links (optional) array[Link] sessions (optional) array[VProxyVmBrowseSessionResponse]
VProxyVmBrowseSessionResponseStatus - Up
state (optional) String Status of browse session whose value shall be Queued, Running, Success, Failure, or Cancelled. description (optional) String Status description of browse session.
VProxyVmMountSessionResponse - Up
config (optional) VProxyVmMountSessionResponseConfig status (optional) VProxyVmMountSessionResponseStatus links (optional) array[Link]
VProxyVmMountSessionResponseConfig - Up
mountPointPath (optional) String Mount point path of the mounted session. idleTimeout (optional) Integer Idle timeout of the mounted session.
VProxyVmMountSessionResponseStatus - Up
state (optional) String Status of mounted session. description (optional) String Status description of mounted session.
Volume - Up
accessTime (optional) Date format: date-time availabilityFlags (optional) array[String] Availability Flags
Enum: barcode (optional) String capacity (optional) Size expirationTime (optional)
NetWorker 18.2 REST API Reference Guide 373
Date format: date-time family (optional) String flags (optional) array[String] Flags
Enum: id (optional) String latestLabelTime (optional) Date format: date-time links (optional) array[Link] location (optional) String mounts (optional) Long format: int64 name (optional) String originalLabelTime (optional) Date format: date-time pool (optional) String recover (optional) Size recycled (optional) Long format: int64 saveSetExpirationTime (optional) Date format: date-time saveSetIds (optional) array[String] states (optional) array[String]
Enum: tenant (optional) String type (optional) String written (optional) Size
VolumeList - Up
count (optional) Integer format: int32 links (optional) array[Link] volumes (optional) array[Volume]
NetWorker 18.2 REST API Reference Guide 374
XmlError - Up
Specifies the error object. text (optional) String Error message that appeared while retrieving the content of the session. code (optional) Integer Error code that appeared while retrieving the content of the session.
XmlFile - Up
fileName (optional) String Name of the file. fileType (optional) String File type value that can be file, directory, or symlink. fileSize (optional) Integer Size of the file in bytes. fileModificationTime (optional) String Time when the file was last modified.
XmlVmBrowseDirectoryContents - Up
error (optional) XmlError noMoreData (optional) Boolean Specifies whether additional data exists. The value true indicates that no additional data is available. totalObjects (optional) Integer The total number of objects that can be retrieved by using the GET contents action. freeSpace (optional) Integer Available free space in the current working directory. fileList (optional)
Related manuals for Dell NetWorker 18.2 Software REST API Reference Guide
Manualsnet FAQs
If you want to find out how the 18.2 Dell works, you can view and download the Dell NetWorker 18.2 Software REST API Reference Guide on the Manualsnet website.
Yes, we have the REST API Reference Guide for Dell 18.2 as well as other Dell manuals. All you need to do is to use our search bar and find the user manual that you are looking for.
The REST API Reference Guide should include all the details that are needed to use a Dell 18.2. Full manuals and user guide PDFs can be downloaded from Manualsnet.com.
The best way to navigate the Dell NetWorker 18.2 Software REST API Reference Guide is by checking the Table of Contents at the top of the page where available. This allows you to navigate a manual by jumping to the section you are looking for.
This Dell NetWorker 18.2 Software REST API Reference Guide consists of sections like Table of Contents, to name a few. For easier navigation, use the Table of Contents in the upper left corner.
You can download Dell NetWorker 18.2 Software REST API Reference Guide free of charge simply by clicking the “download” button in the upper right corner of any manuals page. This feature allows you to download any manual in a couple of seconds and is generally in PDF format. You can also save a manual for later by adding it to your saved documents in the user profile.
To be able to print Dell NetWorker 18.2 Software REST API Reference Guide, simply download the document to your computer. Once downloaded, open the PDF file and print the Dell NetWorker 18.2 Software REST API Reference Guide as you would any other document. This can usually be achieved by clicking on “File” and then “Print” from the menu bar.