LiveEdge® Node - V12.1.1.163.3
This article applies to Videon's LiveEdge Node and EZ Node products.
Videon's REST API enables you to automate many of the functions available through the local web UI and/or LiveEdge® Cloud. The documentation below provides access to both living API documentation hosted directly on your device and remotely hosted API documentation for reference and development.
Table of Contents:
- Access the API Documentation
- About Living API Documentation
- Remotely Hosted / Downloadable API Documentation
- Getting Started
- API Availability
Access the API Documentation
Core API - Port 2020 (Firmware Versions >V12.1.1)
Interactive living API documentation hosted directly on the device.http://<encoder_ip>/api-docs
About Living API Documentation
The living API documentation is hosted directly on the Videon device and reflects the APIs available on the firmware currently running on that device. This makes the local documentation the authoritative reference when developing against a specific device.
For convenience, remotely hosted documentation is also available. This documentation reflects the latest supported API version and may not include changes or endpoints specific to older firmware versions. If your device is running older firmware, use the local living API documentation as your primary reference.Remotely Hosted / Downloadable API Documentation
Remotely Hosted / Downloadable API Documentation
For development and reference purposes, the latest API documentation is also available remotely in the following formats:
HTML - Documentation files for offline reference
JSON - OpenAPI/Swagger specification for use with compatible development tools
Getting Started
To use the living API documentation hosted on your device:
Connect your computer to the same network as the Videon device.
Determine the Videon device's IP address.
Open the appropriate API documentation URL in a web browser.
Explore the available endpoints, parameters, and responses.
Use the API to integrate with or automate your Videon device.
API Availability
Available API endpoints and functionality may vary by product and software version. Always use the living API documentation hosted on the device as the authoritative reference for the APIs available on that device.