config/settings_group/instance_specifier

The config/settings_group/instance_specifier URI manipulates a single settings record, for settings with an instance specifier.

URI path

config/settings_group/instance_specifier

Supported request methods

GET

Queries the settings, returning the named settings instance record.

PUT

Changes the settings instance to match the supplied record.

Supported content types

XML

Settings are returned inside tags matching the name of the settings group, with the appropriate instance specifier inserted if applicable. For example, here is a settings group without an instance specifier:

<http>
          <enable>on</enable>
          <port>80</port>
</http>

Here is an example of a settings group with an instance specifier:

<interface  name="wlan0">
          <static>off</static>
          <dhcp>on</dhcp>
          <ip>0.0.0.0</ip>
          <subnet>0.0.0.0</subnet>
          <gateway>0.0.0.0</gateway>
</interface>

JSON

Settings are returned as an object with a field whose name matches the settings group, and whose value is an object with fields matching the settings record fields. If there is an instance specifier associated with the record, it is not present in the JSON; it only is present in the request URI.

Here is an example of a settings group without an instance specifier:

{  “http” : { “enable” : “on”, “port” : 80 } }

Here is an example of a settings group with an instance specifier:

{  “interface” : { “static” : “off”, “dhcp” : “on”,
   “ip” : “0.0.0.0”, “subnet” : “0.0.0.0”,
   “gateway” : “0.0.0.0” } }

 

© 2019 Digi International Inc. All rights reserved.
config/settings_group/instance_specifier updated on 18 Oct 2017 10:28 AM