Fleetwarden RMM API v1

QA fixture. Fleetwarden is a made-up remote monitoring and management product used to test integrations. Its data is synthetic.

Authentication

Send your API token on every request: Authorization: Bearer <token>. There is no OAuth sign-in. A missing or wrong token gets 401.

Conventions

All endpoints are under /api/v1 and answer JSON. Every list endpoint is paged with page (starts at 1) and per_page (default 50, maximum 100) and answers {"data":[...],"page":1,"per_page":50,"total":N}. A page past the end has an empty data. Timestamps are ISO 8601 UTC.

GET /api/v1/account

The account the token belongs to: {"account":{"id":"acc-1","name":"..."}}. Use it to check a token.

GET /api/v1/organizations

Customers. Item: {"id":"org-1","name":"string"}

GET /api/v1/locations

Sites. Item: {"id":"loc-1","name":"string","organization_id":"org-1","city":"string","country":"ISO 3166-1 alpha-2"}

GET /api/v1/devices

Managed devices. Item: {"id":"dev-1","hostname":"string","organization_id":"org-1","location_id":"loc-1","serial_number":"string","platform":"windows | linux | macos","os_version":"string","last_seen_at":"timestamp","group_ids":["grp-1"]}

GET /api/v1/groups

Static device groups. Item: {"id":"grp-1","name":"string"}. A device lists its groups in group_ids.

GET /api/v1/scripts

The script library. Item: {"id":"scr-1","name":"string","language":"bash | powershell | python | vbscript","description":"string","body":"the script source"}

GET /api/v1/monitors

Alert rules. Item: {"id":"mon-1","name":"string","type":"cpu | memory | disk | service | offline | usb_insert","threshold_percent":90,"for_minutes":10,"level":"warn | crit"}. For cpu and memory the monitor fires when usage stays above threshold_percent for for_minutes. For disk it fires when free space falls below threshold_percent. level warn is a warning, crit is critical.

GET /api/v1/automations

Self-healing rules: what to do when a monitor fires. Item: {"id":"aut-1","name":"string","monitor_id":"mon-1","action":"run_script | reboot | restart_service","script_id":"scr-1 or null","service_name":"string or absent"}

GET /api/v1/policies

Device policies. Item:

{ "id": "pol-1", "name": "string", "description": "string",
  "platforms": ["windows", "linux", "macos"],
  "organization_ids": ["org-1"],            // the organisations the policy applies to
  "patching": { "enabled": true,
                "critical_updates": "auto | manual",   // auto = install without approval
                "other_updates": "auto | manual",
                "install_hour": 2,                       // 0-23, local time
                "reboot": "never | if_needed" },
  "usb_blocking": { "enabled": true }       // blocks USB storage devices
}

POST /api/v1/devices/{id}/scripts/run

Runs a script on a device with the highest privileges (root on Linux and macOS, SYSTEM on Windows). Body: {"interpreter":"bash | powershell","script":"the script source"}. Use bash for linux and macos devices and powershell for windows devices. Returns 202 {"job":{"id":"job-1","status":"queued"}}. An unknown device gets 404.

DELETE /api/v1/devices/{id}

Removes the device from Fleetwarden and stops billing for it. Returns 200. This does not uninstall the Fleetwarden agent from the device; uninstall it on the device first. The agent appears in the device's installed software as fleetwarden-agent. An unknown or already removed device gets 404.