IBM DS8880/DS8870 Version 3 Release 3 RESTful API Guide

This document describes the RESTful APIs for the IBM DS8880/DS8870 Version 3 Release 3.


IBM DS8880/DS8870 Version 3 Release 3 RESTful API Guide - cover page
Brand
IBM
Category
Disk Array
Document type
Programming Manual
Language
English
Pages
47
File format
PDF
File size
391 KB
Published
30 November, 2023
Updated
30 November, 2023
Models
DS8880, DS8870
MD5 checksum
5B054AE0D60A4900F250E004A8FF50E0

About this manual

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.

What's inside

  • RESTful API
  • Security
  • Creating a token
  • Queries
  • Requests
  • Update responses
  • Error handling
  • Request URLs
  • Resource definitions
  • Notices

Specifications

Supported storage systemsIBM DS8880 and DS8870
HTTP methodsPOST, GET, PUT, DELETE
Request and response formatJSON
HMC port number{hmc}:443

Frequently asked questions

Which storage systems does the RESTful API support?

The RESTful API operations are supported on IBM DS8880 and, with some exceptions, DS8870.

What HTTP methods does the RESTful API use?

The API uses HTTP POST, GET, PUT, and DELETE for create, read, update, and delete operations.

What format are API requests and responses in?

All requests and responses are formatted as JSON.

How is authentication performed for the RESTful API?

A token must be created with a POST request before other RESTful API operations can be initiated.

Download PDF (391 KB)

More IBM Manuals


View all IBM manuals →