Set network settings

Important

An access token must be generated to use this API.

URL

POST https://{gatewayIp}:5480/api/v2/networksettings

Sample URL

https://192.168.xxx.xxx:5480/api/v2/networksettings

Sample cURL

curl -k -X GET https://{gateway_IP_address}:5480/api/v2/networksettings 
-H 'Accept: application/json' -H 'Authorization: Token <TOKEN>' 
-H 'Content-Type: application/json' -k -d 
{ 
    "hostname": "<hostname>", 
    "domainname": "<domainname>", 
    "interface": "<interface>", 
    "static_IP": "<True/False>", 
    "ipaddr": "<ipaddr>", 
    "subnet": "<subnet>", 
    "gateway": "<gatewayIP>", 
    "dnsArray": "<xxx,xxx>"
 }

Header format

Header	Value
Authorization	Token {accessToken}
Content-type	application/json
Accept	application/json

Parameters

All fields are mandatory.

Field	Data Type	Description
hostname	String	Host name for the gateway.
domainname	String	Domain name for the gateway.
interface	String	Interface for the gateway.
static_IP	String	If true, static IP is used instead of the (default) DHCP IP address. If false, IP address, subnet, gatewayIP, and dnsArray parameters are not required.
ipaddr	String	Static IP (instead of DHCP). Note: If `static_IP` is false, IP address, subnet, gatewayIP, and dnsArray parameters are not required.
subnet	String	Subnet for the gateway. Note: If `static_IP` is false, IP address, subnet, gatewayIP, and dnsArray parameters are not required.
gateway	String	Default gateway IP address. Note: If `static_IP` is false, IP address, subnet, gatewayIP, and dnsArray parameters are not required.
dnsArray	String	DNS entries for the gateway. Note: If `static_IP` is false, IP address, subnet, gatewayIP, and dnsArray parameters are not required.

Status code

200 OK

Sample request

{
    "hostname": "<hostname>", 
    "domainname": "<domainname>”,
    "interface": "<interface>", 
    "static_IP": "<True/False>", 
    "ipaddr": "<IP Address>", 
    "subnet": "<subnet>",
    "gateway": "<Default Gateway>”, 
    "dnsArray": "<xxx,xxx>”
}

Sample response

{"Success":"Successfully updated network configuration."}