Overview

The documentation pages in this section describe the RESTful APIs included with NetProfiler products. It is assumed that the reader has practical knowledge of RESTful APIs, so the documentation does not go into detail about what REST is and how to use it. Instead the documentation focuses on what data can be accessed, how to configure and clear it.

The following operations can be performed via the API:

Display System Configuration General settings
Configure System Configuration General settings

Details about REST resources can be found in the Resources section. This overview continues with how to run these API's.

Authentication

All REST requests must be authenticated. The Authentication section of the Common API describes which authentication methods are presently supported.

Resources

Settings: Display Settings

Displays system configuration settings.

GET https://{device}/api/mgmt.system_config/1.0/general_settings

Authorization

This request requires authorization.

Response Body

On success, the server returns a response body with the following structure:

JSON

{
  "network": {
    "primary": {
      "dhcp": boolean,
      "ip4_addr": string,
      "ip4_mask": number,
      "ip4_gw": string,
      "ip6_addr": string,
      "ip6_prefix_len": number,
      "ip6_gw": string
    },
    "aux": {
      "dhcp": boolean,
      "ip4_addr": string,
      "ip4_mask": number,
      "ip6_addr": string,
      "ip6_prefix_len": number
    },
    "hostname": string,
    "routes": [
      {
        "dest": string,
        "prefix": number,
        "next-hop": string,
        "is_user_static": boolean
      }
    ]
  },
  "services": {
    "name_resolution": {
      "search": [
        string
      ],
      "dns_servers": [
        string
      ],
      "dns_enabled": boolean,
      "ipv4_precedence": boolean,
      "enable_dns_host_resolution": boolean,
      "report_host_limit": number,
      "dns_request_limit": number,
      "enable_dhcp_host_resolution": boolean
    },
    "device_resolution": {
      "enable_snmp": boolean,
      "enable_dns": boolean,
      "device_dns_refresh": {
        "interval": string,
        "periods": number
      },
      "snmp_prefered_to_dns": boolean
    },
    "time": {
      "timezone": string,
      "ntp": [
        {
          "server": string,
          "type": number,
          "key": string,
          "hash": string,
          "hex": boolean,
          "idx": number
        }
      ]
    }
  },
  "system_component_config": {
    "expansion_modules": [
      {
        "hostname": string,
        "device": string,
        "desc": string,
        "state": string,
        "sn": string,
        "config_password": string,
        "ipaddr": [
          string
        ]
      }
    ],
    "inside_addrs": [
      string
    ],
    "use_vxlan": boolean,
    "ui_mode": number
  },
  "base_integrations": {
    "snmp": {
      "location": string,
      "description": string,
      "contact": string,
      "community": string,
      "version": string,
      "max_trap_list_len": number,
      "v3_settings": {
        "username": string,
        "security_level": string,
        "auth_passphrase": string,
        "auth_proto": string,
        "priv_passphrase": string,
        "priv_proto": string
      }
    },
    "smtp": {
      "server": string,
      "port": number,
      "from_addr": string,
      "enable_tls": boolean,
      "enable_auth": boolean,
      "username": string,
      "password": string
    }
  }
}

Example:
{
  "network": {
    "primary": {
      "dhcp": false, 
      "ip4_addr": "192.168.55.90", 
      "ip4_mask": 24, 
      "ip4_gw": "192.168.55.1", 
      "ip6_addr": "", 
      "ip6_prefix_len": 0, 
      "ip6_gw": ""
    }, 
    "aux": {
      "dhcp": true, 
      "ip4_addr": "", 
      "ip4_mask": 0, 
      "ip6_addr": "", 
      "ip6_prefix_len": 0
    }, 
    "hostname": "np01.localnet", 
    "routes": [
      {
        "dest": "0.0.0.0", 
        "prefix": 0, 
        "next-hop": "192.168.55.1", 
        "is_user_static": false
      }
    ]
  }, 
  "services": {
    "name_resolution": {
      "search": [
        "localnet"
      ], 
      "dns_servers": [
        "192.168.55.5"
      ], 
      "dns_enabled": true, 
      "ipv4_precedence": true, 
      "enable_dns_host_resolution": true, 
      "report_host_limit": 500, 
      "dns_request_limit": 500, 
      "enable_dhcp_host_resolution": true
    }, 
    "device_resolution": {
      "enable_snmp": true, 
      "enable_dns": true, 
      "device_dns_refresh": {
        "interval": "week", 
        "periods": 1
      }, 
      "snmp_prefered_to_dns": false
    }, 
    "time": {
      "timezone": "America/New_York", 
      "ntp": [
        {
          "server": "pool.ntp.org", 
          "type": 1, 
          "key": null, 
          "hash": null, 
          "hex": null, 
          "idx": null
        }
      ]
    }
  }, 
  "system_component_config": {
    "expansion_modules": [
      {
        "hostname": "np01-Blade0.localnet", 
        "device": "stackable.profiler.eventmanager", 
        "desc": "Management Module", 
        "state": "OK", 
        "sn": "ZE4KG0409BB59", 
        "config_password": "", 
        "ipaddr": [
          "192.168.55.90/24"
        ]
      }, 
      {
        "hostname": "np01-Blade1.localnet", 
        "device": "stackable.profiler.database", 
        "desc": "Database Module", 
        "state": "OK", 
        "sn": "ZE4XH0409BB5A", 
        "config_password": "", 
        "ipaddr": [
          "192.168.55.63/24"
        ]
      }, 
      {
        "hostname": "np01-Blade2.localnet", 
        "device": "stackable.profiler.analyzer.0", 
        "desc": "Analysis Module", 
        "state": "OK", 
        "sn": "ZE5XH0409BB5A", 
        "config_password": "", 
        "ipaddr": [
          "192.168.55.57/24"
        ]
      }
    ], 
    "inside_addrs": [
      "10.0.0.0/8", 
      "172.16.0.0/12", 
      "192.168.0.0/16", 
      "fc00::/7"
    ], 
    "use_vxlan": false, 
    "ui_mode": 1
  }, 
  "base_integrations": {
    "snmp": {
      "location": "", 
      "description": "", 
      "contact": "", 
      "community": "mazu", 
      "version": "SNMP_V1", 
      "max_trap_list_len": 10, 
      "v3_settings": {
        "username": "", 
        "security_level": "SNMP_SEC_NOAUTH", 
        "auth_passphrase": "", 
        "auth_proto": "SNMP_AUTH_NONE", 
        "priv_passphrase": "", 
        "priv_proto": "SNMP_PRIV_NONE"
      }
    }, 
    "smtp": {
      "server": "", 
      "port": 0, 
      "from_addr": "", 
      "enable_tls": false, 
      "enable_auth": false, 
      "username": "", 
      "password": ""
    }
  }
}

