VEverdun
camera-groups

Edit Camera Group

patch/camera-groups/{group_id}

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/camera-groups/{group_id}
  • Auth
    HTTP bearer

Path parameters

group_idstring required

Request body

namestring nullable

New display name. Must stay unique (case-insensitively) among the site's live camera groups; renaming a group to its own current name is a no-op, not a conflict.

descriptionstring nullable

New description. Send null explicitly to clear it; omit to leave it unchanged.

Example request

{
  "name": "Tenant A",
  "description": "Suite 200 - enters past cameras 1-3"
}

Response

Successful Response

idstring uuid required

The camera group ID.

site_idstring uuid required

The site this camera group belongs to. Camera groups never span sites.

namestring required

Display name, unique (case-insensitively) among the site's live camera groups.

descriptionstring nullable

Free-form note about what this camera group covers.

camera_idsstring[]

Live member cameras. A camera may belong to several camera groups at once.

has_scheduleboolean required

Whether this camera group carries a monitoring schedule. FALSE MEANS INERT: membership alone never changes a camera's monitoring state. When true, this group's week replaces the site's for every member camera that has no camera-level override; overlapping scheduled groups combine under 'off wins'.

Example response

{
  "name": "Tenant A",
  "description": "Suite 200 - enters past cameras 1-3"
}

Changes

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