HTTP APILAN Protocol
API Reference
  1. API Endpoints

Sunrise Effect

post
https://api.lifx.com/v1/lights//effects/sunrise
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Performs a sunrise effect on the tiles in your selector, if supported. Use the parameters to tweak the effect. Note that the brightness of the sunrise is determined by the brightness of the tile. To change the brightness, use the SetState endpoint. Requires firmware >= 4.8.

Path Params
string
required

The selector to limit which devices will run the effect.

Body Params
float
Defaults to 10

How long the animation takes in seconds. Specifying 0 makes the animation stop.

boolean
Defaults to false

This persists the final colour of the animation on effect completion, instead of reverting to the previous state of the light.

boolean
Defaults to false

Execute the query fast, without initial state checks and wait for no results.

Response

Updated about 1 year ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago

Did this page help you?