API Introduction Authentication Querying SchedulerHealthCoreWebsocketFileVCAWebhookLicense

Endpoints

Health

Monitor server and camera health status

Health data is continuously updated and can be retrieved for monitoring servers and cameras

Server Health📎

To monitor for example the status of the server hardware, software, license and internet connection.

For more details, please see:

Examples:📎

GET /api/v3/health/servers

GET /api/v3/health/servers/432b9f88-2685-47b2-ba14-71c68a2c26ad

Status📎

The /core/servers endpoint also includes status and status_messages fields to indicate whether certain checks have failed. For example:

GET /api/v3/core/servers/432b9f88-2685-47b2-ba14-71c68a2c26ad

could return:

{ "status": "warning", "status_messages" : { "Hard_disk_almost_full" : true }, ... }

Camera Health📎

To monitor for example the status of the camera hardware, connection, configuration and calibration. The camera calibration can be checked with the help of images, specifically generated for evaluating the calibration.

For more details, please see: