Network Cameras

A network camera is an RTSP or MJPEG streaming enabled device with is optionally assigned to a gateway instance or the cloud infrastructure. The network camera is an object contained within a Network Camera application allowing multiple network cameras can be grouped together under a single network camera application.

Name	Example	Description
network_camera_id string	"9ehfiwhiu2"	(read_only) Unique ID used to identify the network camera.
url string	"rtsp://admin:[email protected]" or "http://19.168.10.76:81/mjpg/video.mjpg?COUNTER"	(required) Camera's Real Time Streaming Protocol (RTSP) URL.
active boolean	True	True = Camera is active - frames will be processed by the camera. There is no direct control of the camera. False = Camera is inactive - frames are not being processed from the camera.
camera_name string	"Camera 1"	(required) User-specified camera name included as a tag with all detections from this camera.
description string	"Security camera"	(optional) Additional user-provided description of the network camera.
latitude float	37.3382	(optional) latitudinal location of camera
longitude float	121.8863	(optional) longitudinal location of camera
hae float	10	(optional) expressed in meters. Reserved for UAV use.
created_at float	1463179215.124683	(read_only) Unix timestamp.
modified_at float	1463179215.124683	(read_only) Unix timestamp.
created_by string	"[email protected]"	(read_only) The user that created the network camera.
tenant_id string	"rt06diepwc3i"	(read_only) The tenant ID for the network camera

Create Network Camera

Endpoint

POST /1/networkCameras
Host: https://api.cogniac.io

Post Body

{
  "url": "rtsp://admin:[email protected]",
  "camera_name": "Camera 1",
  "description": "Cogniac Network Camera",
  "active": True,
  "longitude": -4.036878,
  "longitude": 39.669571 
}

Example Response

{
  "network_camera_id": "Asj45tQ1",
  "url": "rtsp://admin:[email protected]",
  "camera_name": "Camera 1",
  "description": "Cogniac Network Camera",
  "active": True,
  "created_at": 1463179215.124683,
  "modified_at": 1463179215.124683,
  "tenant_id": "rt06diepwc3i",
  "created_by": "[email protected]",
  "longitude": -4.036878,
  "longitude": 39.669571
 }

Update Network Camera

The following endpoint is used to update a network camera's properties e.g. it's URL or state state.

Endpoint

POST /1/networkCameras/{network_camera_id}
Host: https://api.cogniac.io

The body of the request should contain a dictionary of the form:

Post Body

{
  "description": "Cogniac Lobby Camera",
  "url": "rtsp://admin:[email protected]:554/stream"
 }

Example Repsonse

{
  "network_camera_id": "Asj45tQ1",
  "url": "rtsp://admin:[email protected]:554/stream",
  "camera_name": "Camera 1",
  "description": "Cogniac Lobby Camera",
  "active": True,
  "created_at": 1463179215.124683,
  "modified_at": 146318631.124683,
  "tenant_id": "rt06diepwc3i",
  "created_by": "[email protected]"
 }

Delete Network Camera

Endpoint

DELETE /1/networkCameras/{network_camera_id}
Host: https://api.cogniac.io

Example Response

HTTP 204 Code (with no body)

❗️

Network Cameras Must Be Inactive Before Deletion

You must transition an application to 'inactive' before you can delete a Network Camera

Enable/Disable network cameras associated with a gateway

Text

POST /1/gateways/{gateway_id}/networkCameras
Host: https://api.cogniac.io

Input

Post Body

{
	'network_camera_id' : [list of camera ids] OR 'all'
  'active' : True/False
}

Response

Response Body

{
	'status':'success'
}