Endpoint
/v2/gateway/actions/{actionName}

Update deployed gateway configurations.

  • Supported values of config update actions:
    • registration
    • restartAllServices
    • monitService
    • syslogAdd
    • syslogDelete
    • syslogReset
    • ntpSync
    • networkSettings
    • dateTime
    • passwdChange
    • timeZone
    • externalProxy
    • staticRoutes
    • syslogUpdate
    • ntpUpdate

Path Parameters
actionName
string

Update gateway config

{
  "dateTime": {
    "date": "04-13-2021",
    "hour": "13",
    "min": "02",
    "sec": "02"
  }
}
{
  "externalProxy": {
    "connection": "proxy",
    "proxy_ip": "172.xx.xxx.xxx",
    "proxy_port": "3128",
    "proxy_pwd": "xxx",
    "proxy_usr": "xxx"
  }
}
{
  "monitService": {
    "action": "status",
    "service": "nginx"
  }
}
{
  "networkSettings": {
    "dhcp": "False",
    "dnsArray": "xxx.xxx.0.1",
    "domainname": "domain.com",
    "gateway": "xxx.xxx.0.1",
    "hostname": "localhost",
    "interface": "enp0s3",
    "ipaddr": "xxx.xxx.x.xxx",
    "subnet": "255.255.255.0"
  }
}
{
  "ntpUpdate": {
    "ntpServers": [
      "216.239.35.4",
      "45.32.199.189"
    ]
  }
}
{
  "ntpUpdate": {
    "ntpServers": [
      "216.239.35.4",
      "45.32.199.189"
    ]
  }
}
{
  "passwdChange": {
    "newpasswd": "Pass@12345",
    "oldpasswd": "Pass@1234",
    "username": "admin"
  }
}
{
  "registration": {
    "activation_token": "xyz123",
    "server": "\u003cpodName\u003e"
  }
}
{
  "staticRoutes": {
    "srouteGateway": "192.168.0.1",
    "srouteIP": "10.10.5.0",
    "srouteInterface": "enp0s3",
    "srouteMetric": "0",
    "srouteSubnet": "255.255.255.0"
  }
}
{
  "syslogInfo": {
    "port": "514",
    "protocol": "UDP",
    "receiver": "192.168.0.116",
    "selectors": "*.*"
  }
}
{
  "syslogInfo": {
    "port": "514",
    "protocol": "UDP",
    "receiver": "192.168.0.116",
    "selectors": "*.*"
  }
}
{
  "syslogInfo": {
    "port": "514",
    "protocol": "UDP",
    "receiver": "192.168.0.116",
    "selectors": "*.*"
  }
}
{
  "timeZone": {
    "tzs": "Alaska"
  }
}

Responses

OK

success
string

{
  "success": "Successfully updated time and date"
}
{
  "success": "Successfully updated proxy settings."
}
{
  "success": "Service Nginx  is Active (Running..)"
}
{
  "success": "Successfully updated network configuration."
}
{
  "success": "Successfully synchronized date using NTP."
}
{
  "success": "Successfully updated NTP details"
}
{
  "success": "admin password has been changed successfully."
}
{
  "success": "Appliance registered successfully"
}
{
  "success": "Successfully restarted all services"
}
{
  "success": "Successfully added the static route configuration."
}
{
  "success": "Added syslog receiver successfully"
}
{
  "success": "removed syslog receiver successfully"
}
{
  "success": "Syslog settings has been reset successfully"
}
{
  "success": "Updated syslog receiver successfully"
}
{
  "success": "Alaska Time Zone Successfully updated"
}