VxFlex OS REST API Reference Guide

The REST API is served from the VxFlex OS Gateway (which includes the REST gateway). The VxFlex OS Gateway can be installed on any operating system that is supported by VxFlex OS for its core components (MDM/SDS/SDC/LIA/XCACHE). The VxFlex OS Gateway connects to a single MDM and serves requests by querying the MDM and reformatting the answers it receives from the MDM in a RESTful manner, back to a REST client. The Gateway is stateless. It requires the MDM username and password for the login request. The login returns a token in the response, that is used for later authentications for other requests. Every VxFlex OS SCLI command is also available in the VxFlex OS REST API. The responses returned by the VxFlex OS Gateway are formatted in JSON format.

The API is available as part of the VxFlex OS Gateway package. If you used the VxFlex OS Installer to install VxFlex OS, the Gateway has already been installed and configured with the MDM details.

To install the VxFlex OS Gateway manually, see the VxFlex OS Deployment Guide.

Before you start using this API:
  1. If you installed the VxFlex OS Gateway manually, ensure that the MDM connection properties are configured correctly in the VxFlex OS Gateway configuration file. For more information, see “Configuring connection properties in the VxFlex OS Gateway”. If the VxFlex OS Installer was used to install VxFlex OS, the VxFlex OS Gateway is already configured, and no action is required.
    Tip: You can also run this test from the link in the VxFlex OS Installer Maintenance Operation screen.
  2. Run a self-test to verify connectivity and correct configuration via a browser by navigating to the login page at this URL: https://<GATEWAY_IP_ADDRESS>/api/login. In addition, there is a link from the VxFlex OS Gateway maintenance page (maintain.jsp) to the REST test page (rest.jsp).