briqs

Change when a briq goes to sleep

A new sleep window ("30m", "3h", "7d") or "never" (always on, Pro and above), for the briq or its whole stack. Changing it counts as use: a running briq sleeps the window from now. A sleeping briq stays asleep until its next use.

post/v1/briqs/{id}/sleep

Request

  • Base URL: https://api.briq.cloud
  • URL: https://api.briq.cloud/v1/briqs/{id}/sleep
  • Auth: HTTP bearer

Path parameters

idstring required

Request body

sleepstring required

When the briq goes to sleep: after this long without use (agent calls, visits to its stack's URLs). A string: "30m", "3h", "7d" or "never", never a number. A sleeping briq keeps its disk, costs nothing for compute, and the next use wakes it. "never" keeps it always on (Pro plan and above)

stackboolean

true: give the same sleep to every briq of its stack, which sleeps and wakes together

Response

ok

Changes

No recorded changes to this operation across all 2 revisions of this API.