power-policies

Update a power policy

Update a power policy's open and close windows, reboot hour, time zone, or name.

Notes.

  • screenCount in this response is always 0; read the policy to get the real count.
  • An empty name keeps the current name.
  • Needs the permission at the workspace root: a location-scoped key is refused.
patch/v1/power-policies/{id}

Request

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

Path parameters

idstring required

Power policy id.

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 2 revisions of this API.