power-policies

Create a power policy

Create a named power policy that defines when screens using it should power on and off.

Notes.

  • Needs the permission at the workspace root: a location-scoped key is refused.
post/v1/power-policies

Request

  • Base URL: https://api.brixsignage.com
  • URL: https://api.brixsignage.com/v1/power-policies
  • Auth: HTTP bearer

Request body

namestring

Default on create: Untitled policy.

descriptionstring nullable
rebootHourLocalnumber nullable

0–23; rounded and clamped. Null (or a value that is not a number) turns the restart off.

timezonestring nullable

IANA time zone (Europe/London). An unknown zone is refused with 422.

Response

Success.

Example response

{
  "data": {
    "id": "ppol_1a2b3c4d5e6f7a8b"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.