Home

Cerrion API Documentation

This wiki provides a concise overview of the APIs available in the Cerrion solution.

Edge Server APIs

The edge server hosts the following APIs for local / on-premise integration:

• OPC UA API

  • Provides access to machine and process data through standard OPC UA connections.
  • Ideal for industrial devices and SCADA systems that require secure, interoperable data exchange.

• MQTT API

  • Supports lightweight publish/subscribe messaging for real-time telemetry and event data.
  • Commonly used for low-bandwidth, high-frequency edge communication.

Cloud APIs

These cloud-hosted APIs are used for higher-level analytics and business workflows:

• Detections API

  • Offers event and anomaly detection data produced by the cloud service.
  • Use it to retrieve detection summaries, timestamps, categories, and related metadata.

• Downtime API

  • Provides access to equipment downtime records and analysis.
  • Designed to support production performance monitoring, root cause analysis, and reporting.

How to Use This Wiki

Each API has its own page with details about available endpoints, request/response formats, and examples:

• API-Authentication.md — Request and use the Bearer token required for REST access
• Cerrion-OPC-UA.md — OPC UA API details
• Count-and-downtime-MQTT-API.md — MQTT API details
• Detections-API.md — Detections Cloud API details
• Downtime-API.md — Downtime Cloud API details

If you need a quick overview of the services installed on edge versus cloud, start with the sections above and then open the corresponding API page for implementation details.