Lantronix
LSS2200-8P API User Guide
4
1. Introduction
Product Description
The LSS2200-8P is a managed Layer 2+ Gigabit Ethernet switch offering eight (8) 1GBase-T interfaces with full
IEEE 802.3bt 90W support, two (2) 10/5/2.5/1GBase-T multi-gigabit SFP+ slots, two (2) programmable Digital
Input/Outputs with 12V power output, and one (1) RJ-45 console port.
About This Manual
This manual describes how to use the LSS2200-8P REST API. Note that this manual may provide links to third
party websites for which Lantronix is not responsible.
Related Manuals
•
LSS2200-8P Quick Start Guide, 33859
•
LSS2200-8P Install Guide, 33860
•
LSS2200-8P Web User Guide, 33861
•
LSS2200-8P CLI Reference, 33862
•
LSS2200-8P REST API User Guide, 33863
•
LSS2200-8P MobileApp User Guide, 33870
•
Release Notes (revision specific)
LSS2200-8P REST API
The RESTful API is available for integrating and managing the switch via third-party tools.
The LSS2200-8P REST API is a general-purpose management API used by the LSS2200-8P Web UI. It is full-
featured, on par with the CLI in terms of functional scope. It is also exposed and can be used by RESTful
northbound management applications that a customer would deploy. Since there are built-in ways of learning and
using the API, the following information is provided in this document:
•
Connecting to the API
•
Logging in to the API
•
Browsing and interacting with the API endpoints through the built-in OpenAPI (Swagger) client
•
Obtaining the API schema via the link near the top of the OpenAPI page
•
Several curl examples
REST (Representational State Transfer) is an architectural style for HTTP-based interactive Web services that
allows local or remote clients to retrieve and manage data in a target system. A RESTful server uses methods,
structures, and response status codes defined in IETF
RFC 7231 - Hypertext Transfer Protocol (HTTP/1.1):
to implement CRUD (create, retrieve, update, delete) functionality that responds to client
requests.
The LSS2200-8P REST API is used by the local Web UI. It also serves a "northbound" interface that customers
can use to integrate EOS-based devices into their network management applications.
The LSS2200-8P REST API presents "endpoints." An endpoint comprises all of the server components necessary
to fulfill an individual request: the protocol, path, resource and data/media parameter specification, along with the
underlying handlers for that resource and parameter. Collectively, the endpoint definitions form the schema(s)
that the server supports.
Currently, EOS defines one distinct schema: the LSS2200-8P REST API, version 1. In future releases, the
LSS2200-8P REST API may support additional versions. Version is part of the base path, so each version defines
a separate schema.
