API-Alerts

note

Preliminary: subject to change

The Alerts API exposes the current set of Eclipse Pro alerts — the same set the operator UI displays. It is read-only. Alerts are aggregated from production state, agent status, integration health, and licensing concerns; the returned list is already filtered by license and per-machine permissions associated with the API key.

See API-Getting Connected for the Authorization: ApiKey ... header.

Endpoints

GET /api/v1/alerts (get current alerts)

Parameters

name	type	data type	description
machineNumber	optional	int	Only return alerts for this machine.
type	optional	string	Only return alerts of this category. See Alert types.
criticalOnly	optional	bool	When true, only return alerts flagged critical.

Responses

http code	content-type	response
200	application/json	Array of alerts (possibly empty).
401	application/json	Missing or invalid API key.

Response shape

[
  {
    "id": "AgentOffline/Machine-1",
    "alertType": "AgentOffline",
    "title": "Agent offline",
    "description": "The agent on machine 1 has not reported in 5 minutes.",
    "isCritical": true,
    "machineNumber": 1,
    "created": "2026-05-20T13:22:01.0000000Z",
    "updated": "2026-05-20T13:27:05.0000000Z",
    "percentComplete": 0,
    "kbLink": "https://kb.amscontrols.com/eclipse/agent-offline"
  }
]

field	description
id	Stable identifier, formed as {alertType}/{referenceId}.
alertType	Alert category. See Alert types.
title	Short human-readable summary.
description	Longer human-readable description.
isCritical	true when this alert requires urgent operator attention.
machineNumber	0 when the alert is not machine-specific; otherwise the machine number.
created	When the alert was first raised. UTC.
updated	Most recent update to the alert. UTC.
percentComplete	0..1 completion fraction for progress-style alerts (e.g. startup sync); 0 otherwise.
kbLink	URL to a knowledge-base article describing the condition, if one exists.

Example cURL

curl -H "Authorization: ApiKey YOUR_KEY" \
     "http://localhost:8080/api/v1/alerts?criticalOnly=true"

Alert types

The alertType field is one of the following values. The set is filtered by license: e.g. WarehouseTaskLate is only returned when at least one machine carries the warehouse module.

value	meaning
GeneralInfo	Informational notice from the system.
AgentOffline	The Eclipse agent for a machine has stopped reporting.
AgentConfiguration	The agent reports a configuration problem.
CommOffline	Comm to a machine controller is down.
MachineOffline	The machine is not currently producing and is expected to be.
ProductionSyncStatus	Production data sync from Classic has fallen behind or failed.
CommError	A transient communication error was reported.
StartupSyncStatus	Startup-time data sync is incomplete or failing. Progress is reported in percentComplete.
ScheduleSlip	A scheduled job is at risk of missing its required date.
IntegrationError	An external integration (export, webhook, sync) is failing.
WarehouseTaskLate	A warehouse task is past its required date. Warehouse-licensed sites only.
PrinterError	A configured printer is offline or rejecting jobs.
SystemError	A non-recoverable system condition is preventing normal operation.
ScheduleSendError	Eclipse failed to send a scheduled job to its machine controller.
Licensing	A licensing problem is preventing some functionality from operating.
SolutionError	A shape-programming solution failed to compute for a job.

Unknown is reserved and not returned in normal operation.