Powered by Redocly

/config/net/ipv4

The Internet Protocol v4 (IPv4) configuration.

Get /config/net/ipv4

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/ipv4
Request samples 
Response samples 
application/json
{
  • "result": {
    },
  • "error": "Error message (present if an error occurred)."
}
Replace /config/net/ipv4
SecurityApiKey 
Request 
Request Body schema: application/json
dhcp
boolean (configNetIpv4Dhcp) 
Whether or not to use DHCP
to automatically provision the IPv4 address.  If true, DHCP is
enabled. If false, the manually configured IPv4 settings are
used.


 
address
string (configNetIpv4Address) 
An IPv4 address in dotted decimal notation.


 
broadcast
string (configNetIpv4Broadcast) 
An IPv4 broadcast address in dotted decimal notation.


 
netmask
string (configNetIpv4Netmask) 
The address of the IPv4 gateway in dotted decimal notation.


 
network
string (configNetIpv4Network) 
The IPv4 network mask in dotted decimal notation.


 
gateway
string (configNetIpv4Gateway) 
The IPv4 network number in dotted decimal notation.


 
Responses 
200
Normal response.


401
Unauthorized response.


put/config/net/ipv4
Request samples 
application/json
{ }
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
Update /config/net/ipv4
SecurityApiKey 
Request 
Request Body schema: application/json
dhcp
boolean (configNetIpv4Dhcp) 
Whether or not to use DHCP
to automatically provision the IPv4 address.  If true, DHCP is
enabled. If false, the manually configured IPv4 settings are
used.


 
address
string (configNetIpv4Address) 
An IPv4 address in dotted decimal notation.


 
broadcast
string (configNetIpv4Broadcast) 
An IPv4 broadcast address in dotted decimal notation.


 
netmask
string (configNetIpv4Netmask) 
The address of the IPv4 gateway in dotted decimal notation.


 
network
string (configNetIpv4Network) 
The IPv4 network mask in dotted decimal notation.


 
gateway
string (configNetIpv4Gateway) 
The IPv4 network number in dotted decimal notation.


 
Responses 
200
Normal response.


401
Unauthorized response.


post/config/net/ipv4
Request samples 
application/json
{ }
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
Delete /config/net/ipv4
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/ipv4
Request samples 
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
➔ Next to /config/net/ipv4/dhcp