Powered by Redocly

/config/net

The network configuration.

The current state of the network is available at /sys/net.

Get /config/net

SecurityApiKey
Request
query Parameters
max-depth
integer >= 1

Limit output depth of the response. See Max-Depth.

Example: max-depth=2
filter
string

Response filter string. See Filter-Spec.

Example: filter={foo,bar}
Responses
200

Normal response.

401

Unauthorized response.

get/config/net
Request samples 
Response samples 
application/json
{
  • "result": {
    },
  • "error": "Error message (present if an error occurred)."
}
Replace /config/net
SecurityApiKey 
Request 
Request Body schema: application/json
object (configNetEthernet) 
The Ethernet configuration of the meter.


 
object (configNetGoproxy) 
The Go proxy configuration of the meter.


 
object (configNetHomeplug) 
HomePlug configuration.  This is used only by devices with
built-in HomePlug power-line communication (egauge2, EG3x10 and
EG41xx).


 
hostname
string (configNetHostname) 
The hostname of the meter.  Must consist of ASCII letters, digits,
and dashes only.


 
object (configNetHttp) 
Web (HTTP) related configurations.


Modification requests (PUT, POST, and DELETE) to this
resource are not executed
transactionally.


 
object (configNetIpv4) 
The Internet Protocol v4 (IPv4)
configuration.


 
object (configNetNameserver) 
The name server (DNS)
configuration.


 
object (configNetNtp) 
The Network Time Protocol
(NTP) configuration.


 
object (configNetOption) 
Options that have a system-wide effect on the network services.


 
object (configNetProxy) 
The proxy configuration of the meter.


 
object (configNetPtp) 
The Precision Time Protocol
(PTP)
configuration.


 
Responses 
200
Normal response.


401
Unauthorized response.


put/config/net
Request samples 
application/json
{ }
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
Update /config/net
SecurityApiKey 
Request 
Request Body schema: application/json
object (configNetEthernet) 
The Ethernet configuration of the meter.


 
object (configNetGoproxy) 
The Go proxy configuration of the meter.


 
object (configNetHomeplug) 
HomePlug configuration.  This is used only by devices with
built-in HomePlug power-line communication (egauge2, EG3x10 and
EG41xx).


 
hostname
string (configNetHostname) 
The hostname of the meter.  Must consist of ASCII letters, digits,
and dashes only.


 
object (configNetHttp) 
Web (HTTP) related configurations.


Modification requests (PUT, POST, and DELETE) to this
resource are not executed
transactionally.


 
object (configNetIpv4) 
The Internet Protocol v4 (IPv4)
configuration.


 
object (configNetNameserver) 
The name server (DNS)
configuration.


 
object (configNetNtp) 
The Network Time Protocol
(NTP) configuration.


 
object (configNetOption) 
Options that have a system-wide effect on the network services.


 
object (configNetProxy) 
The proxy configuration of the meter.


 
object (configNetPtp) 
The Precision Time Protocol
(PTP)
configuration.


 
Responses 
200
Normal response.


401
Unauthorized response.


post/config/net
Request samples 
application/json
{ }
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
Delete /config/net
Reset to default. See the descriptions of the individual endpoints for their default values.  Commonly, arrays and strings are cleared to empty, numbers are cleared to 0, and booleans are cleared to false.  


SecurityApiKey 
Responses 
200
Normal response.


401
Unauthorized response.


delete/config/net
Request samples 
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
➔ Next to /config/net/ethernet