Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.canaryedge.com/llms.txt

Use this file to discover all available pages before exploring further.

Returns the current operational status and baseline information for a specific machine. Requires that a baseline has been created for the machine via POST /v1/baseline.
​
machine_id
string
required
The machine identifier to query.
​
machine_id
string
The machine identifier.
​
regime
string
Current regime: HEALTHY, ACTIVE, TRANSITION, or SHOCK.
​
last_energy
number
Most recent energy score.
​
last_z_score
number
Most recent z-score relative to baseline.
​
baseline_id
string
Associated baseline identifier.
​
alert_active
boolean
Whether an alert is currently active for this machine.
curl https://api.canaryedge.com/v1/status/pump-47 \
  -H "X-Canary-Key: YOUR_API_KEY"

{
  "machine_id": "pump-47",
  "regime": "HEALTHY",
  "last_energy": 0.034,
  "last_z_score": 0.42,
  "baseline_id": "bl_pump-47",
  "alert_active": false
}