Dell EMC OpenStack Data Protection Extension 19.7 REST API Getting Started Guide

OpenStack DPE API specification

The OpenStack DPE API reference documentation is provided as online documentation along with the API itself. Both are available on a deployed instance of the OpenStack DPE API qcow2 image.

The URL to access the documentation on a deployed instance of the OpenStack DPE API service is https://dpe-api-sever.com:8443/v1/ui.

This URL provides an interactive web application based on the Swagger REST API documentation implementation, Swagger UI. The application divides the API into sections, based on the authentication role required to access that section's set of API calls. Each section can be expanded to display the list of API calls supported in that section. Each API can be further expanded to display complete details of the inputs and outputs for that call, as well as the ability to execute that call from the web page itself.

When using the embedded client in the documentation, an example of how to call the same API using 'curl' on the command line is also provided. This is a very simple example of one such call:

curl -X GET --header 'Accept: application/json' --header 'X-Auth-Token: 1234...' 'http://host:8443/v1/protectionProviders'

This example demonstrates listing all registered protection providers. The response to this call should be a JSON object containing an array of protectionProvider objects.

The X-Auth-Token header is described below.