RESTful API protocol

The API uses HTTP as the transport protocol and relies on HTTP for some features (for example, security).

The protocol relies on HTTP methods to support CRUD operations (Create/Read/Update/Delete).
  • POST – Create and action operations.
  • GET – Query (read) operations.
  • DELETE – Delete operations.
  • PATCH – Partial update operations.
The API URL is built from scope specifiers and resource identifiers.
  • api – Specifies the main API scope.
  • v1 – Specifies the protocol version.
  • resource type – Specifies type of the system resource.
  • id – Identifies the resource.

For example, GET /api/v1/disks/7.

RESTful API for Spectrum Control Base returns the following codes for request status:

  • 200 – The request has succeeded.
  • 401 – The request requires user authentication.
  • 405 – The request method is not allowed for the specified resource.
  • 500 – The request cannot be implemented due to an unexpected condition.