RESTful API

The topics in this section provide information related to the RESTful (Representational State Transfer) API.

Overview
DS8000 RESTful API supports create, read, update, and delete operations.
Security
RESTful API is dependent upon Hypertext Transfer Protocol (HTTP) for security. Token creation is required for authentication.
Queries
The RESTful API can query one or more system resources.
Query responses
RESTful API returns a response to a query with a structure that varies based on the system resource and the status of the operation.
Paging support
Paging restricts the number of records returned by the server. For instance, a volume query request can return thousands of volume records. To enhance your control of received data, two parameters are available.
Querying events
RESTful API queries for an event a little differently than for all other resources.
Requests
You can create, edit, and delete system resources through RESTful API requests.
Update responses
RESTful API displays responses that denote the success or failure of update requests.
Error handling
RESTful API responds to each request with an HTTP status code and a server status code.
Request URLs
You can use URLs to submit resource requests through the RESTful API.
Resource definitions
RESTful API sends the settings of the specified resource in response to all submitted GET requests.