Skip to main content
Version: 3.7.x.x LTS

Swagger UI

We recommend that you use the built-in Swagger UI to explore the current functionality and learn about how to use the interface. The Swagger application runs at:

https://<nevisAdmin server>:<nevisAdmin port>/nevisadmin/apidocs/index.html

The API supports XML and JSON. We recommend using JSON as Swagger has limited XML support. When creating a new object (POST), click on the "Model Schema" to copy a JSON request and remove fields which are not required. You need to specify at least "name" and "type".

The curl examples shown by Swagger UI do not work out of the box as authentication needs to be added (refer to the chapter: Authentication, for details).