jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-21 08:16:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

Minor changes

Browse Source
This commit is contained in:
Fabian Affolter 2017-01-07 09:27:43 +01:00
parent b0d33fad74
commit d6af430df8
No known key found for this signature in database
GPG Key ID: DDF3D6F44AAB1336
1 changed files with 11 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
source/_components/rest_command.markdown
View File

@ -9,30 +9,32 @@ sharing: true
footer: true
logo: restful.png
ha_category: Automation
ha_release: 0.36.0
ha_release: 0.36
---
This component can expose regular rest commands as services. Services can be called from a [script] or in [automation].
This component can expose regular REST commands as services. Services can be called from a [script] or in [automation].
[script]: /components/script/
[automation]: /getting-started/automation/
To enable this switch, add the following lines to your `configuration.yaml` file:
```yaml
# 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.
- **[service_name]** (*Required*): The name used to expose the service. E.g. in the above example would it be ` rest_command.example_request`.
- **url** (*Required*): The 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*): The username for HTTP authentication.
- **password** (*Optional*): The password for HTTP authentication.
- **timeout** (*Optional*): Timeout for requests. Defaults to 10 seconds.
The commands can be dynamic, using templates to insert values of other entities. Service call support variables for template stuff.