Lantronix LSS2200-8P User manual

LSS2200-8P
Managed Layer 2 Gigabit Ethernet PoE++ Switch
(8) 10/100/1000Base-T IEEE 802.3bt + (2) 10G/5G/2.5G/1G SFP+ Multi-Gig Slots
REST API User Guide
Part Number 33863
Revision A October 2022

Lantronix LSS2200-8P API User Guide
33863 Rev. A https://www.lantronix.com/ 2
Intellectual Property
© 2022 Lantronix, Inc. All rights reserved. No part of the contents of this publication may be transmitted or
reproduced in any form or by any means without the written permission of Lantronix.
Lantronix is a registered trademark of Lantronix, Inc. in the United States and other countries.
All other trademarks and trade names are the property of their respective holders.
Patented: https://www.lantronix.com/legal/patents/; additional patents pending.
Warranty
For details on the Lantronix warranty policy, go to http://www.lantronix.com/support/warranty.
Contacts
Lantronix Corporate Headquarters
48 Discovery, Suite 250
Irvine, CA 92618, USA
Toll Free: 800-526-8766
Phone: [phone]
Fax: [phone]
Technical Support
Phone: [phone] or 1.800.260.1312 or Email https://www.lantronix.com/technical-support/
Sales Offices
For a current list of our domestic and international sales offices, go to www.lantronix.com/about/contact.
Disclaimer
All information contained herein is provided “AS IS.” Lantronix undertakes no obligation to update the information
in this publication. Lantronix does not make, and specifically disclaims, all warranties of any kind (express, implied
or otherwise) regarding title, non-infringement, fitness, quality, accuracy, completeness, usefulness, suitability or
performance of the information provided herein. Lantronix shall have no liability whatsoever to any user for any
damages, losses and causes of action (whether in contract or in tort or otherwise) in connection with the user’s
access or usage of any of the information or content contained herein. The information and specifications
contained in this document are subject to change without notice.
Revision History
Date
Rev.
Comments
10/20/22
A
Initial release at LSS2200-8P REST API version 1.

Lantronix LSS2200-8P API User Guide
33863 Rev. A https://www.lantronix.com/ 3
Contents
1. Introduction..........................................................................................................................................................4
Product Description ................................................................................................................................................4
About This Manual..................................................................................................................................................4
Related Manuals.....................................................................................................................................................4
LSS2200-8P REST API ..........................................................................................................................................4
Path Structure.........................................................................................................................................................5
Using and Testing...................................................................................................................................................5
To use the built-in Swagger UI client ..................................................................................................................5
Using Command Line Clients (curl, postman) ....................................................................................................6
Troubleshooting ......................................................................................................................................................7

Lantronix LSS2200-8P API User Guide
33863 Rev. A https://www.lantronix.com/ 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):
Semantics and Content 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.

