Rest API
The Flir Si2a provides a Representational State Transfer (REST) Application Programming Interface (API) that enables programmatic access to selected camera information and functions.
The REST API of the Flir Si2a Fixed Acoustic Camera enables secure and flexible integration with external systems using standard web technologies. By providing structured access to device status, events, and detection results, the API supports automation, monitoring, and advanced system integration while keeping acoustic processing and control within the Flir Si2a platform.
The REST API is intended for system integration and automation use cases, allowing external applications to retrieve device status, detection results, events, and configuration data over standard IP networks using HTTP‑based requests.
The REST API complements other interfaces such as the web user interface and RTSP. It is designed for integration and data access, not for live video streaming or raw acoustic signal processing.
The REST API can be used, for example, to:
Integrate the Flir Si2a into industrial monitoring systems, asset management platforms, or cloud solutions.
Retrieve camera status and health information.
Access acoustic detection events, such as leak or partial discharge detections.
Support remote monitoring and automation workflows.
Enable custom software development and third‑party integrations.
Typical users include system integrators, software developers, and IT/OT administrators.
API characteristics
Protocol: HTTP.
Data format: JSON.
Architecture: Resource‑oriented REST interface.
Access: Local network (and remote access were permitted by network configuration).
The API uses standard HTTP methods such as GET, POST, and PUT/PATCH to access and manage resources.
Authentication and security
Access to the REST API is controlled using the same security mechanisms as the camera’s web interface.
Depending on system configuration, API access may require:
User authentication (username and password).
Rile-based access control.
Flir recommends limiting API access to trusted networks and users and following standard IT security practices when integrating the Flir Si2a into external systems.
Available API resources (typical)
The REST API provides access to a defined set of resources, which may include:
System information.
Device identification.
Firmware version.
Uptime and operating state.
Health and diagnostics.
Device status indicators.
Environmental and internal health metrics.
Detection results.
Acoustic leak detections.
Partial discharge detection.
Detection metadata (time, severity, confidence).
Events and alarms.
Active and historical events.
Acknowledgement status.
Configuration data.
Selected configuration parameters.
Read‑only or limited write access, depending on user permissions.
The exact set of available endpoints may vary depending on firmware version and system configuration.
Limitations
The REST API does not provide access to:
Raw microphone array data.
Acoustic beamforming data.
Continuous acoustic signal streams.
Live video streaming is not supported via REST (use RTSP instead).
API availability and functionality may depend on firmware version and licensing.
API documentation and version management
The REST API follows a versioned interface model to support future enhancements while maintaining backward compatibility where possible.
Detailed API endpoint descriptions, request/response examples, and data models are provided in separate API documentation or integration guides supplied by Flir.
Always verify API compatibility when updating camera firmware or integrating with third‑party software.
Typical integration workflow
Configure network settings and user accounts on the camera.
Enable API access according to system requirements.
Authenticate to the REST API.
Query device status or subscribe to event updates.
Process detection results or system data in the external application.