/

Docs
History
Schema
Generate

Filter operations

Authentication11

Basic3

Certificates10

Cluster17

Cluster Backups23

Cluster Internal1

Cluster Replication9

Container29

Directory Services19

Disk12

Dynamic DNS5

Events1

Groups4

Health2

Info18

iSCSI17

Jail48

mDNS6

Network72

get/network/dhcp/configGet DHCP configuration
put/network/dhcp/configUpdate DHCP configuration
get/network/dhcp/leaseList DHCP leases
post/network/dhcp/leaseCreate a static DHCP lease
delete/network/dhcp/lease/dynamicDelete a dynamic DHCP lease
put/network/dhcp/lease/{id}Update a static DHCP lease
delete/network/dhcp/lease/{id}Delete a static DHCP lease
get/network/dhcp/rangeList DHCP ranges
post/network/dhcp/rangeCreate a DHCP range
put/network/dhcp/range/{id}Update a DHCP range
delete/network/dhcp/range/{id}Delete a DHCP range
get/network/firewall/advancedGet Firewall Advanced Settings
put/network/firewall/advancedUpdate Firewall Advanced Settings
post/network/firewall/advanced/previewPreview Firewall Configuration
get/network/firewall/advanced/renderedGet Rendered Firewall Configuration
get/network/firewall/logs/liveList Live Firewall Logs
get/network/firewall/natList Firewall NAT Rules
post/network/firewall/natCreate Firewall NAT Rule
delete/network/firewall/natBulk Delete Firewall NAT Rules
get/network/firewall/nat/countersList Firewall NAT Rule Counters
put/network/firewall/nat/reorderReorder Firewall NAT Rules
put/network/firewall/nat/{id}Update Firewall NAT Rule
delete/network/firewall/nat/{id}Delete Firewall NAT Rule
get/network/firewall/nat/{id}/route-suggestionsSuggest routes from NAT rule
get/network/firewall/trafficList Firewall Traffic Rules
post/network/firewall/trafficCreate Firewall Traffic Rule
delete/network/firewall/trafficBulk Delete Firewall Traffic Rules
get/network/firewall/traffic/countersList Firewall Traffic Rule Counters
put/network/firewall/traffic/reorderReorder Firewall Traffic Rules
put/network/firewall/traffic/{id}Update Firewall Traffic Rule
delete/network/firewall/traffic/{id}Delete Firewall Traffic Rule
get/network/global-configGet this node's global network configuration
put/network/global-configUpdate this node's DNS, search domains, and host aliases
post/network/host-ip/pending/{id}/confirmConfirm A Pending Host Interface L3 Operation
post/network/host-ip/pending/{id}/revertRevert A Pending Host Interface L3 Operation
get/network/interfaceList Network Interfaces
get/network/interface/l3List Host Interface L3 Configuration
get/network/interface/l3/pendingList Pending Host Interface L3 Operations
put/network/interface/{name}/l3Save Host Interface L3 Configuration
delete/network/interface/{name}/l3Delete Host Interface L3 Configuration
post/network/interface/{name}/l3/reapplyReapply Host Interface L3 Configuration
get/network/objectList Network Objects
post/network/objectCreate Network Object
delete/network/objectBulk Delete Network Objects
put/network/object/{id}Update Network Object
delete/network/object/{id}Delete Network Object
get/network/routeList static routes
post/network/routeCreate static route
put/network/route/{id}Update static route
delete/network/route/{id}Delete static route
get/network/switchList network switches
post/network/switch/manualCreate a manual switch
delete/network/switch/manual/{id}Delete a manual switch
post/network/switch/standardCreate a standard switch
put/network/switch/standard/{id}Update a standard switch
delete/network/switch/standard/{id}Delete a standard switch
get/network/switch/syncGet switch reconciliation status
post/network/switch/syncRe-apply stored switch network configuration
get/network/wireguard/clientsList WireGuard clients
post/network/wireguard/clientsCreate WireGuard client
put/network/wireguard/clients/{clientId}Update WireGuard client
delete/network/wireguard/clients/{clientId}Delete WireGuard client
patch/network/wireguard/clients/{clientId}Set WireGuard client state
get/network/wireguard/serverGet WireGuard server
put/network/wireguard/serverUpdate WireGuard server
post/network/wireguard/serverInitialize WireGuard server
delete/network/wireguard/serverDeinitialize WireGuard server
patch/network/wireguard/serverSet WireGuard server state
post/network/wireguard/server/peerAdd WireGuard server peer
put/network/wireguard/server/peer/{peerId}Update WireGuard server peer
delete/network/wireguard/server/peer/{peerId}Remove WireGuard server peer
patch/network/wireguard/server/peer/{peerId}Set WireGuard server peer state

Notifications17

Samba8

System19

Tasks6

Users9

Utilities19

VM50

ZFS35

Network

Changes to Get this node's global network configuration

get/network/global-config

Oct 13, 20263b2ab23c2629 Revision changes
- info
  endpoint added