REST API for scalable tape libraries

The REST API is a simple application programming interface (API) to manage the 3U scalable tape libraries remotely over an HTTPS interface. This API is requested and needed for manufacturing and for automated test and monitoring systems.

Version information

Version: 1.1.15

URI scheme

Base Path: /rest
Schemes: HTTPS

Tags

  • System : System requests
  • Library Information : Library Status / Information
  • Library Operations : Library Operations
  • Library Configuration : Library Configuration
  • Library Test : Library Tests
  • Drive Information : Drive Information
  • Drive Configuration : Drive Configuration
  • Partition Information : Partition Information
  • Partition Configuration : Partition Configuration

General REST API information

Table 1. General REST API information
Name Value
Protocol HTTPS
Port 3031
Authorization Bearer Token
Base Path /rest/
Certificate Self-Signed
Example URL https://libraryip:3031/rest/library/baseinfo

How to use the REST API

The REST API workflow is as follows:
  1. Log in to the system with the POST command URL https://libraryip:3031/rest/login, where the user name and password must be sent as content in JSON format (application/json). Example: 
    {
"username" : "administrator",
"password" : "password"
}
  2. If the login was successful, a Bearer token is returned like: "Bearer eyJ0eXAiOiJKV1QiLCJhb….zRcVud3c"
  3. The returned Bearer token must be added as the "Authorization" header value to the REST calls, which have a security check.

    Authorization: Bearer token

    Note: If the token or the login is invalid, a 401 HTTP error is returned.
CURL Examples: 
curl -X GET "https://libraryip:3031/rest/library/status" -H "accept: application/json" -H
"Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhb….zRcVud3c" -k

curl -X POST "https://libraryip:3031/rest/library/io/open" -H "accept: application/json" -H "Content-
Type: application/json" -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhb….zRcVud3c" -d "{
\"module\": 1}" -k

Synonyms

To generalize the document and to support different wording in different environments, the following synonyms are used in this specification.
Table 2. Synonyms
Name Synonym Description
I/O Station Mailslot The removable media slots in a magazine.
Logical Library Partition The virtualization of the physical library into multiple logical partitions, which shows up for a host a tape library.
Tape, Cartridge Media The data tape.
VOLSER, VolSer Bar code The bar code label, which is on the back of the tape media.

Product Variants

The REST API differs in a few areas, depending on the product variants.
Table 3. Product Variants
Item IBM/DELL BDT
Authentication No administrator password is required to log in to service level. An administrator password is required to log in to service level.
Sequential Mode Applicable N/A