Action Endpoints
Action Endpoints⚓︎
Turn On⚓︎
| Method | Endpoint | Description |
|---|---|---|
| POST | /switcher/turn_on | Turn a device on, optionally setting a timer for turning it back off automatically. |
Query Params
| Param | Type | Description | Required | Example |
|---|---|---|---|---|
| type | Device Type | the type of the selected device | Yes | mini |
| id | string | the id of the selected device | Yes | ab1c2d |
| key | string | the login key of the selected device | No | 18 |
| ip | string | the ip address of the selected device | Yes | 10.0.0.1 |
| index | integer | the circuit number to operate | No | 0 |
| token | string | the user token from Switcher API | No | zvVvd7JxtN7CgvkD1Psujw== |
Body
| Key | Type | Required | Example |
|---|---|---|---|
| minutes | integer | No | 90 |
Turn Off⚓︎
| Method | Endpoint | Description |
|---|---|---|
| POST | /switcher/turn_off | Turn a device off. |
Query Params
| Param | Type | Description | Required | Example |
|---|---|---|---|---|
| type | Device Type | the type of the selected device | Yes | mini |
| id | string | the id of the selected device | Yes | ab1c2d |
| key | string | the login key of the selected device | No | 18 |
| ip | string | the ip address of the selected device | Yes | 10.0.0.1 |
| index | integer | the circuit number to operate | No | 0 |
| token | string | the user token from Switcher API | No | zvVvd7JxtN7CgvkD1Psujw== |
Turn On Light⚓︎
| Method | Endpoint | Description |
|---|---|---|
| POST | /switcher/turn_on_light | Turn a light device on. |
Query Params
| Param | Type | Description | Required | Example |
|---|---|---|---|---|
| type | Device Type | the type of the selected device | Yes | mini |
| id | string | the id of the selected device | Yes | ab1c2d |
| key | string | the login key of the selected device | No | 18 |
| ip | string | the ip address of the selected device | Yes | 10.0.0.1 |
| index | integer | the circuit number to operate | No | 0 |
| token | string | the user token from Switcher API | No | zvVvd7JxtN7CgvkD1Psujw== |
Turn Off Light⚓︎
| Method | Endpoint | Description |
|---|---|---|
| POST | /switcher/turn_off_light | Turn a light device off. |
Query Params
| Param | Type | Description | Required | Example |
|---|---|---|---|---|
| type | Device Type | the type of the selected device | Yes | mini |
| id | string | the id of the selected device | Yes | ab1c2d |
| key | string | the login key of the selected device | No | 18 |
| ip | string | the ip address of the selected device | Yes | 10.0.0.1 |
| index | integer | the circuit number to operate | No | 0 |
| token | string | the user token from Switcher API | No | zvVvd7JxtN7CgvkD1Psujw== |
Stop Shutter⚓︎
| Method | Endpoint | Description |
|---|---|---|
| POST | /switcher/set_stop_shutter | Stop a shutter device. |
Query Params
| Param | Type | Description | Required | Example |
|---|---|---|---|---|
| type | Device Type | the type of the selected device | Yes | mini |
| id | string | the id of the selected device | Yes | ab1c2d |
| key | string | the login key of the selected device | No | 18 |
| ip | string | the ip address of the selected device | Yes | 10.0.0.1 |
| index | integer | the circuit number to operate | No | 0 |
| token | string | the user token from Switcher API | No | zvVvd7JxtN7CgvkD1Psujw== |
Control Breeze⚓︎
| Method | Endpoint | Description |
|---|---|---|
| POST | /switcher/control_breeze_device | Control a breeze device. |
Query Params
| Param | Type | Description | Required | Example |
|---|---|---|---|---|
| type | Device Type | the type of the selected device | Yes | mini |
| id | string | the id of the selected device | Yes | ab1c2d |
| key | string | the login key of the selected device | No | 18 |
| ip | string | the ip address of the selected device | Yes | 10.0.0.1 |
| index | integer | the circuit number to operate | No | 0 |
| token | string | the user token from Switcher API | No | zvVvd7JxtN7CgvkD1Psujw== |
Body
| Key | Type | Required | Example |
|---|---|---|---|
| device_state | string | No | on |
| thermostat_mode | string | No | auto |
| target_temp | integer | No | 25 |
| fan_level | string | No | low |
| thermostat_swing | string | No | off |
| remote_id | string | Yes | DLK65863 |