API Camera Details

This API provides details for a specified camera.

Resource URL

http://valt.example.com/api/v3/admin/cameras/{cameraid}

Replace {cameraid} with the actual id number of the camera. Cameras are numbered sequentially when added to VALT.

Resource Information

Method	GET
Response Type	JSON
Authentication Required	Yes

Parameters

No parameters can be passed to this call.

Response

Code	Reason
200	Request Successful
401	Unauthorized
404	Camera ID Not Found

JSON Response

data
id		Camera ID
name		Camera Name
type		Device Type: Camera or Device (ipad, iphone, card reader)
device_type		Device Type: Camera or Device (ipad, iphone, card reader)
ip		IP Address or FQDN of the camera
http_port		Port used for camera control.
rtsp_port		Port used for pulling the video stream from the camera.
username		Username to access the camera.
password		Password to access the camera.
brand		Camera Brand (Axis or Epiphan)
model		Camera Model Type (Usually Axis-1)
wowza		Media server camera is assigned to.
	id	Media Server ID Number
	name	Media Server Name
	address	Media Server IP Address or FQDN
	port	Port used for streaming video from server to client.
	ssl	true = video stream encrypted, false = video stream not encrypted
	storage_folder	Folder where video files are stored under /usr/local/WowaStreamingEngine/content/
color		Color for camera control interface in VALT
colo_hex		Hex code for color value above.
rooms		Array of rooms the camera is assigned to.
	id	Room ID
	name	Room Name

Examples

Request

https://https://ivstest1.ad.ipivs.com/api/v3/admin/cameras/52?access_token=e82632d19c523678fea3d1016c6df9e9

Successful Response

Sample response is shown with line breaks to make it more readable. Actual responses will not include line breaks.

{
"data":{
"id": 52,
"name": "P5414-E",
"type": "camera",
"device_type": "camera",
"ip": "192.168.7.20",
"http_port": 80,
"rtsp_port": 554,
"username": "root",
"password": "admin51",
"brand": "Axis",
"model": "Axis-1",
"wowza":{
"id": 1,
"name": "localhost",
"address": "ivstest1.ad.ipivs.com",
"port": 444,
"ssl": true,
"storage_folder": "valt_recordings"
},
"color": "white",
"colo_hex": "#ffffff",
"rooms":[
{
"id": 40,
"name": "Wall PTZ"
}
]
}
}

Failure Response

{"error":{"code":401,"message":"No API key provided"}}