Overview of the Topology API

The Topology API is a RESTful interface that enables you to extract chassis device data from the Network Manager NCIM topology database into a JavaScript Object Notation (JSON) file that represents the device resources. This JSON file can be parsed and imported into a third-party tool, possibly together with data from other products, for presentation or further analysis.

In order to implement the Topology API within an integration you can use a command-line HTTP client that understands HTTPS, such as wget or curl, or whatever libraries your programming language of choice provides. A quick and simple way to test the output of the Topology API is to use GET and POST REST methods in a REST client within a web browser. Results are presented in JSON format.