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-23 17:27:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update rest_command.markdown configuration (#7122)

Browse Source 
* Update rest_command.markdown

* Update rest_command.markdown

* Update rest_command.markdown

* Update rest_command.markdown

* Update rest_command.markdown

* ✏️ Tweak
This commit is contained in:
Hmmbob 2018-10-29 12:06:12 +01:00 committed by Franck Nijhof
parent f505b2853b
commit bc71516c56
1 changed files with 41 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
source/_components/rest_command.markdown
View File

@ -27,17 +27,47 @@ rest_command:
url: 'http://example.com/'
```
Configuration variables:
- **[service_name]** (*Required*): The name used to expose the service. E.g., in the above example, it would be `rest_command.example_request`.
- **url** (*Required*): The URL (support template) for sending request.
- **method** (*Optional*): HTTP method to use (`get`, `post`, `put`, or `delete`). Defaults to `get`.
- **headers** (*Optional*): The headers for the requests.
- **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.
- **content_type** (*Optional*): Content type for the request.
{% configuration %}
service_name:
description: The name used to expose the service. E.g., in the above example, it would be 'rest_command.service_name'.
required: true
type: map
keys:
url:
description: The URL (supports template) for sending request.
required: true
type: [string, template]
method:
description: HTTP method to use (get, post, put, or delete).
required: false
default: get
type: string
headers:
description: The headers for the requests.
required: false
type: list
payload:
description: A string/template to send with request.
required: false
type: [string, template]
username:
description: The username for HTTP authentication.
required: false
type: string
password:
description: The password for HTTP authentication.
required: false
type: string
timeout:
description: Timeout for requests in seconds.
required: false
type: string
defaut: 10
content_type:
description: Content type for the request.
required: false
type: string
{% endconfiguration %}
## {% linkable_title Examples %}