UBubiquiti
Camera information & management

Patch camera settings

Patch the settings for a specific camera

patch/v1/cameras/{id}

Request

Path parameters

idstring required

The primary key of camera

Example:66d025b301ebc903e80003ea

Request body

namestring

The name of the device.

micVolumenumber

Mic volume: a number from 0-100.

videoMode'default' | 'highFps' | 'sport' | 'slowShutter' | 'lprReflex' | 'lprNoneReflex'

Current video mode of the camera

hdrType'auto' | 'on' | 'off'

High Dynamic Range (HDR) mode setting.

Example request

{
  "osdSettings": {
    "overlayLocation": "bottomRight"
  },
  "lcdMessage": {
    "text": "Hello world!"
  },
  "micVolume": 50,
  "videoMode": "highFps",
  "hdrType": "auto"
}

Response

Success response

idstring required

The primary key of camera

modelKey'camera' required

The model key of the camera

state'CONNECTED' | 'CONNECTING' | 'DISCONNECTED' required

Connection state of the device.

namestring required

The name of the device.

macstring required

The primary MAC address of the device.

isMicEnabledboolean required

Whether or not the microphone on camera is enabled

micVolumenumber required

Mic volume: a number from 0-100.

activePatrolSlotnumber required

The slot number (0-4) of the patrol that is currently running, or null if no patrol is running

videoMode'default' | 'highFps' | 'sport' | 'slowShutter' | 'lprReflex' | 'lprNoneReflex' required

Current video mode of the camera

hdrType'auto' | 'on' | 'off' required

High Dynamic Range (HDR) mode setting.

hasPackageCameraboolean required

Whether the camera has a package camera.

Example response

{
  "id": "66d025b301ebc903e80003ea",
  "state": "CONNECTED",
  "name": "Front Door",
  "mac": "24A43C3DFEB9",
  "osdSettings": {
    "overlayLocation": "bottomRight"
  },
  "micVolume": 50,
  "videoMode": "highFps",
  "hdrType": "auto"
}

Changes

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