NSight REST API

The NSight API enables developers to interact programmatically with the NSight database, configure NSight alarms, schedule reports, get troubleshooting information, and much more. It is based on RESTful principles and is organized around the main resources and features from the NSight platform's graphical user interface.

The NSight API uses a combination of configuration daemon and an HTTP/HTTPS front-end. API request and response bodies are formatted in JavaScript Object Notation (JSON). The front-end receives REST requests via standard HTTP/HTTPS methods and forwards the request to the NSight device after converting it into internal configuration daemon format. The response generated by the NSight configuration daemon is converted to JSON and sent back to the client.

To make API calls and build custom applications for users with an NSight account, you need to log in using credentials granting at least read permissions. Any administrator account can be used with the REST API, but only fully privileged accounts can be used to make configuration changes through the REST API.

Note

The NSight REST API is supported on all NX switches and NSight enabled devices.

This guide provides information about how to access the API, structure of the API request and response bodies, error codes, and usage examples.

Note

You cannot run the sample requests in this guide as-is. Replace call-specific parameters such as host IP address, user credentials, and session IDs with your own values.