REST API

You are looking at an older version of the documentation. The latest version is found here.

Overview

REST API uses HTTP requests to GET, PUT, POST, and DELETE data. You can use the Data Virtuality REST API to build web services on top of the Data Virtuality Logical Data Warehouse to develop integrations with other applications.

In this guide, you will find the REST endpoints available in the Data Virtuality Logical Data Warehouse and expected HTTP response codes, along with examples.

Please note that at the moment, there are two limitations. First, the Data Virtuality REST API only supports JSON content type; if you use an HTTP client (such as Postman), we recommend setting language detection to JSON. Second, the Data Virtuality REST API works only with the default virtual database (datavirtuality); this is why no VDB name or id specification is required in any of the commands.

Authentication

Basic HTTP authentication is the easiest way to authenticate but is rather insecure. Instead, we recommend more secure application authentication using a special app. If you use Postman, open the Authorization tab, select Basic Auth, and enter your credentials. To check that the credentials are correct, you can perform the following call to the status endpoint:

GET http://<datavirtuality-server-address>:8080/rest/api/status/

The server then responds with REST API status:

STATUS 200

{ "status": "OK" }