Package Exports

iobroker.rest-api
iobroker.rest-api/main.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (iobroker.rest-api) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Logo

REST-API adapter

Number of Installations

This adapter uses Sentry libraries to automatically report exceptions and code errors to the developers. For more details and for information how to disable the error reporting see Sentry-Plugin Documentation! Sentry reporting is used starting with js-controller 3.0.

This is RESTFul interface to read the objects and states from ioBroker and to write/control the states over HTTP Get/Post requests.

The purpose of this adapter is similar to simple-api. But this adapter supports long-polling and URL hooks for subscribes.

It has very useful web interface to play with the requests:

Screenshot

Usage

Call in browser http://ipaddress:8093/ and use Swagger UI to request and modify the states and objects

Your application could get notifications by every change of the state or object.

For that your application must provide an HTTP(S) end-point to accept the updates.

Example in node.js see here demoNodeClient.js

Long polling

This adapter supports subscribe on data changes via long polling.

Example for browser could be found here: demoNodeClient.js

Web extension

This adapter can run as web-extension. In this case the path is available under http://iipaddress:8082/rest

Notice

POST is always for creating a resource (does not matter if it was duplicated)
PUT is for checking if resource exists then update, else create new resource
PATCH is always for updating a resource

Changelog

0.3.0 (2022-04-15)

(bluefox) First release

0.1.0 (2017-09-14)

(bluefox) initial commit

License

Apache 2.0

iobroker.rest-api