Skip to main content

We've Moved!

Product Documentation has moved to docs.hitachivantara.com
Hitachi Vantara Knowledge

Getting Started with Hitachi Visualization Suite API

Overview

HVS API allows integrators and customers to interact with the HVS system using a standard REST API. You can find the available APIs in the built-in Swagger API user interface (UI) or using your preferred REST client application.

Use the following link to access the HVS API documentation in Swagger.

https://<HVS API instance>/swagger 

For more information about the Swagger OpenAPI 2.0, see swagger.io.

6.0_HVSAPI.png

Authentication and Authorization

HVS API uses the open standard JSON Web Token (JWT) to provide a compact and self-contained way for transmitting information and uses Bearer authentication (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens.

Authorize request

Before making any requests, you can authorize your session by clicking the Authorize button and completing the information required in the Authorization screen as shown in the figure below: 

HVSAPI_authorize.png

To receive the Bearer schema, use authenticate method under Authorization.

HVSAPI_authenticate.png

Make a request

  1. Expand the endpoint.

  2. Click Try it out. Upon click, the example value in the Request Body field becomes editable.

  3. Make necessary changes.

  4. Click Execute.

  5. Swagger UI submits the request and shows the curl that was submitted. The Responses section shows the response. (If you select JSON rather than XML in the “Response content type” drop-down box, you can specify that JSON is returned rather than XML.)

Related Articles

 

 

  • Was this article helpful?