Platforms / Devices
Devices of a platform — read device metadata, software/maps, alerts and status, ingest agent telemetry (logs/metrics), read/write device data, read device restrictions, and report bugs.
📄️ Get Registered Devices
This service message allows retrieval of all registered devices. Returns a plain array of devices.
📄️ Get Registered Devices
This service message allows retrieval of all registered devices as a paginated result. Pagination is controlled via `page`/`perPage` (defaults are applied when omitted). When a rule is supplied — either a saved `ruleId` or an inline dynamic `rule` (JSON string) — only devices matching that rule are returned (pagination is applied after filtering).
📄️ Get Device meta data
This service message allow to get device meta data and properties
📄️ Delete Device
This service message allows de letion of a device
📄️ Get Device Maps
This service message allows retrieval of all registered maps on the given device.
📄️ Get Device softwares
This service message allows retrieval of all software on a process in a given device.
📄️ Ingest Agent Logs
Receives log entries from agents (including third-party logs forwarded by the agent) and stores them in Elasticsearch. Logs are categorized by deviceId, group and topic.
📄️ Ingest Agent Metrics
Receives metric entries from agents and stores them in Elasticsearch. Metrics are categorized by deviceId and topic.
📄️ Get Device Data
Returns the persistent deviceData stored on the device, including orchestrated_by, platformId and any additional agent-reported fields.
📄️ Set Device Data
Stores deviceData on the device. Body follows the agent-zone data structure.
📄️ Get Device Restrictions
This service message retrieves all applicable restrictions for a device based on device ID, device type, OS, and other metadata collected during discovery.
📄️ Report New Bug
This endpoint allows a user to report a new bug associated with a specific device.
📄️ Get Alerts for Device
Returns the most recent alerts for a specific device.
📄️ Device Status SSE Stream
Server-Sent Events endpoint that pushes real-time device status updates (discovery, delivery, deploy). Optionally filter by projectId and/or deviceIds query parameters.