Oxelone API

Read your fleet, its AI activity and its issues, and manage policies from your own scripts. Every route in this reference is one an API key may call. A key that calls any other route is refused with 403.

A key stands in one workspace and acts as one role, so a script sees what that role sees in the console and nothing more. Start with Authentication.

Base URL: https://api.oxelone.com
Format: JSON in, JSON out.
Spec: /api/openapi.json · OpenAPI 3.1.0

Your first call

curl https://api.oxelone.com/machines \
  -H "Authorization: Bearer $OXEL_API_KEY"

200 ResponseEvery field

{
  "machines": [
    {
      "agent_version": "string",
      "attachment_encrypted_archives": "string",
      "attachment_fail_mode": "string",
      "browsers": {},
      "bundle_hash": "string",
      "capture_strategies": [],
      "capture_tactic": "none",
      "collect_artifact_content": true,
      "companion_version": "string",
      "disabled_strategies": [],
      "enabled_strategies": [],
      "enrolled_at": "string",
      "health": "unreachable",
      "health_reasons": [],
      "hostname": "string",
      "id": "string",
      "is_paused": true,
      "last_seen_at": "string",
      "lifecycle": "string",
      "log_level": "string",
      "machine_group": "string",
      "observed_address": "string",
      "os": "string",
      "os_version": "string",
      "panel_show_collection": true,
      "panel_show_steering": true,
      "paused_until": "string",
      "pauses": [],
      "profile": {},
      "reported_address": "string",
      "reported_log_level": "string",
      "scan_categories": [],
      "scan_enabled": true,
      "scan_full_hours": 0,
      "scan_max_depth": 0,
      "scan_max_files": 0,
      "scan_roots": [],
      "scan_skips": [],
      "scan_smart_minutes": 0,
      "suspended_at": "string",
      "tool_hooks": {},
      "tool_restrictions": {},
      "tools": [],
      "uninstalled_at": "string",
      "users": []
    }
  ],
  "next_cursor": "string",
  "total": 0
}