homebridge-http-status's Introduction

homebridge-http-status

A Http status sensor plugin for homebridge (https://github.com/nfarina/homebridge).

Installation

Install homebridge using: npm install -g homebridge
Install homebridge-http-status plugin: npm install -g homebridge-http-status
Update your config.json configuration file

Configuration

Example config.json entry:

{
            "platform": "HttpStatus",
            "sensors": [
                {
                    "id": "check-api",
                    "name": "Api Health",
                    "okStatus" : 200,
                    "expectedResponse": "true",   
                    "responsePath": "path.to.the.json.entry",   {"path": {"to": {"the": {"json": {"entry": true}}}}}  
                    "method": "get",
                    "headers": {"Authorization": "TOKEN", "Some-Header": "Some-Header-Value"},
                    "url": "https://some.api.com/health",
                    "interval": 180
                },
               ....
               ....
            ]

Credits

This Plugin inspired by the https://github.com/jsworks/homebridge-ping-hosts

Support homebridge-http-status

homebridge-http-status is a free plugin under the BSD license. it was developed as a contribution to the homebridge/hoobs community with lots of love and thoughts. Creating and maintaining Homebridge plugins consume a lot of time and effort and if you would like to share your appreciation, feel free to "Star" or donate.

Recommend Projects