Access the Documentation User
Interface
This topic explains how to access the REST API Documentation GUI for cloud management.
Accessing the Documentation GUI
There are two parts to the REST API documentation:
- An HTML reference user interface, known as the REST API Documentation GUI. It contains
a complete list of attributes, elements, and resources. The documentation resides in a
user interface that is accessed using this URL: http://api.extremenetworks.com/extremecloud/rest_api/index.html
- This SDK guide, which provides
information about logging in, tools, methods, headers, and examples.
Logging In to the Documentation GUI
Anyone with
ExtremeCloud
credentials can log in to the REST API Documentation GUI and view the content.
Note
To
submit REST API calls, your REST-API consuming program needs to have logged in using
credentials granting at least read permissions for the GET method. Only fully privileged
administrator accounts can be used to make configuration changes through the REST API. For
more information, see
Log in to the REST API Server.