docs

Author: Tbaile

packages/ns-api/README.md

@@ -4995,7 +4995,7 @@ Example response:
       "type": "domain",
       "description": "cool domain",
       "domain": "cool.domain",
-      "certificate": "cool_certificate", 
+      "certificate": "cool_certificate",
       "destination": "http://10.24.42.1",
       "location": "/",
       "allow": [
@@ -5196,6 +5196,7 @@ All parameters:
 - `dhcp_vendor_class`: Vendor class to send when requesting DHCP
 - `dhcp_hostname_to_send`: Hostname to send when requesting DHCP, can be `deviceHostname`, `doNotSendHostname` or `customHostname`
 - `dhcp_custom_hostname`: Custom hostname to use when `dhcp_hostname_to_send = customHostname`
+- `metric`: Routing metric for the interface, if left empty, system will assign an incremental value
 
 ```bash
 api-cli ns.devices configure-device --data '{"device_type": "physical", "interface_name": "myiface", "protocol": "static", "zone": "lan", "ip6_enabled": false, "device_name": "eth2", "ip4_address": "10.20.30.40/24"}'
@@ -6021,7 +6022,7 @@ api-cli ns.threatshield dns-edit-blocklist --data '{ "blocklist": "blocklist_nam
 Response example:
 ```json
 {"message": "success"}
-``` 
+```
 
 ### dns-list-settings
 
@@ -8407,7 +8408,7 @@ Add a wireguard tunnel as a client
 api-cli ns.wireguard add-tunnel --data '{"enabled": true, "name": "HQ Milan", "reserved_ip": "10.2.13.4", "server_public_key": "XXX", "peer_private_key": "XXX", "pre_shared_key": "XXX", "route_all_traffic": true, "network_routes": [""], "endpoint": "wireguard.example.com", "udp_port": 51121, "dns": ["192.168.1.1"]}'
 ```
 
-Parameters: 
+Parameters:
 - `enabled`: create the tunnel as active if `true`, inactive if `false`
 - `name`: the name of the tunnel
 - `reserved_ip`: the reserved IP address for the tunnel
@@ -8446,7 +8447,7 @@ Parameters:
 
 ### ns.ha
 
-The following APIs are available for managing High Availability (HA) configuration. 
+The following APIs are available for managing High Availability (HA) configuration.
 
 #### import-network-config
 

packages/ns-api/files/ns.devices

@@ -1198,6 +1198,7 @@ if cmd == 'list':
             'dhcp_vendor_class': 'string',
             'dhcp_hostname_to_send': 'string',
             'dhcp_custom_hostname': 'string',
+            'metric': 'integer'
         },
         'unconfigure-device': {
             'iface_name': 'string',