Cameras

Managing cameras in an account

Adding a camera to your account

Once a camera that needs to be added is identified using availableDevices, add it using the /cameras endpoint:

curl -X 'POST' \
  'https://<baseURL>/api/v3.0/cameras' \
  --header 'accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <access_token>'\
  -d '{
  "registrationStrategy": "bridge",
  "name": "MyNewCamera",
  "tags": [
    "Lobby"
  ],
  "bridgeId": "1000ba31",
  "guid": "23591cb7-1066-4551-8257-d95c413a2b83"
}'

Viewing cameras added to the account

  • Use the GET cameras endpoint to get a paginated result of all cameras added to the account.
curl --location --request GET 'https://<baseURL>/api/v3.0/cameras?include=status,notes,capabilities' \
--header 'Authorization: Authorization: Bearer <access_token>'
  • You can also specify the cameraId to get information of a single camera.
curl --location --request GET 'https:/<baseURL>/api/v3.0/cameras/1002c1f6?include=locationSummary,timeZone,tags,devicePosition,visibleByBridges,capabilities' \
--header 'Authorization: Bearer <access_token>'

Removing a camera

Remove a camera from the account by providing the cameraId.

curl --location --request DELETE 'https://<baseURL>/api/v3.0/cameras/100e6550' \
--header 'Authorization: Bearer <access_token>'

Result: When the camera is successfully removed, the endpoint returns a 204.