{
  "network": {
    "primary": {
      "dhcp": boolean,
      "ip4_addr": string,
      "ip4_mask": number,
      "ip4_gw": string,
      "ip6_addr": string,
      "ip6_prefix_len": number,
      "ip6_gw": string
    },
    "aux": {
      "dhcp": boolean,
      "ip4_addr": string,
      "ip4_mask": number,
      "ip6_addr": string,
      "ip6_prefix_len": number
    },
    "hostname": string,
    "routes": [
      {
        "dest": string,
        "prefix": number,
        "next-hop": string,
        "is_user_static": boolean
      }
    ]
  },
  "services": {
    "name_resolution": {
      "search": [
        string
      ],
      "dns_servers": [
        string
      ],
      "dns_enabled": boolean,
      "ipv4_precedence": boolean,
      "enable_dns_host_resolution": boolean,
      "report_host_limit": number,
      "dns_request_limit": number,
      "enable_dhcp_host_resolution": boolean
    },
    "device_resolution": {
      "enable_snmp": boolean,
      "enable_dns": boolean,
      "device_dns_refresh": {
        "interval": string,
        "periods": number
      },
      "snmp_prefered_to_dns": boolean
    },
    "time": {
      "timezone": string,
      "ntp": [
        {
          "server": string,
          "type": number,
          "key": string,
          "hash": string,
          "hex": boolean,
          "idx": number
        }
      ]
    }
  },
  "system_component_config": {
    "expansion_modules": [
      {
        "hostname": string,
        "device": string,
        "desc": string,
        "state": string,
        "sn": string,
        "config_password": string,
        "ipaddr": [
          string
        ]
      }
    ],
    "inside_addrs": [
      string
    ],
    "use_vxlan": boolean,
    "ui_mode": number
  },
  "base_integrations": {
    "snmp": {
      "location": string,
      "description": string,
      "contact": string,
      "community": string,
      "version": string,
      "max_trap_list_len": number,
      "v3_settings": {
        "username": string,
        "security_level": string,
        "auth_passphrase": string,
        "auth_proto": string,
        "priv_passphrase": string,
        "priv_proto": string
      }
    },
    "smtp": {
      "server": string,
      "port": number,
      "from_addr": string,
      "enable_tls": boolean,
      "enable_auth": boolean,
      "username": string,
      "password": string
    }
  }
}

