Endpoint
/v2/gateway

Gets the deployed gateway configuration details.

  • Supported query variable values
    • generalInfo
    • syslogInfo
    • ntpInfo
    • tzInfo
    • servicesInfo
    • routesInfo

Query Parameters
info
string

Required type of info

Responses

OK

generalInfo
object

generalInfo.applianceInformation
generalInfo.networkInformation
ntpInfo
object

ntpInfo.ntpStatus
ntpInfo.servers
ntpInfo.time
routesInfo
object

routesInfo.srouteGateway
routesInfo.srouteIP
routesInfo.srouteInterface
routesInfo.srouteMetric
routesInfo.srouteSubnet
servicesInfo
array

servicesInfo.name
servicesInfo.status
syslogInfoList
array

syslogInfoList.syslogInfo
tzInfo
object

tzInfo.regionanlTimezoneInformation
{
  "generalInfo": {
    "applianceInformation": {
      "applianceFirmwareVersion": "9.0.0",
      "firmwareBuildTag": "9.0.0-b208-202105191005",
      "model": "OGVMAU18",
      "registrationStatus": "Registered",
      "tunnelStatus": "Established"
    },
    "networkInformation": {
      "defaultGateway": "172.25.0.1",
      "defaultInterface": "ens160",
      "dhcp": "Enabled",
      "dnsEntries": "8.8.8.8,8.8.4.4",
      "domainName": "domain.com",
      "hostName": "localhost",
      "ipAddress": "172.25.252.149",
      "macAddress": "00:50:56:98:B5:8D",
      "subnetMask": "255.255.0.0"
    }
  },
  "ntpInfo": {
    "ntpStatus": "ON",
    "servers": "216.239.35.4",
    "time": "Wed May 19 22:35:09 AKDT 2021"
  },
  "servicesInfo": [
    {
      "name": "vprobe",
      "status": "Service VProbe is Active (Running..)"
    },
    {
      "name": "ntp",
      "status": "Service NTP is Active (Running..)"
    },
    {
      "name": "postgresql",
      "status": "Service Database is Active (Running..)"
    },
    {
      "name": "network",
      "status": "Service Network is Active (Running..)"
    },
    {
      "name": "squid",
      "status": "Service Squid Proxy is Active (Running..)"
    },
    {
      "name": "nginx",
      "status": "Service Nginx  is Active (Running..)"
    }
  ],
  "syslogInfoList": [
    {
      "syslogInfo": {
        "port": "514",
        "protocol": "udp",
        "receiver": "172.12.112.154",
        "selectors": "*.*"
      }
    },
    {
      "syslogInfo": {
        "port": "514",
        "protocol": "udp",
        "receiver": "172.25.112.154",
        "selectors": "*.*"
      }
    }
  ],
  "tzInfo": {
    "regionanlTimezoneInformation": {
      " (GMT) UTC": "UTC",
      " (GMT+12:00) NewZealand ": "Auckland",
      " (GMT+3:30) Iran ": "Iran",
      " (GMT+8:00) Russia": "Irkutsk",
      " (GMT-10:00) Hawaii": "Hawaii",
      " (GMT-11:00) Midway I.,Samoa ": "Samoa",
      " (GMT-4:00) Caracas, LaPaz  ": "Caracas",
      " (GMT-9:30) Marquesas Is.": "Marquesas",
      "(GMT) Casablanca, Monrovia": "Casablanca",
      "(GMT) UK ": "London",
      "(GMT+10:00) Brisbane, Guam": "Brisbane",
      "(GMT+10:00) Papua New Guinea": "Hobart",
      "(GMT+10:00) Russia": "Vladivostok",
      "(GMT+10:00) Sydney, Melbourne": "Sydney",
      "(GMT+10:00) Tasmania": "Tasmania",
      "(GMT+10:30) LordHowe I.": "Lord_Howe ",
      "(GMT+11:00) Solomon Is., Magadan  ": "Magadan",
      "(GMT+11:30) Norfolk I.": "Norfolk",
      "(GMT+12:00) Fiji, Kamchatka, Marshall Is": "Fiji",
      "(GMT+12:00) Russia  ": "Kamchatka",
      "(GMT+1:00) Europe ": "Amsterdam",
      "(GMT+2:00) Egypt, Finland, Romania, Greece": "Cairo",
      "(GMT+2:00) Israel ": "Israel",
      "(GMT+2:00) Jordan": "Jerusalem",
      "(GMT+3:00) Iraq, Syria": "Baghdad",
      "(GMT+3:00) Moscow": "Moscow",
      "(GMT+3:00) Turkey ": "Turkey",
      "(GMT+4:00) Armenia, Azerbaijan": "Muscat",
      "(GMT+4:30) Afghanistan": "Kabul",
      "(GMT+5:00) Pakistan": "Karachi",
      "(GMT+5:00) Russia": "Yekaterinburg",
      "(GMT+5:30) India, Kolkata": "Kolkata",
      "(GMT+6:00) Bangladesh ": "Dhaka",
      "(GMT+6:00) Russia": "Almaty",
      "(GMT+6:30) Burma": "Rangoon",
      "(GMT+7:00) Russia": "Krasnoyarsk",
      "(GMT+7:00) Thailand, Cambodia, Laos": "Bangkok",
      "(GMT+8:00) China, Mongolia, Indonesia, Philippines, Australia": "Hong_Kong",
      "(GMT+9:00) Russia ": "Yakutsk",
      "(GMT+9:00) Tokyo, Korea": "Tokyo",
      "(GMT+9:30) Adelaide ": "Adelaide",
      "(GMT+9:30) Darwin": "Darwin",
      "(GMT-12:00) Eniwetok, Kwajalein": "Kwajalein",
      "(GMT-1:00) Azores, CapeVerde Is.": "Azores",
      "(GMT-3:00) BuenosAires, Georgetown": "Buenos_Aires",
      "(GMT-3:30) Newfoundland": "Newfoundland",
      "(GMT-4:00) Atlantic Time (US \u0026 Canada)": "Atlantic",
      "(GMT-5:00) Bogota, Lima, Quito": "Bogota",
      "(GMT-5:00) EasternTime (US \u0026 Canada) ": "Eastern",
      "(GMT-5:00) Indiana (East)": "Indianapolis",
      "(GMT-6:00) Central Time(US \u0026 Canada)": "Central",
      "(GMT-6:00) MexicoCity, Tegucigalpa": "Mexico_City",
      "(GMT-7:00) Arizona": "Arizona",
      "(GMT-7:00) Mountain Time (US \u0026 Canada)": "Mountain",
      "(GMT-8:00) Pacific Time (US \u0026 Canada)": "Pacific",
      "(GMT-8:30) Pitcairn Is. ": "Pitcairn",
      "(GMT-9:00) Alaska  ": "Alaska"
    }
  }
}
{
  "generalInfo": {
    "applianceInformation": {
      "applianceFirmwareVersion": "9.0.0",
      "firmwareBuildTag": "9.0.0-b208-202105191005",
      "model": "OGVMAU18",
      "registrationStatus": "Not Registered",
      "tunnelStatus": "Not Established"
    },
    "networkInformation": {
      "defaultGateway": "172.25.0.1",
      "defaultInterface": "ens160",
      "dhcp": "Enabled",
      "dnsEntries": "8.8.8.8,8.8.4.4",
      "domainName": "domain.com",
      "hostName": "host",
      "ipAddress": "xxx.xx.xxx.xxx",
      "macAddress": "00:50:56:98:B5:8D",
      "subnetMask": "255.255.0.0"
    }
  }
}
{
  "ntpInfo": {
    "ntpStatus": "ON",
    "servers": "216.239.35.4,45.32.199.189",
    "time": "Thu May 20 05:09:42 UTC 2021"
  }
}
{
  "routesInfo": {
    "srouteGateway": "172.125.0.0",
    "srouteIP": "172.125.18.116",
    "srouteInterface": "enp0sX",
    "srouteMetric": "0",
    "srouteSubnet": "255.255.0.0"
  }
}
{
  "servicesInfo": [
    {
      "name": "vprobe",
      "status": "Service VProbe is inactive (not Running..)"
    },
    {
      "name": "ntp",
      "status": "Service NTP is Active (Running..)"
    },
    {
      "name": "postgresql",
      "status": "Service Database is inactive (not Running..)"
    },
    {
      "name": "network",
      "status": "Service Network is Active (Running..)"
    },
    {
      "name": "squid",
      "status": "Service Squid Proxy is inactive (not Running..)"
    },
    {
      "name": "nginx",
      "status": "Service Nginx  is Active (Running..)"
    }
  ]
}
{
  "syslogInfoList": [
    {
      "syslogInfo": {
        "port": "514",
        "protocol": "udp",
        "receiver": "172.25.0.1",
        "selectors": "*.*"
      }
    },
    {
      "syslogInfo": {
        "port": "514",
        "protocol": "udp",
        "receiver": "172.25.1.1",
        "selectors": "*.*"
      }
    }
  ]
}
{
  "tzInfo": {
    "regionanlTimezoneInformation": {
      "(GMT) UK ": "London",
      "(GMT+10:00) Russia": "Vladivostok",
      "(GMT+2:00) Israel ": "Israel",
      "(GMT+4:00) Armenia, Azerbaijan": "Muscat",
      "(GMT+5:00) Pakistan": "Karachi",
      "(GMT-7:00) Mountain Time (US \u0026 Canada)": "Mountain"
    }
  }
}