sites

Set Site Live View Only

put/sites/{site_id}/live-view-only

Request

  • Base URL
    https://api.verdun.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.verdun.ai/sites/{site_id}/live-view-only
  • Auth
    HTTP bearer

Path parameters

site_idstring required

Request body

live_view_onlyboolean required

true = every camera at this site is Live View only (no AI, no alarms); false = cameras follow their schedules again (except cameras that are Live View only on their own).

Example request

{
  "live_view_only": true
}

Response

Successful Response

site_idstring uuid required

The site that was updated.

site_namestring required

The site's name.

live_view_onlyboolean required

The site's Live View only flag after this request.

camera_countinteger required

Live cameras at the site, all of which the site flag covers.

changedboolean required

False when the site already had this value (nothing was written).

Example response

{
  "site_name": "Harbor Warehouse",
  "live_view_only": true,
  "camera_count": 6,
  "changed": true
}

Changes

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