Example:
{
  "network": {
    "primary": {
      "dhcp": false, 
      "ip4_addr": "192.168.55.90", 
      "ip4_mask": 24, 
      "ip4_gw": "192.168.55.1", 
      "ip6_addr": "", 
      "ip6_prefix_len": 0, 
      "ip6_gw": ""
    }, 
    "aux": {
      "dhcp": true, 
      "ip4_addr": "", 
      "ip4_mask": 0, 
      "ip6_addr": "", 
      "ip6_prefix_len": 0
    }, 
    "hostname": "np01.localnet", 
    "routes": [
      {
        "dest": "0.0.0.0", 
        "prefix": 0, 
        "next-hop": "192.168.55.1", 
        "is_user_static": false
      }
    ]
  }, 
  "services": {
    "name_resolution": {
      "search": [
        "localnet"
      ], 
      "dns_servers": [
        "192.168.55.5"
      ], 
      "dns_enabled": true, 
      "ipv4_precedence": true, 
      "enable_dns_host_resolution": true, 
      "report_host_limit": 500, 
      "dns_request_limit": 500, 
      "enable_dhcp_host_resolution": true
    }, 
    "device_resolution": {
      "enable_snmp": true, 
      "enable_dns": true, 
      "device_dns_refresh": {
        "interval": "week", 
        "periods": 1
      }, 
      "snmp_prefered_to_dns": false
    }, 
    "time": {
      "timezone": "America/New_York", 
      "ntp": [
        {
          "server": "pool.ntp.org", 
          "type": 1, 
          "key": null, 
          "hash": null, 
          "hex": null, 
          "idx": null
        }
      ]
    }
  }, 
  "system_component_config": {
    "expansion_modules": [
      {
        "hostname": "np01-Blade0.localnet", 
        "device": "stackable.profiler.eventmanager", 
        "desc": "Management Module", 
        "state": "OK", 
        "sn": "ZE4KG0409BB59", 
        "config_password": "", 
        "ipaddr": [
          "192.168.55.90/24"
        ]
      }, 
      {
        "hostname": "np01-Blade1.localnet", 
        "device": "stackable.profiler.database", 
        "desc": "Database Module", 
        "state": "OK", 
        "sn": "ZE4XH0409BB5A", 
        "config_password": "", 
        "ipaddr": [
          "192.168.55.63/24"
        ]
      }, 
      {
        "hostname": "np01-Blade2.localnet", 
        "device": "stackable.profiler.analyzer.0", 
        "desc": "Analysis Module", 
        "state": "OK", 
        "sn": "ZE5XH0409BB5A", 
        "config_password": "", 
        "ipaddr": [
          "192.168.55.57/24"
        ]
      }
    ], 
    "inside_addrs": [
      "10.0.0.0/8", 
      "172.16.0.0/12", 
      "192.168.0.0/16", 
      "fc00::/7"
    ], 
    "use_vxlan": false, 
    "ui_mode": 1
  }, 
  "base_integrations": {
    "snmp": {
      "location": "", 
      "description": "", 
      "contact": "", 
      "community": "mazu", 
      "version": "SNMP_V1", 
      "max_trap_list_len": 10, 
      "v3_settings": {
        "username": "", 
        "security_level": "SNMP_SEC_NOAUTH", 
        "auth_passphrase": "", 
        "auth_proto": "SNMP_AUTH_NONE", 
        "priv_passphrase": "", 
        "priv_proto": "SNMP_PRIV_NONE"
      }
    }, 
    "smtp": {
      "server": "", 
      "port": 0, 
      "from_addr": "", 
      "enable_tls": false, 
      "enable_auth": false, 
      "username": "", 
      "password": ""
    }
  }
}

