A HTTP GET to /api/edge/getcfg.json can be used to get a JSON formatted object of the requested configuration tree.
| Name | Type | Values | Description |
|---|---|---|---|
|
Object |
|
An object that contains the sections of the configuration for the request. |
|
Boolean |
|
Whether the API request was successful. |
| Name | Type | Values | Description |
|---|---|---|---|
|
Array (String, Object or empty string) |
Array of children |
An array of strings of further keys or of an object of key value pairs of only the configured children contained within the search criteria. |
|
Object |
|
An object defining the definition of any children and/or values within this parent node. |
|
Array (String) |
Array of |
An array of values contained within this configuration node. |
|
String |
A boolean encapsulated in a string (e.g. |
Whether the configuration settings get tree operation was successful. |
|
String |
An error message (e.g. |
The error that occurred while trying to process this GETCFG request. |
| Name | Type | Values | Description |
|---|---|---|---|
Key |
String |
The unique name of a particular child or value (e.g. |
A property that represents the configuration child or value. |
Value |
Object |
|
An object that represents a particular configuration key or value. |
| Name | Type | Values | Description |
|---|---|---|---|
type (Optional) |
String |
The type of the value (e.g. |
The type of the configurable value (in the format |
type2 (Optional) |
String |
The type of the value (e.g. |
An additional permitted type of the configurable value (in the format |
default (Optional) |
String |
A default value for this setting |
The default value for this setting. |
multi (Optional) |
String |
A boolean encapsulated in a string (e.g. |
Whether this value can be specified multiple times. |
tag (Optional) |
Boolean |
A boolean encapsulated in a string (e.g. |
Whether this is a tag (list in web UI) that can contain children. |
help (Optional) |
String |
Help text |
An explanation of the key or value that is used in the web UI as the tooltip text. |
| Name | Type | Description |
|---|---|---|
txt |
String |
A string of text. |
u32 |
UInt32 |
Unsigned 32bit number. |
ipv4 |
IPv4 Address |
An IPv4 Address. |
ipv6 |
IPv6 Address |
An IPv6 Address. |
bool |
Boolean |
A |
macaddr |
MAC Address |
A MAC Address. |
ipv4net |
IPv4 Network |
An IPv4 Network (CIDR). |
ipv6net |
IPv6 Network |
An IPv6 Network (CIDR). |
{"GETCFG": {"children": ["firewall", "interfaces", "port-forward", "service", "system"], "defs": {"custom-attribute": {"type": "txt", "tag": "true", "help": "Custom attribute name\n"}, "firewall": {"help": "Firewall\n"}, "interfaces": {"help": "Network interfaces\n"}, "load-balance": {"help": "Load Balance\n"}, "policy": {"help": "Routing policy\n"}, "port-forward": {"help": "Port forwarding"}, "protocols": {"help": "Routing protocol parameters\n"}, "service": {"help": "Services\n"}, "system": {"help": "System parameters\n"}, "traffic-control": {"help": "Traffic control (QOS) type\n"}, "traffic-policy": {"help": "Quality of Service (QOS) policy type\n"}, "vpn": {"help": "Virtual Private Network (VPN)"}, "zone-policy": {"help": "Configure zone-policy\n"}}, "success": "1"}, "success": true}{"GETCFG": {"tags": ["0.ubnt.pool.ntp.org", "1.ubnt.pool.ntp.org", "2.ubnt.pool.ntp.org", "3.ubnt.pool.ntp.org"], "success": "1"}, "success": true}{"GETCFG": {"children": [{"send-crash-report": "true"}], "defs": {"save-core-file": {"type": "bool", "help": "Save core file of crashed userspace process in \"/var/core/\""}, "send-crash-report": {"type": "bool", "help": "Send *anonymous* app/kernel crash report to Ubiquiti cloud"}}, "success": "1"}, "success": true}