Overview¶
Overview of REST endpoints to different services comprising CMTK.
Breaking Changes
With version 2.0 some of the End Points changed. Review the Breaking Changes table: Breaking Changes
Warning
The endpoints documented in this sections are only available through the Docker environment.
Note
A massive amount of parallel REST request might cause issues. There is a rate limit set for the used reverse proxy nginx. For example it might be a good idea to receive process data via MQTT instead of "polling" it by a REST call. For acyclical parameter data it is important to wait for previous calls to finish before requesting again. Requests to different ports might be placed in parallel.
- IO-Link Data Provider API — endpoints for data collection and filtering
- Gateway Settings API — allows changing gateway related settings such as time, network etc.
- YAASY API — cmtk related configuration.
- MQTT Manager API — MQTT broker configuration
- Database Manager API — allows retrieval of InfluxDB related info and configuration of external access to DB as well as endpoints to export the data.
- Grafana Manager API — dashboard generation and notification endpoints
- Certificate Manager API — cmtk security certificate