Sign in
Cameras

Create camera

post/cameras

Request body

Response

OK

idinteger required

The ID of the camera

resource_type'Camera' required

The resource type of the camera

namestring required

The name of the camera

descriptionstring nullable required

The description of the camera

created_atstring date-time required

When the camera was created

updated_atstring date-time required

When the camera was updated

metadataobject required

The metadata for the camera.

  • Only basic types are allowed: string, null, integer, float, boolean.
  • Keys have a limit of 50 characters.
  • Values have a limit of 500 characters.
  • Keys number is limited to 50.
enabledboolean required

Whether the camera is enabled or not. Only enabled cameras takes snapshots.

clip_durationinteger required

Duration in seconds of the video clip to take.

number_of_snapshotsinteger required

The number of snapshots to fetch.

remote_idstring required

The remote id of the camera.

snapshot_offsetinteger required

Offset in seconds of the clock of the camera if it has a drift from the API.

supports_clipsboolean required

Whether the camera supports clips.

supports_imagesboolean required

Whether the camera supports images.

supports_thumbnailsboolean required

Whether the camera supports thumbnails.

status'online' | 'offline' required

Whether the camera is online or offline.

status_changed_atstring date-time nullable required

When the camera connectivity status last changed.

place_idinteger required

The place ID of the camera

lock_idinteger nullable required

The lock ID of the camera

type'generic' required

The type of the camera.

Changes

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