List camera statuses

Returns the online/offline status of cameras. Both filters are optional: with neither, the answer covers the whole organization, and cameraIds limits it to named cameras. A camera that has never reported is absent from the answer rather than offline, so the number of rows is not a count of the cameras in scope. To ask about one site, use GET /v3/locations/{locationId}, which carries the same cameras grouped by core.

Required scope: read:cameras

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
boolean

Set to true to include the health status of the camera components.

cameraIds
array of strings

Comma-separated list of camera IDs to query. Omit it to get every camera in the organization, which is how status alone answers "which of my cameras are offline".

cameraIds
string
enum

Return only the cameras whose status is this value. Omit it to return every camera in scope. The filter is applied to the rolled-up online/offline verdict, so it narrows the result with components=true as well. Combine it with no cameraIds to list every online, or every offline, camera in the organization.

Allowed:
Responses

500

Server error. Could not return data.

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*