NetWorker REST API
The NetWorker REST API provides programatic interface to NetWorker data protection services. The API interface enables you to create integrations from other applications, using any programming language that has support for JSON over HTTP. More importantly, the API interface makes it easier to build client applications and automate NetWorker operations in a standard way.
The API documentation provided in this portal supports NetWorker 19.4 and later to 19.11 . If you are using an older version of NetWorker, you can find and download the API documentation for your version here.
Overview
The NetWorker REST API provides a mechanism to access the functions provided by the NetWorker software. The API interface helps you to build client applications and automate NetWorker operations by using any programming language that supports JSON over HTTP.
The NetWorker REST API supports the following functions:
- Client management to backup the data that you want to protect.
- Managing devices, media pools, storage nodes, and volumes.
- Enabling Data protection using policies, workflows, and actions.
- Monitoring jobs, alerts, licenses, and enabling notifications.
- Support for restricted data zones and user management.
- Customization through probes, directives, and rules.
- Application level protection for Microsoft SQL VDI, Microsoft Exchange and SAP HANA.
For information on managing NetWorker software, see the NetWorker Administration Guide.
The tutorial provides a fair amount of detail and handholding to get started with the NetWorker REST API. It assumes that you are familiar with web programming concepts and web data formats.
The API reference provides the information on the endpoints, alongwith the supported methods, available parameters, the specific details on the responses and errors.
API support across NetWorker releases
| Networker API Version | NetWorker Release | Supported Features |
|---|---|---|
| v1 | NetWorker 9.0 and minor releases | Support for protection policy and protection groups. Support for client management. Support for pools, device and storage node management. Support for monitoring jobs and job indications. Support for server and audit configurations. Support for probes, labels, and directives. Support for tenancy. Support for alerts, notifications, and sessions. |
| v2 | NetWorker 9.1 and minor releases | Support for VMWare use cases. Swagger documentation for the APIs. |
| v3 | Networker 9.2 | Support for Data Domain retention lock. New version of the API is released with changes in the API end points for tenants and user groups. |
| v3 | Networker 18.1 | Support for recovery of file system, BBB, and NDMP backups. Ability to browse files in Client File Index. Ability to mount and browse VMWare based virtual machine backups to perform file level recovery. |
| v3 | Networker 18.2 | Expose hidden client attributes. Security hardening. |
| v3 | Networker 19.1 | Query improvements: time range filtering. Listing of Data Domain systems. Swagger documentation enhancements to define parameter definitions, examples etc. |
| v3 | Networker 19.2 | Configuration, backup, and recovery of SAP HANA and SAP HANA MDC databases. Support to view remote agent capabilities for a client resource. |
| v3 | Networker 19.3 | Configuration, backup, and recovery of SQL VDI databases. Support for mounting and browsing of BBB backups. Support for redeployment of vProxy servers. Support for user management. |
| v3 | Networker 19.4 | Configuration, backup, and recovery of Microsoft Exchange Server. |
| v3 | Networker 19.5 | Device management and volume management enhancements. |
| v3 | Networker 19.6 | Media management enhancement: Support for managing browse and retention time of clones. AFTD enhancement: Ability to browse top level folders from Storage Node. Security Hardening of RESTAPI headers. |
| v3 | Networker 19.7 | A new attribute “chronologicalOrder” is introduced to support clone saveset. |
| v3 | Networker 19.8 | Support to enable global server properties. Support to replicate an MTree backup. A new attribute “msuState” is introduced to support for data domain smart scale paused migration. |
| v3 | Networker 19.9 | Licensing enhancements : Support to perform operations like create, update and delete on Traditional Licensing. A new attribute serverstate is introduced to determine the server’s current operating state. |
| v3 | Networker 19.10 | NDMP enhancements : Support to configure and discover NDMP client. VProxy enhancements : Addition of new attributes of “datastoreContainsWildcards” in vProxy resource, and “transportMode” in vmbackup action for vproxy workflows. Internationalization : Application is I18N ready and supports localization for Ja(Japanese). |
| v3 | Networker 19.11 | Tape library and device management enhancements : Support to scan, configure, autodetect and configure the library and delete the jukebox and unconfigured library resources. |
| v3 | Networker 19.12 | Tape library and device management enhancements : Update the jukebox and unconfigured library resources, operations of reconfiguration, enable/disable, label, inventory and managing library operations. Internationalization : Application supports localization of ko(Korean). |
| v3 | Networker 19.13 | Tape library and device management enhancements : Tape library operations of reset, deposit, eject/withdraw, mount, unmount and load without mount. Mtree enhancements: Ability to delete dd device replication resource and addition of attributes “lastReplicationTime” and “replicationStatus” in dd device replication resource. |