domotz_agents
Manage Domotz collectors: list, delete, monitor activity, bandwidth, VPNs, uptime, speed tests, IP conflicts, and more.
Instructions
Manage Domotz collectors (agents). Use the "action" parameter to select an operation. Requires agent_id for most actions.
ACTION REFERENCE:
list: List all collectors (paginated, filterable by display_name/team_name)
count: Count collectors (lightweight HEAD request, returns {"count": N})
get: Get single collector details by agent_id
delete: Delete a collector
activity_log: Collector activity log (filterable by from/to/type)
connection_consumption: Bandwidth consumption data
vpn_connections: List VPN sessions
create_vpn: Create a VPN session (needs body)
delete_vpn: Delete a VPN session (needs vpn_session_id)
status_history: Online/offline event history (filterable by from/to)
speed_test_history: Internet speed test results (filterable by from/to)
ip_conflicts: Detected IP conflicts on a collector
rtd_stats: Round-trip delay statistics for all devices on a collector
network_topology: Network topology map
uptime: Collector uptime percentage (filterable by from/to)
list_uptime_all: Uptime for ALL collectors (no agent_id needed - the only action that doesn't require one)
variables: Collector-level variables (paginated, filterable by value/path/metric)
count_variables: Count collector variables (lightweight HEAD request)
variable_history: Time-series for a specific variable (needs variable_id)
move: Move collector to a different team (needs team_id)
eyes_usage: SNMP/TCP sensor usage statistics
metric_usage: Metric usage statistics
device_applications: Applications across all devices on collector (paginated)
count_device_applications: Count applications (lightweight HEAD)
device_variables: Variables across all devices on collector (paginated)
count_device_variables: Count device variables (lightweight HEAD)
eyes_snmp: All SNMP sensors across collector
eyes_tcp: All TCP sensors across collector
unmanaged_devices: Devices not being monitored
external_host: Add an external host to monitor (needs body)
dhcp_discovery: Configure DHCP discovery (needs body)
GOTCHAS:
count/count_variables/count_device_applications/count_device_variables use HEAD requests and return {"count": N} from the X-Entities-Count header
list_uptime_all is the ONLY action that works without specifying agent_id
from/to accept ISO 8601 timestamps, default to last 7 days if omitted
Use page_size (1-1000) and page_number (0-based) for large result sets
EXAMPLES:
List all collectors: {"action": "list"}
Get collector details: {"action": "get", "agent_id": 5}
Check for IP conflicts: {"action": "ip_conflicts", "agent_id": 12}
Show network topology: {"action": "network_topology", "agent_id": 8}
Uptime for all collectors: {"action": "list_uptime_all"}
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | No | End time for time series (default: now) | |
| body | No | Request body (JSON object) | |
| from | No | Start time for time series (default: one week ago) | |
| name | No | Filter applications by name | |
| path | No | Filter variables by path | |
| type | No | Activity log type filter | |
| value | No | Filter variables by value | |
| action | Yes | The operation to perform | |
| metric | No | Filter by metric | |
| sort_by | No | Sort field for variables | |
| team_id | No | Team ID (for move action) | |
| agent_id | No | Agent/Collector ID | |
| page_size | No | Max items to return (1-1000) | |
| team_name | No | Filter by team name | |
| device_ids | No | Filter applications by device IDs | |
| has_history | No | Filter by has_history field | |
| page_number | No | Page number, 0-indexed | |
| variable_id | No | Variable ID | |
| display_name | No | Filter by display name (case insensitive) | |
| vpn_session_id | No | VPN Session ID | |
| sorting_direction | No | Sort direction (asc/desc) |