home-assistant.io/source/_components/switch.rest.markdown

layout, title, description, date, sidebar, comments, sharing, footer, ha_category, ha_release

layout	title	description	date	sidebar	comments	sharing	footer	ha_category	ha_release
page	RESTful Switch	Instructions how to integrate REST switches into Home Assistant.	2015-09-14 19:10	true	false	true	true	Switch	0.7.6

The rest switch platform allows you to control a given endpoint that supports a RESTful API. The switch can get the state via GET and set the state via POST on a given REST resource.

To enable this switch, add the following lines to your configuration.yaml file:

# Example configuration.yaml entry
switch:
  platform: rest
  resource: http://IP_ADDRESS/ENDPOINT
  name: "Bedroom Switch"
  body_on: "ON"
  body_off: "OFF"

Configuration variables:

• resource (Required): The resource or endpoint that contains the value.
• name (Optional): Name of the REST switch.
• body_on (Optional): The body that represents enabled state. Default is "ON".
• body_off (Optional):The body that represents disabled state. Default is "OFF".

Make sure that the URL matches exactly your endpoint or resource.