Skip to content

Breaking ChangesΒΆ

Description Version 1.6 Version 2.0 Method
Get the interval of the Logging Interval. /iolink/v1/mqtt/topics/{portNumber} /iolink/v1/mqtt/datarate GET
Set the interval of the Logging Interval. /iolink/v1/mqtt/topics /iolink/v1/mqtt/datarate POST
Gets the initialization state of the device. /api/device-manager/v1/configuration/initialization Deprecated GET
(Re)Sets the initialization state of the device. /api/device-manager/v1/configuration/initialization Deprecated POST
Host device properties. /api/device-manager/v1/host /api/yaasy/v1/device GET
Update host device properties. /api/device-manager/v1/host /api/yaasy/v1/device PUT
Host device image (jpeg/png). /api/device-manager/v1/host/image /api/yaasy/v1/device/image GET
Update host device image. /api/device-manager/v1/host/image /api/yaasy/v1/device/image POST
Update host device image. /api/device-manager/v1/host/image /api/yaasy/v1/device/image DELETE
Retrieve some info on configured broker and influxdb. /api/cmtk/mqtt2influx/v1/info Deprecated GET
Returns whether recording of the database is enabled. /api/cmtk/mqtt2influx/v1/recording Deprecated GET
Turns recording on or off. /api/cmtk/mqtt2influx/v1/recording Deprecated PUT
Returns whether status-bits data get stored in db. /api/cmtk/mqtt2influx/v1/statusbits Deprecated GET
Adjust status-bits data storage. /api/cmtk/mqtt2influx/v1/statusbits Deprecated PUT
Change the broker password of the user and change the broker status. /api/cmtk/mqttconfigurator/v1/broker /api/mqtt-configurator/v1/broker POST
Returns the state of the internal broker. /api/cmtk/mqttconfigurator/v1/brokerconf /api/mqtt-configurator/v1/brokerconf GET
Returns the state of the internal broker. /api/cmtk/mqttconfigurator/v1/brokerconf /api/mqtt-configurator/v1/brokerconf GET
Get the external broker user. /api/cmtk/mqttconfigurator/v1/brokeruser /api/mqtt-configurator/v1/brokeruser GET
Get a String with the broker ca.crt. /api/cmtk/mqttconfigurator/v1/brokerca Deprecated GET
Renew the broker tls cert. /api/cmtk/mqttconfigurator/v1/brokerca Deprecated POST
Retrieves infos about influxdb and retention. /api/cmtk/influxconfigurator/v1/info /api/database-manager/v1/db GET
Set the status of the internal influxdb for extern. /api/cmtk/influxconfigurator/v1/influx /api/database-manager/v1/db/port GET
Set the status of the internal influxdb for extern. /api/cmtk/influxconfigurator/v1/influx /api/database-manager/v1/db/port POST
Set the password of the influx-cmtk user. /api/cmtk/influxconfigurator/v1/user /api/database-manager/v1/db/user POST
Deletes measurements in InfluxDB. /api/cmtk/influxconfigurator/v1/measurements /api/database-manager/v1/db DELETE
Triggers and downloads an CSV export of the database. /api/influxexporter/database /api/database-manager/v1/db/export GET
Cancels the currently active database export. /api/influxexporter/database /api/database-manager/v1/db/export DELETE
Get errors, status and progress of the influx export. /api/influxexporter/progress /api/database-manager/v1/db/export/progress GET
Gets the configured smtp settings of grafana. /api/cmtk/grafana-configurator/v1/mail /api/grafana-manager/v1/mail GET
Sets the configuration of the smtp settings of grafana. /api/cmtk/grafana-configurator/v1/mail /api/grafana-manager/v1/mail POST
(Re)Creates the dashboard based on the current data in the database. /api/cmtk/grafana-configurator/v1/generate-dashboard /api/grafana-manager/v1 POST
(Re)Creates the anomaly dashboard based on the model input payload. /api/cmtk/grafana-configurator/v1/generate-anomaly-dashboard Deprecated POST
Query logs. /api/cmtk/grafana-configurator/v1/log Deprecated GET
Delete all log entries. /api/cmtk/grafana-configurator/v1/log Deprecated DELETE
Get total of log entries. /api/cmtk/grafana-configurator/v1/log/numberEntries Deprecated GET
Get grafana alerts count. /api/cmtk/grafana-configurator/v1/alerts Deprecated GET
Get all notification of the gateway device. /api/cmtk/grafana-configurator/v1/notifications /api/yaasy/v1/notifications GET
Dismisses all notification of the gateway device. /api/cmtk/grafana-configurator/v1/notifications/dismissNotification /api/yaasy/v1/notifications/dismiss POST
Dismisses the selected notification of the gateway device. /api/cmtk/grafana-configurator/v1/notifications/dismissNotification/{id} /api/yaasy/v1/notifications/dismiss/{id} POST
Read the identification of the device/application /api/balluff/v1/identification /api/balluff/identification GET
Read the general information of the device/application /api/balluff/v1/ /api/balluff/identification/configuration GET
Write the general information of the device/application /api/balluff/v1/ /api/balluff/identification/configuration PUT
Retrieve links to manuals that are stored on the device /api/balluff/v1/documents /api/balluff/documents GET
Request a shutdown /api/balluff/v1/shutdown /api/balluff/shutdown POST
Reboot request to device /api/balluff/v1/reboot /api/balluff/reboot POST
Get system time /api/balluff/v1/time /api/balluff/time GET
Set system time /api/balluff/v1/time /api/balluff/time PUT
Get information about the firmware /api/balluff/v1/firmwares/{firmwareId} /api/balluff/firmware/{firmwareId} GET
Install a firmware file /api/balluff/v1/firmwares/{firmwareId}/install /api/balluff/firmware/{firmwareId}/install POST
Information about firmware installation progress /api/balluff/v1/firmwares/{firmwareId}/install /api/balluff/firmware/{firmwareId}/install GET
Read the configuration of the network /api/balluff/v1/configuration/network /api/balluff/network/configuration GET
This REST API command is optional. Update the configuration of the network /api/balluff/v1/configuration/network /api/balluff/network/configuration PUT
Returns the ntp server configuration and timezone configuration /api/balluff/v1/configuration/ntp /api/balluff/time/configuration GET
Sets the ntp server configuration and timezone configuration /api/balluff/v1/configuration/ntp /api/balluff/time/configuration PUT
Returns the ntp server configuration /api/balluff/v1/configuration/timezone Deprecated GET
Sets the ntp server configuration /api/balluff/v1/configuration/timezone Deprecated POST