Lantronix LSS2200-8P API User Guide
33863 Rev. A https://www.lantronix.com/ 5
Path Structure
The path (URI) structure for each endpoint is:
<protocol>://<mgmt_ip>:<rest_port>/<api_prefix>/<resource> , where:
<protocol> http
<mgmt_ip> the management logical interface IP address on the switch
<rest_port> REST listening port, currently fixed at 8000 (eventually configurable)
<api_prefix> identifies the schema: rest/v1/
<resource> a managed entity class or instance within a namespace (e.g., sysinfo for system information,
/user/{username} for requests on a specified user account)
Examples (LSS2200-8P REST API):
•GET https://172.17.0.2:8000/rest/v1/sysinfo - gets system info
•GET https://172.17.0.2:8000/rest/v1/users - gets the list of all configured user accounts
•PUT https://172.17.0.2:8000/rest/v1/user/john <plus header and data blocks> - create a user
account with username "john"
Using and Testing
The LSS2200-8P Web UI uses the LSS2200-8P REST API to interact with the management layers.
It is also possible to interact directly with the LSS2200-8P REST API using the built-in Swagger UI
(https://swagger.io/tools/swagger-ui/) or any command line HTTP web service, such as Curl (https://curl.se/) or
Postman (https://www.postman.com/).
To use the built-in Swagger UI client
For the LSS2200-8P REST API, Swagger presents a button for each resource (e.g., `sysinfo`). Clicking on a
resource expands to show a button for each method supported for that resource. After clicking on the resource
and method you want to use, click "Try it out".
If data is required (typically JSON format), Swagger shows a form field and usually shows an example of valid
data. Type over the values in the example, taking care not to change field names. Certain endpoints also require
a user-provided identifier in the path. For example, the `user/{username}` endpoints require a valid username to
be entered. When the form fields are complete, click the "Execute" button.
In a Web browser that can access your device, navigate to the base path of the schema you want to use --
https://192.168.60.1:8000/rest/v1/ for the LSS2200-8P REST API version 1.
Swagger generates and sends a curl request to the server and then presents the response received from the
server. The response includes an HTTP status code (see IETF RFC 7231) and relevant content, where content
may be data or a message, depending on the endpoint and the outcome of the request.

Lantronix LSS2200-8P API User Guide
33863 Rev. A https://www.lantronix.com/ 6
Using Command Line Clients (curl, postman)
Curl examples with data fields
Note: Login is required, so you must set the authentication header using the "Bearer <key>" string obtained
above in the Authentication section. Example:
-H 'Authorization: Bearer
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJmcmVzaCI6ZmFsc2UsImlhdCI6MTYyMTQ2MjkzMywianRpIjoiNz
ZjOGRmYzUtYjE1MS00MGU3LTk2MGUtMjgwNTFjZDI4NzA4IiwidHlwZSI6ImFjY2VzcyIsInN1YiI6ImFkbWluIiwib
mJmIjoxNjIxNDYyOTMzLCJleHAiOjE2MjIwNjc3MzN9.dPSzHvnlLkytxCx1xv3VPn3WDTwJp8QlH2r9AiVeZVM'
Some endpoints require a trailing '/' in the URL when using curl, but not in Swagger UI. Curl will return a
redirection error if an expected trailing '/' is omitted.
Resource: sysinfo
curl -k -X 'GET' 'https://172.17.0.2:8000/rest/v1/sysinfo/' -H 'accept:
application/json' -H 'Authorization: Bearer <key>'
curl -k -X 'POST' 'https://172.17.0.2:8000/rest/v1/sysinfo/' -H 'accept:
application/json' -H 'Authorization: Bearer <key>' -H 'Content-Type:
application/json' -d '{"SYSNAME": "NewName", "LOCATION": "New Place", "CONTACT":
"Someone Else"}'
Resource: banner
curl -k -X 'GET' 'https://172.17.0.2:8000/rest/v1/banner/' -H 'accept:
application/json' -H 'Authorization: Bearer <key>'
curl -k -X 'POST' 'https://172.17.0.2:8000/rest/v1/banner/' -H 'accept:
application/json' -H 'Authorization: Bearer <key>' -H 'Content-Type:
application/json' -d '{"BANNER": "New login banner"}'
Resource: users
curl -k -X 'GET' 'https://172.17.0.2:8000/rest/v1/users/' -H 'accept:
application/json' -H 'Authorization: Bearer <key>'
Resource: user/{username}
curl -k -X 'GET' 'https://172.17.0.2:8000/rest/v1/user/bob' -H 'accept:
application/json' -H 'Authorization: Bearer <key>'
curl -k -X 'PUT' 'https://172.17.0.2:8000/rest/v1/user/bob' -H 'accept:
application/json' -H 'Authorization: Bearer <key>' -H 'Content-Type:
application/json' -d '{"PASSWD": "abcdef", "ENABLED": "true", "GROUP": "config"}'
curl -k -X 'POST' 'https://172.17.0.2:8000/rest/v1/user/bob' -H 'accept:
application/json' -H 'Authorization: Bearer <key>' -H 'Content-Type:
application/json' -d '{"GROUP": "readonly"}'
curl -k -X 'DELETE' 'https://172.17.0.2:8000/rest/v1/user/bob' -H 'accept:
application/json' -H 'Authorization: Bearer <key>'

Lantronix LSS2200-8P API User Guide
33863 Rev. A https://www.lantronix.com/ 7
Troubleshooting
Note: TheLSS2200-8P REST API uses a time-dependent web token. If the system time is changed, subsequent
REST requests may return an unauthorized response, as shown below. If that occurs, the client must logout and
log in again to continue using the REST API.
1 POST https://192.168.0.200:8000/rest/v1/date_time
2 Response: 200 {'DATE': '2022-06-22', 'TIME': '16:14:08', 'SOURCE': 'Local'}
3 GET https://192.168.0.200:8000/rest/v1/date_time
4 Response: 401 {'message': 'Unauthorized'}

Lantronix LSS2200-8P API User Guide
33863 Rev. A https://www.lantronix.com/ 8
Lantronix Corporate Headquarters
48 Discovery, Suite 250
Irvine, CA 92618, USA
Toll Free: 800-526-8766
Phone: [phone]
Fax: [phone]
Technical Support
Online: https://www.lantronix.com/technical-support/
Sales Offices
For a current list of our domestic and international sales offices, go to the Lantronix web site at
www.lantronix.com/about/contact.