Skip to content

Tool Manifest

Auto-generated by scripts/generate_tool_manifest.py. One row per registered tool, sorted alphabetically. Re-run the generator after changing any tool’s registration; the pre-commit hook enforces this.

Total tools: 129

ToolSummary
audit_expiring_credentialsReturn credentials expiring within days_ahead days.
audit_network_driftCompare current controller state to a declared YAML spec.
audit_open_portsAudit WAN-facing exposure (port forwards and WAN_IN accept rules).
backup_configSnapshot every persistent resource on the controller into one envelope.
block_clientBlock a client by MAC so it cannot rejoin until unblocked.
confirm_destructive_actionExecute a queued destructive action by its preview token.
create_dynamic_dnsCreate a Dynamic DNS update configuration.
create_firewall_groupCreate a reusable firewall group of addresses, IPv6 addresses, or ports.
create_firewall_ruleCreate a firewall rule on the controller.
create_guest_networkProvision an isolated guest network end-to-end: VLAN + guest SSID + drop rule.
create_honeypotAdd a honeypot trap to a network.
create_iot_networkProvision an isolated IoT network end-to-end: VLAN + SSID + drop rule.
create_port_forwardCreate a port-forward (DNAT) rule on the WAN.
create_port_profileCreate a switch port profile.
create_routeCreate a static next-hop route.
create_static_dhcp_leaseReserve a fixed IP for a client by MAC.
create_traffic_ruleCreate a v2 traffic rule from a full rule object.
create_vlanCreate a VLAN-tagged network on the controller.
create_wlanCreate a WiFi SSID bound to an existing network/VLAN.
delete_content_filterPreview deletion of a content-filtering profile.
delete_dynamic_dnsPreview deletion of a Dynamic DNS config.
delete_firewall_groupPreview deletion of a firewall group.
delete_firewall_rulePreview deletion of a firewall rule.
delete_honeypotPreview deletion of a honeypot entry.
delete_port_forwardPreview deletion of a port-forward (DNAT) rule.
delete_port_profilePreview deletion of a switch port profile.
delete_routePreview deletion of a static route.
delete_static_dhcp_leasePreview deletion of a static DHCP reservation.
delete_vlanPreview deletion of a VLAN/network.
delete_wlanPreview deletion of a WiFi SSID.
get_access_deviceFetch one Access device’s full record by ID.
get_access_policyFetch one access policy’s full record by ID.
get_access_system_infoReturn controller version, license tier, and capacity.
get_anomaliesList client-impacting anomalies the controller has detected.
get_cameraFetch a single camera’s full record by ID.
get_client_sessionsList recent client connection sessions over a time window.
get_client_statsReport per-client traffic, signal, and uptime for one client by MAC.
get_content_filter_detailsShow one content-filtering profile’s full record by _id.
get_credentialFetch one credential’s full record by ID.
get_device_radiosShow per-radio RF settings for an access point.
get_device_statsReport per-device stats for one UniFi device by MAC.
get_doorFetch one door’s full record by ID.
get_dynamic_dns_detailsShow one Dynamic DNS config’s full record by _id.
get_event_thumbnailFetch the JPEG thumbnail for a Protect event, base64-encoded.
get_firewall_group_detailsShow one firewall group’s full record by _id.
get_gateway_statsReport gateway resource stats: CPU, memory, temperature, throughput.
get_network_detailsShow one network’s full record, grouped into readable sections.
get_recent_access_eventsReturn the most recent N events across every door.
get_route_detailsShow one static route’s full record by _id.
get_site_healthReport per-subsystem health (wan, lan, wlan, www, vpn).
get_snapshotFetch a current JPEG snapshot from a camera, base64-encoded.
get_speedtest_resultsList recent speed-test results, newest first.
get_system_infoReport controller/system info: version, uptime, device type.
get_teleport_configReturn Teleport VPN state and any wireguard-server networks.
get_threat_managementReturn current Threat Management (IDS/IPS) configuration.
get_traffic_route_detailsShow one traffic route’s full record by _id.
get_traffic_rule_detailsShow one traffic rule’s full record by _id.
get_visitorFetch one visitor pass’s full record by ID.
get_wan_ipv6Show the current IPv6 configuration of the WAN uplink(s).
get_wan_statusReport current WAN status: link, ISP, public IP, throughput, latency.
list_access_devicesList hubs, readers, relays, and intercoms bonded to the controller.
list_access_eventsList badge-scan / door events with filters.
list_access_policiesList every access policy on the controller.
list_access_usersList every user enrolled in the Access system.
list_alarmsList controller alarms, active or archived.
list_ap_groupsList access-point groups configured on the controller.
list_camerasList every camera bonded to the Protect controller.
list_clientsList currently active wireless and wired clients.
list_content_filtersList DNS content-filtering profiles (category blocking, safe-search).
list_credentialsList every credential enrolled in the Access controller.
list_devicesList every UniFi device adopted by this controller.
list_dhcp_leasesList static DHCP reservations on the controller.
list_door_groupsList every door group defined on the controller.
list_doorbell_messagesList doorbell cameras (those with isDoorbell=True).
list_doorsList every door bonded to the Access controller.
list_dynamic_dnsList Dynamic DNS update configurations on the controller.
list_eventsList recent controller events (connections, disconnections, etc.).
list_failed_access_attemptsReturn only result == "denied" events within the window.
list_firewall_groupsList reusable firewall groups (address, IPv6-address, and port groups).
list_firewall_rulesList every firewall rule on the controller.
list_honeypotsList configured honeypots and the global honeypot toggle.
list_motion_eventsList motion events in the last hours_back hours.
list_networksList every network/VLAN configured on the controller.
list_port_forwardsList every port-forward (DNAT) rule on the controller.
list_port_profilesList switch port profiles configured on the controller.
list_recordingsList Protect recordings for one camera over the last hours_back hours.
list_routesList user-defined static (next-hop) routes on the controller.
list_smart_detectionsList smart-detection events (person, vehicle, animal, package).
list_top_talkersList top clients by total bytes (DPI by-station report).
list_traffic_routesList v2 traffic routes (policy-based routing, e.g. VPN-client routes).
list_traffic_rulesList v2 traffic rules (app/domain/IP-based allow & block policies).
list_visitorsList every visitor pass on the controller (active and expired).
list_wlansList every WiFi SSID configured on the controller.
locate_deviceToggle the LED locate beacon on a device.
provision_cameraConfigure a camera end-to-end: recording mode + sensitivity + privacy.
provision_homelab_serviceStand up a homelab service: DHCP lease + firewall allow + (optional) port forwards.
quarantine_clientBlock a client and log the quarantine action with a reason.
reconnect_clientForce a client to reconnect (kick-sta).
rename_deviceRename an adopted UniFi device (AP, switch, or gateway).
restart_deviceRestart an adopted UniFi device (gateway, AP, or switch).
restore_configRestore controller state from a backup_config envelope.
set_camera_privacy_modeToggle a camera’s privacy mask (lens cover) on or off.
set_camera_recording_modeSet a camera’s recording mode (always, motion, or never).
set_lan_ipv6Set the IPv6 configuration of one LAN/VLAN network.
set_motion_sensitivitySet a camera’s motion sensitivity (0-100).
set_port_stateOverride settings on a single switch port.
set_radio_channelSet the channel and/or channel width of one radio on an AP.
set_radio_min_rssiEnable, tune, or disable minimum RSSI on one radio of an AP.
set_radio_tx_powerSet the transmit power mode of one radio on an access point.
set_teleport_enabledToggle the Teleport VPN listener.
set_threat_managementUpdate Threat Management (IDS/IPS) configuration.
set_wan_ipv6Set the WAN uplink’s IPv6 connection type and prefix delegation.
summarize_access_activityAggregate badge events by door, user, and outcome.
toggle_traffic_routeEnable or disable a traffic route without editing its other fields.
toggle_traffic_ruleEnable or disable a traffic rule without editing its other fields.
trigger_speedtestKick off a UniFi speed test on the WAN link.
unblock_clientUnblock a previously-blocked client by MAC.
update_content_filterPatch fields on an existing content-filtering profile (read-modify-write).
update_dynamic_dnsPatch fields on an existing Dynamic DNS config.
update_firewall_groupRename a firewall group or replace its members (read-modify-write).
update_firewall_rulePatch fields on an existing firewall rule.
update_port_forwardPatch fields on an existing port-forward rule.
update_port_profilePatch fields on an existing port profile.
update_routePatch fields on an existing static route.
update_static_dhcp_leaseConvert or update an existing client to a fixed-IP reservation.
update_traffic_routePatch fields on an existing traffic route (read-modify-write).
update_traffic_rulePatch fields on an existing traffic rule (read-modify-write).
update_vlanPatch fields on an existing VLAN/network record.
update_wlanPatch fields on an existing WiFi SSID.