This document describes the RESTful APIs for the IBM DS8880/DS8870 Version 3 Release 3.
This guide provides specifications for RESTful API operations on IBM DS8880 and DS8870 storage systems. It covers query and update operations, security and token creation, request URLs, resource definitions, and error handling.
The RESTful API runs on the storage system HMC and uses HTTP POST, GET, PUT, and DELETE methods with JSON-formatted requests and responses. Operations are supported on IBM DS8880 and, with some exceptions, DS8870.
| Supported storage systems | IBM DS8880 and DS8870 |
|---|---|
| HTTP methods | POST, GET, PUT, DELETE |
| Request and response format | JSON |
| HMC port number | {hmc}:443 |
The RESTful API operations are supported on IBM DS8880 and, with some exceptions, DS8870.
The API uses HTTP POST, GET, PUT, and DELETE for create, read, update, and delete operations.
All requests and responses are formatted as JSON.
A token must be created with a POST request before other RESTful API operations can be initiated.