
* Create rest_command.markdown * Update rest_command.markdown * Update rest_command.markdown * Update rest_command.markdown * Update rest_command.markdown * Update rest_command.markdown
1.2 KiB
1.2 KiB
layout | title | description | date | sidebar | comments | sharing | footer | logo | ha_category | ha_release |
---|---|---|---|---|---|---|---|---|---|---|
page | RESTful Command | Instructions how to integrate REST commands into Home Assistant. | 2016-12-27 00:00 | true | false | true | true | restful.png | Automation | 0.36.0 |
This component can expose regular rest commands as services. Services can be called from a script or in automation.
To enable this switch, add the following lines to your configuration.yaml
file:
# Example configuration.yaml entry
# Exposes service rest_command.example_request
rest_command:
example_request:
url: 'http://example.com/'
Configuration variables:
- url (Required): URL (support template) for sending request.
- method (Optional): HTTP method (get, post, put, delete). Default is get.
- payload (Optional): A string/Template to send with request.
- username (Optional): username for HTTP authentication
- password (Optional): password for HTTP authentication
- timeout (Optional): Timeout for requests, default 10 seconds.
The commands can be dynamic, using templates to insert values of other entities. Service call support variables for template stuff.