{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/lights/:selector/effects/off","auth":"required","examples":{"codes":[{"code":"curl -X POST \"https://api.lifx.com/v1/lights/all/effects/off\" \\\n -H \"Authorization: Bearer [[app:Token]]\" \\\n -d 'power_off=true'","language":"curl"},{"code":"<?php\n\n$link = \"https://api.lifx.com/v1/lights/all/effects/off\";\n$authToken = \"[[app:Token]]\";\n\n$headers = array('Authorization: Bearer ' . $authToken);\n$data = 'power_off=true';\n\n$ch = curl_init($link);\ncurl_setopt($ch, CURLOPT_HTTPHEADER, $headers);\ncurl_setopt($ch, CURLOPT_POSTFIELDS, $data);\ncurl_setopt($ch, CURLOPT_POST, true);\n$response = curl_exec($ch);\n\n?>","language":"php"},{"code":"import requests\n\ntoken = \"[[app:Token]]\"\n\nheaders = {\n \"Authorization\": \"Bearer %s\" % token,\n}\n\ndata = {\n \"power_off\": True\n}\n\nresponse = requests.post('https://api.lifx.com/v1/lights/all/effects/off', data=data, headers=headers)","language":"python"}]},"settings":"","results":{"codes":[{"language":"json","status":"2XX","name":"","code":"{\n \"results\": [\n {\n \"id\": \"d3b2f2d97452\",\n \"label\": \"Left Lamp\",\n \"status\": \"ok\"\n }\n ]\n}"}]},"method":"post","params":[{"name":"selector","type":"string","default":"","desc":"The [selector](doc:selectors) to limit which lights this applies to","required":true,"in":"path","ref":"","_id":"5581116804ae5b0d0026287d"},{"name":"power_off","type":"boolean","default":"false","desc":"If true, the devices will also be turned off","required":false,"in":"body","ref":"","_id":"558112dfa5474a0d00d9438d"}]},"next":{"description":"","pages":[]},"title":"Effects off","type":"endpoint","slug":"effects-off","excerpt":"","body":"Turns off any running effects on the device. This includes any waveform (breathe or pulse) as well as Tile or Multizone firmware effects.\n\nAlso, if you specify power_off as true then the lights will also be powered off.","updates":[],"order":11,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5c930bf0af23990013eaa722","project":"54ebb40d6423300d003672c0","version":{"version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["55f28172f9f3991900f38a14","55f28172f9f3991900f38a15","55f28172f9f3991900f38a16","55f66acb297b37170058accb","5d229ff5e59b8e003ab3a9da"],"_id":"55f28172f9f3991900f38a13","project":"54ebb40d6423300d003672c0","releaseDate":"2015-09-11T07:23:30.065Z","createdAt":"2015-09-11T07:23:30.065Z","__v":3},"category":{"sync":{"isSync":false,"url":""},"pages":["55f28173f9f3991900f38a1d","55f28173f9f3991900f38a1e","55f28173f9f3991900f38a1f","55f28173f9f3991900f38a20","55f28173f9f3991900f38a21","55f28173f9f3991900f38a22","55f28173f9f3991900f38a23","55f28173f9f3991900f38a24","55f28173f9f3991900f38a25","55f28173f9f3991900f38a26","55f28173f9f3991900f38a27","55f63d46fe4cce21005c785e","55f65cc16be5ea0d00bbbf4c"],"title":"API Endpoints","slug":"api-endpoints","order":2,"from_sync":false,"reference":false,"_id":"55f28172f9f3991900f38a16","__v":3,"createdAt":"2015-06-17T05:23:31.147Z","project":"54ebb40d6423300d003672c0","version":"55f28172f9f3991900f38a13"},"user":"57749b725b96cf0e00558ea6","createdAt":"2019-03-21T03:58:40.868Z","__v":2,"parentDoc":null}
postEffects off
Definition
{{ api_url }}{{ page_api_url }}
Parameters
Path Params
selector:
required
string
The [selector](doc:selectors) to limit which lights this applies to
Body Params
power_off:
booleanfalse
If true, the devices will also be turned off