DP Rest API Documentation

Idea ID 1658041

DP Rest API Documentation

I can see there is not much documentation around DP API since this is a new features in data protector, there should be enogh data available for the reference. Does anyone has any idea or any documemnt on how to use DP rest api to automate backup job creation. 

Status changed to: New Idea


The REST API documentation is available within the Data Protector UI itself which helps automate tasks.

Please see details in the link below.



Micro Focus Expert
Micro Focus Expert

Hi Mukesh.

     Like Sheetal said, there's documentation available for the current set of APIs. Backup job automation is currently not available, though you can look at Operations Orchestration as an alternative way to accomplish this (https://docs.microfocus.com/itom/Data_Protector:10.04/Integrate/about_this_guide/PRE_About_TG/OO_integration).



Status changed to: Already Offered
Regular Contributor.. Regular Contributor..
Regular Contributor..
Maybe one day https://docs.microfocus.com/itom/Data_Protector:10.04/Develop/Develop will have documentation, but now it's no more than a kind of title page. And the "API Documentation" link is a nice web form, but it's no documentation: * no words on data types * no words on optional or required parameters * no list of enumerated values (fixed set of values allowed) * no preconditions (relation between parameters, allowed ranges, etc.) * same for the result...
Regular Contributor.. Regular Contributor..
Regular Contributor..

I played a bit with the API, and I found out more problems:

  • The API is poorly designed: Some read functions use GET, others use POST, parameters can only be passed URL-encoded (it seems), some functions have the parameters as part of the URI...
  • Different functions require different permissions, but it's not documented which permission is needed for which function. So with my test user some calls succeed, while others fail.
  • Some documentation is wrong. For example "/dp-gui/dp-scheduler-gui/restws/pre-schedules?Schedule Name" does not work; it claims the parameter should be "schedName" instead, but even when using that, it does not work. What I get back from the call is (JSON decoded):


test2: {
  "parameters" : [
  "catalogPackage" : "com.hp.im.jce.ws.common",
  "causeMessage" : null,
  "id" : 800000,
  "causeClass" : null,
  "message" : "Missing value for mandatory parameter schedName."

 Actually I found the casue of the problem: The API only seems to work if the parameter is passed as part of the URL (i.e. ?schedName=...).

Another stupid thing is that holidays are returned (GET) in JSON format, but are sent (POST) as text/plain. There really was no design behind the REST API of Data Protector!

Micro Focus Expert
Micro Focus Expert
Status changed to: Archived
The opinions expressed above are the personal opinions of the authors, not of Micro Focus. By using this site, you accept the Terms of Use and Rules of Participation. Certain versions of content ("Material") accessible here may contain branding from Hewlett-Packard Company (now HP Inc.) and Hewlett Packard Enterprise Company. As of September 1, 2017, the Material is now offered by Micro Focus, a separately owned and operated company. Any reference to the HP and Hewlett Packard Enterprise/HPE marks is historical in nature, and the HP and Hewlett Packard Enterprise/HPE marks are the property of their respective owners.