Submitting forms on the support site are temporary unavailable for schedule maintenance. If you need immediate assistance please contact technical support. We apologize for the inconvenience.
The NetVault API provides a web-service based interface to configure and administer NetVault. The NetVault API is built on the Representational State Transfer (REST) architecture, which is the most widely used style for building APIs. The NetVault API uses the HTTP protocol to communicate with NetVault. The NetVault API is therefore easy to use in cloud-based applications, as well as across multiple platforms and programming languages.
The NetVault API uses JavaScript Object Notation (JSON) as the message format for request and response messages.
Resolution
NetVault offers REST APIs managed Swagger, an open-source suite of API developer tools To obtain the REST API files (Refer the attachment )
To deploy the REST APIs, on a Windows server or a Linux server, complete one of the following procedures.
NOTE: When deploying on Windows, run the command line as Administrator. When deploying on Linux,
execute the commands as root.
To deploy REST APIs on Windows:
1 On the NetVault Server, download and unzip the REST API files.
2 On the NetVault Server, download and install Node.js from https://nodejs.org/en/.
3 If not already installed, download and install NPM from https://npmjs.com/get-npm.
4 If not already installed, download and install Visual Studio Community including "Desktop development with C++" workload. More info https://github.com/nodejs/node-gyp#on-windows
5 Update config.js (for URL, DB_LOCATION, SERVER_PUBLIC_IP, CLI_PATH) present in the API folder.
6 In the root directory of the drive where you installed Node.js, create a folder named “db” (for example,
C:\db).
7 On the command line as Administrator, change to the path that contains the unzipped API files and run the following command:
npm install
8 Start the node server and run the following command:
npm run dev
9 After the server starts, to start using the APIs and view API documentation, open the following Swagger
of 'REST APIs forvideo-demonstration-of-rest-w.tColorWhiteBlackRedGreenBlueYellowMagentaCyai-TransparentBackgroundColorBlackWhiteRedGreenBlueYellowMagentaCyanTransparencyOpaqueemi-TransparentTransparentWindowColorBlackWhiteRedGreenBlueYellowMagentaCyanTransparencyTransparentSemi-TransparentOpaque
Font Size50%75%100%125%150%175%200%300%400%
Text Edge StyleNoneRaisedDepressedUniformDropshadow
Font FamilyProportional Sans-SerifMonospace Sans-SerifProportional SerifMonospace SerifCasu
Your Request will be reviewed by our technical reviewer team and, if approved, will be added as a Topic in our Knowledgebase.
Recommended Content
Product(s):
NetVault
13.0.2, 13.0.1, 13.0
Topic(s):
How To
Article History:
Created on: 6/30/2020 Last Update on: 5/19/2023
Thank you for your feedback for Topic Request
Your Request will be reviewed by our technical reviewer team and, if approved, will be added as a Topic in our Knowledgebase.
Welcome to Quest Support
You can find online support help for Quest *product* on an affiliate support site. Click continue to be directed to the correct support content and assistance for *product*.
Search All Articles
IE 8, 9, & 10 No longer supported
The Quest Software Portal no longer supports IE8, 9, & 10 and it is recommended to upgrade your browser to the latest version of Internet Explorer or Chrome.
