{"__v":1,"_id":"57eaf7480392f60e001251ff","category":{"__v":0,"_id":"571699927256fb0e00c1d01c","project":"56130e29d2b2370d0096b91a","version":"56130e2ad2b2370d0096b91d","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-04-19T20:48:18.215Z","from_sync":false,"order":0,"slug":"sites","title":"Reference"},"parentDoc":null,"project":"56130e29d2b2370d0096b91a","user":"56130dcf8e503f0d00648b03","version":{"__v":11,"_id":"56130e2ad2b2370d0096b91d","project":"56130e29d2b2370d0096b91a","createdAt":"2015-10-05T23:56:26.509Z","releaseDate":"2015-10-05T23:56:26.509Z","categories":["56130e2bd2b2370d0096b91e","56130f638e503f0d00648b05","561317cdbe80130d00f188dd","561317d8ff92880d005ca212","56f97c0f8fef7520003f818e","570d751180c9010e00d77f4d","570d7543e2a0b40e0077aa90","571699927256fb0e00c1d01c","57f43db31592cb0e00761dd6","57f52ed668a53b2000e03efa","57f5350f485e6e2b005b2f27"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"0.0.0","version":"0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-09-27T22:48:40.153Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"curl","code":"curl -X POST 'https://api.stacklighting.com/v0/sites/6133345811384985/strobe \\\n     -H 'Content-Type: application/json' \\\n     -H 'Authorization: Bearer YmE3MTU5MWItZTIwMC00MDc2LWJmZTQtZDH5YmUxMTA0ZTNmOjU3NjE2NzM5MzE1MjIwNDg=' \n     -d '{\"transition_duration\":\"500\", \"strobe_count\":\"5\", \"email\":\"darth:::at:::stacklighting.com\",\"password\":\"deathstar4eva\"}'"}]},"method":"post","results":{"codes":[{"status":201,"language":"json","code":"{\n \"on\": true,\n \"end_delay\": 0,\n \"description\": \"selected\",\n \"max_brightness\": 1600,\n \"color_temperature\": 4250,\n \"id\": \"QXn7ed66WDyLOLJMReAyjraPM\",\n \"min_brightness\": 200,\n \"transition_duration\": 500,\n \"sequence_count\": 1,\n \"zone_ids\": [],\n \"bulb_ids\": [\"GvmReG8nDLVMMabgLaPKrdrwz\", \"NRmgQy3JRv7qDAnNknYjzbam7\"],\n \"strobe_count\": 5\n}","name":""}]},"settings":"","auth":"required","params":[{"_id":"57eaf7480392f60e00125201","ref":"","in":"body","required":false,"desc":"The amount of time between strobes, in milliseconds.","default":"200","type":"string","name":"transition_duration"},{"_id":"57eaf7480392f60e00125200","ref":"","in":"body","required":false,"desc":"The number of time to strobe the lights.","default":"3","type":"string","name":"strobe_count"},{"_id":"57eaf7a443d2780e008e7a85","ref":"","in":"path","required":true,"desc":"","default":"The unique identifier for the site.","type":"string","name":"site_id"}],"url":"/sites/:site_id/strobe"},"isReference":true,"order":6,"body":"","excerpt":"This endpoint strobes all of the lights in a user's site.","slug":"strobe","type":"endpoint","title":"Strobe"}

postStrobe

This endpoint strobes all of the lights in a user's site.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

site_id:
required
stringThe unique identifier for the site.

Body Params

transition_duration:
string200
The amount of time between strobes, in milliseconds.
strobe_count:
string3
The number of time to strobe the lights.

Examples


Result Format


User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}