API Reference

This document is intended to help people use the API for NGINX Instance Manager.

Prerequisites

Install NGINX Instance Manager and know what port the API/UI is listening on (11000 by default).

Usage

Use curl, postman or another tool to call the API. The API will be in the format https://nginx-manager.example.com:11000/api/v0/. (note you may be using http if you didn’t set SSL certificates on the proxy or in the config).

For example, to call the instances in a GET call, you can run a curl command similar to the following.

curl -X GET "https://nginx-manager.example.com/api/v0/instances" -H  "accept: application/json"

Swagger-UI

You can also find examples of all the calls available through the swagger-ui page, installed by default with nginx-manager. To access this page, point your browser to the URL of the Instance Manager user interface and append /swagger-ui to the end. For example, https://nginx-manager.example.com:11000/swagger-ui.

Swagger-UI

You can select the “Try it out” button and run the calls directly against your server. For example, a GET of instances is showen below.

Swagger-UI Instances

Swagger-UI JSON

To download the swagger-ui json, point to the above address and append /lightning.swagger.json to the end. For example, https://nginx-manager.example.com:11000/swagger-ui/lightning.swagger.json.