Representational State Transfer (REST) is a software architecture style consisting of guidelines and best practice 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, REST requests also maybe sent on the HTTPS port (443).

  • The REST interface is enabled by default.

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

  • IPv6 Rest API support is not available.

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

  • REST API requests that to stacked switches must use schema version v3 (except 3800 stack) or above.

  • Do not use windows extractor to unzip schema files from 16.06 RestAPI.

  • Default configuration of stack switches with build 16.04 and above does not display "no rest-interface" [except for 3800 stack].

More information