Skip to main content
Jump to: navigation, search

Orion/Server API/About API

< Orion‎ | Server API
Revision as of 13:24, 13 March 2018 by Michael Rennie.ca.ibm.com (Talk | contribs) (Create About API page)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

The About API is a web server API for viewing general and component information about the running server.

About

Overview
To view general and component information, send a GET to the /about endpoint
HTTP Method
GET
Example Request
GET /version HTTP/1.1
Orion-Version: 1.0

  
Example Response
HTTP/1.1 200 OK
Content-Type: text/html

  <html xmlns="http://www.w3.org/1999/xhtml">
  <head>
  <title>About</title>
   <style type = "text/css"> td { padding-right : 10px; }</style></head>
  <body>
  <table>
    <tr>
      <td><img src="../webapp/orion-96.png"/></td>
      <td><p>Build Id: 18.0.0<br/></p></td>
    </tr>
  </table>
  <table>
    <tr>
      <th align="left">Library</th>
      <th align="center">Version</th>
    </tr>
    <tr><td align="left">app-module-path</td><td align="center">^2.2.0</td></tr>
    ....
  </table>
  </html>
Detailed Explanation
The information about the running server.

Back to the top