The chapter describes various API topics such as deprecation and purging policy and an inventory of supported APIs.
- Child Topics
- Resource URI format
Resources can be accessed using the following URI formats.
- HTTP methods
The REST API server supports the following HTTP methods.
- Non-CRUD operations
Some storage actions cannot be completed using the create, read, update, and delete (CRUD) operations. In general, a POST operation is performed for non-CRUD actions on a resource. For example, to format a file system, the request URI is:
- Required custom HTTP headers
The following custom headers are required by all operations.
- Optional custom HTTP headers
- HTTP status codes
The REST API server responds with the following status codes, which are defined in RFC 2616.
- Storage system error response
In cases when an error is thrown by the storage system, the REST API server displays the error code and error message in the response body as shown in the example below.
- Basic data types
The data types are JSON data types.
- Inventory of supported APIs
A GET operation to https://<host>:<port>/ will return an HTML page that lists all supported REST API server operations.
- Input and output format
The REST API server supports JSON input/output format.
- Asynchronous operations
REST API server supports asynchronous operations. Asynchronous operations are processed in two ways.
- Sort output
Sorting is controlled by the top-level scalar (of type boolean, number, or string) attributes. REST API server does not support either multi-level or nesting sort operations. REST API server only supports sorting for the GET ALL API operations (for example, Get All Pools).
- Filter output
Filtering is used to narrow the result set.
- Output embedded
REST API server supports embedding for single-level associations.
