Spectra Logic

1-800-833-1132 : 1-303-449-6400

Get General System Information

Description

Get basic system information, including software version and build information, and the system serial number.

Requests

Syntax

GET http[s]://{datapathDNSname}/_rest_/system_information/

Responses

Response Elements

<Data>
   <ApiVersion>{string}</ApiVersion>
   <BackendActivated>TRUE|FALSE</BackendActivated>
   <BuildInformation>
      <Branch>{string}</Branch>
      <Revision>{string}</Revision>
      <Version>{string}</Version>
   </BuildInformation>
   <SerialNumber>{string}</SerialNumber>
</Data>

where the response elements are defined as follows:

Parameter	Description
Data	The container for the response.
ApiVersion	The version of the Spectra S3 API. The version is in the form X.Y, where X is the MD5 checksum across all request handler major revisions and Y is the MD5 checksum across all request handler full versions (including the minor revision).
BackendActivated	Whether the BlackPearl gateway is allowed to send data to the data path backend (pool or tape partitions). Values: TRUE, FALSE
BuildInformation	A container for the information about the build.
Branch	The branch used to build the API.
Revision	The revision of the software build.
Version	The version of the software build.
SerialNumber	The serial number of the BlackPearl Deep Storage Gateway

Example

Sample Request

This request gets general system information.

GET http://blackpearl-hostname/_rest_/system_information/ HTTP/1.1

Sample Response

HTTP/1.1 200 OK
<Data>
   <ApiVersion>
      5107E9A4021B822F2533C3B619AB1C4C.
      4C2BB2339FC04CDAFB523E1B86F5F2D5
   </ApiVersion>
   <BuildInformation>
      <Branch>//BlueStorm/mainline</Branch>
      <Revision>1099282</Revision>
      <Version>1.0.0</Version>
   </BuildInformation>
   <SerialNumber>50030480003e6abf</SerialNumber>
</Data>