Use The Post Method To Modify Device Configuration Parameters And List Arrays; Use The Delete Method To Remove Items From A List Array - Digi IX20-WAG4 User Manual

Table of Contents

Advertisement

Applications
Use the POST method to modify device configuration parameters
and list arrays
Use the POST method to modify device configuration parameters
To modify configuration parameters, use the POST method with the path and value parameters.
$ curl -k -u admin "https://ip-address/cgi-
bin/config.cgi/value?path=path&value=new_value" -X POST
where:
path is the path to the configuration parameter, in dot notation (for example,
n
ssh.service.enable).
new_value is the new value for the parameter.
n
For example, to disable the ssh service using curl:
$ curl -k -u admin "https://192.168.210.1/cgi-
bin/config.cgi/value?path=service.ssh.enable&value=false" -X POST
Enter host password for user 'admin':
{ "ok": true }
$
Use the POST method to add items to a list array
To add items to a list array, use the POST method with the path and append parameters. For
example, to add the external firewall zone to the ssh service:
$ curl -k -u admin "https://192.168.210.1/cgi-
bin/config.cgi/value?path=service.ssh.acl.zone&append=true&value=external" -X
POST
Enter host password for user 'admin':
{ "ok": true, "result": "service.ssh.acl.zone.4" }
$
Use the POST method to add objects to a list array
Objects in an array that require one or more underlying values can be set using the collapsed URI
parameter. The below example would add a new static route for the WAN interface for the 1.2.4.0/24
destination network:
$ curl -k -u admin "https://192.168.210.1/cgi-
bin/config.cgi/value?pathnetwork.route.static&append=true&collapsed
[dst]=1.2.4.0/24&collapsed[interface]=/network/interface/wan' -X POST-X POST
Enter host password for user 'admin':
{ "ok": true, "result": "network.route.static.1" }
$

Use the DELETE method to remove items from a list array

To remove items from a list array, use the DELETE method. For example, using curl:
$ curl -k -u admin "https://192.168.210.1/cgi-bin/config.cgi/value?path=path
IX20 User Guide
Use the local REST API to configure the IX20 device
575

Advertisement

Table of Contents
loading

This manual is also suitable for:

Ix20

Table of Contents