Documentation is now available for the Fall 2020 Update release!

Set network settings

This endpoint is used to specify the network settings on the gateway.

Leave Feedback

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

HeaderValue
AuthorizationToken {accessToken}
Content-typeapplication/json
Acceptapplication/json

Parameters

All fields are mandatory.

FieldData TypeDescription
hostnameStringHost name for the gateway.
domainnameStringDomain name for the gateway.
interfaceStringInterface for the gateway.
static_IPStringIf true, static IP is used instead of the (default) DHCP IP address.
If false, IP address, subnet, gatewayIP, and dnsArray parameters are not required.
ipaddrStringStatic IP (instead of DHCP).
Note: If static_IP is false, IP address, subnet, gatewayIP, and dnsArray parameters are not required.
subnetStringSubnet for the gateway.
Note: If static_IP is false, IP address, subnet, gatewayIP, and dnsArray parameters are not required.
gatewayStringDefault gateway IP address.
Note: If static_IP is false, IP address, subnet, gatewayIP, and dnsArray parameters are not required.
dnsArrayStringDNS 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."}