Dell PowerStore REST API Developers Guide

The PowerStore REST API

The PowerStore REST API is a set of resources (objects), operations, and attributes that provide interactive, scripted, and programmatic management control of the PowerStore cluster. Here are some examples of what you can do with the REST API:

• Provision new cluster components, such as appliances and volumes.
• Configure replication destinations and sessions, and rules.
• Fail over and fail back an appliance.
• Create snapshots for backup purposes.
• Gather metrics to use for historical analysis.
• Gather configuration information and logs to use for auditing and trending analysis.

Reference materials are also available on the appliance in several formats:

• Swagger UI—https://<cluster management ip address>/swaggerui
• JSON—https://<cluster management ip address>/api/rest/openapi.json

The REST API uses a Representational State Transfer (REST) architecture style to expose data. Using a REST API provides the following advantages:

• Presents a single, consistent interface for managing PowerStore clusters.
• Requires no additional tools, other than standard web browsers or command-line HTTP tools, such as wGET and cURL. For complex interactions, clients can use any procedural programming language, such as C++ or Java, or scripting language, such as Perl or Python, to make calls to the REST API.
• Uses well-known HTTP conventions in a standard manner to interact with the appliance.
• Is easy to transport in the network. REST API traffic looks and acts like standard HTTP network traffic, and requires no special ports open in the firewall or special settings in the switches.

The REST API connection is secured with SSL. The same authentication is used for the REST API and GUI.