{ "restSchemaVersion": "1.0", "errors": [ { "error_id": "BAD_REQUEST", "description": "Invalid argument.", "http_status": "400" }, { "error_id": "AUTH_REQUIRED", "description": "Authentication required.", "http_status": "401" }, { "error_id": "AUTH_INVALID_CREDENTIALS", "description": "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_status": "401" }, { "error_id": "HTTP_INVALID_METHOD", "description": "Requested method is not available for this resource.", "http_status": "405" }, { "error_id": "INTERNAL_ERROR", "description": "Internal error.", "http_status": "500" } ], "name": "mgmt.system_config", "title": "System Configuration API.", "version": "1.0", "schemas": [], "defaultAuthorization": "required", "servicePath": "/api/mgmt.system_config/1.0", "resources": { "Settings": { "methods": { "Display Settings": { "description": "Displays system configuration settings.", "formats": [ "json" ], "httpmethod": "GET", "path": "general_settings", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Current set of system configuration settings.", "properties": { "network": { "description": "Base Unit Network Configuration.", "required": false, "type": "object", "properties": { "primary": { "description": "Primary Interface Network Configuration.", "required": true, "type": "object", "properties": { "dhcp": { "description": "Boolean: Is DHCP active on this interface.", "required": true, "type": "boolean" }, "ip4_addr": { "description": "IPv4 address for this interface. May be empty string.", "required": true, "type": "string" }, "ip4_mask": { "description": "IPv4 Subnet Mask for this interface (0-32). May be 0.", "required": true, "type": "number" }, "ip4_gw": { "description": "IPv4 gateway address for this interface. May be empty string.", "required": true, "type": "string" }, "ip6_addr": { "description": "IPv6 address for this interface. May be empty string.", "required": true, "type": "string" }, "ip6_prefix_len": { "description": "IPv6 prefix length for this interface (0-128). May be 0.", "required": true, "type": "number" }, "ip6_gw": { "description": "IPv6 gateway address for this interface. May be empty string.", "required": true, "type": "string" } } }, "aux": { "description": "Aux Interface Network Configuration.", "required": true, "type": "object", "properties": { "dhcp": { "description": "Boolean: Is DHCP active on this interface.", "required": true, "type": "boolean" }, "ip4_addr": { "description": "IPv4 address for this interface. May be empty string.", "required": true, "type": "string" }, "ip4_mask": { "description": "IPv4 Subnet Mask for this interface (0-32). May be 0.", "required": true, "type": "number" }, "ip6_addr": { "description": "IPv6 address for this interface. May be empty string.", "required": true, "type": "string" }, "ip6_prefix_len": { "description": "IPv6 prefix length for this interface (0-128). May be 0.", "required": true, "type": "number" } } }, "hostname": { "description": "Base hostname for this system.", "required": true, "type": "string" }, "routes": { "description": "System Routes.", "required": true, "type": "array", "items": { "description": "Route", "type": "object", "id": "SystemRoute", "properties": { "dest": { "description": "Destination IP address.", "required": true, "type": "string" }, "prefix": { "description": "Destination Prefix Len (0-128).", "required": true, "type": "number" }, "next-hop": { "description": "Next Hop Router IP address.", "required": true, "type": "string" }, "is_user_static": { "description": "Boolean: Was this system added by the user (true) or created by the system (false).", "required": true, "type": "boolean" } } } } } }, "services": { "description": "Core System Services.", "required": false, "type": "object", "properties": { "name_resolution": { "description": "Hostname Resolution Service Configuration.", "required": false, "type": "object", "properties": { "search": { "description": "Search Domain List.", "required": true, "type": "array", "items": { "description": "Search Domain.", "required": false, "type": "string" } }, "dns_servers": { "description": "DNS Server List.", "required": true, "type": "array", "items": { "description": "DNS Server.", "required": false, "type": "string" } }, "dns_enabled": { "description": "Boolean: Is DNS Resolution Enabled.", "required": true, "type": "boolean" }, "ipv4_precedence": { "description": "Boolean: Do IPv4 answers take precedence.", "required": true, "type": "boolean" }, "enable_dns_host_resolution": { "description": "Boolean: DNS Host Resolution will be used in Reports.", "required": true, "type": "boolean" }, "report_host_limit": { "description": "Total number of hosts to be resolved for any single report.", "required": true, "type": "number" }, "dns_request_limit": { "description": "Total number of hosts to be requested for any single DNS query.", "required": true, "type": "number" }, "enable_dhcp_host_resolution": { "description": "Boolean: DHCP data will be used to resolve hosts in reports if available.", "required": true, "type": "boolean" } } }, "device_resolution": { "description": "Device Resolution Service Configuration.", "required": false, "type": "object", "properties": { "enable_snmp": { "description": "Boolean: SNMP will be used for device and interface resolution (if available).", "required": true, "type": "boolean" }, "enable_dns": { "description": "Boolean: DNS will be used for device resolution (if available).", "required": true, "type": "boolean" }, "device_dns_refresh": { "description": "Hostname Resolution Service Configuration.", "required": true, "type": "object", "properties": { "interval": { "description": "Refresh period interval ('day', 'week', 'month'.", "required": true, "type": "string" }, "periods": { "description": "Number of intervals to use. Must be a positive integer.", "required": true, "type": "number" } } }, "snmp_prefered_to_dns": { "description": "Boolean: SNMP data will be preferred to DNS.", "required": true, "type": "boolean" } } }, "time": { "description": "Time Service Configuration.", "required": false, "type": "object", "properties": { "timezone": { "description": "The name of the timezone used by this system.", "required": true, "type": "string" }, "ntp": { "description": "Time Service Configuration.", "required": false, "type": "array", "items": { "description": "Time Source Config", "type": "object", "id": "TimeSourceConfig", "properties": { "server": { "description": "NTP Server name or IP address or name in case of pool type.", "required": true, "type": "string" }, "type": { "description": "NTP time source type. (0 - server, 1 - pool, 2 - peer)", "required": true, "type": "number" }, "key": { "description": "NTP key to use with this server. Is a string but may be null.", "required": true, "type": "string" }, "hash": { "description": "hashing algorythm used with the 'key'. One of 'MD5', 'SHA1', 'SHA256', 'SHA384', or 'SHA512'", "required": true, "type": "string" }, "hex": { "description": "Boolean: This key is in hex format. false denotes ascii format.", "required": true, "type": "boolean" }, "idx": { "description": "Index of this key on the time server.", "required": true, "type": "number" } } } } } } } }, "system_component_config": { "description": "Core System Component Configuration.", "required": false, "type": "object", "properties": { "expansion_modules": { "description": "System Expansion Modules.", "required": true, "type": "array", "items": { "description": "System Module.", "required": false, "type": "object", "properties": { "hostname": { "description": "Hostname for this module.", "required": true, "type": "string" }, "device": { "description": "Device ID for this module.", "required": true, "type": "string" }, "desc": { "description": "Device description for this module.", "required": true, "type": "string" }, "state": { "description": "Current System State for this module.", "required": true, "type": "string" }, "sn": { "description": "System Serial Number for this module.", "required": true, "type": "string" }, "config_password": { "description": "Configuration Password to use when adding a new module. Empty for existing moduels.", "required": true, "type": "string" }, "ipaddr": { "description": "Module IP addresses.", "required": true, "type": "array", "items": { "description": "Module IP address.", "required": false, "type": "string" } } } } }, "inside_addrs": { "description": "List of CIDR blocks internal to this NetProfiler's Analysis.", "required": true, "type": "array", "items": { "description": "CIDR Block in x.x.x.x/bits notation (eg. '10.0.0.0/8').", "required": false, "type": "string" } }, "use_vxlan": { "description": "Boolean: This system will use vxlan (if available).", "required": true, "type": "boolean" }, "ui_mode": { "description": "UI Mode: 0 - UI not active. Display Setup page, 1 - UI active. Display Home page.", "required": true, "type": "number" } } }, "base_integrations": { "description": "Base System Integration Configuration.", "required": false, "type": "object", "properties": { "snmp": { "description": "System SNMP settings.", "required": false, "type": "object", "properties": { "location": { "description": "System SNMP Location.", "required": true, "type": "string" }, "description": { "description": "System SNMP Description.", "required": true, "type": "string" }, "contact": { "description": "System SNMP Contact.", "required": true, "type": "string" }, "community": { "description": "System SNMP Community String (if version is 1 or 2c).", "required": true, "type": "string" }, "version": { "description": "System SNMP Version (1, 2c, or 3).", "required": true, "type": "string" }, "max_trap_list_len": { "description": "System will send up to this many traps at once.", "required": true, "type": "number" }, "v3_settings": { "description": "System SNMP Version 3 settings. Ignored if 'version' is not '3'.", "required": false, "type": "object", "properties": { "username": { "description": "System SNMP Version 3 Username.", "required": true, "type": "string" }, "security_level": { "description": "System SNMP Version 3 Security Level ('SNMP_SEC_NOAUTH', 'SNMP_SEC_AUTH', 'SNMP_SEC_PRIV', or '').", "required": true, "type": "string" }, "auth_passphrase": { "description": "System SNMP Version 3 Authentication Passphrase. Ignored if security_level is 'SNMP_SEC_NOAUTH'.", "required": true, "type": "string" }, "auth_proto": { "description": "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 '')", "required": true, "type": "string" }, "priv_passphrase": { "description": "System SNMP Version 3 Authentication Passphrase. Ignored if security_level is not 'SNMP_SEC_PRIV'.", "required": true, "type": "string" }, "priv_proto": { "description": "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 '')", "required": true, "type": "string" } } } } }, "smtp": { "description": "System email configuration.", "required": false, "type": "object", "properties": { "server": { "description": "System email relay host.", "required": true, "type": "string" }, "port": { "description": "Port that the 'server' listens on (usually 25).", "required": true, "type": "number" }, "from_addr": { "description": "Emails sent by this system will come from this address.", "required": true, "type": "string" }, "enable_tls": { "description": "Boolean: Use TLS with this server.", "required": true, "type": "boolean" }, "enable_auth": { "description": "Boolean: Use a username and password with this server.", "required": true, "type": "boolean" }, "username": { "description": "If 'enable_auth' is true then use this username.", "required": true, "type": "string" }, "password": { "description": "If 'enable_auth' is true then use this password.", "required": true, "type": "string" } } } } } }, "id": "GeneralSettings", "type": "object", "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": "" } } } }, "authorization": "required" }, "Configure Settings": { "description": "Configure system configuration settings.", "formats": [ "json" ], "httpmethod": "POST", "path": "general_settings", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required", "request": { "description": "An updated set of system configuration settings.", "id": "NewGeneralSettings", "type": "object", "properties": { "network": { "description": "Base Unit Network Configuration.", "required": false, "type": "object", "properties": { "primary": { "description": "Primary Interface Network Configuration.", "required": true, "type": "object", "properties": { "dhcp": { "description": "Boolean: Is DHCP active on this interface.", "required": true, "type": "boolean" }, "ip4_addr": { "description": "IPv4 address for this interface. May be empty string.", "required": true, "type": "string" }, "ip4_mask": { "description": "IPv4 Subnet Mask for this interface (0-32). May be 0.", "required": true, "type": "number" }, "ip4_gw": { "description": "IPv4 gateway address for this interface. May be empty string.", "required": true, "type": "string" }, "ip6_addr": { "description": "IPv6 address for this interface. May be empty string.", "required": true, "type": "string" }, "ip6_prefix_len": { "description": "IPv6 prefix length for this interface (0-128). May be 0.", "required": true, "type": "number" }, "ip6_gw": { "description": "IPv6 gateway address for this interface. May be empty string.", "required": true, "type": "string" } } }, "aux": { "description": "Aux Interface Network Configuration.", "required": true, "type": "object", "properties": { "dhcp": { "description": "Boolean: Is DHCP active on this interface.", "required": true, "type": "boolean" }, "ip4_addr": { "description": "IPv4 address for this interface. May be empty string.", "required": true, "type": "string" }, "ip4_mask": { "description": "IPv4 Subnet Mask for this interface (0-32). May be 0.", "required": true, "type": "number" }, "ip6_addr": { "description": "IPv6 address for this interface. May be empty string.", "required": true, "type": "string" }, "ip6_prefix_len": { "description": "IPv6 prefix length for this interface (0-128). May be 0.", "required": true, "type": "number" } } }, "hostname": { "description": "Base hostname for this system.", "required": true, "type": "string" }, "routes": { "description": "System Routes.", "required": true, "type": "array", "items": { "description": "Route", "type": "object", "id": "NewSystemRoute", "properties": { "dest": { "description": "Destination IP address.", "required": true, "type": "string" }, "prefix": { "description": "Destination Prefix Len (0-128).", "required": true, "type": "number" }, "next-hop": { "description": "Next Hop Router IP address.", "required": true, "type": "string" }, "is_user_static": { "description": "Boolean: Was this system added by the user (true) or created by the system (false).", "required": true, "type": "boolean" } } } } } }, "services": { "description": "Core System Services.", "required": false, "type": "object", "properties": { "name_resolution": { "description": "Hostname Resolution Service Configuration.", "required": false, "type": "object", "properties": { "search": { "description": "Search Domain List.", "required": true, "type": "array", "items": { "description": "Search Domain.", "required": false, "type": "string" } }, "dns_servers": { "description": "DNS Server List.", "required": true, "type": "array", "items": { "description": "DNS Server.", "required": false, "type": "string" } }, "dns_enabled": { "description": "Boolean: Is DNS Resolution Enabled.", "required": true, "type": "boolean" }, "ipv4_precedence": { "description": "Boolean: Do IPv4 answers take precedence.", "required": true, "type": "boolean" }, "enable_dns_host_resolution": { "description": "Boolean: DNS Host Resolution will be used in Reports.", "required": true, "type": "boolean" }, "report_host_limit": { "description": "Total number of hosts to be resolved for any single report.", "required": true, "type": "number" }, "dns_request_limit": { "description": "Total number of hosts to be requested for any single DNS query.", "required": true, "type": "number" }, "enable_dhcp_host_resolution": { "description": "Boolean: DHCP data will be used to resolve hosts in reports if available.", "required": true, "type": "boolean" } } }, "device_resolution": { "description": "Device Resolution Service Configuration.", "required": false, "type": "object", "properties": { "enable_snmp": { "description": "Boolean: SNMP will be used for device and interface resolution (if available).", "required": true, "type": "boolean" }, "enable_dns": { "description": "Boolean: DNS will be used for device resolution (if available).", "required": true, "type": "boolean" }, "device_dns_refresh": { "description": "Hostname Resolution Service Configuration.", "required": true, "type": "object", "properties": { "interval": { "description": "Refresh period interval ('day', 'week', 'month'.", "required": true, "type": "string" }, "periods": { "description": "Number of intervals to use. Must be a positive integer.", "required": true, "type": "number" } } }, "snmp_prefered_to_dns": { "description": "Boolean: SNMP data will be preferred to DNS.", "required": true, "type": "boolean" } } }, "time": { "description": "Time Service Configuration.", "required": false, "type": "object", "properties": { "timezone": { "description": "The name of the timezone used by this system.", "required": true, "type": "string" }, "ntp": { "description": "Time Service Configuration.", "required": false, "type": "array", "items": { "description": "Time Source Config", "type": "object", "id": "TimeSourceConfig", "properties": { "server": { "description": "NTP Server name or IP address or name in case of pool type.", "required": true, "type": "string" }, "type": { "description": "NTP time source type. (0 - server, 1 - pool, 2 - peer)", "required": true, "type": "number" }, "key": { "description": "NTP key to use with this server. Is a string but may be null.", "required": true, "type": "string" }, "hash": { "description": "hashing algorythm used with the 'key'. One of 'MD5', 'SHA1', 'SHA256', 'SHA384', or 'SHA512'", "required": true, "type": "string" }, "hex": { "description": "Boolean: This key is in hex format. false denotes ascii format.", "required": true, "type": "boolean" }, "idx": { "description": "Index of this key on the time server.", "required": true, "type": "number" } } } } } } } }, "system_component_config": { "description": "Core System Component Configuration.", "required": false, "type": "object", "properties": { "expansion_modules": { "description": "System Expansion Modules.", "required": true, "type": "array", "items": { "description": "System Module.", "required": false, "type": "object", "properties": { "hostname": { "description": "Hostname for this module.", "required": true, "type": "string" }, "device": { "description": "Device ID for this module.", "required": true, "type": "string" }, "desc": { "description": "Device description for this module.", "required": true, "type": "string" }, "state": { "description": "Current System State for this module.", "required": true, "type": "string" }, "sn": { "description": "System Serial Number for this module.", "required": true, "type": "string" }, "config_password": { "description": "Configuration Password to use when adding a new module. Empty for existing moduels.", "required": true, "type": "string" }, "ipaddr": { "description": "Module IP addresses.", "required": true, "type": "array", "items": { "description": "Module IP address.", "required": false, "type": "string" } } } } }, "inside_addrs": { "description": "List of CIDR blocks internal to this NetProfiler's Analysis.", "required": true, "type": "array", "items": { "description": "CIDR Block in x.x.x.x/bits notation (eg. '10.0.0.0/8').", "required": false, "type": "string" } }, "use_vxlan": { "description": "Boolean: This system will use vxlan (if available).", "required": true, "type": "boolean" }, "ui_mode": { "description": "UI Mode: 0 - UI not active. Display Setup page, 1 - UI active. Display Home page.", "required": true, "type": "number" } } }, "base_integrations": { "description": "Base System Integration Configuration.", "required": false, "type": "object", "properties": { "snmp": { "description": "System SNMP settings.", "required": false, "type": "object", "properties": { "location": { "description": "System SNMP Location.", "required": true, "type": "string" }, "description": { "description": "System SNMP Description.", "required": true, "type": "string" }, "contact": { "description": "System SNMP Contact.", "required": true, "type": "string" }, "community": { "description": "System SNMP Community String (if version is 1 or 2c).", "required": true, "type": "string" }, "version": { "description": "System SNMP Version (1, 2c, or 3).", "required": true, "type": "string" }, "max_trap_list_len": { "description": "System will send up to this many traps at once.", "required": true, "type": "number" }, "v3_settings": { "description": "System SNMP Version 3 settings. Ignored if 'version' is not '3'.", "required": false, "type": "object", "properties": { "username": { "description": "System SNMP Version 3 Username.", "required": true, "type": "string" }, "security_level": { "description": "System SNMP Version 3 Security Level ('SNMP_SEC_NOAUTH', 'SNMP_SEC_AUTH', 'SNMP_SEC_PRIV', or '').", "required": true, "type": "string" }, "auth_passphrase": { "description": "System SNMP Version 3 Authentication Passphrase. Ignored if security_level is 'SNMP_SEC_NOAUTH'.", "required": true, "type": "string" }, "auth_proto": { "description": "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 '')", "required": true, "type": "string" }, "priv_passphrase": { "description": "System SNMP Version 3 Authentication Passphrase. Ignored if security_level is not 'SNMP_SEC_PRIV'.", "required": true, "type": "string" }, "priv_proto": { "description": "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 '')", "required": true, "type": "string" } } } } }, "smtp": { "description": "System email configuration.", "required": false, "type": "object", "properties": { "server": { "description": "System email relay host.", "required": true, "type": "string" }, "port": { "description": "Port that the 'server' listens on (usually 25).", "required": true, "type": "number" }, "from_addr": { "description": "Emails sent by this system will come from this address.", "required": true, "type": "string" }, "enable_tls": { "description": "Boolean: Use TLS with this server.", "required": true, "type": "boolean" }, "enable_auth": { "description": "Boolean: Use a username and password with this server.", "required": true, "type": "boolean" }, "username": { "description": "If 'enable_auth' is true then use this username.", "required": true, "type": "string" }, "password": { "description": "If 'enable_auth' is true then use this password.", "required": true, "type": "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": "" } } } } } } }, "description": "

Overview

\n\n

\nThe documentation pages in this section describe\nthe RESTful APIs included with NetProfiler products. It is assumed \nthat the reader has practical knowledge of\nRESTful APIs, so the documentation does not go into detail about what\nREST is and how to use it. Instead the documentation focuses on what\ndata can be accessed, how to configure and clear it.\n

\n\n

\nThe following operations can be performed via the API:\n

\n\n\n

\nDetails about REST resources can be found in the Resources\nsection. This overview continues with how to run these API's.\n

\n\n

Authentication

\n\n

\nAll REST requests must be authenticated. The Authentication\nsection of the Common API describes which authentication methods\nare presently supported. \n

\n\n" }