About The Cisco NAE REST API Reference (OpenAPI/Swagger)

The Cisco NAE REST API uses OpenAPI, formerly known as Swagger, to provide a complete and interactive API reference for developers, linked directly from the Cisco NAE GUI. The Swagger reference allows you to visualize and demonstrate the resources of the API. The direct connection from the reference document to the live REST API provides an easy way to write and test simple requests directly from the Swagger reference UI.

You can find the Cisco NAE REST API Swagger Interface document in the Appliance Documentation menu of the Cisco NAE GUI or at this URL: https://<Your_NAE_Appliance>/nae/api/v1/swagger-ui.html

NOTE: When you use the "Try it out" interactive feature of the Cisco NAE Swagger UI, you are required to enter a value for the session token X-NAE-CSRF-TOKEN, which is obtained in the login process. If you are already logged in to the Cisco NAE GUI, you can either log out of the GUI and then log in using the API, noting the new session token value, or you can use your browser's developer console to inspect the value of localStorage.CSRF_TOKEN. This element contains the current session token.