Camera

Get Camera List

This API retrieves a list of cameras, including the camera ID, camera name, location ID, and camera RTSP.

Endpoint: GET /cameras

Parameters:

ParameterDescriptionTypeRequireDefault

limit

The number of cameras to retrieve per page.

integer

No

100

offset

The starting position for the result set.

integer

No

0

Example Request:

GET /cameras?limit=2&offset=0

Example Response:

[
    {
      "id": 1,
      "name": "Camera 1",
      "location_id": 1,
      "rtsp": "rtsp://example.com/camera1",
      "model_name": ""
    },
    {
      "id": 2,
      "name": "Camera 2",
      "location_id": 2,
      "rtsp": "rtsp://example.com/camera2",
      "model_name": ""
    }
]

Response Fields:

FieldDescriptionType

id

The unique identifier for the camera.

integer

name

The name of the camera.

string

location_id

The ID of the location of the camera.

integer

rtsp

The RTSP stream URL of the camera.

string

model_name

The model name of the camera.

string


Get Camera Details

This API retrieves the details of a specific camera, including the camera ID, camera name, location ID, and camera RTSP.

Endpoint: GET /cameras/:camera_id

Path Parameters:

ParameterDescriptionTypeRequire

camera_id

The unique identifier for the camera.

integer

Required

Example Request:

GET /cameras/1

Example Response:

{
    "id": 1,
    "name": "Camera 1",
    "location_id": 1,
    "rtsp": "rtsp://example.com/camera1",
    "model_name": ""
}

Response Fields:

FieldDescriptionType

id

The unique identifier for the camera.

integer

name

The name of the camera.

string

location_id

The ID of the location of the camera.

integer

rtsp

The RTSP stream URL of the camera.

string

model_name

The model name of the camera.

string