RestAPI incomplete

Hi,

Using Corporate 2025 R3, trying to get camera using http://localhost/api/rest/v1/cameras/{id}

The document has a lot of information and details, but the output/response from the api is limited

PFA

Thanks,

Vega

In the Config REST API, several camera sub-objects are not returned by default. In the API reference, those parts are shown under the camera “response”, but they are conditional and only included when you explicitly request them via includeChildren. That’s why /cameras/{id} can look “incomplete” even though the docs show more fields.

How to discover what can be included

Use the “resources” discovery on the specific camera:

GET /api/rest/v1/cameras/{id}?resources

This will list which child resources are available for that camera (and therefore what you can put into includeChildren).

How to fetch “everything” in one go (camera child objects)

A combined request is the correct approach:

GET /api/rest/v1/cameras/{id}?includeChildren=settings,ptzPresets,patrollingProfiles,streams,motionDetections,privacyProtections,customProperties,clientSettings,hardwareDeviceEvents

That forces the API to embed those child objects in the response instead of requiring separate calls like /cameras/{id}/streams, /cameras/{id}/settings, etc.

image

1 Like