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.

​
List Machines

GET /v1/machines Returns all machines with active baselines for the authenticated organization.
​
machines
array
Array of machine records, each containing machine metadata and baseline info.
​
total
integer
Total number of machines.
curl https://api.canaryedge.com/v1/machines \
  -H "X-Canary-Key: YOUR_API_KEY"

{
  "machines": [
    {
      "machine_id": "pump-47",
      "baseline_created_at": "2026-03-30T12:00:00Z",
      "num_windows": 1984
    },
    {
      "machine_id": "compressor-12",
      "baseline_created_at": "2026-03-28T08:30:00Z",
      "num_windows": 4096
    }
  ],
  "total": 2
}

​
Delete Machine

DELETE /v1/machines/{machine_id} Remove a machine and its baseline data. Future detection requests for this machine will use the generic model instead of a fine-tuned predictor.

​
Path Parameters

ParameterTypeDescription
machine_idstringThe machine identifier to delete

​
Response

{
  "machine_id": "pump-47",
  "deleted": true,
  "baseline_deleted": true
}