diff --git a/source/_components/rest_command.markdown b/source/_components/rest_command.markdown index d8b2d566b87..f637155ec2f 100644 --- a/source/_components/rest_command.markdown +++ b/source/_components/rest_command.markdown @@ -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.