RESTful API Document Version and Location
The ESPEC North America Web Controller provides full support for monitoring, control, and operation via a RESTful API. Although naming conventions differ somewhat across software versions, they originate from the same core design and reflect the product's ongoing evolution and refinement.
The location of the RESTful API documentation depends on the firmware version of your Web Controller.
ESPEC Web Controller Version 3 (EWC V3) is the current generation of the Web Controller software. As of June 2026, the latest release is Version 3.3.16. The first release of EWC V3 became available in April 2022.
RESTful API documentation for EWC V3 is generated dynamically based on the chamber configuration. As a result, the software includes built-in RESTful API documentation that reflects the features available on the specific controller. The documentation can be accessed in two different ways:
Procedure: Method 1
- From within the EWC V3 user interface, log in as admin
- Access the Settings menu
- Access the API submenu
- Click on the RESTful API V4 Documentation link under the GENERAL tab
Procedure: Method 2
- While already logged in EWC V3,
- Edit the URL link with the following: http://IP_OR_HOSTNAME/api-docs, where IP_OR_HOSTNAME can be the IP address or hostname of EWC V3.
- Example: If your EWC V3 has IP address 192.168.1.222, the URL will be: http://192.168.1.222/api-docs
- Don't have access to your server? Use our Demo Server
This version was used from Jan 2017 (2.1.0) thru March 2022 (2.5.12).
RESTful API documentation Firmware Version 2
This documentation also works for Firmware Version 3 using a built-in adapter layer, but it is not recommended for new development.