Property Name	Type	Description	Notes
GeneralSettings	<object>	Current set of system configuration settings.
GeneralSettings.network	<object>	Base Unit Network Configuration.	Optional
GeneralSettings.network.primary	<object>	Primary Interface Network Configuration.
GeneralSettings.network.primary.dhcp	<boolean>	Boolean: Is DHCP active on this interface.
GeneralSettings.network.primary.ip4_addr	<string>	IPv4 address for this interface. May be empty string.
GeneralSettings.network.primary.ip4_mask	<number>	IPv4 Subnet Mask for this interface (0-32). May be 0.
GeneralSettings.network.primary.ip4_gw	<string>	IPv4 gateway address for this interface. May be empty string.
GeneralSettings.network.primary.ip6_addr	<string>	IPv6 address for this interface. May be empty string.
GeneralSettings.network.primary. ip6_prefix_len	<number>	IPv6 prefix length for this interface (0-128). May be 0.
GeneralSettings.network.primary.ip6_gw	<string>	IPv6 gateway address for this interface. May be empty string.
GeneralSettings.network.aux	<object>	Aux Interface Network Configuration.
GeneralSettings.network.aux.dhcp	<boolean>	Boolean: Is DHCP active on this interface.
GeneralSettings.network.aux.ip4_addr	<string>	IPv4 address for this interface. May be empty string.
GeneralSettings.network.aux.ip4_mask	<number>	IPv4 Subnet Mask for this interface (0-32). May be 0.
GeneralSettings.network.aux.ip6_addr	<string>	IPv6 address for this interface. May be empty string.
GeneralSettings.network.aux. ip6_prefix_len	<number>	IPv6 prefix length for this interface (0-128). May be 0.
GeneralSettings.network.hostname	<string>	Base hostname for this system.
GeneralSettings.network.routes	<array of <object>>	System Routes.
GeneralSettings.network.routes [SystemRoute]	<object>	Route
GeneralSettings.network.routes [SystemRoute].dest	<string>	Destination IP address.
GeneralSettings.network.routes [SystemRoute].prefix	<number>	Destination Prefix Len (0-128).
GeneralSettings.network.routes [SystemRoute].next-hop	<string>	Next Hop Router IP address.
GeneralSettings.network.routes [SystemRoute].is_user_static	<boolean>	Boolean: Was this system added by the user (true) or created by the system (false).
GeneralSettings.services	<object>	Core System Services.	Optional
GeneralSettings.services.name_resolution	<object>	Hostname Resolution Service Configuration.	Optional
GeneralSettings.services.name_resolution. search	<array of <string>>	Search Domain List.
GeneralSettings.services.name_resolution. search[item]	<string>	Search Domain.	Optional
GeneralSettings.services.name_resolution. dns_servers	<array of <string>>	DNS Server List.
GeneralSettings.services.name_resolution. dns_servers[item]	<string>	DNS Server.	Optional
GeneralSettings.services.name_resolution. dns_enabled	<boolean>	Boolean: Is DNS Resolution Enabled.
GeneralSettings.services.name_resolution. ipv4_precedence	<boolean>	Boolean: Do IPv4 answers take precedence.
GeneralSettings.services.name_resolution. enable_dns_host_resolution	<boolean>	Boolean: DNS Host Resolution will be used in Reports.
GeneralSettings.services.name_resolution. report_host_limit	<number>	Total number of hosts to be resolved for any single report.
GeneralSettings.services.name_resolution. dns_request_limit	<number>	Total number of hosts to be requested for any single DNS query.
GeneralSettings.services.name_resolution. enable_dhcp_host_resolution	<boolean>	Boolean: DHCP data will be used to resolve hosts in reports if available.
GeneralSettings.services. device_resolution	<object>	Device Resolution Service Configuration.	Optional
GeneralSettings.services. device_resolution.enable_snmp	<boolean>	Boolean: SNMP will be used for device and interface resolution (if available).
GeneralSettings.services. device_resolution.enable_dns	<boolean>	Boolean: DNS will be used for device resolution (if available).
GeneralSettings.services. device_resolution.device_dns_refresh	<object>	Hostname Resolution Service Configuration.
GeneralSettings.services. device_resolution.device_dns_refresh. interval	<string>	Refresh period interval ('day', 'week', 'month'.
GeneralSettings.services. device_resolution.device_dns_refresh. periods	<number>	Number of intervals to use. Must be a positive integer.
GeneralSettings.services. device_resolution.snmp_prefered_to_dns	<boolean>	Boolean: SNMP data will be preferred to DNS.
GeneralSettings.services.time	<object>	Time Service Configuration.	Optional
GeneralSettings.services.time.timezone	<string>	The name of the timezone used by this system.
GeneralSettings.services.time.ntp	<array of <object>>	Time Service Configuration.	Optional
GeneralSettings.services.time.ntp [TimeSourceConfig]	<object>	Time Source Config
GeneralSettings.services.time.ntp [TimeSourceConfig].server	<string>	NTP Server name or IP address or name in case of pool type.
GeneralSettings.services.time.ntp [TimeSourceConfig].type	<number>	NTP time source type. (0 - server, 1 - pool, 2 - peer)
GeneralSettings.services.time.ntp [TimeSourceConfig].key	<string>	NTP key to use with this server. Is a string but may be null.
GeneralSettings.services.time.ntp [TimeSourceConfig].hash	<string>	hashing algorythm used with the 'key'. One of 'MD5', 'SHA1', 'SHA256', 'SHA384', or 'SHA512'
GeneralSettings.services.time.ntp [TimeSourceConfig].hex	<boolean>	Boolean: This key is in hex format. false denotes ascii format.
GeneralSettings.services.time.ntp [TimeSourceConfig].idx	<number>	Index of this key on the time server.
GeneralSettings.system_component_config	<object>	Core System Component Configuration.	Optional
GeneralSettings.system_component_config. expansion_modules	<array of <object>>	System Expansion Modules.
GeneralSettings.system_component_config. expansion_modules[item]	<object>	System Module.	Optional
GeneralSettings.system_component_config. expansion_modules[item].hostname	<string>	Hostname for this module.
GeneralSettings.system_component_config. expansion_modules[item].device	<string>	Device ID for this module.
GeneralSettings.system_component_config. expansion_modules[item].desc	<string>	Device description for this module.
GeneralSettings.system_component_config. expansion_modules[item].state	<string>	Current System State for this module.
GeneralSettings.system_component_config. expansion_modules[item].sn	<string>	System Serial Number for this module.
GeneralSettings.system_component_config. expansion_modules[item]. config_password	<string>	Configuration Password to use when adding a new module. Empty for existing moduels.
GeneralSettings.system_component_config. expansion_modules[item].ipaddr	<array of <string>>	Module IP addresses.
GeneralSettings.system_component_config. expansion_modules[item].ipaddr[item]	<string>	Module IP address.	Optional
GeneralSettings.system_component_config. inside_addrs	<array of <string>>	List of CIDR blocks internal to this NetProfiler's Analysis.
GeneralSettings.system_component_config. inside_addrs[item]	<string>	CIDR Block in x.x.x.x/bits notation (eg. '10.0.0.0/8').	Optional
GeneralSettings.system_component_config. use_vxlan	<boolean>	Boolean: This system will use vxlan (if available).
GeneralSettings.system_component_config. ui_mode	<number>	UI Mode: 0 - UI not active. Display Setup page, 1 - UI active. Display Home page.
GeneralSettings.base_integrations	<object>	Base System Integration Configuration.	Optional
GeneralSettings.base_integrations.snmp	<object>	System SNMP settings.	Optional
GeneralSettings.base_integrations.snmp. location	<string>	System SNMP Location.
GeneralSettings.base_integrations.snmp. description	<string>	System SNMP Description.
GeneralSettings.base_integrations.snmp. contact	<string>	System SNMP Contact.
GeneralSettings.base_integrations.snmp. community	<string>	System SNMP Community String (if version is 1 or 2c).
GeneralSettings.base_integrations.snmp. version	<string>	System SNMP Version (1, 2c, or 3).
GeneralSettings.base_integrations.snmp. max_trap_list_len	<number>	System will send up to this many traps at once.
GeneralSettings.base_integrations.snmp. v3_settings	<object>	System SNMP Version 3 settings. Ignored if 'version' is not '3'.	Optional
GeneralSettings.base_integrations.snmp. v3_settings.username	<string>	System SNMP Version 3 Username.
GeneralSettings.base_integrations.snmp. v3_settings.security_level	<string>	System SNMP Version 3 Security Level ('SNMP_SEC_NOAUTH', 'SNMP_SEC_AUTH', 'SNMP_SEC_PRIV', or '').
GeneralSettings.base_integrations.snmp. v3_settings.auth_passphrase	<string>	System SNMP Version 3 Authentication Passphrase. Ignored if security_level is 'SNMP_SEC_NOAUTH'.
GeneralSettings.base_integrations.snmp. v3_settings.auth_proto	<string>	System SNMP Version 3 Authentication Protocol ('SNMP_AUTH_MD5', 'SNMP_AUTH_SHA', 'SNMP_AUTH_SHA224', 'SNMP_AUTH_SHA256', 'SNMP_AUTH_SHA384', 'SNMP_AUTH_SHA512', 'SNMP_AUTH_NONE', or '')
GeneralSettings.base_integrations.snmp. v3_settings.priv_passphrase	<string>	System SNMP Version 3 Authentication Passphrase. Ignored if security_level is not 'SNMP_SEC_PRIV'.
GeneralSettings.base_integrations.snmp. v3_settings.priv_proto	<string>	System SNMP Version 3 Authentication Protocol ('SNMP_PRIV_DES', 'SNMP_PRIV_AES', 'SNMP_PRIV_AES192', 'SNMP_PRIV_AES256', 'SNMP_PRIV_AES192C', 'SNMP_PRIV_AES256C', 'SNMP_PRIV_NONE', or '')
GeneralSettings.base_integrations.smtp	<object>	System email configuration.	Optional
GeneralSettings.base_integrations.smtp. server	<string>	System email relay host.
GeneralSettings.base_integrations.smtp. port	<number>	Port that the 'server' listens on (usually 25).
GeneralSettings.base_integrations.smtp. from_addr	<string>	Emails sent by this system will come from this address.
GeneralSettings.base_integrations.smtp. enable_tls	<boolean>	Boolean: Use TLS with this server.
GeneralSettings.base_integrations.smtp. enable_auth	<boolean>	Boolean: Use a username and password with this server.
GeneralSettings.base_integrations.smtp. username	<string>	If 'enable_auth' is true then use this username.
GeneralSettings.base_integrations.smtp. password	<string>	If 'enable_auth' is true then use this password.

Settings: Configure Settings

Configure system configuration settings.

POST https://{device}/api/mgmt.system_config/1.0/general_settings

Authorization

This request requires authorization.

Request Body

Provide a request body with the following structure:

JSON

{
  "network": {
    "primary": {
      "dhcp": boolean,
      "ip4_addr": string,
      "ip4_mask": number,
      "ip4_gw": string,
      "ip6_addr": string,
      "ip6_prefix_len": number,
      "ip6_gw": string
    },
    "aux": {
      "dhcp": boolean,
      "ip4_addr": string,
      "ip4_mask": number,
      "ip6_addr": string,
      "ip6_prefix_len": number
    },
    "hostname": string,
    "routes": [
      {
        "dest": string,
        "prefix": number,
        "next-hop": string,
        "is_user_static": boolean
      }
    ]
  },
  "services": {
    "name_resolution": {
      "search": [
        string
      ],
      "dns_servers": [
        string
      ],
      "dns_enabled": boolean,
      "ipv4_precedence": boolean,
      "enable_dns_host_resolution": boolean,
      "report_host_limit": number,
      "dns_request_limit": number,
      "enable_dhcp_host_resolution": boolean
    },
    "device_resolution": {
      "enable_snmp": boolean,
      "enable_dns": boolean,
      "device_dns_refresh": {
        "interval": string,
        "periods": number
      },
      "snmp_prefered_to_dns": boolean
    },
    "time": {
      "timezone": string,
      "ntp": [
        {
          "server": string,
          "type": number,
          "key": string,
          "hash": string,
          "hex": boolean,
          "idx": number
        }
      ]
    }
  },
  "system_component_config": {
    "expansion_modules": [
      {
        "hostname": string,
        "device": string,
        "desc": string,
        "state": string,
        "sn": string,
        "config_password": string,
        "ipaddr": [
          string
        ]
      }
    ],
    "inside_addrs": [
      string
    ],
    "use_vxlan": boolean,
    "ui_mode": number
  },
  "base_integrations": {
    "snmp": {
      "location": string,
      "description": string,
      "contact": string,
      "community": string,
      "version": string,
      "max_trap_list_len": number,
      "v3_settings": {
        "username": string,
        "security_level": string,
        "auth_passphrase": string,
        "auth_proto": string,
        "priv_passphrase": string,
        "priv_proto": string
      }
    },
    "smtp": {
      "server": string,
      "port": number,
      "from_addr": string,
      "enable_tls": boolean,
      "enable_auth": boolean,
      "username": string,
      "password": string
    }
  }
}

{
  "network": {
    "primary": {
      "dhcp": boolean,
      "ip4_addr": string,
      "ip4_mask": number,
      "ip4_gw": string,
      "ip6_addr": string,
      "ip6_prefix_len": number,
      "ip6_gw": string
    },
    "aux": {
      "dhcp": boolean,
      "ip4_addr": string,
      "ip4_mask": number,
      "ip6_addr": string,
      "ip6_prefix_len": number
    },
    "hostname": string,
    "routes": [
      {
        "dest": string,
        "prefix": number,
        "next-hop": string,
        "is_user_static": boolean
      }
    ]
  },
  "services": {
    "name_resolution": {
      "search": [
        string
      ],
      "dns_servers": [
        string
      ],
      "dns_enabled": boolean,
      "ipv4_precedence": boolean,
      "enable_dns_host_resolution": boolean,
      "report_host_limit": number,
      "dns_request_limit": number,
      "enable_dhcp_host_resolution": boolean
    },
    "device_resolution": {
      "enable_snmp": boolean,
      "enable_dns": boolean,
      "device_dns_refresh": {
        "interval": string,
        "periods": number
      },
      "snmp_prefered_to_dns": boolean
    },
    "time": {
      "timezone": string,
      "ntp": [
        {
          "server": string,
          "type": number,
          "key": string,
          "hash": string,
          "hex": boolean,
          "idx": number
        }
      ]
    }
  },
  "system_component_config": {
    "expansion_modules": [
      {
        "hostname": string,
        "device": string,
        "desc": string,
        "state": string,
        "sn": string,
        "config_password": string,
        "ipaddr": [
          string
        ]
      }
    ],
    "inside_addrs": [
      string
    ],
    "use_vxlan": boolean,
    "ui_mode": number
  },
  "base_integrations": {
    "snmp": {
      "location": string,
      "description": string,
      "contact": string,
      "community": string,
      "version": string,
      "max_trap_list_len": number,
      "v3_settings": {
        "username": string,
        "security_level": string,
        "auth_passphrase": string,
        "auth_proto": string,
        "priv_passphrase": string,
        "priv_proto": string
      }
    },
    "smtp": {
      "server": string,
      "port": number,
      "from_addr": string,
      "enable_tls": boolean,
      "enable_auth": boolean,
      "username": string,
      "password": string
    }
  }
}

Property Name	Type	Description	Notes
NewGeneralSettings	<object>	An updated set of system configuration settings.
NewGeneralSettings.network	<object>	Base Unit Network Configuration.	Optional
NewGeneralSettings.network.primary	<object>	Primary Interface Network Configuration.
NewGeneralSettings.network.primary.dhcp	<boolean>	Boolean: Is DHCP active on this interface.
NewGeneralSettings.network.primary. ip4_addr	<string>	IPv4 address for this interface. May be empty string.
NewGeneralSettings.network.primary. ip4_mask	<number>	IPv4 Subnet Mask for this interface (0-32). May be 0.
NewGeneralSettings.network.primary. ip4_gw	<string>	IPv4 gateway address for this interface. May be empty string.
NewGeneralSettings.network.primary. ip6_addr	<string>	IPv6 address for this interface. May be empty string.
NewGeneralSettings.network.primary. ip6_prefix_len	<number>	IPv6 prefix length for this interface (0-128). May be 0.
NewGeneralSettings.network.primary. ip6_gw	<string>	IPv6 gateway address for this interface. May be empty string.
NewGeneralSettings.network.aux	<object>	Aux Interface Network Configuration.
NewGeneralSettings.network.aux.dhcp	<boolean>	Boolean: Is DHCP active on this interface.
NewGeneralSettings.network.aux.ip4_addr	<string>	IPv4 address for this interface. May be empty string.
NewGeneralSettings.network.aux.ip4_mask	<number>	IPv4 Subnet Mask for this interface (0-32). May be 0.
NewGeneralSettings.network.aux.ip6_addr	<string>	IPv6 address for this interface. May be empty string.
NewGeneralSettings.network.aux. ip6_prefix_len	<number>	IPv6 prefix length for this interface (0-128). May be 0.
NewGeneralSettings.network.hostname	<string>	Base hostname for this system.
NewGeneralSettings.network.routes	<array of <object>>	System Routes.
NewGeneralSettings.network.routes [NewSystemRoute]	<object>	Route
NewGeneralSettings.network.routes [NewSystemRoute].dest	<string>	Destination IP address.
NewGeneralSettings.network.routes [NewSystemRoute].prefix	<number>	Destination Prefix Len (0-128).
NewGeneralSettings.network.routes [NewSystemRoute].next-hop	<string>	Next Hop Router IP address.
NewGeneralSettings.network.routes [NewSystemRoute].is_user_static	<boolean>	Boolean: Was this system added by the user (true) or created by the system (false).
NewGeneralSettings.services	<object>	Core System Services.	Optional
NewGeneralSettings.services. name_resolution	<object>	Hostname Resolution Service Configuration.	Optional
NewGeneralSettings.services. name_resolution.search	<array of <string>>	Search Domain List.
NewGeneralSettings.services. name_resolution.search[item]	<string>	Search Domain.	Optional
NewGeneralSettings.services. name_resolution.dns_servers	<array of <string>>	DNS Server List.
NewGeneralSettings.services. name_resolution.dns_servers[item]	<string>	DNS Server.	Optional
NewGeneralSettings.services. name_resolution.dns_enabled	<boolean>	Boolean: Is DNS Resolution Enabled.
NewGeneralSettings.services. name_resolution.ipv4_precedence	<boolean>	Boolean: Do IPv4 answers take precedence.
NewGeneralSettings.services. name_resolution. enable_dns_host_resolution	<boolean>	Boolean: DNS Host Resolution will be used in Reports.
NewGeneralSettings.services. name_resolution.report_host_limit	<number>	Total number of hosts to be resolved for any single report.
NewGeneralSettings.services. name_resolution.dns_request_limit	<number>	Total number of hosts to be requested for any single DNS query.
NewGeneralSettings.services. name_resolution. enable_dhcp_host_resolution	<boolean>	Boolean: DHCP data will be used to resolve hosts in reports if available.
NewGeneralSettings.services. device_resolution	<object>	Device Resolution Service Configuration.	Optional
NewGeneralSettings.services. device_resolution.enable_snmp	<boolean>	Boolean: SNMP will be used for device and interface resolution (if available).
NewGeneralSettings.services. device_resolution.enable_dns	<boolean>	Boolean: DNS will be used for device resolution (if available).
NewGeneralSettings.services. device_resolution.device_dns_refresh	<object>	Hostname Resolution Service Configuration.
NewGeneralSettings.services. device_resolution.device_dns_refresh. interval	<string>	Refresh period interval ('day', 'week', 'month'.
NewGeneralSettings.services. device_resolution.device_dns_refresh. periods	<number>	Number of intervals to use. Must be a positive integer.
NewGeneralSettings.services. device_resolution.snmp_prefered_to_dns	<boolean>	Boolean: SNMP data will be preferred to DNS.
NewGeneralSettings.services.time	<object>	Time Service Configuration.	Optional
NewGeneralSettings.services.time. timezone	<string>	The name of the timezone used by this system.
NewGeneralSettings.services.time.ntp	<array of <object>>	Time Service Configuration.	Optional
NewGeneralSettings.services.time.ntp [TimeSourceConfig]	<object>	Time Source Config
NewGeneralSettings.services.time.ntp [TimeSourceConfig].server	<string>	NTP Server name or IP address or name in case of pool type.
NewGeneralSettings.services.time.ntp [TimeSourceConfig].type	<number>	NTP time source type. (0 - server, 1 - pool, 2 - peer)
NewGeneralSettings.services.time.ntp [TimeSourceConfig].key	<string>	NTP key to use with this server. Is a string but may be null.
NewGeneralSettings.services.time.ntp [TimeSourceConfig].hash	<string>	hashing algorythm used with the 'key'. One of 'MD5', 'SHA1', 'SHA256', 'SHA384', or 'SHA512'
NewGeneralSettings.services.time.ntp [TimeSourceConfig].hex	<boolean>	Boolean: This key is in hex format. false denotes ascii format.
NewGeneralSettings.services.time.ntp [TimeSourceConfig].idx	<number>	Index of this key on the time server.
NewGeneralSettings. system_component_config	<object>	Core System Component Configuration.	Optional
NewGeneralSettings. system_component_config. expansion_modules	<array of <object>>	System Expansion Modules.
NewGeneralSettings. system_component_config. expansion_modules[item]	<object>	System Module.	Optional
NewGeneralSettings. system_component_config. expansion_modules[item].hostname	<string>	Hostname for this module.
NewGeneralSettings. system_component_config. expansion_modules[item].device	<string>	Device ID for this module.
NewGeneralSettings. system_component_config. expansion_modules[item].desc	<string>	Device description for this module.
NewGeneralSettings. system_component_config. expansion_modules[item].state	<string>	Current System State for this module.
NewGeneralSettings. system_component_config. expansion_modules[item].sn	<string>	System Serial Number for this module.
NewGeneralSettings. system_component_config. expansion_modules[item]. config_password	<string>	Configuration Password to use when adding a new module. Empty for existing moduels.
NewGeneralSettings. system_component_config. expansion_modules[item].ipaddr	<array of <string>>	Module IP addresses.
NewGeneralSettings. system_component_config. expansion_modules[item].ipaddr[item]	<string>	Module IP address.	Optional
NewGeneralSettings. system_component_config.inside_addrs	<array of <string>>	List of CIDR blocks internal to this NetProfiler's Analysis.
NewGeneralSettings. system_component_config.inside_addrs [item]	<string>	CIDR Block in x.x.x.x/bits notation (eg. '10.0.0.0/8').	Optional
NewGeneralSettings. system_component_config.use_vxlan	<boolean>	Boolean: This system will use vxlan (if available).
NewGeneralSettings. system_component_config.ui_mode	<number>	UI Mode: 0 - UI not active. Display Setup page, 1 - UI active. Display Home page.
NewGeneralSettings.base_integrations	<object>	Base System Integration Configuration.	Optional
NewGeneralSettings.base_integrations. snmp	<object>	System SNMP settings.	Optional
NewGeneralSettings.base_integrations. snmp.location	<string>	System SNMP Location.
NewGeneralSettings.base_integrations. snmp.description	<string>	System SNMP Description.
NewGeneralSettings.base_integrations. snmp.contact	<string>	System SNMP Contact.
NewGeneralSettings.base_integrations. snmp.community	<string>	System SNMP Community String (if version is 1 or 2c).
NewGeneralSettings.base_integrations. snmp.version	<string>	System SNMP Version (1, 2c, or 3).
NewGeneralSettings.base_integrations. snmp.max_trap_list_len	<number>	System will send up to this many traps at once.
NewGeneralSettings.base_integrations. snmp.v3_settings	<object>	System SNMP Version 3 settings. Ignored if 'version' is not '3'.	Optional
NewGeneralSettings.base_integrations. snmp.v3_settings.username	<string>	System SNMP Version 3 Username.
NewGeneralSettings.base_integrations. snmp.v3_settings.security_level	<string>	System SNMP Version 3 Security Level ('SNMP_SEC_NOAUTH', 'SNMP_SEC_AUTH', 'SNMP_SEC_PRIV', or '').
NewGeneralSettings.base_integrations. snmp.v3_settings.auth_passphrase	<string>	System SNMP Version 3 Authentication Passphrase. Ignored if security_level is 'SNMP_SEC_NOAUTH'.
NewGeneralSettings.base_integrations. snmp.v3_settings.auth_proto	<string>	System SNMP Version 3 Authentication Protocol ('SNMP_AUTH_MD5', 'SNMP_AUTH_SHA', 'SNMP_AUTH_SHA224', 'SNMP_AUTH_SHA256', 'SNMP_AUTH_SHA384', 'SNMP_AUTH_SHA512', 'SNMP_AUTH_NONE', or '')
NewGeneralSettings.base_integrations. snmp.v3_settings.priv_passphrase	<string>	System SNMP Version 3 Authentication Passphrase. Ignored if security_level is not 'SNMP_SEC_PRIV'.
NewGeneralSettings.base_integrations. snmp.v3_settings.priv_proto	<string>	System SNMP Version 3 Authentication Protocol ('SNMP_PRIV_DES', 'SNMP_PRIV_AES', 'SNMP_PRIV_AES192', 'SNMP_PRIV_AES256', 'SNMP_PRIV_AES192C', 'SNMP_PRIV_AES256C', 'SNMP_PRIV_NONE', or '')
NewGeneralSettings.base_integrations. smtp	<object>	System email configuration.	Optional
NewGeneralSettings.base_integrations. smtp.server	<string>	System email relay host.
NewGeneralSettings.base_integrations. smtp.port	<number>	Port that the 'server' listens on (usually 25).
NewGeneralSettings.base_integrations. smtp.from_addr	<string>	Emails sent by this system will come from this address.
NewGeneralSettings.base_integrations. smtp.enable_tls	<boolean>	Boolean: Use TLS with this server.
NewGeneralSettings.base_integrations. smtp.enable_auth	<boolean>	Boolean: Use a username and password with this server.
NewGeneralSettings.base_integrations. smtp.username	<string>	If 'enable_auth' is true then use this username.
NewGeneralSettings.base_integrations. smtp.password	<string>	If 'enable_auth' is true then use this password.

Response Body

On success, the server does not provide any body in the responses.

Error Codes

In the event that an error occurs while processing a request, the server will respond with appropriate HTTP status code and additional information in the response body:

{
     "error_id":   "{error identifier}",
     "error_text": "{error description}",
     "error_info": {error specific data structure, optional}
}

The table below lists the possible errors and the associated HTTP status codes that may returned.

Error ID	HTTP Status	Comments
BAD_REQUEST	400	Invalid argument.
AUTH_REQUIRED	401	Authentication required.
AUTH_INVALID_CREDENTIALS	401	Make sure the user name is correct and type your password again. Be sure to use the correct case for the user name and password.
HTTP_INVALID_METHOD	405	Requested method is not available for this resource.
INTERNAL_ERROR	500	Internal error.