Dell NetWorker 18.1 Software REST API Reference Guide PDF
Summary of Content for Dell NetWorker 18.1 Software REST API Reference Guide PDF
Dell EMC NetWorker Version 18.1
REST API Reference Guide 302-004-433
REV 01
Copyright 1990-2018 Dell Inc. or its subsidiaries All rights reserved.
Published August, 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, 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.1 REST API Reference Guide
Preface
As part of an effort to improve product lines, periodic revisions of software and hardware are released. Therefore, all versions of the software or hardware currently in use might not support some functions that are described in this document. The product release notes provide the most up-to-date information on product features.
If a product does not function correctly or does not function as described in this document, contact a technical support professional.
Note
This document was accurate at publication time. To ensure that you are using the latest version of this document, go to the Support website at https:// support.emc.com.
Purpose This document describes how to install and remove the NetWorker software.
Audience This document is part of the NetWorker documentation set and is intended for use by system administrators during the installation and setup of the NetWorker software.
Revision history The following table presents the revision history of this document.
Table 1 Revision history
Revision Date Description
01 August 17, 2018 First release of this document for NetWorker 18.1 .
Related documentation The NetWorker documentation set includes the following publications, available on the Support website:
l NetWorker Online Software Compatibility Matrix Provides compatibility information, including specific software and hardware configurations that NetWorker supports. To access the matrix, go to http:// compatibilityguide.emc.com:8080/CompGuideApp/.
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.
NetWorker 18.1 REST API Reference Guide 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.1 with CloudBoost 18.1 Integration Guide Describes the integration of NetWorker with CloudBoost.
l NetWorker 18.1 with CloudBoost 18.1 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.1 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://support.emc.com l https://community.emc.com
Where to get support The Support website at https://support.emc.com provides access to licensing information, product documentation, advisories, and downloads, as well as how-to and
Preface
NetWorker 18.1 REST API Reference Guide 5
troubleshooting information. This information may enable you to resolve a product issue before you contact Support.
To access a product specific Support page:
1. Go to https://support.emc.com/products.
2. In the Find a Product by Name box, type a product name, and then select the product from the list that appears.
3. Click .
4. (Optional) To add the product to My Saved Products, in the product specific page, click Add to My Saved Products.
Knowledgebase The Knowledgebase contains applicable solutions that you can search for by solution number, for example, 123456, or by keyword.
To search the Knowledgebase:
1. Go to https://support.emc.com.
2. Click Advanced Search. The screen refreshes and filter options appear.
3. In the Search Support or Find Service Request by Number box, type a solution number or keywords.
4. (Optional) To limit the search to specific products, type a product name in the Scope by product box, and then select the product from the list that appears.
5. In the Scope by resource list box, select Knowledgebase. The Knowledgebase Advanced Search panel appears.
6. (Optional) Specify other filters or advanced options.
7. Click .
Live chat To participate in a live interactive chat with a support agent:
1. Go to https://support.emc.com.
2. Click Chat with Support.
Service requests To obtain in-depth help from Licensing, submit a service request. To submit a service request:
1. Go to https://support.emc.com.
2. Click Create a Service Request.
Note
To create a service request, you must have a valid support agreement. Contact a sales representative for details about obtaining a valid support agreement or with questions about an account. If you know the service request number, then directly enter the service request number in the Service Request field to get the valid details.
To review an open service request:
1. Go to https://support.emc.com.
2. Click Manage service requests.
Preface
6 NetWorker 18.1 REST API Reference Guide
Online communities Go to the Community Network at https://community.emc.com for peer contacts, conversations, and content on product support and solutions. Interactively engage online with customers, partners, and certified professionals for all products.
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
NetWorker 18.1 REST API Reference Guide 7
NetWorker REST API RESOURCE REFERENCE
Overview
The NetWorker REST API is exposed in the following base URI: https://{nw-server-hostname}:9090/nwrestapi/v3 There is one URI groups: {baseuri}/global For example, to access a single Client resource: https://{nw-server-hostname}:9090/nwrestapi/v3/global/{id} The client {id} corresponds to the ResourceId attribute.
Version: 18.1.0 Copyright (c) 2018 EMC Corporation https://www.dellemc.com
Methods
[ Jump to Models ]
Table of Contents
1. GET /alerts
2. GET /auditlogconfig
3. PUT /auditlogconfig
4. GET /backups
5. GET /backups/{backupId}
6. DELETE /backups/{backupId}
7. GET /backups/{backupId}/instances
8. GET /backups/{backupId}/instances/{instanceId}
9. DELETE /backups/{backupId}/instances/{instanceId}
10. GET /clients
11. POST /clients
12. GET /clients/{clientId}
13. PUT /clients/{clientId}
14. DELETE /clients/{clientId}
15. GET /clients/{clientId}/backups
16. GET /clients/{clientId}/backups/{backupId}
17. GET /clients/{clientId}/backups/{backupId}/instances
18. GET /clients/{clientId}/backups/{backupId}/instances/{instanceId}
19. GET /clients/{clientId}/indexes
20. POST /clients/{clientId}/op/backup
21. GET /cloudboostappliances
22. GET /cloudboostappliances/{cloudboostapplianceId}
23. GET /devices
24. POST /devices
25. GET /devices/{deviceId}
26. PUT /devices/{deviceId}
27. DELETE /devices/{deviceId}
28. POST /devices/{deviceId}/op/label
29. POST /devices/{deviceId}/op/mount
30. POST /devices/{deviceId}/op/unmount
31. POST /devices/{deviceId}/op/verifylabel
32. GET /devices/{deviceId}/opstatus
33. GET /directives
34. POST /directives
35. GET /directives/{directiveId}
36. PUT /directives/{directiveId}
37. DELETE /directives/{directiveId}
38. GET /jobgroups
39. GET /jobgroups/{jobGroupId}
40. GET /jobindications
41. GET /jobs
42. GET /jobs/{jobId}
43. GET /jobs/{jobId}/log
44. POST /jobs/{jobId}/op/cancel
45. GET /labels
46. POST /labels
47. GET /labels/{labelId}
48. PUT /labels/{labelId}
49. DELETE /labels/{labelId}
50. GET /licenses
51. GET /licenses/{licenseId}
52. GET /notifications
53. POST /notifications
54. GET /notifications/{notificationId}
55. PUT /notifications/{notificationId}
56. DELETE /notifications/{notificationId}
57. GET /pools
58. POST /pools
59. GET /pools/{poolId}
60. PUT /pools/{poolId}
61. DELETE /pools/{poolId}
62. GET /probes
63. POST /probes
64. GET /probes/{probeId}
65. PUT /probes/{probeId}
66. DELETE /probes/{probeId}
67. GET /protectiongroups
68. POST /protectiongroups
69. GET /protectiongroups/{protectionGroupId}
70. PUT /protectiongroups/{protectionGroupId}
71. DELETE /protectiongroups/{protectionGroupId}
72. POST /protectiongroups/{protectionGroupId}/op/updatevmwareworkitems
73. GET /protectionpolicies
74. POST /protectionpolicies
75. GET /protectionpolicies/{policyId}
76. PUT /protectionpolicies/{policyId}
77. DELETE /protectionpolicies/{policyId}
78. GET /protectionpolicies/{policyId}/jobgroups
79. GET /protectionpolicies/{policyId}/jobgroups/{jobGroupId}
80. GET /protectionpolicies/{policyId}/workflows
81. POST /protectionpolicies/{policyId}/workflows
82. GET /protectionpolicies/{policyId}/workflows/{workflowId}
83. PUT /protectionpolicies/{policyId}/workflows/{workflowId}
84. DELETE /protectionpolicies/{policyId}/workflows/{workflowId}
85. GET /protectionpolicies/{policyId}/workflows/{workflowId}/jobgroups
86. GET /protectionpolicies/{policyId}/workflows/{workflowId}/jobgroups/{j
obGroupId}
87. POST /protectionpolicies/{policyId}/workflows/{workflowId}/op/backup
88. GET /recovers
89. POST /recovers
90. GET /recovers/{recoverId}
91. DELETE /recovers/{recoverId}
92. GET /rules
93. POST /rules
94. GET /rules/{ruleName}
95. PUT /rules/{ruleName}
96. DELETE /rules/{ruleName}
97. GET /serverconfig
98. PUT /serverconfig
99. GET /servermessages
100. GET /serverstatistics
101. GET /sessions
102. GET /sessions/{sessionId}
103. POST /sessions/{sessionId}/op/cancel
104. GET /storagenodes
105. POST /storagenodes
106. GET /storagenodes/{storageNodeId}
107. PUT /storagenodes/{storageNodeId}
108. DELETE /storagenodes/{storageNodeId}
109. GET /tenants
110. POST /tenants
111. GET /tenants/{tenantId}
112. PUT /tenants/{tenantId}
113. DELETE /tenants/{tenantId}
114. GET /usergroups
115. POST /usergroups
116. GET /usergroups/{userGroupId}
117. PUT /usergroups/{userGroupId}
118. DELETE /usergroups/{userGroupId}
119. POST /vmware/op/refreshvcenters
120. GET /vmware/protectedvms
121. GET /vmware/vcenters
122. POST /vmware/vcenters
123. GET /vmware/vcenters/{vcenter-hostname}
124. PUT /vmware/vcenters/{vcenter-hostname}
125. DELETE /vmware/vcenters/{vcenter-hostname}
126. POST /vmware/vcenters/{vcenter-hostname}/op/refresh
127. POST /vmware/vcenters/{vcenter-hostname}/plugins
128. GET /vmware/vcenters/{vcenter-hostname}/protectedvms
129. GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}
130. GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups
131. GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/instances
132. POST /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/instances/{instance-id}/op/inspectbackup
133. POST /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/instances/{instance-id}/op/recover
134. POST /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/instances/{instance-id}/op/vmmount
135. GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/instances/{instance-
id}/op/vmmount/{vproxy-mount-session-id}
136. GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/instances/{instance-
id}/op/vmmount/{vproxy-mount-session-id}/vmbrowse
137. POST /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/instances/{instance-
id}/op/vmmount/{vproxy-mount-session-id}/vmbrowse
138. 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}
139. 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}
140. 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}
141. 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
142. POST /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/op/inspectbackup
143. POST /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/op/recover
144. POST /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/op/vmmount
145. GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/op/vmmount/{vproxy-mount-session-id}
146. GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/op/vmmount/{vproxy-mount-session-
id}/vmbrowse
147. POST /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/op/vmmount/{vproxy-mount-session-
id}/vmbrowse
148. GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/op/vmmount/{vproxy-mount-session-
id}/vmbrowse/{vproxy-browse-session-id}
149. PUT /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/op/vmmount/{vproxy-mount-session-
id}/vmbrowse/{vproxy-browse-session-id}
150. DELETE /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/op/vmmount/{vproxy-mount-session-
id}/vmbrowse/{vproxy-browse-session-id}
151. GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/op/vmmount/{vproxy-mount-session-
id}/vmbrowse/{vproxy-browse-session-id}/contents
152. GET /vmware/vcenters/{vcenter-hostname}/vms
153. GET /vmware/vcenters/{vcenter-hostname}/vms/{vm-uuid}
154. POST /vmware/vcenters/{vcenter-hostname}/vms/{vm-
uuid}/op/backup
155. GET /vmware/vcenters/{vcenter-hostname}/vms/{vm-
uuid}/protectiondetails
156. GET /vmware/vms
157. GET /vmware/vproxies
158. POST /vmware/vproxies
159. POST /vmware/vproxies/op/register
160. GET /vmware/vproxies/{vproxy-hostname}
161. PUT /vmware/vproxies/{vproxy-hostname}
162. DELETE /vmware/vproxies/{vproxy-hostname}
163. GET /volumes
164. GET /volumes/{volumeId}
165. DELETE /volumes/{volumeId}
GET /alerts
Returns the most recent alert messages
Return type AlertList 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
GET /auditlogconfig
Returns the security audit log settings
Return type AuditLogConfiguration 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
PUT /auditlogconfig
Updates the security audit log settings
Request body auditLogConfig (optional)
Body Parameter Audit log settings for update
Responses 204 Resource was updated successfully
GET /backups
Returns a list of all backups.
Return type BackupList 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
GET /backups/{backupId}
Returns a single backup
Path parameters backupId (required)
Path Parameter ID of Backup
Return type Backup Responses 200 Resource was retrieved successfully
DELETE /backups/{backupId}
Deletes a single backup
Path parameters backupId (required)
Path Parameter ID of 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 204 Resource was deleted successfully
GET /backups/{backupId}/instances
Return a list of backup instances
Path parameters backupId (required)
Path Parameter ID of Backup
Return type BackupInstanceList 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
GET /backups/{backupId}/instances/{instanceId}
Returns a list of backup instances for a given backup
Path parameters backupId (required)
Path Parameter ID of Backup instanceId (required)
Path Parameter ID of Instance
Return type BackupInstance 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
DELETE /backups/{backupId}/instances/{instanceId}
Deletes a single backup instance
Path parameters
backupId (required) Path Parameter ID of the backup
instanceId (required) Path Parameter ID of instance
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 deleted successfully
GET /clients
Returns a list of all clients
Return type ClientList 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
POST /clients
Creates a new client
Request body client (required)
Body Parameter Client to be created
Responses 201 Resource was created successfully
GET /clients/{clientId}
Returns a single client
Path parameters
clientId (required) Path Parameter Resource ID of the client.
Return type Client Responses 200 Resource was retrieved successfully
PUT /clients/{clientId}
Updates a single client
Path parameters clientId (required)
Path Parameter Resource ID of the client.
Request body client (required)
Body Parameter Client to modify
Responses 204 Resource was updated successfully
DELETE /clients/{clientId}
Deletes a single client
Path parameters clientId (required)
Path Parameter Resource ID of the client.
Responses 204 Resource was deleted successfully
GET /clients/{clientId}/backups
Returns a list of backups for a given client
Path parameters clientId (required)
Path Parameter Resource ID of the client.
Return type BackupList 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
GET /clients/{clientId}/backups/{backupId}
Return a single backup for a given client
Path parameters clientId (required)
Path Parameter Resource ID of the client. backupId (required)
Path Parameter ID of Backup
Return type 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 200 Resource was retrieved successfully
GET /clients/{clientId}/backups/{backupId}/instances
Return a list of backup instances
Path parameters clientId (required)
Path Parameter Resource ID of the client. backupId (required)
Path Parameter ID of Backup
Return type BackupInstanceList 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
GET /clients/{clientId}/backups/{backupId}/instances/{instanceId}
Returns a list of backup instances for a given backup
Path parameters clientId (required)
Path Parameter Resource ID of the client. backupId (required)
Path Parameter ID of Backup instanceId (required)
Path Parameter ID of Backup Instance
Return type BackupInstance 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
GET /clients/{clientId}/indexes
Returns a list of indexes for a given client.
Path parameters clientId (required)
Path Parameter Resource ID of the client.
Return type IndexList 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. 400 Bad request. 401 Unauthorized. 404 Not found. 405 Method not allowed. 500 Internal server error.
POST /clients/{clientId}/op/backup
Backup save sets for a given client
Path parameters clientId (required)
Path Parameter Resource ID of the client.
Request body 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 202 Operation successful
GET /cloudboostappliances
Returns a list of Cloudboost appliances.
Return type CloudboostApplianceList 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. 400 Bad request. 401 Unauthorized. 404 Not found. 405 Method not allowed. 500 Internal server error.
GET /cloudboostappliances/{cloudboostapplianceId}
Returns a single Cloudboost appliances
Path parameters cloudboostapplianceId (required)
Path Parameter ID of Cloudboost appliance
Return type CloudboostAppliance Responses 200 Resource was retrieved successfully 400 Bad request. 401 Unauthorized. 404 Not found. 405 Method not allowed. 500 Internal server error.
GET /devices
Returns a list of devices
Return type DeviceList 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
POST /devices
Creates a new device
Request body 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
GET /devices/{deviceId}
Returns a single device
Path parameters deviceId (required)
Path Parameter ID of the device
Return type 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
PUT /devices/{deviceId}
Updates a single device
Path parameters deviceId (required)
Path Parameter ID of the device
Request body 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 204 Resource was updated successfully
DELETE /devices/{deviceId}
Deletes a single device
Path parameters deviceId (required)
Path Parameter ID of the 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 204 Resource was deleted successfully
POST /devices/{deviceId}/op/label
Creates a label for a device resource
Path parameters deviceId (required)
Path Parameter ID of the device
Request body 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 Operation successful
POST /devices/{deviceId}/op/mount
Mounts a volume into a device
Path parameters deviceId (required)
Path Parameter ID of the device
Request body 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 Operation successful
POST /devices/{deviceId}/op/unmount
Unmounts a volume from a device
Path parameters deviceId (required)
Path Parameter ID of the 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 202 Operation successful
POST /devices/{deviceId}/op/verifylabel
Verifies label in a device. Note: Verifying a label unmounts mounted volumes
Path parameters deviceId (required)
Path Parameter ID of the 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 202 Operation successful
GET /devices/{deviceId}/opstatus
Returns a status of a device
Path parameters deviceId (required)
Path Parameter ID of the device
Return type DeviceOpStatus 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
GET /directives
Returns a list of directives
Return type DirectiveList
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
POST /directives
Creates a new directive
Request body 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
GET /directives/{directiveId}
Returns a single directive
Path parameters directiveId (required)
Path Parameter ID of the directive
Return type 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
PUT /directives/{directiveId}
Updates a single directive
Path parameters directiveId (required)
Path Parameter ID of the directive
Request body 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
DELETE /directives/{directiveId}
Deletes a single directive
Path parameters directiveId (required)
Path Parameter ID of the 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 204 Resource was deleted successfully
GET /jobgroups
Returns a list of job groups
Return type JobList
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
GET /jobgroups/{jobGroupId}
Returns a list of jobs belonging to a job group
Path parameters jobGroupId (required)
Path Parameter ID of the job group
Return type JobList 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
GET /jobindications
Returns a list of job indications
Return type JobIndicationList 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
GET /jobs
Returns a list of jobs
Return type JobList 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
GET /jobs/{jobId}
Returns a single job
Path parameters jobId (required)
Path Parameter ID of the job
Return type Job 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
GET /jobs/{jobId}/log
Returns a log file for a job
Path parameters jobId (required)
Path Parameter ID of the job
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/octet-stream
Responses 200 Resource was retrieved successfully 400 Bad request. 401 Unauthorized. 404 Not found. 405 Method not allowed. 500 Internal server error.
POST /jobs/{jobId}/op/cancel
Cancels a job
Path parameters jobId (required)
Path Parameter ID of the job
Request body 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 Operation successful
GET /labels
Returns a list of labels
Return type LabelList 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
POST /labels
Creates a new label
Request body 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.
application/json
Responses 201 Resource was created successfully
GET /labels/{labelId}
Returns a single label
Path parameters labelId (required)
Path Parameter ID of the label
Return type Label 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
PUT /labels/{labelId}
Updates a single label
Path parameters labelId (required)
Path Parameter ID of the label
Request body 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
DELETE /labels/{labelId}
Deletes a single label
Path parameters labelId (required)
Path Parameter ID of the label
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 deleted successfully
GET /licenses
Returns a list of licenses
Return type LicenseList 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 400 Bad request. 401 Unauthorized. 404 Not found. 405 Method not allowed. 500 Internal server error.
GET /licenses/{licenseId}
Returns a single license
Path parameters licenseId (required)
Path Parameter ID of the license.
Return type License 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 400 Bad request. 401 Unauthorized. 404 Not found. 405 Method not allowed. 500 Internal server error.
GET /notifications
Returns a list of notifications
Return type NotificationList 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
POST /notifications
Creates a new notification
Request body 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
GET /notifications/{notificationId}
Returns a single notification
Path parameters notificationId (required)
Path Parameter ID of the notification
Return type Notification 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
PUT /notifications/{notificationId}
Updates a single notification
Path parameters notificationId (required)
Path Parameter ID of the notification
Request body 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
Responses 204 Resource was updated successfully
DELETE /notifications/{notificationId}
Deletes a single notification
Path parameters notificationId (required)
Path Parameter ID of the notification
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 deleted successfully
GET /pools
Returns a list of media pools
Return type PoolList 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
POST /pools
Creates a new media pool
Request body 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
GET /pools/{poolId}
Returns a single media pool
Path parameters poolId (required)
Path Parameter ID of the media pool
Return type Pool 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
PUT /pools/{poolId}
Updates a single media pool
Path parameters poolId (required)
Path Parameter ID of the media pool
Request body 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
DELETE /pools/{poolId}
Deletes a single media pool
Path parameters poolId (required)
Path Parameter ID of the media pool
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 deleted successfully
GET /probes
Returns a list of probes
Return type ProbeList 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
POST /probes
Creates a new probe
Request body probe (required)
Body Parameter Probe 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
GET /probes/{probeId}
Returns a single probe
Path parameters probeId (required)
Path Parameter ID of the probe
Return type Probe 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
PUT /probes/{probeId}
Updates a single probe
Path parameters probeId (required)
Path Parameter ID of the probe
Request body 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
DELETE /probes/{probeId}
Deletes a single probe
Path parameters probeId (required)
Path Parameter ID of the probe
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 deleted successfully
GET /protectiongroups
Returns a list of protection groups
Return type ProtectionGroupList 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
POST /protectiongroups
Creates a new protection group
Request body protectiongroups (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
GET /protectiongroups/{protectionGroupId}
Returns a single protection group
Path parameters protectionGroupId (required)
Path Parameter ID of the protection group
Return type ProtectionGroup 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
PUT /protectiongroups/{protectionGroupId}
Updates a single protection group
Path parameters protectionGroupId (required)
Path Parameter ID of the protection group
Request body 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 Resource was updated successfully
DELETE /protectiongroups/{protectionGroupId}
Deletes a single protection group
Path parameters protectionGroupId (required)
Path Parameter ID of the protection group
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 deleted successfully
POST /protectiongroups/{protectionGroupId}/op/updatevmwareworkitems
Update work items for vmware/all protection groups
Path parameters protectionGroupId (required)
Path Parameter ID of Protection Group
Request body 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 Operation successful
GET /protectionpolicies
Returns a list of policies
Return type PolicyList 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
POST /protectionpolicies
Creates a new policy
Request body 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
GET /protectionpolicies/{policyId}
Returns a single policy
Path parameters policyId (required)
Path Parameter This specifies the name of the Data Protection Policy.
Return type Policy 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
PUT /protectionpolicies/{policyId}
Updates a single policy
Path parameters policyId (required)
Path Parameter This specifies the name of the Data Protection Policy.
Request body 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
DELETE /protectionpolicies/{policyId}
Deletes a single policy
Path parameters policyId (required)
Path Parameter This specifies the name of the Data Protection Policy.
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 deleted successfully
GET /protectionpolicies/{policyId}/jobgroups
Returns a list of job groups for a given policy
Path parameters policyId (required)
Path Parameter This specifies the name of the Data Protection Policy.
Return type JobList 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
GET /protectionpolicies/{policyId}/jobgroups/{jobGroupId}
Returns a list of jobs for a given job group
Path parameters policyId (required)
Path Parameter This specifies the name of the Data Protection Policy. jobGroupId (required)
Path Parameter ID of the job group
Return type JobList 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
GET /protectionpolicies/{policyId}/workflows
Returns a list of workflows for a policy
Path parameters policyId (required)
Path Parameter This specifies the name of the Data Protection Policy.
Return type PolicyWorkflowList 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
POST /protectionpolicies/{policyId}/workflows
Creates a new workflow
Path parameters policyId (required)
Path Parameter This specifies the name of the Data Protection Policy.
Request body workflow (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
GET /protectionpolicies/{policyId}/workflows/{workflowId}
Returns a single workflow
Path parameters policyId (required)
Path Parameter This specifies the name of the Data Protection Policy. workflowId (required)
Path Parameter ID of the workflow
Return type PolicyWorkflow 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
PUT /protectionpolicies/{policyId}/workflows/{workflowId}
Updates a single workflow
Path parameters policyId (required)
Path Parameter This specifies the name of the Data Protection Policy. workflowId (required)
Path Parameter ID of the workflow
Request body workflow (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
DELETE /protectionpolicies/{policyId}/workflows/{workflowId}
Deletes a single workflow
Path parameters policyId (required)
Path Parameter This specifies the name of the Data Protection Policy. workflowId (required)
Path Parameter ID of 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 204 Resource was deleted successfully
GET /protectionpolicies/{policyId}/workflows/{workflowId}/jobgroups
Returns a list of job groups for a given workflow
Path parameters policyId (required)
Path Parameter This specifies the name of the Data Protection Policy. workflowId (required)
Path Parameter ID of the workflow
Return type JobList 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
GET
/protectionpolicies/{policyId}/workflows/{workflowId}/jobgroups/{jobG
roupId}
Returns a list of jobs for a given job group
Path parameters policyId (required)
Path Parameter This specifies the name of the Data Protection Policy. workflowId (required)
Path Parameter ID of the workflow jobGroupId (required)
Path Parameter ID of the job group
Return type JobList 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
POST /protectionpolicies/{policyId}/workflows/{workflowId}/op/backup
Starts a specified workflow
Path parameters policyId (required)
Path Parameter This specifies the name of the Data Protection Policy. workflowId (required)
Path Parameter ID of the workflow
Request body 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 202 Operation successful
GET /recovers
Returns a list of all recovery resources.
Return type RecoverList 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. 400 Bad request. 401 Unauthorized. 404 Not found. 405 Method not allowed. 500 Internal server error.
POST /recovers
Creates a new recovery resource and triggers a new just-in-time recovery.
Request body recover (required)
Body Parameter Recovery resource to be created.
Responses 201 Resource was created successfully. 400 Bad request. 401 Unauthorized. 404
Not found. 405 Method not allowed. 500 Internal server error.
GET /recovers/{recoverId}
Returns a single recovery resource.
Path parameters recoverId (required)
Path Parameter ID of the recovery.
Return type Recover Responses 200 Resource was retrieved successfully. 400 Bad request. 401 Unauthorized. 404 Not found. 405 Method not allowed. 500 Internal server error.
DELETE /recovers/{recoverId}
Deletes a single recovery resource.
Path parameters recoverId (required)
Path Parameter ID of recovery.
Responses 204 Resource was deleted successfully. 400 Bad request. 401 Unauthorized. 404 Not found. 405 Method not allowed.
500 Internal server error.
GET /rules
Returns a list of rules
Return type RuleList 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
POST /rules
Creates a new rule
Request body 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
GET /rules/{ruleName}
Returns a single rule
Path parameters ruleName (required)
Path Parameter Name of the rule
Return type Rule 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
PUT /rules/{ruleName}
Updates a single rule
Path parameters ruleName (required)
Path Parameter Name of the rule
Request body 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
DELETE /rules/{ruleName}
Deletes a single rule
Path parameters ruleName (required)
Path Parameter Name of the rule
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 deleted successfully
GET /serverconfig
Returns the server configuration settings
Return type ServerConfiguration 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
PUT /serverconfig
Updates the server configuration settings
Request body serverConfig (optional)
Body Parameter Server configuration settings for update
Responses 204 Resource was updated successfully
GET /servermessages
Returns a list of server messages
Return type ServerMessageList 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
GET /serverstatistics
Returns the server statistics
Return type ServerStatistics 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
GET /sessions
Returns a list of sessions
Return type SessionList 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
GET /sessions/{sessionId}
Returns a single session
Path parameters sessionId (required)
Path Parameter ID of the session
Return type Session 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
POST /sessions/{sessionId}/op/cancel
Cancel a specified session
Path parameters sessionId (required)
Path Parameter ID of the session
Request body 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 Operation successful
GET /storagenodes
Returns a list of storage nodes
Return type StorageNodeList 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
POST /storagenodes
Creates a new storage node
Request body 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
GET /storagenodes/{storageNodeId}
Returns a single storage node
Path parameters storageNodeId (required)
Path Parameter ID of the storage node
Return type StorageNode 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
PUT /storagenodes/{storageNodeId}
Updates a single storage node
Path parameters storageNodeId (required)
Path Parameter ID of the storage node
Request body storageNode (required)
Body Parameter Storage node 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
DELETE /storagenodes/{storageNodeId}
Deletes a single storage node
Path parameters storageNodeId (required)
Path Parameter ID of the storage node
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 deleted successfully
GET /tenants
Returns a list of tenants
Return type TenantList 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
POST /tenants
Creates a new tenant
Request body 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
GET /tenants/{tenantId}
Returns a single tenant
Path parameters tenantId (required)
Path Parameter ID of the tenant
Return type 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
PUT /tenants/{tenantId}
Updates a single tenant
Path parameters tenantId (required)
Path Parameter ID of the tenant
Request body 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
DELETE /tenants/{tenantId}
Deletes a single tenant
Path parameters tenantId (required)
Path Parameter ID of the 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 204 Resource was deleted successfully
GET /usergroups
Returns a list of user groups
Return type UserGroupList 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
POST /usergroups
Creates a new user group
Request body usergroups (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
GET /usergroups/{userGroupId}
Returns a single user group
Path parameters userGroupId (required)
Path Parameter ID of the user group
Return type UserGroup 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
PUT /usergroups/{userGroupId}
Updates a single user group
Path parameters userGroupId (required)
Path Parameter ID of the user group
Request body 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
DELETE /usergroups/{userGroupId}
Deletes a single user group
Path parameters userGroupId (required)
Path Parameter ID of the user group
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 deleted successfully
POST /vmware/op/refreshvcenters
Refreshes NetWorker information for all 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.
GET /vmware/protectedvms
Returns a list of protected VMs
Return type VMwareProtectedVmList 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
GET /vmware/vcenters
Returns a list of vCenters
Return type VCenterList 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
POST /vmware/vcenters
Creates a new vCenter
Request body vcenter (required)
Body Parameter vCenter to be created
Responses 201 Resource was created successfully
GET /vmware/vcenters/{vcenter-hostname}
Returns a specific vCenter
Path parameters vcenter-hostname (required)
Path Parameter vCenter hostname
Return type VCenter 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
PUT /vmware/vcenters/{vcenter-hostname}
Updates a single vCenter
Path parameters vcenter-hostname (required)
Path Parameter ID of vCenter
Request body vcenter (required)
Body Parameter vCenter to modify
Responses 204 Resource was updated successfully
DELETE /vmware/vcenters/{vcenter-hostname}
Deletes a single vCenter
Path parameters vcenter-hostname (required)
Path Parameter ID of vCenter
Responses 204 Resource was deleted successfully
POST /vmware/vcenters/{vcenter-hostname}/op/refresh
Refreshes NetWorker information for the specific vCenter
Path parameters vcenter-hostname (required)
Path Parameter vCenter hostname
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.
POST /vmware/vcenters/{vcenter-hostname}/plugins
Install NetWorker plugins for the specific vCenter
Path parameters vcenter-hostname (required)
Path Parameter vCenter hostname
Request body vCenterPlugin (required)
Body Parameter Parameters to install the plugin
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, body contains a response. 400 Bad request. 401 Unauthorized. 404 Not found. 405 Method not allowed. 500 Internal server error.
GET /vmware/vcenters/{vcenter-hostname}/protectedvms
Returns a list of protected VMs for a specific vCenter
Path parameters vcenter-hostname (required)
Path Parameter vCenter hostname
Return type VMwareProtectedVmList
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
GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-uuid}
Returns a specific protected VM for a specific vCenter
Path parameters vcenter-hostname (required)
Path Parameter vCenter hostname vm-uuid (required)
Path Parameter Virtual Machine UUID
Return type VMwareProtectedVm 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
GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups
Returns a list of backups (savesets) for a specific protected VM
Path parameters vcenter-hostname (required)
Path Parameter vCenter hostname vm-uuid (required)
Path Parameter Virtual Machine UUID
Return type BackupList 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
GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/instances
Returns a list of instances (clones) for a specific protected VM backup
Path parameters vcenter-hostname (required)
Path Parameter vCenter hostname vm-uuid (required)
Path Parameter Virtual Machine UUID backup-id (required)
Path Parameter Backup ID
Return type BackupInstanceList 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
POST /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/instances/{instance-id}/op/inspectbackup
Inspect an app consistent VM backup instance for purposes of catalog retrieval
Path parameters vcenter-hostname (required)
Path Parameter vCenter hostname vm-uuid (required)
Path Parameter Virtual Machine UUID backup-id (required)
Path Parameter Backup ID instance-id (required)
Path Parameter Instance ID
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 Operation Successful
POST /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/instances/{instance-id}/op/recover
Starts a recovery of a selected protected VM backup instance
Path parameters vcenter-hostname (required)
Path Parameter vCenter hostname vm-uuid (required)
Path Parameter Virtual Machine UUID backup-id (required)
Path Parameter Backup ID instance-id (required)
Path Parameter Instance ID
Request body vmwareVmOpRecover (required)
Body Parameter Parameters to start the recover
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 Operation Successful 400 Bad request. 401 Unauthorized. 404
Not found. 405 Method not allowed. 500 Internal server error.
POST /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/instances/{instance-id}/op/vmmount
Mounts a selected protected VM backup instance for purposes of FLR
Path parameters vcenter-hostname (required)
Path Parameter vCenter hostname vm-uuid (required)
Path Parameter Virtual Machine UUID backup-id (required)
Path Parameter Backup ID instance-id (required)
Path Parameter Instance ID
Request body 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 202 Operation Successful
GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/instances/{instance-id}/op/vmmount/{vproxy-
mount-session-id}
Returns a single mount session.
Path parameters vcenter-hostname (required)
Path Parameter Specifies the vCenter hostname. vm-uuid (required)
Path Parameter Specifies the virtual machine UUID. backup-id (required)
Path Parameter Specifies the backup ID. instance-id (required)
Path Parameter Specifies the instance ID. vproxy-mount-session-id (required)
Path Parameter Specifies the ID of the vproxy VM mount session.
Return type VProxyVmMountSessionResponse Responses 200 Resource was retrieved successfully. 400 Bad request. 401 Unauthorized. 404 Not found. 405 Method not allowed. 500 Internal server error.
GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/instances/{instance-id}/op/vmmount/{vproxy-
mount-session-id}/vmbrowse
Returns a list of all vmbrowse sessions.
Path parameters vcenter-hostname (required)
Path Parameter Specifies the vCenter hostname. vm-uuid (required)
Path Parameter Specifies the virtual machine UUID. backup-id (required)
Path Parameter Specifies the backup ID. instance-id (required)
Path Parameter Specifies the instance ID. vproxy-mount-session-id (required)
Path Parameter Specifies the ID of the vproxy VM mount session.
Return type VProxyVmBrowseSessionResponseList 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. 400 Bad request. 401 Unauthorized. 404 Not found. 405 Method not allowed. 500 Internal server error.
POST /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/instances/{instance-id}/op/vmmount/{vproxy-
mount-session-id}/vmbrowse
Creates a new vmbrowse session.
Path parameters vcenter-hostname (required)
Path Parameter Specifies the vCenter hostname. vm-uuid (required)
Path Parameter Specifies the virtual machine UUID. backup-id (required)
Path Parameter Specifies the backup ID. instance-id (required)
Path Parameter Specifies the instance ID. vproxy-mount-session-id (required)
Path Parameter Specifies the ID of the vproxy VM mount session.
Request body VProxyVmBrowseSessionRequest (required)
Body Parameter The vmbrowse session details to be created.
Responses 201 Resource was created successfully. 400 Bad request. 401 Unauthorized. 404 Not found. 405 Method not allowed. 500 Internal server error.
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}
Returns a single vmbrowse session.
Path parameters vcenter-hostname (required)
Path Parameter Specifies the vCenter hostname. vm-uuid (required)
Path Parameter Specifies the virtual machine UUID. backup-id (required)
Path Parameter Specifies the backup ID. instance-id (required)
Path Parameter Specifies the instance ID. vproxy-mount-session-id (required)
Path Parameter Specifies the ID of the vproxy VM mount session. vproxy-browse-session-id (required)
Path Parameter Specifies the ID of the vproxy VM browse session.
Return type VProxyVmBrowseSessionResponse Responses 200 Resource was retrieved successfully. 400 Bad request. 401 Unauthorized. 404 Not found. 405 Method not allowed. 500 Internal server error.
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}
Updates the vmbrowse session.
Path parameters vcenter-hostname (required)
Path Parameter Specifies the vCenter hostname. vm-uuid (required)
Path Parameter Specifies the virtual machine UUID. backup-id (required)
Path Parameter Specifies the backup ID. instance-id (required)
Path Parameter Specifies the instance ID. vproxy-mount-session-id (required)
Path Parameter Specifies the ID of the vproxy VM mount session. vproxy-browse-session-id (required)
Path Parameter Specifies the ID of the vproxy VM browse session.
Request body VProxyVmBrowseSessionRequest (required)
Body Parameter The vmbrowse session details to be updated.
Responses 202 Resource was updated successfully. 400 Bad request. 401 Unauthorized. 404 Not found. 405 Method not allowed. 500 Internal server error.
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}
Deletes a single vmbrowse session.
Path parameters vcenter-hostname (required)
Path Parameter Specifies the vCenter hostname. vm-uuid (required)
Path Parameter Specifies the virtual machine UUID. backup-id (required)
Path Parameter Specifies the backup ID. instance-id (required)
Path Parameter Specifies the instance ID. vproxy-mount-session-id (required)
Path Parameter Specifies the ID of the vproxy VM mount session. vproxy-browse-session-id (required)
Path Parameter Specifies the ID of the vproxy VM browse session.
Responses 204 Resource was deleted successfully. 400 Bad request.
401 Unauthorized. 404 Not found. 405 Method not allowed. 500 Internal server error.
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
Returns content of a single vmbrowse session.
Path parameters vcenter-hostname (required)
Path Parameter Specifies the vCenter hostname. vm-uuid (required)
Path Parameter Specifies the virtual machine UUID. backup-id (required)
Path Parameter Specifies the backup ID. instance-id (required)
Path Parameter Specifies the instance ID. vproxy-mount-session-id (required)
Path Parameter Specifies the ID of the vproxy VM mount session. vproxy-browse-session-id (required)
Path Parameter Specifies the ID of the vproxy vm browse session.
Return type XmlVmBrowseDirectoryContents Responses 200 Resource was retrieved successfully. 400 Bad request. 401 Unauthorized. 404 Not found. 405 Method not allowed. 500 Internal server error.
POST /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/op/inspectbackup
Inspect an app consistent VM backup for purposes of catalog retrieval
Path parameters vcenter-hostname (required)
Path Parameter vCenter hostname vm-uuid (required)
Path Parameter Virtual Machine UUID backup-id (required)
Path Parameter Backup ID
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 Operation Successful
POST /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/op/recover
Starts a recovery of a selected protected VM backup
Path parameters vcenter-hostname (required)
Path Parameter vCenter hostname vm-uuid (required)
Path Parameter Virtual Machine UUID backup-id (required)
Path Parameter Backup ID
Request body vmwareVmOpRecover (required)
Body Parameter Parameters to start the recover
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 Operation Successful 400
Bad request. 401 Unauthorized. 404 Not found. 405 Method not allowed. 500 Internal server error.
POST /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/op/vmmount
Mounts a selected protected VM backup for purposes of FLR
Path parameters vcenter-hostname (required)
Path Parameter vCenter hostname vm-uuid (required)
Path Parameter Virtual Machine UUID backup-id (required)
Path Parameter Backup ID
Request body 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 202 Operation Successful
GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/op/vmmount/{vproxy-mount-session-id}
Returns a single mount session.
Path parameters vcenter-hostname (required)
Path Parameter Specifies the vCenter hostname. vm-uuid (required)
Path Parameter Specifies the virtual machine UUID. backup-id (required)
Path Parameter Specifies the backup ID.
vproxy-mount-session-id (required) Path Parameter Specifies the ID of the vproxy VM mount session.
Return type VProxyVmMountSessionResponse Responses 200 Resource was retrieved successfully. 400 Bad request. 401 Unauthorized. 404 Not found. 405 Method not allowed. 500 Internal server error.
GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/op/vmmount/{vproxy-mount-session-
id}/vmbrowse
Returns a list of all vmbrowse sessions.
Path parameters vcenter-hostname (required)
Path Parameter Specifies the vCenter hostname. vm-uuid (required)
Path Parameter Specifies the virtual machine UUID. backup-id (required)
Path Parameter Specifies the backup ID. vproxy-mount-session-id (required)
Path Parameter Specifies the ID of the vproxy VM mount session.
Return type VProxyVmBrowseSessionResponseList 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. 400 Bad request.
401 Unauthorized. 404 Not found. 405 Method not allowed. 500 Internal server error.
POST /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/op/vmmount/{vproxy-mount-session-
id}/vmbrowse
Creates a new vmbrowse session.
Path parameters vcenter-hostname (required)
Path Parameter Specifies the vCenter hostname. vm-uuid (required)
Path Parameter Specifies the virtual machine UUID. backup-id (required)
Path Parameter Specifies the backup ID. vproxy-mount-session-id (required)
Path Parameter Specifies the ID of the vproxy VM mount session.
Request body VProxyVmBrowseSessionRequest (required)
Body Parameter The vmbrowse session details to be created.
Responses 201 Resource was created successfully. 400 Bad request. 401 Unauthorized. 404 Not found. 405 Method not allowed. 500 Internal server error.
GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/op/vmmount/{vproxy-mount-session-
id}/vmbrowse/{vproxy-browse-session-id}
Returns a single vmbrowse session.
Path parameters
vcenter-hostname (required) Path Parameter Specifies the vCenter hostname.
vm-uuid (required) Path Parameter Specifies the virtual machine UUID.
backup-id (required) Path Parameter Specifies the backup ID.
vproxy-mount-session-id (required) Path Parameter Specifies the ID of the vproxy VM mount session.
vproxy-browse-session-id (required) Path Parameter Specifies the ID of the vproxy VM browse session.
Return type VProxyVmBrowseSessionResponse Responses 200 Resource was retrieved successfully. 400 Bad request. 401 Unauthorized. 404 Not found. 405 Method not allowed. 500 Internal server error.
PUT /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/op/vmmount/{vproxy-mount-session-
id}/vmbrowse/{vproxy-browse-session-id}
Updates the vmbrowse session.
Path parameters vcenter-hostname (required)
Path Parameter Specifies the vCenter hostname. vm-uuid (required)
Path Parameter Specifies the virtual machine UUID. backup-id (required)
Path Parameter Specifies the backup ID. vproxy-mount-session-id (required)
Path Parameter Specifies the ID of the vproxy VM mount session. vproxy-browse-session-id (required)
Path Parameter Specifies the ID of the vproxy VM browse session.
Request body VProxyVmBrowseSessionRequest (required)
Body Parameter The vmbrowse session details to be updated.
Responses 202 Resource was updated successfully. 400 Bad request. 401 Unauthorized. 404 Not found. 405 Method not allowed. 500 Internal server error.
DELETE /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/op/vmmount/{vproxy-mount-session-
id}/vmbrowse/{vproxy-browse-session-id}
Deletes a single vmbrowse session.
Path parameters vcenter-hostname (required)
Path Parameter Specifies the vCenter hostname. vm-uuid (required)
Path Parameter Specifies the virtual machine UUID. backup-id (required)
Path Parameter Specifies the backup ID. vproxy-mount-session-id (required)
Path Parameter Specifies the ID of the vproxy VM mount session. vproxy-browse-session-id (required)
Path Parameter Specifies the ID of the vproxy VM browse session.
Responses 204 Resource was deleted successfully. 400 Bad request. 401 Unauthorized. 404 Not found. 405 Method not allowed. 500 Internal server error.
GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-
uuid}/backups/{backup-id}/op/vmmount/{vproxy-mount-session-
id}/vmbrowse/{vproxy-browse-session-id}/contents
Returns content of a single vmbrowse session.
Path parameters vcenter-hostname (required)
Path Parameter Specifies the vCenter hostname. vm-uuid (required)
Path Parameter Specifies the virtual machine UUID. backup-id (required)
Path Parameter Specifies the backup ID. vproxy-mount-session-id (required)
Path Parameter Specifies the ID of the vproxy VM mount session. vproxy-browse-session-id (required)
Path Parameter Specifies the ID of the vproxy VM mount session.
Return type XmlVmBrowseDirectoryContents Responses 200 Resource was retrieved successfully. 400 Bad request. 401 Unauthorized. 404 Not found. 405 Method not allowed. 500 Internal server error.
GET /vmware/vcenters/{vcenter-hostname}/vms
Returns a list of VMs for a specific vCenter
Path parameters vcenter-hostname (required)
Path Parameter vCenter hostname
Return type VMwareVmList 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
GET /vmware/vcenters/{vcenter-hostname}/vms/{vm-uuid}
Returns a specific VM for a specific vCenter
Path parameters vcenter-hostname (required)
Path Parameter vCenter hostname vm-uuid (required)
Path Parameter Virtual Machine UUID
Return type VMwareVm 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
POST /vmware/vcenters/{vcenter-hostname}/vms/{vm-uuid}/op/backup
Starts a backup for a specific vCenter VM
Path parameters vcenter-hostname (required)
Path Parameter vCenter hostname vm-uuid (required)
Path Parameter Virtual Machine UUID
Request body 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 202 Operation Successful
GET /vmware/vcenters/{vcenter-hostname}/vms/{vm-
uuid}/protectiondetails
Returns a list of protection details for a specific vCenter VM
Path parameters vcenter-hostname (required)
Path Parameter vCenter hostname vm-uuid (required)
Path Parameter Virtual Machine UUID
Return type VMwareVmProtectionDetailList 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
GET /vmware/vms
Returns a list of protected VMs
Return type VMwareVmList 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
GET /vmware/vproxies
Returns a list of vProxies
Return type VProxyList 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
POST /vmware/vproxies
Create a single vProxy
Request body vproxy (required)
Body Parameter vProxy to create
Responses 201 Resource was created successfully 202 Operation Successful 400 Bad request. 401 Unauthorized. 404 Not found. 405 Method not allowed. 500 Internal server error.
POST /vmware/vproxies/op/register
Create and register a single vProxy
Request body VProxy (required)
Body Parameter Requst body to create and register a single vProxy
Responses 201 Resource was created successfully 202 Operation Successful 400 Bad request.
401 Unauthorized. 404 Not found. 405 Method not allowed. 500 Internal server error.
GET /vmware/vproxies/{vproxy-hostname}
Returns a specific vProxy
Path parameters vproxy-hostname (required)
Path Parameter vProxy hostname
Return type VProxy 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
PUT /vmware/vproxies/{vproxy-hostname}
Updates a single vProxy
Path parameters vproxy-hostname (required)
Path Parameter ID of vProxy
Request body vproxy (required)
Body Parameter vProxy to modify
Responses 204 Resource was updated successfully
DELETE /vmware/vproxies/{vproxy-hostname}
Deletes a single vProxy
Path parameters vproxy-hostname (required)
Path Parameter ID of vProxy
Responses 204 Resource was deleted successfully
GET /volumes
Returns a list of volumes
Return type VolumeList 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
GET /volumes/{volumeId}
Returns a single volume
Path parameters volumeId (required)
Path Parameter ID of the volume
Return type Volume 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
DELETE /volumes/{volumeId}
Deletes a single volume
Path parameters volumeId (required)
Path Parameter ID of the volume
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 deleted successfully
Up
Models
[ 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. Device
15. DeviceList
16. DeviceOpLabel
17. DeviceOpMount
18. DeviceOpStatus
19. Directive
20. DirectiveList
21. ErrorResponse
22. HttpHeader
23. HttpRequest
24. HttpStatus
25. Index
26. IndexList
27. CloudboostAppliance
28. CloudboostApplianceList
29. VCenterPlugin
30. Job
31. JobIndication
32. JobIndicationList
33. JobList
34. JobOpCancel
35. Label
36. LabelList
37. License
38. LicenseList
39. Link
40. Notification
41. NotificationList
42. Policy
43. PolicyAction
44. PolicyActionSpecificData
45. PolicyActionBackup
46. PolicyActionBackupSpecificData
47. PolicyActionBackupSnapshot
48. PolicyActionBackupTraditional
49. PolicyActionBackupVMwareVba
50. PolicyActionBackupVMwareVProxy
51. PolicyActionCheckConnectivity
52. PolicyActionClone
53. PolicyActionDiscover
54. PolicyActionExpire
55. PolicyActionGenerateIndex
56. PolicyActionProbe
57. PolicyActionServerBackup
58. PolicyActionSettingOverride
59. PolicyActionVbaCheckpointBackup
60. PolicyActionVbaCheckpointDiscover
61. PolicyActionWorkItemFilter
62. PolicyList
63. PolicyNotification
64. PolicyWorkflow
65. PolicyWorkflowList
66. PolicyWorkflowOpBackup
67. Pool
68. PoolList
69. Probe
70. ProbeList
71. Rule
72. RuleItemDefinition
73. RuleList
74. ProtectionGroup
75. ProtectionGroupList
76. Recover
77. RecoverBackupInstance
78. TimeStampBasedGranularRecover
79. RecoverNDMPOptions
80. RecoverList
81. ResourceId
82. ServerConfiguration
83. ServerMessage
84. ServerMessageList
85. ServerStatistics
86. Session
87. SessionList
88. Size
89. StorageNode
90. StorageNodeList
91. Tenant
92. TenantList
93. UserGroup
94. UserGroupList
95. Volume
96. VolumeList
97. VCenter
98. VCenterList
99. VMwareVm
100. VMwareProtectedVm
101. VMwareVmBackupInfo
102. VMwareVmdkBackupInfo
103. VMwareVmdkRecoverInfo
104. VMwareVmEmergencyRecoverCleanupOptions
105. VMwareVmFlrOptions
106. VMwareVmGuestInfo
107. VMwareApplicationRecoverSavesetInfo
108. VMwareVmdkWorkItem
109. VMwareVmList
110. VMwareProtectedVmList
111. VMwareVmOpBackup
112. VMwareVmOpRecover
113. VMwareVmProtectionDetail
114. VMwareVmProtectionDetailList
115. VMwareWorkItemOpUpdate
116. VMwareWorkItemSelection
117. VProxy
118. VProxyList
119. XmlVmBrowseDirectoryContents
120. XmlError
121. XmlFile
122. VProxyVmBrowseSessionRequest
123. VProxyVmBrowseSessionResponse
124. VProxyVmBrowseSessionResponseConfig
125. VProxyVmBrowseSessionResponseStatus
126. VProxyVmBrowseSessionResponseList
127. VProxyVmMountSessionResponse
128. VProxyVmMountSessionResponseConfig
129. VProxyVmMountSessionResponseStatus
Alert
category String
message String
priority String
timestamp Date
AlertList
count Integer
alerts array[Alert]
links array[Link]
Attr
key String
values array[String]
AuditLogConfiguration
administrators array[String]
auditLogFilePath String
auditLogHostname String
auditLogMaxFileSizeInMB Integer
auditLogMaxFileVersion Integer
auditLogRenderedLocale String
auditLogRenderedService String Enum:
None Local Syslog Eventlog
auditLogSeverity String Enum:
Information Notice Warning Error Severe Critical
name String
resourceId ResourceId
Backup
attributes array[Attr]
browseTime Date
clientHostname String
clientId String
completionTime Date
creationTime Date
fileCount Long
id String
instances array[BackupInstance]
level
String Enum:
1 2 3 4 5 6 7 8 9 Consolidate Full Incr IncrSynthFull Manual Migration Skip SynthFull TxnLog
links array[Link]
name String
retentionTime Date
saveTime Date
shortId String
size Size
tenant String
type String Enum:
CoverSet DSA File NDMP Raw Snapshot Unknown
vmInformation VMwareVmBackupInfo
BackupInstance
clone Boolean
id String
links array[Link]
status String Enum:
Aborted Browsable InProgress Recoverable Recyclable Unknown
volumeIds array[String]
BackupInstanceList
backupInstances array[BackupInstance]
count Integer
links array[Link]
BackupList
backups array[Backup]
count Integer
links array[Link]
BackupOpVmMount
backupDeviceExportPath String
installFlrAgent Boolean
targetVCenterHostname String
targetVmAdminUserId String
targetVmAdminUserPassword String
targetVmMoref
String targetVmName
String targetVmUserId
String targetVmUserPassword
String uninstallFlrAgent
Boolean vProxy
String
BitRate
unit String Enum:
Byte/s KB/s
value Long
Client
aliases array[String]
applicationInformation array[String]
backupCommand String
backupType String
blockBasedBackup Boolean
checkpointEnabled Boolean
clientId String
comment String
directive String
executablePath String
hostname String
indexBackupContent Boolean
links
array[Link] nasDevice
Boolean nasDeviceManagementName
String nasFileAccessPassword
String nasFileAccessUser
String nasManagementPassword
String nasManagementUser
String ndmp
Boolean ndmpArrayName
String ndmpMultiStreamsEnabled
Boolean ndmpVendorInformation
array[String] parallelSaveStreamsPerSaveSet
Boolean parallelism
Integer password
String postCommand
String preCommand
String probeResourceName
String protectionGroups
array[String] remoteAccessUsers
array[String] remoteUser
String resourceId
ResourceId retentionPolicy
String saveSets
array[String] schedule
String scheduledBackup
Boolean storageNodes
array[String] storageReplicationPolicyName
String tags
array[String] tenant
String
ClientList
clients array[Client]
count Integer
links array[Link]
ClientOpBackup
actionOverrides array[PolicyActionSettingOverride]
policy String
workflow String
Device
autoMediaManagement Boolean
cdi String Enum:
NotUsed SCSI
cleaningInterval String
cleaningRequired Boolean
cloudBandwidthThrottlingSettings array[String]
cloudBandwithThrottlingEnabled Boolean
cloudCACertificate String
cloudCompression String
Enum: None SpeedVerySlow SpeedSlow SpeedMedium SpeedFast
cloudEncryption String Enum:
None AES256
cloudNetworkFailureRetryInMin Integer
cloudNumberOfRetries Integer
cloudServer String
cloudTimeout Integer
cloudWriteSizeInKB Integer
comment String
dataDomainFibreChannel Boolean
dataDomainFibreChannelHostname String
dataDomainHost String
dataDomainRetentionLockMode String Enum:
None Governance Compliance
dataDomainRetentionLockPeriodMin String
dataDomainRetentionLockPeriodMax String
dateLastCleaned Date
description String
deviceAccessInfo String
deviceSerialNumber String
dltWormCapable
Boolean hardwareId
String links
array[Link] maxNsrmmdCount
Integer maxSession
Integer mediaFamily
String Enum:
Tape Disk Cloud Logical
mediaType String 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 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 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 String
mountedVolume String
name String
ndmp Boolean
parentJukebox String
password String
pathId String
readOnly Boolean
remoteUser String
resourceId ResourceId
status String Enum:
Enabled Disabled Service
suspectedDevice
Boolean tapeAlertsWarning
array[String] tapeAlertsCritical
array[String] tapeAlertsInformation
array[String] targetSession
Integer tenant
String verifyLabelOnEject
Boolean volumeId
String volumePool
String warnOnSuspectVolumesInPercent
Integer wormCapable
Boolean wormCartridgePresent
Boolean writeEnabled
Boolean
DeviceList
count Integer
devices array[Device]
links array[Link]
DeviceOpLabel
capacity String
labelWithoutMount Boolean
manualRecycleOnly Boolean
pool String
relabel Boolean
verifyUnlabeledVolume Boolean
volumeLabel String
DeviceOpMount
volume String
writeEnabled Boolean
DeviceOpStatus
error String
message String
operation String Enum:
Unmount Mount VerifyLabel Label LabelWithoutMount Eject VerifyWriteTime MonitorDevice RecoverSpace CheckFileSystem Check Erase CheckMedia
operationInProgress Boolean
resourceId ResourceId
volumeLabel String
Directive
comment String
directive String
links array[Link]
name String
resourceId ResourceId
tenant String
DirectiveList
count Integer
directives array[Directive]
links array[Link]
ErrorResponse
message String
status HttpStatus
timestamp Date
userAgentRequest HttpRequest
version String
HttpHeader
name String
value String
HttpRequest
contentLength Long
headers array[HttpHeader]
method String
query String
url String
HttpStatus
code
Integer codeClass
String reasonPhrase
String
Index
clientFileId String
fileName String
fileSizeInBytes Long
namespace 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 iq msvmapp
offset
Long saveTime
String
IndexList
count Integer
items array[Index]
CloudboostAppliance
host String
name String
username String
password String
resourceId ResourceId
CloudboostApplianceList
count Integer
cloudBoostAppliances array[CloudboostAppliance]
VCenterPlugin
pluginType String Enum:
VC EBR
nwUserId String
nwPassword String
httpsPort Integer
httpPort Integer
authcIp String
authcPort
Integer
Job
adhocJob Boolean
clientHostname String
command String
completionStatus String Enum:
Unknown NoStart Succeeded Failed Cancelled Abandoned
dataSize Size
dependentJobIds array[Long]
endTime Date
exitCode Long
id Long
itemCount Long
itemIdLong Integer
links array[Link]
logFile String
message String
name String
ndmp Boolean
parentJobId Long
previousJobId Long
progress
String recoverAppItemStatus
String rootParentJobId
Long runOnHost
String saveSetId
String siblingJobIds
array[Long] startTime
Date state
String Enum:
Unknown Created Queued Started Active SessionActive Cancelled Completed
stopped Boolean
tenant String
terminationReason String
type String
vProxyErrorMessages array[String]
vProxyFlrAgentInstallRequired Boolean
vProxyHostname String
vProxyMountSessionId String
vProxyMountState String
vProxyMountTargetVmInvalidAdminUser Boolean
vProxyMountTargetVmInvalidUser Boolean
vProxyMountTargetVmMoref String
vProxyMountTargetVmName String
vProxyMountTargetVmUserId String
vProxyMountVCenterHostname String
vProxyInspectDescriptor String
vProxyRecoverSessionId String
JobIndication
catalogId String
jobId Long
links array[Link]
message String
messageCatalogNumber String
messageId String
originComponent String
severity String Enum:
Invalid Debug Information Notice Warning Intervention Error Severe Critical Alert Emergency
tenant String
timestamp Date
JobIndicationList
count
Integer jobIndications
array[JobIndication] links
array[Link]
JobList
count Integer
jobs array[Job]
links array[Link]
JobOpCancel
reason String
timeoutInSec Integer
Label
comment String
fields array[String]
links array[Link]
name String
next String
resourceId ResourceId
separator String Enum:
. _ : -
tenant String
LabelList
count
Integer labels
array[Label] links
array[Link]
License
name String
comment String
enablerCode String
hostId String
expirationDate String
authCode String
licenseType String
resourceId ResourceId
LicenseList
count Integer
licenses array[License]
links array[Link]
Link
href String
id String
rel String Enum:
create-form item related
title String
Notification
action String
additionalEmailRecipient String
comment String
enabled Boolean
events array[String]
links array[Link]
name String
priorities array[String]
resourceId ResourceId
NotificationList
count Integer
links array[Link]
notifications array[Notification]
Policy
allowManualSaves Boolean
applyEntireWorkflow Boolean
comment String
links array[Link]
name String
resourceId ResourceId
summaryNotification PolicyNotification
policyProtectionEnable Boolean
policyProtectionPeriod
String tenant
String workflows
array[PolicyWorkflow]
PolicyAction
actionSpecificData PolicyActionSpecificData
actionStartTime String
comment String
completionNotification PolicyNotification
concurrent Boolean
customTags array[String]
drivenBy String
enabled Boolean
failureImpact String Enum:
Continue AbortAction AbortWorkflow
hardLimit String
inactivityTimeoutInMin Integer
name String
newName String
parallelism Integer
retries Integer
retryDelayInSec Integer
scheduleActivities array[String]
scheduleComment String
scheduleOverrides array[String]
schedulePeriod String Enum:
Week Month
softLimit String
workItemFilter PolicyActionWorkItemFilter
PolicyActionSpecificData
backup PolicyActionBackup
testConnectivity PolicyActionCheckConnectivity
clone PolicyActionClone
discover PolicyActionDiscover
expire PolicyActionExpire
generateIndex PolicyActionGenerateIndex
probe PolicyActionProbe
serverBackup PolicyActionServerBackup
vbaCheckpointBackup PolicyActionVbaCheckpointBackup
vbaCheckpointDiscover PolicyActionVbaCheckpointDiscover
PolicyActionBackup
backupSpecificData PolicyActionBackupSpecificData
clientOverride String Enum:
ClientCanNotOverride ClientCanOverride LegacyBackupRules
destinationStorageNodes array[String]
overrideBackupSchedule Boolean
overrideRetentionPeriod Boolean
retentionPeriod String
successThreshold String Enum:
Warning Success
PolicyActionBackupSpecificData
snapshot PolicyActionBackupSnapshot
traditional PolicyActionBackupTraditional
vmware PolicyActionBackupVMwareVba
vmwareVProxy PolicyActionBackupVMwareVProxy
PolicyActionBackupSnapshot
destinationPool String
forceBackupLevel String
minimumRetentionPeriod String
PolicyActionBackupTraditional
enableDDRetentionLock Boolean
ddRetentionLockTime String
destinationPool String
estimate Boolean
forceBackupLevel String
fileInactivityAlertThresholdPercentage Integer
fileInactivityThresholdInDays Integer
revertToFullWhenSyntheticFullFails Boolean
timestampFormat
String Enum:
None ISO Unix
verifySyntheticFull Boolean
PolicyActionBackupVMwareVba
destinationPool String
saveType String Enum:
VMDK VirtualMachine
useVbaInternalStorage Boolean
vbaName String
PolicyActionBackupVMwareVProxy
destinationPool String
proxyName String
appConsistentQuiesce String Enum:
Basic Advanced None
transactionLogBackup Boolean
quiesceTimeoutInMinutes Integer
quiesceSystemAdminUsername String
quiesceSystemAdminPassword String
enableDDRetentionLock Boolean
ddRetentionLockTime String
PolicyActionCheckConnectivity
PolicyActionClone
enableDDRetentionLock Boolean
ddRetentionLockTime String
deleteSource Boolean
destinationPool String
destinationStorageNode String
retentionPeriod String
sourceStorageNode String
PolicyActionDiscover
discoverType String Enum:
NAS snapshot
PolicyActionExpire
PolicyActionGenerateIndex
generateIndexType String Enum:
NAS snapshot
PolicyActionProbe
allProbsMustSucceed Boolean
maxBackupIntervalInDays Integer
PolicyActionServerBackup
destinationPool String
destinationStorageNode String
performBootstrap Boolean
performClientFileIndexing Boolean
retentionPeriod String
PolicyActionSettingOverride
action String
commandLineArguments String
PolicyActionVbaCheckpointBackup
destinationPool String
retentionPeriod String
PolicyActionVbaCheckpointDiscover
PolicyActionWorkItemFilter
clients array[String]
levels array[String]
saveSetTypes array[String]
timeRangeEnd Date
timeRangeStart Date
PolicyList
count Integer
links array[Link]
protectionPolicies array[Policy]
PolicyNotification
command String
executeOn String Enum:
Completion Failure
Ignore
PolicyWorkflow
actions array[PolicyAction]
autoStartEnabled Boolean
comment String
completionNotification PolicyNotification
description String
enabled Boolean
endTime String
links array[Link]
name String
newName String
nextStartDate Date
protectionGroups array[String]
restartTimeWindow String
startInterval String
startTime String
PolicyWorkflowList
count Integer
links array[Link]
workflows array[PolicyWorkflow]
PolicyWorkflowOpBackup
actionOverrides array[PolicyActionSettingOverride]
clients
array[String] restart
Boolean vmwareWorkItemSelection
VMwareWorkItemSelection
Pool
autoMediaVerify Boolean
barcodePrefix String
comment String
createDltWorm Boolean
devices array[String]
enabled Boolean
labelTemplate String
links array[Link]
maxParallelism Integer
maxVolumesToRecycle Integer
mediaTypeRequired String 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 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 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 String
poolType String Enum:
Backup BackupClone Archive ArchiveClone
recycleFromOtherPools Boolean
recycleInterval String
recycleStart String
recycleToOtherPools Boolean
resourceId ResourceId
storeIndexEntries Boolean
tenant String
volumeTypePreference String 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 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 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 Boolean
PoolList
count Integer
links array[Link]
pools array[Pool]
Probe
commandOptions String
comment String
links array[Link]
name String
probeCommand String
resourceId ResourceId
ProbeList
count Integer
links array[Link]
probes array[Probe]
Rule
dataSourceType String Enum:
VMware MSSQL
comment String
definitions array[RuleItemDefinition]
links array[Link]
name String
matchType String Enum:
All Any
resourceId ResourceId
RuleItemDefinition
operator String Enum:
Equals DoesNotEquals Contains DoesNotContains StartsWith DoesNotStartsWith EndsWith DoesNotEndsWith RegExp
property String Enum:
Name Path Tag
type String Enum:
VirtualMachine Cluster vApp
VmFolder Datacenter ResourcePool Database
value String
RuleList
count Integer
links array[Link]
rules array[Rule]
ProtectionGroup
comment String
links array[Link]
name String
resourceId ResourceId
tenant String
workItemQueries array[String]
workItemSource String Enum:
Static Dynamic
workItemSubType String Enum:
VirtualMachine VMDK All None
workItemType String Enum:
Client SaveSetId VMware NASDevice
workItems array[String]
vmwareWorkItemSelection VMwareWorkItemSelection
rule String
backupOptimization String Enum:
Capacity Performance
dynamicAssociation Boolean
ProtectionGroupList
count Integer
links array[Link]
protectionGroups array[ProtectionGroup]
Recover
recoveryType String Enum:
Filesystem BBB NDMP VM File Level Recover
recoveryDestination String
itemsToRecover array[String]
destinationClientResID String
backupInstance RecoverBackupInstance
timeStampBasedGranularRecover TimeStampBasedGranularRecover
actionForDuplicateItems String Enum:
Rename Overwrite Skip
targetVolume
String poolForStaging
String passphrase
array[String] recoveryStartTime
String namespace
String Enum:
backup archive bbb
NDMPOptions RecoverNDMPOptions
links array[Link]
resourceId ResourceId
RecoverBackupInstance
backupID String
instanceID String
TimeStampBasedGranularRecover
sourceClientResID String
timeStamp String
RecoverNDMPOptions
verifyIndexDB Boolean
useIPv4 Boolean
RecoverList
count Integer
recovers array[Recover]
ResourceId
id String
sequence Long
ServerConfiguration
acceptNewRecoverSessions Boolean
acceptNewSessions Boolean
aclPassthrough Boolean
administrators array[String]
authenticationProxyPort Integer
authenticationServiceDatabase String
authenticationServicePort Integer
cityOrTown String
clpLicenseServer String
clpLicenseServerPort Integer
clpRefresh String
clpSwid String
clpUom String
comment String
company String
contactName String
country String
datazonePassPhrase String
deviceSharingMode String Enum:
NoSharing MaximalSharing
ServerDefault disableRpsClone
Boolean emailAddress
String fax
String jobInactivityTimeout
Integer jobsdbRetentionInHours
Integer keepIncompleteBackups
Boolean licenseServers
array[String] manualSaves
Boolean name
String nasDevicePolicyAllowed
Boolean parallelism
Integer phone
String productSerialNumber
String publicArchives
Boolean purchaseDate
String resourceId
ResourceId saveSessionDistribution
String Enum:
MaxSessions TargetSessions
serverOSType String
siteId String
solutionId String
stateOrProvince String
streetAddress String
supportEmailAddress String
vmwarePolicyAllowed Boolean
vmwsEnable Boolean
vmwsPort Integer
vmwsUserName String
vmwsUserPassword String
volumePriority String Enum:
NearLinePriority SmartMediaPriority
wormPoolsOnlyHoldWormTapes Boolean
wormTapesOnlyInWormPools Boolean
zipOrPostalCode String
ServerMessage
category String
id String
message String
priority String
source String
timestamp Date
ServerMessageList
count Integer
links array[Link]
serverMessages array[ServerMessage]
ServerStatistics
badRecovers Long
badSaves Long
currentRecovers Long
currentSaves Long
links array[Link]
maxRecovers Long
maxSaves Long
recoverSize Size
recovers Long
saveSize Size
saves Long
upSince Date
version String
Session
clientHostname String
completed Boolean
compressionRatio BigDecimal
device String
deviceFamily String Enum:
Tape Disk Cloud Logical
deviceType String 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 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 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
Date extendedInformation
String id
Integer itemIdLong
Long jobId
Long links
array[Link] mode
String Enum:
Unknown Saving Recovering Browsing
pool String
protectionGroup String
rootJobId Long
saveSet String
saveSetId String
size Size
startTime Date
stopped Boolean
tenant String
totalRecoverSize Size
totalRecoverVolumesNeeded Long
transferRate BitRate
volume String
SessionList
count Integer
links array[Link]
sessions array[Session]
Size
unit String Enum:
Byte KB
value Long
StorageNode
aftdAllowedDirectories array[String]
cloneStorageNodes array[String]
comment String
configuredDevices array[String]
configuredLibraries array[String]
configuredLibraryTypes array[String]
configuredSilos array[String]
configuredSiloTypes array[String]
daemonVersions array[String]
dateOfLastScan Date
dateOfRegistration Date
dedicatedStorageNode Boolean
deviceSharingMode String Enum:
NoSharing MaximalSharing ServerDefault
dynamicNsrmmds Boolean
enabled Boolean
lastErrorMessages array[String]
lastErrorNumber Integer
links array[Link]
maxActiveDevices Integer
name String
numberOfDevices Integer
numberOfLibraries Integer
password String
ready Boolean
remoteUser String
resourceId ResourceId
searchAllLuns Boolean
sharedDeviceCreation Boolean
skipScsiTargets Boolean
storageNodeIsConfigured Boolean
tenant String
typeOfStorageNode String Enum:
SCSI NDMP SILO
usePersistentNames Boolean
version String
StorageNodeList
count Integer
links array[Link]
storageNodes array[StorageNode]
Tenant
clientHostnames array[String]
comment String
devices array[String]
directives array[String]
externalRoles array[String]
jukeboxes array[String]
labels array[String]
links array[Link]
name String
numberOfClients Integer
numberOfDevices Integer
numberOfJukeboxes Integer
numberOfStorageNodes Integer
pools array[String]
privileges array[String]
protectionGroups array[String]
protectionPolicies array[String]
recovers array[String]
resourceId ResourceId
storageNodes
array[String] users
array[String]
TenantList
count Integer
links array[Link]
tenants array[Tenant]
UserGroup
comment String
externalRoles array[String]
links array[Link]
name String
privileges array[String]
resourceId ResourceId
users array[String]
UserGroupList
count Integer
links array[Link]
userGroups array[UserGroup]
Volume
accessTime Date
availabilityFlags array[String]
barcode String
capacity Size
expirationTime Date
family String
flags array[String]
id String
latestLabelTime Date
links array[Link]
location String
mounts Long
name String
originalLabelTime Date
pool String
recover Size
recycled Long
saveSetExpirationTime Date
saveSetIds array[String]
states array[String]
tenant String
type String
written Size
VolumeList
count Integer
links array[Link]
volumes array[Volume]
VCenter
cloudDeployment Boolean
comment String
hostname String
links array[Link]
resourceId ResourceId
userName String
userPassword String
VCenterList
count Integer
links array[Link]
vCenters array[VCenter]
VMwareVm
annotation String
connectionState String
hostname String
ipAddress String
ipAddresses array[String]
links array[Link]
morefId String
name String
osId String
osName String
powerState
String state
String status
String type
String uuid
String vCenterHostname
String version
String
VMwareProtectedVm
hasAppConsistencyBackup Boolean
hostname String
ipAddress String
links array[Link]
morefId String
name String
osId String
osName String
uuid String
vCenterHostname String
version String
VMwareVmBackupInfo
datastoreMoref String
disks array[VMwareVmdkBackupInfo]
hostMoref String
morefPath String
vCenterHostname String
vmMoref String
vmName String
VMwareVmdkBackupInfo
datastoreMoref String
datastoreName String
key String
name String
sizeInKb Integer
thinProvisioned Boolean
VMwareVmdkRecoverInfo
datastoreMoref String
key String
name String
VMwareVmEmergencyRecoverCleanupOptions
deleteEsxClient Boolean
deleteEsxHypervisor Boolean
deleteVproxy Boolean
vCenterHostnameForVproxy String
VMwareVmFlrOptions
recoveryDestination String
itemsToRecover array[String]
terminateMountSession
Boolean overwrite
Boolean
VMwareVmGuestInfo
installAppAgent Boolean
targetVmAdminUserId String
targetVmAdminUserPassword String
targetVmUserId String
targetVmUserPassword String
uninstallAppAgent Boolean
VMwareApplicationRecoverSavesetInfo
applicationData String
backupId String
instanceId String
VMwareVmdkWorkItem
vmUuid String
vmdkUuid String
VMwareVmList
count Integer
links array[Link]
vms array[VMwareVm]
VMwareProtectedVmList
count Integer
links array[Link]
vms array[VMwareProtectedVm]
VMwareVmOpBackup
policy String
workflow String
VMwareVmOpRecover
applicationData String
applicationName String
applicationRestoreSavesets array[VMwareApplicationRecoverSavesetInfo]
clusterComputeResourceMoref String
computeResourceMoref String
datacenterMoref String
datastoreMoref String
debugLevel Integer
deleteExistingBackingFile Boolean
disks array[VMwareVmdkRecoverInfo]
hostMoref String
jobName String
mountJobId String
powerOn Boolean
reconnectNic Boolean
recoverMode String Enum:
Revert Instant New Disk
Application FLR Emergency
resourcePoolMoref String
revertConfiguration Boolean
stagingPool String
vCenterHostname String
vmEmergencyRecoverCleanupOptions VMwareVmEmergencyRecoverCleanupOptions
vmFolderMoref String
vmGuestLogin VMwareVmGuestInfo
vmMoref String
vmName String
vmwareVmFlrOptions VMwareVmFlrOptions
vProxyHostname String
VMwareVmProtectionDetail
protectionGroup ProtectionGroup
protectionPolicy Policy
workflow PolicyWorkflow
VMwareVmProtectionDetailList
count Integer
links array[Link]
protectionDetails array[VMwareVmProtectionDetail]
VMwareWorkItemOpUpdate
addWorkItems VMwareWorkItemSelection
deleteWorkItems
VMwareWorkItemSelection
VMwareWorkItemSelection
vCenterHostname String
containerMorefs array[String]
vmUuids array[String]
vmdks array[VMwareVmdkWorkItem]
VProxy
comment String
datastores array[String]
enabled Boolean
encryptNbdSessions Boolean
forceRegister Boolean
hostname String
links array[Link]
maxHotaddDisks Integer
maxHotaddSessions Integer
maxNbdSessions Integer
password String
resourceId ResourceId
userName String
version String
vCenterHostname String
vProxyPort Integer
VProxyList
count Integer
links array[Link]
vProxies array[VProxy]
XmlVmBrowseDirectoryContents
error XmlError
noMoreData Boolean
totalObjects Integer
freeSpace Integer
fileList array[XmlFile]
XmlError
text String
code Integer
XmlFile
fileName String
fileType String
fileSize Integer
fileModificationTime String
VProxyVmBrowseSessionRequest
currentWorkingDirectory String
idleTimeout Integer
cacheRetentionSeconds Integer
browseDestination Boolean
osType
String Enum:
Windows Linux
VProxyVmBrowseSessionResponse
config VProxyVmBrowseSessionResponseConfig
status VProxyVmBrowseSessionResponseStatus
links array[Link]
VProxyVmBrowseSessionResponseConfig
sessionId String
currentWorkingDirectory String
idleTimeout Integer
cacheRetentionSeconds Integer
browseDestination Boolean
VProxyVmBrowseSessionResponseStatus
state String
description String
VProxyVmBrowseSessionResponseList
count Integer
links array[Link]
sessions array[VProxyVmBrowseSessionResponse]
VProxyVmMountSessionResponse
config VProxyVmMountSessionResponseConfig
status VProxyVmMountSessionResponseStatus
links
array[Link]
VProxyVmMountSessionResponseConfig
mountPointPath String
idleTimeout Integer
VPro
Related manuals for Dell NetWorker 18.1 Software REST API Reference Guide
Manualsnet FAQs
If you want to find out how the 18.1 Dell works, you can view and download the Dell NetWorker 18.1 Software REST API Reference Guide on the Manualsnet website.
Yes, we have the REST API Reference Guide for Dell 18.1 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.1. Full manuals and user guide PDFs can be downloaded from Manualsnet.com.
The best way to navigate the Dell NetWorker 18.1 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.1 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.1 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.1 Software REST API Reference Guide, simply download the document to your computer. Once downloaded, open the PDF file and print the Dell NetWorker 18.1 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.