Opnsense MCP Server — 343 tools
contains code
The Opnsense DADL turns Opnsense's API into an MCP server that Claude, GPT or any MCP-compatible agent can consume directly. One YAML file declares all 343 tools — firewall, ipsec, unbound, haproxy, system, wireguard, and more — and ToolMesh serves them at runtime. No Python boilerplate, no per-endpoint code, no separate MCP server process.
Below: the endpoint coverage matrix, a two-block ToolMesh setup, the full tool reference grouped by Opnsense feature area, required credential scopes.
Source: OPNsense REST API
Which Opnsense endpoints are covered?
23% (343 of ~1500 endpoints)
Focus: firewall (aliases, filter rules, NAT, outbound NAT mode, NPTv6), diagnostics (ARP, states, system, ping jobs, packet capture), interfaces (overview, VLANs, VIPs, global settings, reload), Unbound DNS, WireGuard, OpenVPN, IPsec, Kea DHCP, routes/gateways/gateway groups, firmware, system/backup, HAProxy, IDS/IPS, traffic shaper, certificates, syslog, cron, HA (hasync syncitems, config sync), IPv6 RA (radvd), NDP proxy, services (per-instance start/stop/restart)
Missing: per-interface IPv4/IPv6 address config (configuration type, addresses, MTU/MSS — legacy config.xml, no API as of 26.7), firewall normalization/scrub rules (firewall_scrub.php legacy, no API as of 26.7), firewall savepoint/rollback (no such endpoints on 26.7), captive portal vouchers, BIND DNS, Caddy, Nginx, FRR routing, ACME client, Monit, collectd, CrowdSec, FreeRADIUS, most third-party plugins
How do you configure the Opnsense DADL?
- Log in to OPNsense web UI as admin
- Navigate to System → Access → Users
- Edit the user you want to create API credentials for (or create a dedicated API user)
- Scroll down to 'API keys' section and click the '+' (add) button
- A key/secret pair is generated and downloaded as an apikey.txt file
- The file contains: key=<your-api-key> and secret=<your-api-secret>
- IMPORTANT: The secret is NOT stored on the system — save it securely
- Set env vars: CREDENTIAL_OPNSENSE_API_KEY=<key> and CREDENTIAL_OPNSENSE_API_SECRET=<secret>
Environment variable: CREDENTIAL_OPNSENSE_API_KEY and CREDENTIAL_OPNSENSE_API_SECRET
OPNsense uses page-based permissions. The API user needs GUI access to the same pages they want to access via API. For full API access, assign the user to the 'admins' group. API key + secret are used as HTTP Basic Auth (key=username, secret=password). The health check calls get_system_time, which needs only the 'Lobby: Dashboard' privilege, so a dedicated monitoring user with that single privilege is enough for it. OPNsense API keys do not expire, so the check reports no expiry date.
How do you install the Opnsense MCP server with ToolMesh?
Add to your backends.yaml:
- name: opnsense
transport: rest
dadl: opnsense.dadl
url: "https://your-opnsense-host/api"
Set the credential:
CREDENTIAL_OPNSENSE_API_KEY and CREDENTIAL_OPNSENSE_API_SECRET=your-token-hereWhat 343 tools does the Opnsense DADL expose?
POSTsearch_firewall_aliasesSearch firewall aliases (IP lists, port groups, URL tables, GeoIP, etc.)GETget_firewall_aliasGet a single firewall alias by UUIDPOSTadd_firewall_aliasCreate a new firewall aliasPOSTset_firewall_aliasUpdate an existing firewall aliasPOSTdel_firewall_aliasDelete a firewall alias by UUIDPOSTtoggle_firewall_aliasToggle a firewall alias on or off. Omit 'enabled' to flip the current state.POSTreconfigure_firewall_aliasesApply alias changes to the running firewallGETget_alias_uuid_by_nameLook up alias UUID by nameGETlist_alias_contentList the resolved content (IPs/networks) of an aliasPOSTadd_alias_entryAdd an entry to an alias at runtime (without modifying config)POSTdelete_alias_entryRemove an entry from an alias at runtimePOSTflush_aliasFlush (clear) all entries from an alias at runtimeGETlist_network_aliasesList all aliases usable as network referencesGETlist_alias_categoriesList all alias categoriesGETlist_geoipGet GeoIP configuration and available countriesPOSTsearch_firewall_rulesSearch firewall filter rules. Returns {total, returned, truncated, rows} — check `truncated` before claiming a complete picture (rowCount defaults to 500 here, the appliance's own default of 50 silently cut a 53-rule ruleset short). The result MIXES user rules (MVC model) with OPNsense's automatic/internal rules (anti-lockout, default deny, pfsync, …): `is_automatic: true` marks the latter and is now always present as a real boolean — the raw API omits the key entirely on user rules. All boolean-ish fields are normalised to real booleans (raw API returns `true` on automatic rules but the string "1"/"0" on user rules, so `if (rule.log)` was true for log "0"): enabled, log, quick, source_not, destination_not, interfacenot, disablereplyto, nosync, nopfsync, allowopts, tcpflags_any. NEGATION: the added comfort fields %source_net / %destination_net / %interface render the negation flags inline ("NOT <alias>"), so a policy-routing rule can no longer be misread as its own opposite. Always read those, or read the *_not flags — the bare source_net/destination_net/interface fields say nothing about negation. Filters: `interface` (comma list of friendly keys; pass "" for floating rules only, omit for ALL rules), `category` (comma list of category UUIDs — automatic rules carry their own category), `show_all: 1` additionally merges live pf hit counters (evaluations/states/packets/bytes) into each row.
GETget_firewall_ruleGet a single firewall filter rule by UUIDPOSTadd_firewall_ruleCreate a new firewall filter rule. Covers the full Filter.xml model — fields not listed here cannot be sent. Apply with apply_firewall afterwards. Key gotchas: icmptype/icmp6type are ignored unless protocol is ICMP/IPv6-ICMP, and leaving them empty means ALL ICMP types; disablereplyto is regularly required on WAN-side rules; statetype defaults to "keep".
POSTset_firewall_ruleUpdate an existing firewall filter rule. Same full field set as add_firewall_rule; the endpoint MERGES, so omitted fields keep their stored value. A field that is not in this list cannot be written and is dropped without any error — check the list before assuming a restriction was applied. Apply with apply_firewall afterwards.
POSTdel_firewall_ruleDelete a firewall filter rulePOSTtoggle_firewall_ruleToggle a firewall filter rule on or off. Omit 'enabled' to flip the current state.POSTmove_firewall_rule_beforeMove a firewall rule before another rule (reorder)GETget_firewall_interface_listList interfaces available for firewall rulesGETget_firewall_rule_statsGet firewall rule hit statisticsPOSTapply_firewallApply the stored firewall ruleset to the running pf (runs configd "filter reload skip_alias"). Takes NO parameters — the old {rollback_revision} path segment does not exist on 26.7 and made this tool uncallable. Returns {"status":"OK"} plus the reload output. NOTE: model writes via add_/set_/del_/toggle_ endpoints already trigger a config save that reloads the filter on most installations, so an explicit apply is usually a no-op confirmation rather than the step that activates the change. NPT/DNAT/ SNAT rules share this same pf reload; there is no separate per-family apply.
POSTsearch_firewall_categoriesSearch firewall rule categoriesPOSTadd_firewall_categoryCreate a new firewall rule categoryPOSTset_firewall_categoryUpdate a firewall rule categoryPOSTdel_firewall_categoryDelete a firewall rule categoryPOSTsearch_dnat_rulesSearch destination NAT (port forwarding) rules. The NAT families use different field conventions than the filter rules — inverted polarity and dot instead of underscore notation — which reads as "everything is disabled" if taken at face value: raw rows carry `disabled: "0"` (NOT `enabled`), `descr` (not `description`) and `source.network` / `destination.network` / `destination.not` (not source_net / destination_net / destination_not). This tool therefore ADDS filter-rule-compatible fields: `enabled` (real boolean, inverse of disabled), `description`, and the negation- aware %source_net / %destination_net ("NOT <alias>" when the .not flag is set). disabled/log/is_automatic/nordr are normalised to real booleans.
GETget_dnat_ruleGet a single DNAT rule by UUIDPOSTadd_dnat_ruleCreate a new destination NAT (port forwarding) rulePOSTset_dnat_ruleUpdate an existing DNAT rulePOSTdel_dnat_ruleDelete a destination NAT (port forwarding) rule by UUIDPOSTtoggle_dnat_ruleToggle a destination NAT rule on or off. Omit 'disabled' to flip the current state.GETget_outbound_nat_modeGet the outbound (source) NAT generation mode — the Firewall→NAT→Outbound radio button. Returns {filter:{general:{snat_mode:{<key>:{value,selected}}}}} as an OPNsense SELECT map; the selected key is one of automatic (rules generated from the interface config), hybrid (automatic PLUS the manual rules), advanced (manual rules ONLY) or disabled (no source NAT at all). Without this, an empty search_snat_rules cannot be interpreted.
POSTset_outbound_nat_modeSet the outbound (source) NAT generation mode. Pass the object param `filter` as {general: {snat_mode: "advanced"}} — a BARE option key, not the {value,selected} map from get_outbound_nat_mode. Valid: automatic, hybrid, advanced, disabled. Switching from automatic/hybrid to advanced with no manual rules present DROPS ALL OUTBOUND NAT and will cut every masqueraded client off the internet — read search_snat_rules first. Apply with apply_firewall.
POSTsearch_snat_rulesSearch source NAT (outbound NAT) rules. An EMPTY rows list is ambiguous on its own — call get_outbound_nat_mode: in mode "automatic" no manual rules exist by design while NAT is still active; in mode "advanced" an empty list means no outbound NAT is applied. Same field-convention normalisation as search_dnat_rules: raw rows use `disabled`, `descr` and dotted source.network/destination.network, so `enabled` (boolean), `description` and negation-aware %source_net / %destination_net are added.
POSTadd_snat_ruleCreate a new source NAT rulePOSTset_snat_ruleUpdate a source NAT rulePOSTdel_snat_ruleDelete a source NAT rulePOSTsearch_npt_rulesSearch NPTv6 (IPv6 network prefix translation) rules. Rows include uuid, sequence, interface, source_net (internal prefix), destination_net (external prefix), trackif, enabled.GETget_npt_ruleGet a single NPTv6 rule by UUID. SELECT fields (interface, trackif, categories) come back as {opt:{value,selected}} maps — flatten to the bare selected key before posting back via set_npt_rule.POSTadd_npt_ruleCreate an NPTv6 rule translating an internal IPv6 prefix (source_net) to an external one (destination_net). For dynamically assigned (tracked) external prefixes set trackif to the upstream interface INSTEAD of destination_net. Booleans are "0"/"1" strings; interface is the bare friendly key. The rule is stored only — call apply_firewall to activate it in pf. Returns {"result":"saved","uuid":...} or {"result":"failed","validations":{...}}.
POSTset_npt_ruleUpdate an NPTv6 rule. FULL-REPLACE (setBase): any field you omit is reset to its model default — read with get_npt_rule, flatten SELECT maps to bare values, change what you need, then post the COMPLETE rule. Call apply_firewall afterwards to activate.
POSTdel_npt_ruleDelete an NPTv6 rule by UUID. Call apply_firewall afterwards to deactivate it in pf.POSTtoggle_npt_ruleEnable/disable an NPTv6 rule. enabled=1 to enable, 0 to disable. Call apply_firewall afterwards.POSTquery_firewall_statesQuery active pf firewall states (connections)GETget_pf_statisticsGet pf firewall statistics. Available sections: info, memory, timeouts, interfaces, rules. Pass a section name or 'all' for everything.GETget_firewall_statsGet firewall statistics summaryGETget_firewall_logGet recent firewall log entries. Use limit to control result size (default 1000, can be large). Use digest for pagination (value from previous response). No content filtering — filter client-side by action, src, dst, etc.GETget_firewall_log_filtersGet available firewall log filter optionsPOSTkill_firewall_statesKill pf states selected by address filter and/or rule label. WORKS ONLY FOR BARE IPv4 ADDRESSES — this is an appliance-side limitation, not a tool bug, and it fails SILENTLY with {"result":"ok","dropped_states":0}. OPNsense runs `filter` through SanitizeFilter::filter_query, which keeps only [0-9 a-z A-Z , space * - _ . #] and therefore STRIPS ":" and "/": an IPv6 address "2001:db8::1" arrives as "2001db81", and a CIDR "198.51.100.0/24" arrives as "198.51.100.024" — neither parses as a network, so both degrade to a plain substring match that matches nothing. Verified against 26.7.1_1 (kill_states.py + lib/states.py + SanitizeFilter.php). WHAT WORKS: one or more space-separated bare IPv4 addresses (e.g. "192.0.2.10 192.0.2.11"); each is matched against a state's src/dst/nat address and gateway, and ALL address clauses must match. Tokens that are not parseable as an address become substring filters over the state record. `ruleid` is matched as a lowercase substring of the pf rule label and is sanitised to alphanumerics only. FOR IPv6 OR CIDR use query_firewall_states to get stateid/creatorid and then del_firewall_state per state, or flush_firewall_states to drop everything.
POSTflush_firewall_statesFlush ALL firewall statesPOSTdel_firewall_stateDelete a specific firewall stateGETlist_firewall_rule_idsList all active pf rule IDs with descriptionsPOSTquery_pf_topQuery top firewall connections by various criteriaGETget_arp_tableGet the ARP table (IPv4 neighbor cache). Returns ALL entries (no server-side filtering). Fields are reduced to ip, mac, hostname, intf_description to keep response compact.GETget_ndp_tableGet the NDP table (IPv6 neighbor cache). Returns ALL entries (no server-side filtering). Fields are reduced to keep response compact.POSTflush_arp_tableFlush the entire ARP tableGETget_routesGet the system routing tableGETget_interface_configGet configuration of all network interfacesGETget_interface_namesGet interface name mappings (physical ↔ friendly)GETget_interface_statisticsGet traffic statistics for all interfacesGETget_vip_statusGet CARP/VIP status for high availabilityGETget_pfsync_nodesGet pfsync HA cluster node statusPOSTdel_routeDelete a route from the system routing tableGETget_protocol_statisticsGet protocol-level traffic statistics (TCP, UDP, ICMP, etc.)GETget_socket_statisticsGet active socket/connection statisticsGETget_memory_statisticsGet network memory (mbuf) allocation statisticsGETget_bpf_statisticsGet BPF (Berkeley Packet Filter) statisticsGETget_system_informationHostname and OPNsense/kernel version strings. Much thinner than the name suggests — no uptime, CPU or memory here (use get_system_resources / get_system_status). The raw response also carries an `updates` field whose value is the UI label "Click to check for updates." rather than any update state; it is stripped here. Real update state: check_firmware_updates or get_firmware_status.
GETget_system_resourcesGet system resource usage (CPU, memory, processes)GETget_system_memoryRAW kernel allocator dump: the complete vmstat malloc-statistics and memory-zone statistics (~45 KB of per-bucket counters). This is NOT a memory usage summary and is almost never what you want — for total/used/ARC in a few hundred bytes use get_system_resources. Reach for this only when you need per-zone allocator detail.
GETget_system_diskGet disk usage for all filesystemsGETget_system_temperatureGet system temperature sensorsGETget_system_timeCurrent system time and uptime: datetime, uptime, boottime, config (time of the last config change) and loadavg, all as display strings. Also serves as the backend's health check; to test reachability and the credential, call the `health` tool instead.
GETget_system_swapGet swap space usage statistics (total, used, free)GETget_system_mbufGet mbuf (network memory buffer) statisticsGETget_activityGet running processes and system activityGETreverse_dns_lookupPerform a reverse DNS lookupGETget_traffic_interfaceGet current traffic rates per interfaceGETget_traffic_topGet top traffic connections for specified interfacesPOSTset_ping_jobCreate a ping diagnostics job (does NOT start it). Pass the single object param `ping` with a nested settings object; returns {"result":"ok","uuid":"…"} — feed the uuid to start_ping_job. Settings fields: hostname (required — target host/IP), fam (address family: "ip"=IPv4, "ip6"=IPv6; default ip), source_address (source IP to ping from — controls source-address selection, e.g. to test a specific GUA/ULA), packetsize (bytes 1-65535), disable_frag ("0"/"1"), interval (seconds between packets 1-120), description.
POSTstart_ping_jobStart a ping job created with set_ping_job. It pings continuously until stop_ping_job.POSTstop_ping_jobStop a running ping job. Final statistics stay readable via search_ping_jobs until the job is removed.POSTremove_ping_jobRemove a stopped ping job and its result filesPOSTsearch_ping_jobsList ping jobs with live status and statistics per job: id (uuid), status, hostname, send, received, loss, min, avg, max (ms)POSTset_capture_jobCreate a packet capture job (does NOT start it). Pass the single object param `packetcapture` with a nested settings object; returns {"result":"ok","uuid":"…"}. Settings fields: interface (required — comma-separated PHYSICAL device names as listed in get_interfaces_overview `device`, e.g. "em0" or "em0,vlan01" — NOT friendly keys like lan/wan, those fail with "Option not in list"), fam (required address-family filter: any|ip|ip6|arp), promiscuous ("0"/"1", default 0), protocol (tcpdump protocol filter, default any — e.g. icmp, tcp, udp, esp), protocol_not ("1" inverts the protocol match), host (host/network filter), port (1-65535), port_not ("1" inverts the port match), snaplen (bytes per packet 1-262144), count (packet limit, default 100 — capture auto-stops when reached), description.
POSTstart_capture_jobStart a packet capture job created with set_capture_jobPOSTstop_capture_jobStop a running packet capture job (it also auto-stops after `count` packets)GETview_capture_jobView decoded packets of a capture job (tcpdump text rows per interface, with interface name map). detail: normal, medium (-v) or high (-vv).GETdownload_captureDownload the raw pcap archive of a capture job as a file (open in Wireshark/tcpdump)POSTremove_capture_jobRemove a stopped capture job and its pcap filesPOSTsearch_capture_jobsList packet capture jobs with status per job: id (uuid), status (stopped/running), interface, descriptionGETget_capture_macinfoLook up the vendor (OUI) of a MAC address seen in a captureGETget_interfaces_overviewDetailed live state of all configured interfaces. The prefix length is only embedded in the address strings (addr4 "198.51.100.2/24", addr6 "2001:db8:0:a::2/64") — this tool adds `subnetbits4` / `subnetbits6` as separate fields so no string splitting is needed (the stored config values are also in config.subnet / config.subnetv6). Per row: device, identifier (friendly key), description, addr4/addr6 plus full ipv4/ipv6 lists incl. CARP VIPs, carp (vhid → MASTER/BACKUP), macaddr, mtu, media, flags, routes.
GETget_interface_detailGet details for a specific interfaceGETexport_interfacesExport interface configurationPOSTreload_interfaceRe-apply the stored configuration of ONE interface (configd "interface reconfigure"): re-runs address assignment and restarts dhclient/dhcp6c on it — the API-side way to bounce/flush an interface after upstream or config changes (e.g. to re-trigger SLAAC/DHCPv6). Expect a brief connectivity loss on that interface.
GETget_interface_settingsGet global interface settings: hardware offloading flags (disablechecksumoffloading, disablesegmentationoffloading, disablelargereceiveoffloading, disablevlanhwfilter 0|1|2), the global IPv6 kill switch (disableipv6), and DHCPv6 client behavior (dhcp6_norelease, dhcp6_debug, dhcp6_duid, dhcp6_ratimeout). Also returns suggested DUID values under `duids`.
POSTset_interface_settingsUpdate GLOBAL interface settings — PARTIAL MERGE (setNodes): only posted fields change, everything else is preserved. Pass the single object param `settings`. Fields: disablechecksumoffloading, disablesegmentationoffloading, disablelargereceiveoffloading ("0"/"1"), disablevlanhwfilter (bare "0"=enable HW filtering, "1"=disable, "2"=leave default), disableipv6 ("1" disables IPv6 on ALL interfaces — dangerous), dhcp6_norelease ("1" = do not send DHCPv6 release on exit), dhcp6_debug, dhcp6_duid (DUID string, see get response `duids` for suggestions), dhcp6_ratimeout (seconds). Call reconfigure_interface_settings to apply.
POSTreconfigure_interface_settingsApply global interface settings changes to the running systemPOSTsearch_vlansSearch VLAN interfacesGETget_vlanGet a VLAN interface by UUIDPOSTadd_vlanCreate a new VLAN interfacePOSTset_vlanUpdate an existing VLAN interfacePOSTdel_vlanDelete a VLAN interfacePOSTreconfigure_vlansApply VLAN interface changes to the running system configurationPOSTsearch_vipsSearch virtual IP addresses (CARP, IP alias, proxy ARP)POSTadd_vipCreate a virtual IP addressPOSTset_vipUpdate a virtual IP addressPOSTdel_vipDelete a virtual IP addressPOSTreconfigure_vipsApply virtual IP changesGETget_unbound_settingsGet Unbound DNS resolver settingsPOSTset_unbound_settingsUpdate Unbound DNS resolver settingsPOSTsearch_unbound_host_overridesSearch DNS host overrides (local DNS records)GETget_unbound_host_overrideGet a DNS host override by UUIDPOSTadd_unbound_host_overrideCreate a DNS host override (local A/AAAA/MX record)POSTset_unbound_host_overrideUpdate a DNS host overridePOSTdel_unbound_host_overrideDelete a DNS host overridePOSTsearch_unbound_forwardsSearch DNS forwarding domainsPOSTadd_unbound_forwardCreate a DNS forwarding entry (forward queries for a domain to specific servers)POSTset_unbound_forwardUpdate a DNS forwarding entryPOSTdel_unbound_forwardDelete a DNS forwarding entryPOSTsearch_unbound_dnsblSearch DNS blocklist entriesPOSTupdate_unbound_blocklistTrigger DNS blocklist updateGETget_unbound_service_statusGet Unbound DNS resolver service statusPOSTreconfigure_unboundApply Unbound DNS changes and restartPOSTrestart_unboundRestart the Unbound DNS resolverGETget_unbound_cacheDump the Unbound DNS cacheGETget_unbound_statsGet Unbound DNS resolver statisticsGETget_unbound_local_dataList Unbound local data entriesGETget_unbound_local_zonesList Unbound local zonesPOSTsearch_wireguard_serversSearch WireGuard server (tunnel) instancesGETget_wireguard_serverGet a WireGuard server instance by UUIDPOSTadd_wireguard_serverCreate a new WireGuard server (tunnel interface)POSTset_wireguard_serverUpdate a WireGuard server instancePOSTdel_wireguard_serverDelete a WireGuard server instancePOSTtoggle_wireguard_serverToggle a WireGuard server instance on/offGETwireguard_key_pairGenerate a new WireGuard key pair (public + private)POSTsearch_wireguard_clientsSearch WireGuard client (peer) configurationsGETget_wireguard_clientGet a WireGuard client (peer) by UUIDPOSTadd_wireguard_clientCreate a new WireGuard client (peer) — returns a new peer with generated keysPOSTset_wireguard_clientUpdate a WireGuard client (peer)POSTdel_wireguard_clientDelete a WireGuard client (peer)POSTtoggle_wireguard_clientToggle a WireGuard client (peer) on/offGETwireguard_pskGenerate a new WireGuard pre-shared keyGETget_wireguard_statusGet WireGuard service statusPOSTreconfigure_wireguardApply WireGuard configuration changesGETwireguard_showShow WireGuard tunnel status (equivalent to 'wg show')POSTsearch_openvpn_instancesSearch OpenVPN server/client instancesGETget_openvpn_instanceGet an OpenVPN instance by UUIDPOSTadd_openvpn_instanceCreate a new OpenVPN instancePOSTset_openvpn_instanceUpdate an OpenVPN instancePOSTdel_openvpn_instanceDelete an OpenVPN instancePOSTtoggle_openvpn_instanceToggle an OpenVPN server or client instance on or off. Omit 'enabled' to flip current state.POSTreconfigure_openvpnApply OpenVPN configuration changesGETsearch_openvpn_sessionsList active OpenVPN sessions/connectionsGETsearch_openvpn_routesList OpenVPN routing table entriesPOSTkill_openvpn_sessionKill an active OpenVPN sessionPOSTsearch_ipsec_connectionsSearch IPsec connections (phase 1)GETget_ipsec_connectionGet an IPsec connection by UUIDPOSTadd_ipsec_connectionCreate a new IPsec connectionPOSTset_ipsec_connectionUpdate an IPsec connectionPOSTdel_ipsec_connectionDelete an IPsec connectionPOSTtoggle_ipsec_connectionToggle an IPsec connection on or off. Omit 'enabled' to flip the current state.POSTsearch_ipsec_childrenSearch IPsec child SAs (phase 2 / traffic selectors)POSTadd_ipsec_childCreate a new IPsec child SAPOSTset_ipsec_childUpdate an IPsec child SAPOSTdel_ipsec_childDelete an IPsec child SAGETsearch_ipsec_phase1List active IPsec phase 1 (IKE) sessionsGETsearch_ipsec_phase2List active IPsec phase 2 (child SA) sessionsPOSTconnect_ipsecInitiate an IPsec connectionPOSTdisconnect_ipsecDisconnect an IPsec connectionGETget_ipsec_statusGet IPsec service statusPOSTreconfigure_ipsecApply IPsec configuration changesPOSTsearch_ipsec_psksSearch IPsec pre-shared keysPOSTadd_ipsec_pskCreate an IPsec pre-shared keyPOSTset_ipsec_pskUpdate an IPsec pre-shared keyPOSTdel_ipsec_pskDelete an IPsec pre-shared keyPOSTsearch_kea_dhcp4_subnetsSearch Kea DHCPv4 subnetsGETget_kea_dhcp4_subnetGet a Kea DHCPv4 subnet by UUIDPOSTadd_kea_dhcp4_subnetCreate a new Kea DHCPv4 subnetPOSTset_kea_dhcp4_subnetUpdate a Kea DHCPv4 subnetPOSTdel_kea_dhcp4_subnetDelete a Kea DHCPv4 subnetPOSTsearch_kea_dhcp4_reservationsSearch Kea DHCPv4 static reservationsPOSTadd_kea_dhcp4_reservationCreate a Kea DHCPv4 static reservationPOSTset_kea_dhcp4_reservationUpdate a Kea DHCPv4 static reservationPOSTdel_kea_dhcp4_reservationDelete a Kea DHCPv4 static reservationGETsearch_kea_leasesSearch active DHCP leasesGETget_kea_statusGet Kea DHCP service statusPOSTreconfigure_keaApply Kea DHCP configuration changesPOSTrestart_keaRestart Kea DHCP servicePOSTsearch_static_routesSearch static routesGETget_static_routeGet a static route by UUIDPOSTadd_static_routeCreate a new static routePOSTset_static_routeUpdate a static routePOSTdel_static_routeDelete a static routePOSTreconfigure_routesApply static route changesGETget_gateway_statusGet gateway status (up/down, latency, loss)POSTsearch_gatewaysSearch configured gateways. WATCH OUT for `defaultgw`: the API reports it COMPUTED, not from the config — it says whether this gateway is the CURRENTLY ACTIVE default route, not whether the "Upstream Gateway" checkbox is ticked. A gateway with defaultgw=1 in config.xml is reported as false whenever a higher-priority gateway holds the default route (lower priority number wins). That looks like data loss but is not; to read the stored flag, use get_gateway (or the config backup).
GETget_gatewayGet a gateway by UUIDPOSTadd_gatewayCreate a new gateway. Provide the whole item as the object param `gateway_item` (posted as gateway_item[<field>]=... form fields). SELECT fields must be BARE option values: interface = friendly key ("wan","opt1"), ipprotocol = "inet"/"inet6". Booleans are "0"/"1" strings. Required: name, interface, ipprotocol, gateway. Returns {"result":"saved"} or {"result":"failed","validations":{...}} — inspect "validations". Fields: name, descr, disabled, interface (bare), ipprotocol (bare), gateway, defaultgw, fargw, nosync, monitor, monitor_disable, monitor_noroute, monitor_killstates, monitor_killstates_priority, force_down, priority, weight, latencylow, latencyhigh, losslow, losshigh, interval, time_period, loss_interval, data_length.
POSTset_gatewayLow-level update of a gateway definition. PREFER the update_gateway composite — it does a safe read-modify-write. This primitive REPLACES the whole item: OPNsense's setBase('gateway_item','gateway_item',uuid) rebuilds the model from exactly what you post, so any field you omit is reset to its model default (monitor cleared, defaultgw/nosync/priority lost). Pass the COMPLETE item as the object param `gateway_item` (form-encoded as gateway_item[<field>]=...): use get_gateway, flatten the SELECT maps, change the fields you want, post it all back. SELECT fields must be BARE values: interface = friendly key ("wan","opt1"), ipprotocol = "inet"/"inet6". Booleans are "0"/"1" strings. Returns {"result":"saved"} on success or {"result":"failed","validations":{...}} on error. RENAMING IS IMPOSSIBLE: Gateways::validateNameChange() rejects any `name` that differs from the stored one with "Changing name on a gateway is not allowed" — no API call can rename a gateway. Create the new gateway, repoint every reference (rules, gateway groups, static routes), then delete the old one.
POSTdel_gatewayDelete a gateway definition by UUIDPOSTreconfigure_gatewaysApply gateway changesPOSTsearch_gateway_groupsSearch gateway groups (failover / load-balancing groups). Each row carries the raw item/item2..item5 tier fields PLUS a `gateways` array indexed by tier that the API enriches with the live dpinger status of every member. Remember: `item` is TIER 1.
GETget_gateway_groupGet one gateway group by UUID. Returns {gateway_group:{…}} with the tier fields as OPNsense SELECT maps ({gatewayname:{value,selected}}) — `item` is TIER 1, item2..item5 are tiers 2..5. Post them back as comma-joined BARE gateway names (see set_gateway_group), or use the update_gateway_group composite which does that flattening for you.
POSTadd_gateway_groupCreate a gateway group. Pass the whole item as the object param `gateway_group` (form-encoded as gateway_group[<field>]=…). Fields: name (required, [a-zA-Z0-9_-]{1,32}), item (TIER 1 — comma-separated gateway NAMES), item2/item3/item4/item5 (tiers 2..5, same format), trigger (required: down | downloss | downlatency | downlosslatency, default down), poolopts ("" = default, "round-robin", "round-robin sticky-address"), descr. Gateway names must exist (search_gateways). Apply with reconfigure_gateway_groups.
POSTset_gateway_groupLow-level update of a gateway group. PREFER the update_gateway_group composite. Pass the object param `gateway_group` with BARE, comma-joined gateway names in item (TIER 1) and item2..item5 — never the {value,selected} maps returned by get_gateway_group. The endpoint merges (omitted fields keep their value), but the tier fields are all-or-nothing per field: posting item="A" replaces the entire tier-1 membership. Apply with reconfigure_gateway_groups.
POSTdel_gateway_groupDelete a gateway group by UUID. Refuses with a UserException when the group is still referenced by a firewall rule or another gateway consumer — the message names the referring object and its UUID.
POSTreconfigure_gateway_groupsApply gateway-group changes (runs configd 'interface routes configure')POSTget_firmware_statusGet firmware update statusPOSTcheck_firmware_updatesCheck for available firmware updatesGETget_firmware_infoFirmware/product identity plus the list of INSTALLED plugins. The raw endpoint answers ~330 KB (900+ base packages, all 100+ known plugins and the full changelog) with no section parameter, which does not fit in a model context — so this tool projects it down to: product identity, os_version, last_check, needs_reboot, pending upgrade count, packages_installed (count only), plugins_available (count) and plugins_installed (the actual list with name/version/tier/locked/automatic/repository/comment). For one specific package use get_firmware_details; for update state use check_firmware_updates / get_firmware_status; for the changelog get_firmware_changelog.
GETget_firmware_runningCheck if a firmware operation is currently runningPOSTupdate_firmwareStart firmware update (non-blocking, check status with get_firmware_running)POSTget_firmware_changelogGet changelog for a specific firmware versionPOSTinstall_firmware_pluginInstall a plugin packagePOSTremove_firmware_pluginRemove a plugin packagePOSTget_firmware_detailsGet details about an installed packageGETget_system_statusGet system status and pending notificationsPOSTreboot_systemReboot the OPNsense appliancePOSThalt_systemShut down the OPNsense applianceGETlist_backupsList the LOCAL configuration backup history — one entry per saved config revision with timestamp, the user who caused it and the change description. Takes no arguments: the host is pinned to "this" in the path because ToolMesh does not apply parameter defaults to path segments, so the previous {host} form failed with "missing required path parameter" whenever it was called without an explicit host. For a CARP peer's history use list_peer_backups.
GETlist_peer_backupsList the configuration backup history of a CARP peer (hostname as configured in HA sync). For the local appliance use list_backups.GETdownload_backupDownload a configuration backup as XML (returned as a broker file URL, not inline). HANDLE WITH CARE: the config XML is the one place where EVERY secret this backend otherwise redacts is present in full — certificate and CA private keys, the HA sync password, user password hashes, PSKs, RADIUS secrets. The broker URL is unauthenticated for its lifetime, so do not pass it on. Use it for restores/diffs, not to work around the redaction on the read tools.
POSTrevert_backupRevert to a previous configuration backupPOSTdelete_backupDelete a configuration backupGETdiff_backupsShow the diff between two configuration backups (filenames from list_backups). Useful for "what changed at 12:13?" — but note the diff is over the raw config XML and can therefore expose secrets when a key or password changed between the two revisions.
GETsearch_servicesList all services and their statusPOSTstart_serviceStart a system service by name (e.g. 'unbound', 'openvpn'). Use search_services to list available service names. For one instance of a multi-instance service use start_service_instance.POSTstop_serviceStop a system service by name. Use search_services to list running services. For one instance of a multi-instance service use stop_service_instance.POSTrestart_serviceRestart a system service by name. Useful after configuration changes or to recover a stalled service. For one instance of a multi-instance service use restart_service_instance.POSTstart_service_instanceStart ONE instance of a multi-instance service. The instance id is the part after the slash in search_services ids — e.g. a per-gateway dpinger monitor is name "dpinger", id "<gateway name>". The id MUST travel as a path segment; a ?id= query param is ignored by the API router.
POSTstop_service_instanceStop ONE instance of a multi-instance service (see start_service_instance for the name/id convention).POSTrestart_service_instanceRestart ONE instance of a multi-instance service — e.g. restart a single gateway's dpinger monitor after source-address or IPv6 changes without touching the other gateway monitors (name "dpinger", id = gateway name from search_services "dpinger/<gateway>").
GETget_ids_statusGet IDS/IPS (Suricata) service statusPOSTquery_ids_alertsQuery IDS/IPS alert logGETget_ids_alert_infoGet detailed information for a specific IDS/IPS alert by alert ID. Returns rule metadata, classification, and affected traffic details.GETget_ids_alert_logsList available IDS alert log filesPOSTreconfigure_idsApply IDS/IPS configuration changesPOSTupdate_ids_rulesDownload and update IDS/IPS rulesetsPOSTdrop_ids_alert_logClear the IDS alert logGETget_ids_settingsGet IDS/IPS settingsPOSTset_ids_settingsUpdate IDS/IPS settingsPOSTsearch_ids_rulesSearch installed IDS/IPS rules (signatures)POSTtoggle_ids_ruleEnable or disable IDS/IPS rules by Suricata SID. Accepts comma-separated SIDs for bulk toggle.POSTsearch_shaper_pipesSearch traffic shaper pipes (bandwidth limiters)POSTadd_shaper_pipeCreate a traffic shaper pipe (bandwidth limit)POSTset_shaper_pipeUpdate a traffic shaper pipe (bandwidth limit)POSTdel_shaper_pipeDelete a traffic shaper pipePOSTsearch_shaper_queuesSearch traffic shaper queues (within pipes)POSTsearch_shaper_rulesSearch traffic shaper rules (match traffic to pipes/queues)POSTadd_shaper_ruleCreate a traffic shaper rulePOSTset_shaper_ruleUpdate a traffic shaper rulePOSTdel_shaper_ruleDelete a traffic shaper rulePOSTreconfigure_shaperApply traffic shaper changesGETget_shaper_statisticsGet traffic shaper statisticsPOSTsearch_haproxy_serversSearch HAProxy backend serversPOSTadd_haproxy_serverCreate an HAProxy backend serverPOSTset_haproxy_serverUpdate an HAProxy backend serverPOSTdel_haproxy_serverDelete an HAProxy backend serverPOSTsearch_haproxy_backendsSearch HAProxy backendsPOSTadd_haproxy_backendCreate an HAProxy backendPOSTset_haproxy_backendUpdate an HAProxy backendPOSTdel_haproxy_backendDelete an HAProxy backendPOSTsearch_haproxy_frontendsSearch HAProxy frontends (public listeners)POSTadd_haproxy_frontendCreate an HAProxy frontendPOSTset_haproxy_frontendUpdate an HAProxy frontendPOSTdel_haproxy_frontendDelete an HAProxy frontendGETget_haproxy_statusGet HAProxy service statusPOSTreconfigure_haproxyApply HAProxy configuration changesGETtest_haproxy_configTest HAProxy configuration for syntax errorsGETget_haproxy_statisticsGet HAProxy statistics countersGETexport_haproxy_configExport the generated HAProxy configuration fileGETdiff_haproxy_configShow diff between staged and active HAProxy configPOSTsearch_certificatesSearch TLS/SSL certificates (inventory). PRIVATE KEY MATERIAL IS NOT RETURNED: the raw endpoint ships `prv` (base64) and `prv_payload` (the full "-----BEGIN PRIVATE KEY-----" PEM) with every row and has no opt-out parameter — a two-certificate inventory was 23 KB of mostly RSA key. Those fields, plus csr/csr_payload, arrive redacted; an empty value still shows as empty so "does this cert have a stored key?" remains answerable, and private_key_location tells you where it lives. Keys stay SETTABLE via add_certificate / set_certificate. The certificate itself (crt/crt_payload) is public and passes through. Expiry: valid_from/valid_to are raw epoch-second strings; readable %valid_from / %valid_to are added — an expired GUI certificate is easy to miss otherwise.
GETget_certificateGet a certificate by UUID. Private key material (prv / prv_payload) and CSR fields are redacted on the way out — settable via set_certificate, never returned. crt/crt_payload (the public certificate) pass through; %valid_from / %valid_to are added.
POSTadd_certificateCreate/import a certificatePOSTset_certificateUpdate a certificatePOSTdel_certificateDelete a certificatePOSTsearch_casSearch Certificate Authorities. Like the certificate search, the raw endpoint returns the CA's PRIVATE KEY (prv / prv_payload) on a plain listing call — arguably worse, since a CA key can mint new certificates. Those fields are redacted here; the CA certificate itself is public and passes through, and %valid_from / %valid_to are added.
GETget_caGet a Certificate Authority by UUIDPOSTadd_caCreate/import a Certificate AuthorityPOSTset_caUpdate a Certificate AuthorityPOSTdel_caDelete a Certificate AuthorityGETget_syslog_settingsGet syslog service settings including log retention, remote destinations, and format optionsPOSTsearch_syslog_destinationsSearch remote syslog destinationsPOSTadd_syslog_destinationCreate a remote syslog destinationPOSTset_syslog_destinationUpdate a remote syslog destinationPOSTdel_syslog_destinationDelete a remote syslog destinationPOSTreconfigure_syslogApply syslog configuration changesGETget_syslog_statsGet syslog service statisticsPOSTsearch_cron_jobsSearch scheduled cron jobsGETget_cron_jobGet a cron job by UUIDPOSTadd_cron_jobCreate a new cron jobPOSTset_cron_jobUpdate a scheduled cron jobPOSTdel_cron_jobDelete a scheduled cron job by UUIDPOSTtoggle_cron_jobToggle a scheduled cron job on or off. Omit 'enabled' to flip the current state.GETget_hasync_settingsGet HA synchronization settings. THE SYNC PASSWORD IS NOT RETURNED: /core/hasync/get hands out `password` in CLEAR TEXT (it is the XMLRPC credential of the peer's admin account); it is redacted here and is write-only — settable through set_hasync_settings / update_hasync_settings, never readable. An unset password still shows as empty. The multi-select fields are flattened from OPNsense's full option maps (36 entries for syncitems alone) to the comma-joined BARE selection you would post back: `syncitems` = the config sections XMLRPC-synced to the peer, `pfsyncinterface`, `pfsyncversion`. Added: "%pfsync_configured" — the model has NO `pfsyncenabled` field on 26.7 (asking for it yields null and reading that as "pfsync is off" is wrong), so this flag reports whether a pfsync interface is configured. For the live picture use get_pfsync_nodes (both creator IDs present = pfsync is actually exchanging states).
POSTset_hasync_settingsLow-level update of HA sync settings. PREFER the update_hasync_settings composite (safe read-modify-write, and the only sane way to change syncitems). Provide the fields under the object param `hasync` (posted as hasync[<field>]=...). Fields: disablepreempt, disconnectppps, synchronizetoip (peer IP), username, password, verifypeer, pfsyncdefer, pfsyncpeerip, pfsyncinterface (bare key, e.g. "lan"), pfsyncversion ("1301"/"1400"), syncitems (comma-joined section keys, e.g. "aliases,ipsec,radvd,ndpproxy" — REPLACES the whole selection). Booleans are "0"/"1" strings. Returns {"result":"saved"} or {"result":"failed","validations":{...}}.
POSTreconfigure_hasyncApply local HA/pfsync changes (runs 'interface pfsync configure'). NOTE: this does NOT push config to the peer — for the XMLRPC config sync use synchronize_ha_services.GETget_ha_status_versionCheck the HA peer link: returns the backup node's version info (empty/❌ when the peer is unreachable or credentials are wrong).POSTget_ha_status_servicesList HA-managed services on the peer with their sync/running state (the rows behind the HA status grid).POSTsynchronize_ha_servicesHA "Synchronize and reconfigure all services": pushes the current config to the backup via XMLRPC (exec_sync), reloads templates, then restarts every HA-managed service on the peer. This is the manual config-sync trigger. Returns {"status":"ok","count":N}. Heavy — it bounces services on the backup; for a routine change, a normal save already auto-syncs.
POSTsearch_radvdSearch Router Advertisement (radvd) per-interface configurationsGETget_radvdGet a radvd interface entry by UUID. SELECT fields (interface, mode, Adv* option fields) come back as {opt:{value,selected}} maps — flatten to the bare selected key before posting back.POSTadd_radvdCreate a Router Advertisement config for an interface. Provide the whole entry as the object param `entries` (posted as entries[<field>]=...). SELECT fields are BARE values: interface = friendly key ("lan","opt1"), mode = router|unmanaged|managed|assist|stateless, AdvDefaultPreference = low|medium|high, DeprecatePrefix/RemoveAdvOnExit/RemoveRoute = ""(auto)|on|off. Booleans (enabled, dns) are "0"/"1". List fields (routes, RDNSS, DNSSL) are comma-separated. Returns {"result":"saved","uuid":...} or {"result":"failed","validations":{...}}. Then call reconfigure_radvd.
POSTset_radvdLow-level replace of a radvd entry — PREFER the update_radvd composite (read-modify-write). setBase rebuilds the entry from exactly what you post, so any omitted field resets to its model default. Pass the COMPLETE entry as the object param `entries`: use get_radvd, flatten the SELECT maps to bare values, change what you need, post it all back. Booleans "0"/"1"; interface/mode/AdvDefaultPreference bare; routes/RDNSS/DNSSL comma-separated. Returns {"result":"saved"} or {"result":"failed","validations":{...}}.
POSTtoggle_radvdEnable/disable a radvd interface entry. enabled=1 to enable, 0 to disable.POSTdel_radvdDelete a radvd interface entry by UUIDPOSTreconfigure_radvdApply radvd changes (regenerates radvd.conf and reloads the daemon)GETget_ndpproxy_settingsGet NDP Proxy settings. Returns {ndpproxy:{general:{...}, aliases:{alias:{...}}}}. `general.upstream`/`downstream` come back as interface SELECT maps.POSTset_ndpproxy_settingsUpdate NDP Proxy `general` settings (partial-merge — omitted fields keep their value). Fields (as ndpproxy.general.*): enabled, upstream (bare interface key), downstream (bare, comma list for multiple), ra ("0"/"1"), routes ("0"/"1"), carp_depend_on ("0"/"1", HA/CARP failover), cache_ttl, cache_max, cache_file, route_qps, pf_qps, pcap_timeout, debug. Booleans are "0"/"1". Then call reconfigure_ndpproxy. Returns {"result":"saved"} or {"result":"failed","validations":{...}}.
POSTsearch_ndpproxy_aliasesSearch NDP Proxy alias entries (proxied external firewall aliases per interface)GETget_ndpproxy_aliasGet an NDP Proxy alias entry by UUIDPOSTadd_ndpproxy_aliasAdd an NDP Proxy alias entry (fields as alias.*): alias.interface (bare key, blank=any), alias.alias (UUID of an EXTERNAL-type firewall alias — use search_firewall_aliases to find it), alias.description. Then call reconfigure_ndpproxy.
POSTset_ndpproxy_aliasUpdate an NDP Proxy alias entry by UUID (full-replace — post interface, alias and description). Then reconfigure_ndpproxy.POSTdel_ndpproxy_aliasDelete an NDP Proxy alias entry by UUIDPOSTreconfigure_ndpproxyApply NDP Proxy changes and reload the ndp-proxy-go serviceGETget_ndpproxy_statusGet NDP Proxy service run state (running/stopped)POSTsearch_usersSearch OPNsense system users with optional filtering by name or emailGETget_userGet a system user account by UUID including group memberships and permissionsPOSTadd_userCreate a system userPOSTset_userUpdate a system user accountPOSTdel_userDelete a system userPOSTsearch_groupsSearch system groupsPOSTadd_user_api_keyGenerate a new API key+secret pair for a user. The key is returned as a downloadable file. IMPORTANT: the secret is not stored on the system — save it immediately.POSTsearch_api_keysSearch API keys across all users — returns key ID, associated username, and creation date. Keys are managed per-user, not as standalone resources.POSTdel_user_api_keyDelete an API key by its ID — revokes API access for this key immediatelyGETget_rrd_listList available RRD graphs (system health metrics)GETget_system_healthGet system health time-series data for a specific RRD metric. Use get_rrd_list to discover available metric names (e.g. cpu-usage, traffic-wan).GETget_health_interfacesList interfaces available for health monitoringPOSTsearch_tunablesSearch system tunables (sysctl)POSTadd_tunableCreate a system tunablePOSTset_tunableUpdate a system tunablePOSTdel_tunableDelete a system tunablePOSTreconfigure_tunablesApply tunable changesGETget_dashboardGet dashboard widget configurationGETget_product_infoGet product info and update feedGETget_menu_treeGet the full OPNsense menu structureWhat composite workflows does the Opnsense DADL provide? ⚠ contains code
FNupdate_gatewaySafely update a gateway by UUID using read-modify-write. Pass `uuid` and a `changes` object with only the fields you want to change (e.g. {monitor:"8.8.8.8", losslow:"10", losshigh:"20"}). The composite GETs the current gateway_item, flattens its SELECT maps (interface, ipprotocol) to bare values, merges your changes, and POSTs the COMPLETE item back under the correct "gateway_item" node — so untouched fields (defaultgw, nosync, priority, weight, …) are preserved instead of being reset by OPNsense's full-replace setBase. Does NOT apply by default: call reconfigure_gateways yourself, or pass apply:true. On failure returns {ok:false, validations, raw} with the full OPNsense response so errors are visible instead of a bare {"result":"failed"}. Field names for `changes`: name, descr, disabled, interface (bare key, e.g. "wan"/"opt1"), ipprotocol ("inet"/"inet6"), gateway, defaultgw, fargw, nosync, monitor, monitor_disable, monitor_noroute, monitor_killstates, monitor_killstates_priority, force_down, priority, weight, latencylow, latencyhigh, losslow, losshigh, interval, time_period, loss_interval, data_length. apply:true runs reconfigure_gateways (access admin), which ToolMesh checks against the caller's own rights like a direct call.
FNupdate_gateway_groupSafely edit a gateway group (failover/load-balancing tiers) by UUID via read-modify-write. Pass `uuid` plus either `changes` (raw field map) or the friendlier `tiers` map {"1": ["PRIMARY_GWv6"], "2": ["BACKUP_GWv6"]} — tier numbers 1..5, values are arrays of gateway NAMES; only the tiers you name are touched. WHY THIS EXISTS: tier 1 is stored in the field `item`, NOT `item1` (tiers 2..5 are item2..item5), and every tier is a multi-select. Hand-written code that loops item1..item5, or that assumes `item` is a scalar, skips tier 1 silently — which is how a gateway rename once left a group pointing at a gateway that no longer existed. This composite reads the group, flattens the SELECT maps to bare comma-joined names, applies your changes and posts the complete item back, then reports the resulting tiers so the result can be counted against what you asked for. Does NOT apply by default — pass apply:true or call reconfigure_gateway_groups. Other writable fields for `changes`: name, trigger (down | downloss | downlatency | downlosslatency), poolopts ("" | "round-robin" | "round-robin sticky-address"), descr. apply:true runs reconfigure_gateway_groups (access admin), which ToolMesh checks against the caller's own rights like a direct call.
FNupdate_hasync_settingsSafely update HA sync settings — especially the syncitems multi-select — via read-modify-write. Pass `changes` (scalar fields: synchronizetoip, username, password, disablepreempt, disconnectppps, verifypeer, pfsyncinterface (bare), pfsyncversion, pfsyncpeerip, pfsyncdefer) and/or `enable_syncitems` / `disable_syncitems` (arrays of section keys, e.g. ["radvd","ndpproxy"]). The composite GETs the current hasync model, derives the new syncitems selection FROM the current one (so untouched sections are preserved, never clobbered by a bare set), merges your scalar changes, and POSTs only what changed (setNodes merges). Does NOT apply pfsync (call reconfigure_hasync if you changed a pfsync field). Valid syncitems keys are whatever the appliance reports — commonly aliases, authservers, captiveportal, categories, certs, cron, dhcpd, dhcpdv6, dhcrelay, dnsforwarder, dnsresolver, hostwatch, ifgroups, ipsec, kea, lvtemplate, monit, nat, ndpproxy, ntpd, opendns, openvpn, radvd, rules, schedules, shaper, ssh, staticroutes, suricata, sysctl, syslog, syslog-ng, users, virtualip, webgui, wireguard. On failure returns {ok:false, validations, raw}. PASSWORD: `changes.password` is accepted and written normally — the sync password is write-only, not unwritable. It is never read back (get_hasync_settings redacts it), and this composite never copies it from the current model, so a plain update_hasync_settings({changes:{synchronizetoip:"…"}}) leaves the stored password untouched. A `changes` value that is itself the redaction marker is rejected rather than written.
FNupdate_radvdSafely update a radvd interface entry by UUID via read-modify-write. Pass `uuid` and a `changes` object with only the fields to change (e.g. {mode:"managed", dns:"1"}). The composite GETs the current entry, flattens its SELECT maps (interface, mode, Adv* option fields, AdvRASrcAddress) to bare values, merges your changes, and POSTs the COMPLETE entry back under the `entries` node — so untouched fields are preserved instead of being reset by setBase's full-replace. Does NOT apply by default: call reconfigure_radvd, or pass apply:true. Field names for `changes`: enabled, interface (bare), Base6Interface (bare), mode (router|unmanaged|managed|assist|stateless), dns, DeprecatePrefix/RemoveAdvOnExit/RemoveRoute (""|on|off), routes/RDNSS/DNSSL (comma lists), MinRtrAdvInterval, MaxRtrAdvInterval, AdvDefaultPreference (low|medium|high), AdvCurHopLimit, AdvDefaultLifetime, AdvLinkMTU, AdvPreferredLifetime, AdvValidLifetime, AdvRDNSSLifetime, AdvRouteLifetime, AdvDNSSLLifetime, AdvRASrcAddress, nat64prefix. On failure returns {ok:false, validations, raw}. apply:true runs reconfigure_radvd (access admin), which ToolMesh checks against the caller's own rights like a direct call.