REST over Ethernet (RoE)
REST over Ethernet (RoE) contains all the same endpoints as REST over SCSI. The only difference in accessing them is that a URL must be used with RoE, and the user must be authenticated. RoE supports the same endpoints as REST over SCSI.
A typical RoE URL looks like https://<IP address>/web/api/v1/<endpoint name>.
Any existing library user can access the REST API over Ethernet.
To access the API, the endpoints listed in section 6.1.2 can be reached by using the method (GET, PUT, POST) and accessing the URL with the endpoint specified at the end. For example, GET /v1/library would be a GET request sent to https://<IP address>/web/api/v1/library.
Authentication
The major difference between RoE and SCSI (apart from the interface) is that RoE requires the user to be authenticated to issue commands to the library. This utilizes the same users as the Diamondback web GUI.
The following JSON structure must be sent to the library at https://<IP
address>/web/api/v1/login:
{“user”: <username>, “password”: <password>}
In order to logout of the session, the same JSON structure needs to be sent to https://<IP address>/web/api/v1/logout.
Once a user is authenticated, they can continue sending commands to the library over Ethernet until they logout or the session times out due to inactivity based on the library’s settings.