Overview REST

Representational State Transfer (REST) is a software architecture style consisting of guidelines and best practices for creating scalable web services. RESTful systems typically communicate over HTTP using the same verbs (that is, GET, POST, PUT, DELETE) used by web browsers.

The REST server listens for requests from clients on port 80 (HTTP) and port 443 (HTTPs). The REST service context is "/rest" followed by REST version. For example, http://192.168.1.1/rest/v1.0. REST requests also maybe sent on the HTTPS port (443).

NOTE:

  • The REST interface is enabled by default.

  • Web management or web management SSL must be enabled. If web management is disabled, requests will not be processed, irrespective of the REST interface status.

  • REST requests may also be sent to a switch through an OOBM port.

  • REST API requests to stacked switches should use schema version v3 (available since 16.04) or above.

More information