Representational State Transfer (REST) uses HTTP requests to interact with resources within Everpure. REST is an architectural style that describes the following constraints:
Uniform Interface: Individual resources are identified in requests using URLs as resource identifiers. For example, volume/v1 Clients manipulate resources through request methods, such as GET List resources, GET volume POST Create a resource, POST volume/v1 PUT Modify a resource, PUT volume/v1 DELETE Delete a resource. DELETE volume/v1 Requests can include additional parameters, either in the URL or as JSON post data.
Stateless: The necessary state to handle a request is contained in the request itself.
Cacheable: The responses must implicitly or explicitly define themselves as cacheable.
Client-Server: The uniform interface creates separation between client and server. While clients can be more portable, severs do not need to know anything about a user interface or state.
Layered System: A client cannot tell if it is connected directly to the server; intermediary servers can be used to improve scalability or enforce security policies.
The Rest API enables you to perform all possible CRUD (create, retrieve, update, delete) operations. Follow the following two methods for setting up the Rest API:
- GUI Setup
- Command-Line Setup Using Python
The GUI method of setup might be simple and straightforward, however, the Python Code setup method might allow for additional capabilities such as setting up an infrastructure for alerting.