# qss-switch-api: reconstructing QNAP QSS switch control

> qss-switch-api reconstructs access to the private REST interface of a QNAP QSS-managed switch from its web UI JavaScript. Its Python CLI logs in, reads port, PoE, sensor and LLDP telemetry, and can send explicit API calls; the documentation records bearer-token authentication and response fields.

- Type: Case study
- Targets: Protocol
- Category: Independent reconstruction cases
- Relationship: Independent reconstruction project
- Sources reviewed: 2026-11-06
- Added to the catalog: 2026-11-08
- Original resource: <https://github.com/Gotham-Sound/qss-switch-api>
- Primary source: <https://github.com/Gotham-Sound/qss-switch-api/blob/3a89625ee17e3ed191f61e880f696ec81e7823d2/README.md>
- Catalog page: <https://awesomerea.org/resources/qss-switch-api-case/>
- Record JSON: <https://awesomerea.org/resources/qss-switch-api-case/record.json>
- Chinese version: [简体中文](https://awesomerea.org/zh/resources/qss-switch-api-case/index.md)

## Requirements & limits

- **Prerequisites:** Python 3.8+; PyYAML is optional for YAML configuration.
- **Scope:** QNAP QSS-managed switch; documented validation covers QSW-M2106PR-2S2T firmware 1.2.1.
- **Limits:** Write requests require explicit confirmation and can disrupt switch configuration.
- **License:** MIT license.

## Primary sources

1. <https://github.com/Gotham-Sound/qss-switch-api/blob/3a89625ee17e3ed191f61e880f696ec81e7823d2/README.md>

## More in Protocols

- [NameLand: reconstructing Casio KL-A45 serial printing](https://awesomerea.org/resources/nameland-case/index.md) · Case study
- [dh360d: reconstructing the Darkflash cooler LCD protocol](https://awesomerea.org/resources/dh360d-case/index.md) · Case study
- [Sony WH-CH720N: reconstructing headset control over RFCOMM](https://awesomerea.org/resources/sony-wh-ch720n-linux-case/index.md) · Case study
- [Kosmos CP1: reconstructing the CP2 cassette format](https://awesomerea.org/resources/kosmos-cp1-cassette-case/index.md) · Case study
- [ISDT PB40: reconstructing a power bank's BLE protocol](https://awesomerea.org/resources/pb40-bluetooth-case/index.md) · Case study
- [Jacuzzi JB1HL: decoding the J185 panel-link bus](https://awesomerea.org/resources/jacuzzi-jb1hl-protocol-case/index.md) · Case study

## About this entry

The description was reviewed against primary sources.
Original editorial content: MIT. Linked projects, papers and assets retain their own rights and licenses.