The REST API of openHAB serves different purposes. It can be used to integrate openHAB with other systems as it allows read access to items and item states as well as status updates or the sending of commands for items. Furthermore, it gives access to the sitemaps, so that it is the interface to be used by remote user interfaces (e.g. fat clients or javascript based web clients). The REST API also supports server-push, so you can subscribe yourself on change notification for certain resources.

For further details, please check:

  • The openHAB 1.x wiki REST API article
  • The interactive REST API documentation in your local installation, available through the openHAB 2 portal page (installable “Misc” extension)

Contributions Wanted

Help improve the openHAB 2 documentation! If you'd like to leave corrections, additons or comments for this article or any other part of this website, please drop a word at: