{ "openapi": "3.1.0", "info": { "version": "2.0", "title": "OpManager External APIs", "description": "This document consists of OpManager's External Apis" }, "servers": [ { "url": "http://{Serverurl}", "variables": { "Serverurl": { "description": "OpManager server host and port.", "default": "localhost:8060" } } } ], "tags": [ { "name": "OpManager.Alarms", "description": "APIs for managing alarms in OpManager, including fetching, acknowledging, clearing, and tracking fault events generated across monitored resources." }, { "name": "OpManager.Devices", "description": "APIs for device monitoring & management in OpManager. Fetches the Device summary, Availability and performance data" }, { "name": "OpManager.Enterprise", "description": "APIs for managing enterprise-level features in OpManager, including probe-central communication, distributed monitoring, and large-scale infrastructure management." }, { "name": "OpManager.Reports", "description": "APIs for generating and retrieving reports in OpManager, including availability, performance, and historical data reports for monitored resources." }, { "name": "OpManager.Downtime Scheduler", "description": "APIs for defining configurations in OpManager." }, { "name": "OpManager.Groups", "description": "APIs for management of Groups in OpManager. Groups organizes the devices, interfaces and sub-groups logically and provides aggregate status, availability & performance data" }, { "name": "OpManager.Interfaces", "description": "APIs related to network interface management in OpManager." }, { "name": "OpManager.BusinessViews", "description": "APIs related to Business Views in OpManager. Business Views provide a logical, topology-based visualization of your network infrastructure." }, { "name": "OpManager.IPSLA", "description": "APIs related to IP SLA monitor management in OpManager." }, { "name": "OpManager.NetworkPath", "description": "APIs related to NetworkPath Analysis management in OpManager." }, { "name": "OpManager.Wireless", "description": "APIs related to wireless management in OpManager." }, { "name": "OpManager.Virtualization", "description": "APIs related to virtual machine and hypervisor management in OpManager." }, { "name": "OpManager.URLMonitors", "description": "APIs for URL monitor management. URL monitors track the availability and response time of HTTP/HTTPS endpoints. They can be global or device-specific." }, { "name": "OpManager.Monitoring", "description": "APIs for performance monitoring in OpManager, including monitor templates, graphing, last-collected values, process monitors, service monitors, URL monitors, and script monitors." }, { "name": "OpManager.Dashboard", "description": "APIs for dashboard widget management in OpManager, including fetching widget data and listing available widgets." }, { "name": "OpManager.Discovery", "description": "APIs for device discovery in OpManager, including adding devices for monitoring." }, { "name": "OpManager.Events", "description": "APIs for event management in OpManager, including listing and creating events." }, { "name": "OpManager.Notifications", "description": "APIs for notification profile management in OpManager, including creating, associating, and managing notification profiles." }, { "name": "OpManager.Subnets", "description": "APIs for subnet management in OpManager, including listing monitored subnets." }, { "name": "OpManager.Workflow", "description": "APIs for workflow management in OpManager, including listing, retrieving, and triggering workflows." } ], "paths": { "/api/json/nfadevice/getWlcRouterData": { "get": { "summary": "List All WLC Devices", "x-zenesis-title": "List All WLC Devices", "x-zenesis-security": {}, "description": "To get all the controllers list with details like ip , number of AP's monitored and Flow count.\n", "operationId": "getWlcRouterData", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "", "properties": { "showdata": { "type": "boolean", "description": "" }, "showCentralMigrationInfo": { "type": "boolean", "description": "" }, "DevList": { "type": "array", "items": { "type": "string", "description": "" }, "description": "" }, "showCentralMigrationError": { "type": "boolean", "description": "" } } }, "examples": { "Example1": { "value": { "showdata": true, "stdEndTime": "2026-04-02 02:24", "showCentralMigrationInfo": false, "DevList": [ { "rType": 999, "IP": "10.5.5.1", "PktCount": 14, "ID": 50007, "Name": "WirelessController", "apCount": 5 } ], "startTime": "2026-04-02 01:24", "stdStartTime": "2026-04-02 01:24", "endTime": "2026-04-02 02:24", "showCentralMigrationError": false } } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "TimeFrame", "required": false, "description": "", "schema": { "$ref": "#/components/schemas/NFA_Inv_TimeFrames_1_regex" } }, { "$ref": "#/components/parameters/NFADEparams_reqFrm", "description": "" }, { "$ref": "#/components/parameters/NFADEparams_TimeZone", "description": "" }, { "in": "query", "name": "searchFilters", "required": false, "description": "", "schema": { "$ref": "#/components/schemas/searchFilterJson" } }, { "$ref": "#/components/parameters/NFADEparams_collOpt", "description": "" } ], "tags": [ "NFA.Inventory" ], "security": [], "x-zenesis-sections": {}, "x-zenesis-doc": { "show": true }, "x-zenesis-envTags": [] } }, "/api/json/alarm/alarmProperties": { "get": { "summary": "Get Alarm Details", "x-zenesis-title": "Get Alarm Details", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "Retrieves detailed properties of a specific alarm, including severity, category, source device, associated events, and workflow logs. Requires the entity identifier obtained from listAlarms. Use this to inspect a single alarm before taking action such as acknowledging, clearing, or adding notes. Returns read-only data; no alarm state is modified by this call.", "operationId": "alarmProperties", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "", "properties": { "categoryString": { "type": "string", "description": "" }, "isSelfMonitoringRedirectionAlarm": { "type": "boolean", "description": "" }, "cycleId": { "type": "string", "description": "" }, "PRIORITY": { "type": "string", "description": "" }, "source": { "type": "string", "description": "" }, "modTimeStr": { "type": "string", "description": "" }, "showManageUnManage": { "type": "boolean", "description": "" }, "isLamaIntegration": { "type": "boolean", "description": "" }, "suppressedMessage": { "type": "string", "description": "" }, "stringseverity": { "type": "string", "description": "" }, "showExecuteWorkflow": { "type": "boolean", "description": "" }, "isFOSAlarm": { "type": "boolean", "description": "" }, "id": { "type": "string", "description": "" }, "events": { "type": "array", "items": { "type": "object", "description": "", "properties": { "severity": { "type": "string", "description": "" }, "modifiedTime": { "type": "string", "description": "" }, "statusStr": { "type": "string", "description": "" }, "source": { "type": "string", "description": "" }, "statusNum": { "type": "string", "description": "" }, "timeInMs": { "type": "string", "description": "" }, "alarmViewInfo": { "type": "string", "description": "" }, "time": { "type": "string", "description": "" }, "text": { "type": "string", "description": "" }, "id": { "type": "string", "description": "" }, "category": { "type": "string", "description": "" }, "imgsrc": { "type": "string", "description": "" }, "entity": { "type": "string", "description": "" } } }, "description": "" }, "createTimeStr": { "type": "string", "description": "" }, "showTestActions": { "type": "boolean", "description": "" }, "WEBNMS": { "type": "string", "description": "" }, "isFileIntegrityAlarm": { "type": "boolean", "description": "" }, "hidePingTraceRoute": { "type": "boolean", "description": "" }, "priority": { "type": "string", "description": "" }, "previousSeverity": { "type": "string", "description": "" }, "isForecastAlert": { "type": "boolean", "description": "" }, "OWNERNAME": { "type": "string", "description": "" }, "statusNum": { "type": "string", "description": "" }, "groupName": { "type": "string", "description": "" }, "EVENTTYPE": { "type": "string", "description": "" }, "showping": { "type": "boolean", "description": "" }, "nfaID": { "type": "integer", "description": "" }, "stringpreviousseverity": { "type": "string", "description": "" }, "who": { "type": "string", "description": "" }, "showtraceroute": { "type": "boolean", "description": "" }, "isDatastore": { "type": "boolean", "description": "" }, "statusStr": { "type": "string", "description": "" }, "displayName": { "type": "string", "description": "" }, "disableRedirectionLink": { "type": "boolean", "description": "" }, "workflows": { "type": "array", "items": { "type": "string", "description": "" }, "description": "" }, "isDeviceAvailable": { "type": "boolean", "description": "" }, "GROUPNAME": { "type": "string", "description": "" }, "strCreateTime": { "type": "string", "description": "" }, "severity": { "type": "string", "description": "" }, "owner": { "type": "string", "description": "" }, "isSuppressed": { "type": "boolean", "description": "" }, "ALARMCODE": { "type": "string", "description": "" }, "strModTime": { "type": "string", "description": "" }, "message": { "type": "string", "description": "" }, "showAvailability": { "type": "boolean", "description": "" }, "MAPNAME": { "type": "string", "description": "" }, "actionType": { "type": "string", "description": "" }, "stage": { "type": "string", "description": "" }, "createTime": { "type": "string", "description": "" }, "modTime": { "type": "string", "description": "" }, "pollid": { "type": "string", "description": "" }, "category": { "type": "string", "description": "" }, "entity": { "type": "string", "description": "" }, "isMailServerAlarm": { "type": "boolean", "description": "" } } }, "examples": { "Example1": { "value": { "categoryString": "SelfMonitoring", "isSelfMonitoringRedirectionAlarm": true, "cycleId": "16", "PRIORITY": "0", "source": "System", "modTimeStr": "29 Jan 2026 11:15:51 AM IST", "showManageUnManage": true, "isLamaIntegration": false, "suppressedMessage": "", "stringseverity": "Critical", "showExecuteWorkflow": true, "isFOSAlarm": false, "id": "601", "events": [ { "severity": "Critical", "modifiedTime": "1769665551221", "statusStr": "Critical", "source": "System", "statusNum": "1", "timeInMs": "1769665551221", "alarmViewInfo": "false", "time": "29 Jan 2026 11:15:51 AM IST", "text": "File Integrity : New files were found during the last scan.", "id": "36", "category": "SelfMonitoring", "imgsrc": "/images/devices/status1.gif", "entity": "localhost_FILEINTEGRITY_BLACKLISTED" }, { "severity": "Critical", "modifiedTime": "1769596806377", "statusStr": "Critical", "source": "System", "statusNum": "1", "timeInMs": "1769596806377", "alarmViewInfo": "false", "time": "28 Jan 2026 04:10:06 PM IST", "text": "File Integrity : New files were found during the last scan.", "id": "29", "category": "SelfMonitoring", "imgsrc": "/images/devices/status1.gif", "entity": "localhost_FILEINTEGRITY_BLACKLISTED" }, { "severity": "Critical", "modifiedTime": "1769510404327", "statusStr": "Critical", "source": "System", "statusNum": "1", "timeInMs": "1769510404327", "alarmViewInfo": "false", "time": "27 Jan 2026 04:10:04 PM IST", "text": "File Integrity : New files were found during the last scan.", "id": "13", "category": "SelfMonitoring", "imgsrc": "/images/devices/status1.gif", "entity": "localhost_FILEINTEGRITY_BLACKLISTED" } ], "createTimeStr": "27 Jan 2026 04:10:04 PM IST", "showTestActions": true, "WEBNMS": "", "isFileIntegrityAlarm": true, "hidePingTraceRoute": true, "priority": "0", "previousSeverity": "1", "isForecastAlert": false, "OWNERNAME": "", "statusNum": "1", "groupName": "-", "EVENTTYPE": "SelfMonitoring Alarm", "showping": true, "nfaID": -1, "stringpreviousseverity": "Critical", "who": "Unacknowledge", "showtraceroute": true, "isDatastore": false, "statusStr": "Critical", "displayName": "System", "disableRedirectionLink": true, "workflows": [], "isDeviceAvailable": false, "GROUPNAME": "", "strCreateTime": "27 Jan 2026 04:10:04 PM IST", "severity": "/images/devices/status1.gif", "owner": "Unacknowledge", "isSuppressed": false, "ALARMCODE": "FILEINTEGRITY_EXTERNALFILES", "strModTime": "29 Jan 2026 11:15:51 AM IST", "message": "File Integrity : New files were found during the last scan.", "showAvailability": true, "MAPNAME": "", "actionType": "None", "stage": "0", "createTime": "1769510404327", "modTime": "1769665551221", "pollid": "-1", "category": "SelfMonitoring", "entity": "localhost_FILEINTEGRITY_BLACKLISTED", "isMailServerAlarm": false } } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "entity", "required": true, "description": "Entity of the alarm. Obtain this from the listAlarms API response.", "schema": { "$ref": "#/components/schemas/entityText_regex" } } ], "tags": [ "OpManager.Alarms" ], "security": [], "x-zenesis-sections": {}, "x-zenesis-doc": { "show": true }, "x-zenesis-envTags": [] } }, "/api/json/reports/getReportsData": { "get": { "summary": "Get Reports Data", "x-zenesis-title": "Get Reports Data", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "Retrieves pre-configured report data across categories like performance, availability, alarms, inventory, and infrastructure. Returns structured datasets with rows, columns, headers, and metadata, supporting filters such as time period, device type, and groups. Used for consistent reporting and historical analysis\n", "operationId": "getReportsData", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "description": "", "properties": { "graphDetails": { "type": "array", "items": { "type": "object", "description": "", "properties": { "CLIENTADDRESS": { "type": "string", "description": "" }, "MODULENAME": { "type": "string", "description": "" }, "DESCRIPTION": { "type": "string", "description": "" }, "LONGTIME": { "type": "integer", "description": "" }, "MODULEID": { "type": "integer", "description": "" }, "ACTIONNAME": { "type": "string", "description": "" }, "USERNAME": { "type": "string", "description": "" }, "TIME": { "type": "string", "description": "" }, "CLIENTADDRESSSHORT": { "type": "string", "description": "" } } }, "description": "" }, "Time": { "type": "string", "description": "" }, "graphDispName": { "type": "string", "description": "" } } }, "description": "" }, "examples": { "Example1": { "value": [ { "graphDetails": [ { "CLIENTADDRESS": "", "MODULENAME": "Data archiving", "DESCRIPTION": "No data found for interface hourly availability archiving.", "LONGTIME": 1769670000669, "MODULEID": 11, "ACTIONNAME": "-", "USERNAME": "System", "TIME": "29 Jan 2026 12:30:00 PM IST", "CLIENTADDRESSSHORT": "" }, { "CLIENTADDRESS": "", "MODULENAME": "Data archiving", "DESCRIPTION": "No data found for interface hourly availability archiving.", "LONGTIME": 1769670000667, "MODULEID": 11, "ACTIONNAME": "-", "USERNAME": "System", "TIME": "29 Jan 2026 12:30:00 PM IST", "CLIENTADDRESSSHORT": "." }, { "CLIENTADDRESS": "", "MODULENAME": "Data archiving", "DESCRIPTION": "No data found for interface hourly availability archiving.", "LONGTIME": 1769670000664, "MODULEID": 11, "ACTIONNAME": "-", "USERNAME": "System", "TIME": "29 Jan 2026 12:30:00 PM IST", "CLIENTADDRESSSHORT": "" } ], "Time": "Report Period : From 28 Jan 2026 12:51:14 PM IST To 29 Jan 2026 12:51:14 PM IST", "graphDispName": "Audit Report" } ] }, "Example2": { "value": [ { "clientParams": { "top": 0, "genAt": "5 Mar 2026 01:06:28 PM IST", "showType": 0, "time": "twfourhours", "category": "Server", "isFavourite": true, "genAtMilliseconds": 1772696188173 }, "additionalRespData": { "defaultGraphList": { "Availability": "Availability", "Packet Loss": "Packet Loss", "Response Time": "Response Time", "Disk Utilization": "Disk Utilization", "CPU Utilization": "CPU Utilization", "Memory Utilization": "Memory Utilization" } }, "graphDetails": { "Availability": { "unit": "%", "graphData": [ { "data": [ [ "", 84.014 ], [ "", 95.861 ], [ "", 100 ], [ "", 100 ], [ "", 100 ] ] } ] }, "Packet Loss": { "unit": "%", "graphData": [ { "data": [ [ "", "18" ], [ "", "4" ], [ "", "0" ], [ "", "0" ], [ "", "0" ] ] } ] }, "Response Time": { "unit": "ms", "graphData": [ { "data": [ [ "", 158 ], [ "", 71 ], [ "1", 71 ], [ "", 45 ], [ "", 27 ] ] } ] }, "Disk Utilization": { "unit": "%", "graphData": [ { "data": [] } ] }, "CPU Utilization": { "unit": "%", "graphData": [ { "data": [] } ] }, "Memory Utilization": { "unit": "%", "graphData": [ { "data": [] } ] } }, "forward": "overview", "vmClientParams": { "defaultGraphList": { "Availability": "Availability", "Packet Loss": "Packet Loss", "Response Time": "Response Time", "Disk Utilization": "Disk Utilization", "CPU Utilization": "CPU Utilization", "Memory Utilization": "Memory Utilization" } }, "ReportGraphName": "Servers Health Report", "graphDispName": "Servers Health Report" } ] } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "$ref": "#/components/parameters/defaultReportParams_reportID", "description": "" }, { "$ref": "#/components/parameters/defaultReportParams_viewAs", "description": "" }, { "$ref": "#/components/parameters/defaultReportParams_time", "description": "" }, { "$ref": "#/components/parameters/defaultReportParams_startTime", "description": "" }, { "$ref": "#/components/parameters/defaultReportParams_endTime", "description": "" }, { "$ref": "#/components/parameters/defaultReportParams_startHour", "description": "" }, { "$ref": "#/components/parameters/defaultReportParams_endHour", "description": "" }, { "$ref": "#/components/parameters/defaultReportParams_fromTime", "description": "" }, { "$ref": "#/components/parameters/defaultReportParams_toTime", "description": "" }, { "$ref": "#/components/parameters/defaultReportParams_timeWindow", "description": "" }, { "$ref": "#/components/parameters/defaultReportParams_businessRuleID", "description": "" }, { "$ref": "#/components/parameters/defaultReportParams_isBusinessHour", "description": "" }, { "$ref": "#/components/parameters/defaultReportParams_excludedDays", "description": "" }, { "$ref": "#/components/parameters/defaultReportParams_isExcludeDays", "description": "" }, { "$ref": "#/components/parameters/defaultReportParams_category", "description": "" }, { "$ref": "#/components/parameters/defaultReportParams_logicalGroup", "description": "" }, { "$ref": "#/components/parameters/defaultReportParams_bview", "description": "" }, { "$ref": "#/components/parameters/defaultReportParams_perfGroupId", "description": "" }, { "$ref": "#/components/parameters/defaultReportParams_cpResult", "description": "" }, { "$ref": "#/components/parameters/defaultReportParams_valueType", "description": "Value type to get mimum or maximum or average value in Trend report." }, { "$ref": "#/components/parameters/defaultReportParams_customerId", "description": "" }, { "$ref": "#/components/parameters/defaultReportParams_customerName", "description": "" } ], "tags": [ "OpManager.Reports" ], "security": [], "x-zenesis-sections": {}, "x-zenesis-doc": { "show": true }, "x-zenesis-envTags": [] } }, "/api/json/alarm/clearAlarm": { "post": { "summary": "Clear Alarms", "x-zenesis-title": "Clear Alarms", "security": [ {} ], "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "Clears one or more alarms, marking them as resolved in OpManager's fault management system. Requires the entity identifier obtained from listAlarms. Use this after confirming the underlying issue (e.g., device downtime, threshold breach, interface failure) has been addressed. Cleared alarms are removed from the active alarm view but retained in alarm history for audit and reporting purposes.", "operationId": "clearAlarm", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "", "properties": { "result": { "type": "object", "description": "", "properties": { "message": { "type": "string", "description": "" } } } } }, "examples": { "Example1": { "value": { "result": { "message": "Alarm has been successfully Cleared!" } } } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "entity", "required": true, "description": "Entity of the alarm to clear. Obtain this from the listAlarms API response.", "schema": { "$ref": "#/components/schemas/entityText_regex" } } ], "tags": [ "OpManager.Alarms" ], "x-zenesis-sections": {}, "x-zenesis-doc": { "show": true }, "x-zenesis-envTags": [] } }, "/api/json/alarm/addNotes": { "post": { "summary": "Add Notes to Alarms", "x-zenesis-title": "Add Notes to Alarms", "security": [ {} ], "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "Adds a user note or comment to one or more alarms for tracking investigation progress or resolution steps. Requires the entity identifier obtained from listAlarms. Use this to record diagnostic findings, remediation actions, or escalation context against active or acknowledged alarms. Notes are appended to the alarm's annotation history and visible to\n\nall users with alarm access.", "operationId": "addNotes", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "", "properties": { "result": { "type": "object", "description": "", "properties": { "message": { "type": "string", "description": "" } } } } }, "examples": { "Example1": { "value": { "result": { "message": "Successfully Added" } } } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "notes", "required": true, "description": "Notes description to be added.", "schema": { "$ref": "#/components/schemas/text_twoByteSupport_regex" } }, { "in": "query", "name": "entity", "required": true, "description": "Entity of the alarm to annotate. Obtain this from the listAlarms API response.", "schema": { "$ref": "#/components/schemas/entityText_regex" } } ], "tags": [ "OpManager.Alarms" ], "x-zenesis-sections": {}, "x-zenesis-doc": { "show": true }, "x-zenesis-envTags": [] } }, "/api/json/v2/nfadevice/getIndividualGraphData": { "get": { "summary": "Get Criteria based Interface Traffic ", "x-zenesis-title": "Get Criteria based Interface Traffic ", "x-zenesis-security": {}, "description": "Get NFA Bandwidth Usage Graph for each element.", "operationId": "getIndividualGraphData", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "properties": { "TimeZone": { "type": "string", "description": "Time zone of the data" }, "stdEndTime": { "type": "string", "description": "Standard end time" }, "granularity": { "type": "string", "description": "Granularity of the graph data" }, "startTime": { "type": "string", "description": "Start time" }, "stdStartTime": { "type": "string", "description": "Standard start time" }, "endTime": { "type": "string", "description": "End time" }, "yaxis": { "type": "string", "description": "Y-axis unit" }, "graphData": { "type": "array", "description": "Graph data series", "items": { "type": "object", "properties": { "seriesname": { "type": "string", "description": "Name of the series (e.g., IP address)" }, "data": { "type": "array", "description": "Timestamp and value pairs", "items": { "type": "array", "items": { "type": "number" } } }, "yaxiscolumnorder": { "type": "array", "items": { "type": "integer" }, "description": "Order of Y-axis columns" } } } } } }, "examples": { "Example1": { "value": { "TimeZone": "America/New_York", "stdEndTime": "2026-04-02 02:56", "granularity": "10 Minute Average", "startTime": "2026-04-02 01:56", "stdStartTime": "2026-04-02 01:56", "graphData": [ { "seriesname": "10.5.5.1", "data": [ [ 1775109360000, 0 ], [ 1775110199000, 0 ], [ 1775110200000, 13.333333333333334 ], [ 1775112000000, 13.333333333333334 ], [ 1775112001000, 0 ], [ 1775112960000, 0 ] ], "yaxiscolumnorder": [ 0 ] } ], "endTime": "2026-04-02 02:56", "yaxis": "bps" } } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "DeviceID", "required": true, "description": "Unique identifier of the interface/Interface group/IP group", "schema": { "$ref": "#/components/schemas/NFA_Device_ID_regex" } }, { "in": "query", "name": "Type", "required": true, "description": "To which we need indepth data for . like Application|Protocol|AppGrp|Source|SrcNetwork|Destination|DstNetwork|DSCP|TOS|DSCPGrp|Conversation", "schema": { "$ref": "#/components/schemas/only_alphabets_regex" } }, { "in": "query", "name": "cloudInterface", "required": false, "description": "true - if the resource is cloud interface.", "schema": { "$ref": "#/components/schemas/NFABoolean_regex" } }, { "in": "query", "name": "Entity", "required": false, "description": "selected data to which we need a indepth data. it may be source ip / application / dscp / any convesation.", "schema": { "$ref": "#/components/schemas/NFATextWithBasicSymbols_regex" } }, { "in": "query", "name": "Source", "required": false, "description": "Source ip [optional]. Applicable only if the entiry is conversation", "schema": { "$ref": "#/components/schemas/NFATextWithBasicSymbols_regex" } }, { "in": "query", "name": "Destination", "required": false, "description": "destination ip[optional]. Applicable only if the entiry is conversation", "schema": { "$ref": "#/components/schemas/NFATextWithBasicSymbols_regex" } }, { "in": "query", "name": "SrcPort", "required": false, "description": "source port [optional]. Applicable only if the entiry is conversation", "schema": { "$ref": "#/components/schemas/NFAPort_regex" } }, { "in": "query", "name": "DstPort", "required": false, "description": "Destination port [optional]. Applicable only if the entiry is conversation", "schema": { "$ref": "#/components/schemas/NFAPort_regex" } }, { "in": "query", "name": "Application", "required": false, "description": "Application name [optional]. Applicable only if the entiry is conversation", "schema": { "$ref": "#/components/schemas/NFATextWithBasicSymbols_regex" } }, { "in": "query", "name": "ProtocolName", "required": false, "description": "Protocol name of the particular conversation [optional]. Applicable only if the entiry is conversation", "schema": { "$ref": "#/components/schemas/NFAProtocolName_regex" } }, { "in": "query", "name": "dscpcode", "required": false, "description": " dscp code of the conversation[optional]. Applicable only if the entiry is conversation", "schema": { "$ref": "#/components/schemas/alphanumeric_regex" } }, { "in": "query", "name": "SrcAS", "required": false, "description": "Source AS of the conversation [optional]. Applicable only if the entiry is conversation", "schema": { "$ref": "#/components/schemas/NFA_AS_Number_Minus1_regex" } }, { "in": "query", "name": "DstAS", "required": false, "description": "Destination AS of the conversation [optional]. Applicable only if the entiry is conversation", "schema": { "$ref": "#/components/schemas/NFA_AS_Number_Minus1_regex" } }, { "in": "query", "name": "GroupBy", "required": false, "description": "list conversation group by option . it may Conversation grouping method: 'none', 'application', 'source', 'destination', 'srcdst'(Source and Destination), 'dscp', 'srcas', 'dstas', 'srcdstas'", "schema": { "$ref": "#/components/schemas/only_alphabets_regex" } }, { "in": "query", "name": "Data", "required": false, "description": "A directional filter for the data set. Set to Ingress to retrieve incoming data or Egress to retrieve outgoing data.", "schema": { "$ref": "#/components/schemas/NFAData_regex" } }, { "in": "query", "name": "IPGroup", "required": false, "description": "true - if the selected resource is IPGroups, false for other resource types", "schema": { "$ref": "#/components/schemas/NFABoolean_regex" } }, { "in": "query", "name": "BussView", "required": true, "description": "true - if the selected resource is Interface Groups, false for other resource types", "schema": { "$ref": "#/components/schemas/NFABoolean_regex" } }, { "in": "query", "name": "TimeFrame", "required": false, "description": "Time window to fetch data . Possible time frames : 15minute|30minute|hourly|6hour|daily|today|yesterday|weekly|prevweek|monthly|prevmonth|quarterly|custom", "schema": { "$ref": "#/components/schemas/NFATimeFrame_regex" } }, { "in": "query", "name": "StartTime", "required": false, "description": " Start time of custom time period (only if custom time period is chosen) in YYYY-MM-DD HH:MMformat.", "schema": { "$ref": "#/components/schemas/DateTime_WithoutSeconds_regex" } }, { "in": "query", "name": "EndTime", "required": false, "description": "Start time of custom time period (only if custom time period is chosen) in YYYY-MM-DD HH:MMformat.", "schema": { "$ref": "#/components/schemas/DateTime_WithoutSeconds_regex" } }, { "$ref": "#/components/parameters/NFADEparams_collOpt", "description": "" }, { "in": "query", "name": "eeProbeID", "required": false, "description": "Probe ID to be supplied if the device is accessed from OpManager Central.", "schema": { "type": "integer", "format": "int64", "description": "" } } ], "tags": [ "NFA.Inventory" ], "security": [], "x-zenesis-sections": {}, "x-zenesis-doc": { "show": true }, "x-zenesis-envTags": [] } }, "/api/json/alarm/acknowledgeAlarm": { "post": { "summary": "Acknowledge Alarms", "x-zenesis-title": "Acknowledge Alarms", "security": [ {} ], "x-zenesis-security": {}, "description": "Acknowledges one or more alarms, assigning ownership to the current API user. Requires the entity identifier obtained from listAlarms. Use this to signal that an operator is actively investigating the alarm and prevent duplicate triage by other users. Acknowledged alarms remain in the active alarm view but are flagged with the owner's identity.", "operationId": "acknowledgeAlarm", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "", "properties": { "result": { "type": "object", "description": "", "properties": { "message": { "type": "string", "description": "" } } } } }, "examples": { "Example1": { "value": { "result": { "message": "Alarm has been successfully Acknowledged" } } } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "entity", "required": true, "description": "Entity of the alarm to acknowledge. Obtain this from the listAlarms API response.", "schema": { "$ref": "#/components/schemas/entityText_regex" } } ], "tags": [ "OpManager.Alarms" ], "x-zenesis-sections": {}, "x-zenesis-doc": { "show": true }, "x-zenesis-envTags": [] } }, "/api/json/alarm/getAnnotation": { "get": { "summary": "Get Alarm Notes", "x-zenesis-title": "Get Alarm Notes", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "Retrieves all notes and comments (annotations) associated with a specific alarm, ordered chronologically. Requires the entity identifier obtained from listAlarms. Use this to review investigation history, prior remediation steps, or escalation context before taking further action on the alarm. Returns read-only annotation data; no alarm state is modified by this call.", "operationId": "getAnnotation", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "description": "", "properties": { "notes": { "type": "string", "description": "" }, "modTime": { "type": "integer", "description": "" }, "noteID": { "type": "integer", "description": "" }, "modTimeStr": { "type": "string", "description": "" }, "entity": { "type": "string", "description": "" }, "who": { "type": "string", "description": "" } } }, "description": "" }, "examples": { "Example1": { "value": [ { "notes": "This is file integrity alarm", "modTime": 1769665655079, "noteID": 2, "modTimeStr": "29 Jan 2026 11:17:35 AM IST", "entity": "localhost_FILEINTEGRITY_BLACKLISTED", "who": "admin" }, { "notes": "It is a file integrity alarm", "modTime": 1769665615843, "noteID": 1, "modTimeStr": "29 Jan 2026 11:16:55 AM IST", "entity": "localhost_FILEINTEGRITY_BLACKLISTED", "who": "admin" } ] } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "entity", "required": true, "description": "\u00a0Entity of the alarm for which annotations should be retrieved.\n\n\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 Obtain this from the listAlarms API response.", "schema": { "$ref": "#/components/schemas/entityText_regex" } } ], "tags": [ "OpManager.Alarms" ], "security": [], "x-zenesis-sections": {}, "x-zenesis-doc": { "show": true }, "x-zenesis-envTags": [] } }, "/api/json/nfadevice/getIndexRouterData": { "get": { "summary": "Get All Device List", "x-zenesis-title": "Get All Device List", "x-zenesis-security": {}, "description": " Get all available devices with basic info like device type ,number of interfaces and flow count.", "operationId": "getIndexRouterData", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "properties": { "stdEndTime": { "type": "string", "description": "Standard end time" }, "showCentralMigrationInfo": { "type": "boolean", "description": "Flag to show central migration info" }, "startTime": { "type": "string", "description": "Start time" }, "stdStartTime": { "type": "string", "description": "Standard start time" }, "endTime": { "type": "string", "description": "End time" }, "showCentralMigrationError": { "type": "boolean", "description": "Flag to indicate migration error" }, "DevList": { "type": "array", "description": "List of devices", "items": { "type": "object", "properties": { "MerakiID": { "type": "integer" }, "IntfCount": { "type": "integer" }, "rType": { "type": "integer" }, "unsupportedFlow": { "type": "string" }, "snmpStatus": { "type": "integer" }, "tainted": { "type": "boolean" }, "IP": { "type": "string" }, "PktCount": { "type": "integer" }, "wlcStatus": { "type": "integer" }, "ID": { "type": "integer" }, "clrCode": { "type": "integer" }, "Name": { "type": "string" } } } } } }, "examples": { "Example1": { "value": { "stdEndTime": "2026-04-02 03:32", "showCentralMigrationInfo": false, "DevList": [ { "MerakiID": 0, "IntfCount": 2, "rType": 90, "unsupportedFlow": "", "snmpStatus": 1, "tainted": false, "IP": "10.5.5.1", "PktCount": 11, "wlcStatus": 0, "ID": 50009, "clrCode": 5, "Name": "BranchOffice_PaloAlto" } ], "startTime": "2026-04-02 02:32", "stdStartTime": "2026-04-02 02:32", "endTime": "2026-04-02 03:32", "showCentralMigrationError": false } } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "TimeFrame", "required": false, "description": "", "schema": { "$ref": "#/components/schemas/NFA_Inv_TimeFrames_1_regex" } }, { "in": "query", "name": "advancedFilters", "required": false, "description": "", "schema": { "$ref": "#/components/schemas/advancedFilterJson" } }, { "$ref": "#/components/parameters/NFADEparams_reqFrm", "description": "" }, { "$ref": "#/components/parameters/NFADEparams_TimeZone", "description": "" }, { "in": "query", "name": "searchFilters", "required": false, "description": "", "schema": { "$ref": "#/components/schemas/searchFilterJson" } }, { "$ref": "#/components/parameters/NFADEparams_collOpt", "description": "" } ], "tags": [ "NFA.Inventory" ], "security": [], "x-zenesis-sections": {}, "x-zenesis-doc": { "show": true }, "x-zenesis-envTags": [] } }, "/api/json/nfareports/wlccustomReport": { "get": { "summary": "Search Report for WLC Devices", "x-zenesis-title": "Search Report for WLC Devices", "x-zenesis-security": {}, "description": "Get search report data for Accesspoints", "operationId": "wlccustomReport", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "properties": { "nextPageOUT": { "type": "boolean" }, "nextPageIN": { "type": "boolean" }, "totalIN": { "type": "string" }, "totalOUT": { "type": "string" }, "stdEndTime": { "type": "string" }, "startTime": { "type": "string" }, "stdStartTime": { "type": "string" }, "endTime": { "type": "string" }, "isWLC": { "type": "boolean" }, "Data": { "type": "string", "description": "Type of data (IN/OUT/BOTH)" }, "trafficIN": { "type": "array", "description": "Incoming traffic details", "items": { "type": "object", "properties": { "app": { "type": "string" }, "clientmac": { "type": "string" }, "dscpin": { "type": "string" }, "dscpout": { "type": "string" }, "clientip": { "type": "string" }, "apmac": { "type": "string" }, "devName": { "type": "string" }, "ssid": { "type": "string" }, "traffic": { "type": "string" } } } }, "trafficOUT": { "type": "array", "description": "Outgoing traffic details", "items": { "type": "object", "properties": { "app": { "type": "string" }, "clientmac": { "type": "string" }, "dscpin": { "type": "string" }, "dscpout": { "type": "string" }, "clientip": { "type": "string" }, "apmac": { "type": "string" }, "devName": { "type": "string" }, "ssid": { "type": "string" }, "traffic": { "type": "string" } } } } } }, "examples": { "Example1": { "value": { "nextPageOUT": true, "nextPageIN": true, "totalIN": "36.46 KB", "totalOUT": "42.11 KB", "stdEndTime": "2026-04-02 20:23", "startTime": "2026-04-02 00:00", "stdStartTime": "2026-04-02 00:00", "endTime": "2026-04-02 20:23", "isWLC": true, "Data": "BOTH", "trafficIN": [ { "app": "gmail", "clientmac": "00:1A:2B:3C:4D:5E", "dscpin": "000001", "dscpout": "Default", "clientip": "10.5.5.1", "apmac": "00:1A:2B:3C:4D:5E", "devName": "WirelessController", "ssid": "STAFF", "traffic": "126.00 Bytes" } ], "trafficOUT": [ { "app": "codaauth2", "clientmac": "00:1A:2B:3C:4D:5E", "dscpin": "Default", "dscpout": "Default", "clientip": "10.5.5.1", "apmac": "00:1A:2B:3C:4D:5E", "devName": "WirelessController", "ssid": "ADMIN", "traffic": "126.00 Bytes" } ] } } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "DeviceID", "required": true, "description": "Accesspoint ID's with comma seperated like [\"1\",\"2\"] . \"-1\" to select all accesspoints", "schema": { "$ref": "#/components/schemas/NFA_Source_ID_Minus1_Array" } }, { "in": "query", "name": "ReportType", "required": true, "description": "Report type for the wireless devices : custom", "schema": { "$ref": "#/components/schemas/custom_regex" } }, { "in": "query", "name": "Data", "required": false, "description": "A directional filter for the data set. Set to Ingress to retrieve incoming data or Egress to retrieve outgoing data.", "schema": { "$ref": "#/components/schemas/NFAData_regex" } }, { "in": "query", "name": "Oper", "required": false, "description": "Criteria combination type . will use this when we have more than one criteria. [OR / AND]", "schema": { "$ref": "#/components/schemas/NFALogic_regex" } }, { "in": "query", "name": "ResolveDNS", "required": false, "description": "true - to get host names instead of IP", "schema": { "$ref": "#/components/schemas/NFABoolean_regex" } }, { "in": "query", "name": "rows", "required": false, "description": "Defines the maximum number of data entries displayed per page.", "schema": { "$ref": "#/components/schemas/NFA_CustomPager_Rows_regex" } }, { "in": "query", "name": "pageCount", "required": false, "description": "Specifies the page number of the results to retrieve.", "schema": { "$ref": "#/components/schemas/NFA_CustomPager_Page_regex" } }, { "in": "query", "name": "rowsIN", "required": false, "description": "Get Number of rows per page", "schema": { "$ref": "#/components/schemas/NFA_CustomPager_Rows_regex" } }, { "in": "query", "name": "rowsOUT", "required": false, "description": "Get Number of rows per page", "schema": { "$ref": "#/components/schemas/NFA_CustomPager_Rows_regex" } }, { "in": "query", "name": "pageCountIN", "required": false, "description": "Get Nth page of the result", "schema": { "$ref": "#/components/schemas/NFA_CustomPager_Page_regex" } }, { "in": "query", "name": "pageCountOUT", "required": false, "description": "Get Nth page of the result", "schema": { "$ref": "#/components/schemas/NFA_CustomPager_Page_regex" } }, { "in": "query", "name": "Criteria", "required": false, "description": "Get report based on particular criteria. we can have SSID, Clientip, cient mac, Application, pre DSCP,post dscp", "schema": { "$ref": "#/components/schemas/WLC_Search_Report_Criteria_List" } }, { "$ref": "#/components/parameters/NFA_Reports_Time_Params_TimeFrame", "description": "Specifies the period of time for which you want to retrieve data (e.g., last_hour, 6_hours).Possible time frames : 15minute|30minute|hourly|6hour|daily|today|yesterday|weekly|prevweek|monthly|prevmonth|quarterly|custom" }, { "$ref": "#/components/parameters/NFA_Reports_Time_Params_StartTime", "description": "Start time of custom time period (only if custom time period is chosen) in YYYY-MM-DD HH:MMformat." }, { "$ref": "#/components/parameters/NFA_Reports_Time_Params_EndTime", "description": "End time of custom time period (only if custom time period is chosen) in YYYY-MM-DD HH:MMformat." }, { "$ref": "#/components/parameters/NFADEparams_collOpt", "description": "" }, { "in": "query", "name": "eeProbeID", "required": false, "description": "Probe ID to be supplied if the device is accessed from OpManager Central.", "schema": { "type": "integer", "format": "int64", "description": "" } } ], "tags": [ "NFA.Reports" ], "security": [], "x-zenesis-sections": {}, "x-zenesis-doc": { "show": true }, "x-zenesis-envTags": [] } }, "/api/json/v2/nfadevice/getDSCPTosData": { "get": { "summary": "Interface DSCP Data", "x-zenesis-title": "Interface DSCP Data", "x-zenesis-security": {}, "description": " Get NFA DSCP/ToS/DSCP Group Traffic Data", "operationId": "getDSCPTosData", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "properties": { "IPType": { "type": "string", "description": "Type of IP filter" }, "TimeZone": { "type": "string" }, "stdEndTime": { "type": "string" }, "startTime": { "type": "string" }, "stdStartTime": { "type": "string" }, "endTime": { "type": "string" }, "nextPage": { "type": "boolean" }, "result": { "type": "array", "description": "DSCP traffic distribution", "items": { "type": "object", "properties": { "volume": { "type": "string" }, "dscpCode": { "type": "string" }, "octets": { "type": "integer" }, "Name": { "type": "string" }, "traffic": { "type": "string", "description": "Percentage of traffic" } } } }, "devDetails": { "type": "object", "description": "Device details", "properties": { "hdrTitle": { "type": "string" }, "Type": { "type": "string" }, "Total": { "type": "string" }, "RouterIP": { "type": "string" }, "Name": { "type": "string" } } } } }, "examples": { "Example1": { "value": { "IPType": "ALL", "TimeZone": "America/New_York", "stdEndTime": "2026-04-02 20:34", "startTime": "2026-04-02 19:34", "stdStartTime": "2026-04-02 19:34", "endTime": "2026-04-02 20:34", "nextPage": false, "result": [ { "volume": "17.00 KB", "dscpCode": "12", "octets": 17000, "Name": "AF12", "traffic": "26.56 %" } ], "devDetails": { "hdrTitle": "10.5.5.1 ( Gigabit Ethernet 0/0 )", "Type": "DSCPIN", "Total": "64.00 KB", "RouterIP": "10.5.5.1", "Name": "Gigabit Ethernet 0/0" } } } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "DeviceID", "required": true, "description": "single unique Resource ID. Here resource may be interface, ipgroup, interface group ", "schema": { "$ref": "#/components/schemas/NFA_Source_ID_regex" } }, { "in": "query", "name": "Type", "required": false, "description": "Type of dscp data's like DSCP /TOS / Grp", "schema": { "$ref": "#/components/schemas/only_alphabets_regex" } }, { "in": "query", "name": "showapp", "required": false, "description": "true - To get application traffic for each dscp.", "schema": { "$ref": "#/components/schemas/NFABoolean_regex" } }, { "in": "query", "name": "Data", "required": true, "description": "A directional filter for the data set. Set to Ingress to retrieve incoming data or Egress to retrieve outgoing data.", "schema": { "$ref": "#/components/schemas/NFAData_regex" } }, { "in": "query", "name": "IPGroup", "required": false, "description": "true - if the selected resource is IPGroups, false for other resource types", "schema": { "$ref": "#/components/schemas/NFABoolean_regex" } }, { "in": "query", "name": "BussView", "required": false, "description": "true - if the selected resource is Interface Groups, false for other resource types", "schema": { "$ref": "#/components/schemas/NFABoolean_regex" } }, { "in": "query", "name": "TimeFrame", "required": false, "description": "Specifies the period of time for which you want to retrieve data (e.g., last_hour, 6_hours).Possible time frames : 15minute|30minute|hourly|6hour|daily|today|yesterday|weekly|prevweek|monthly|prevmonth|quarterly|custom", "schema": { "$ref": "#/components/schemas/NFATimeFrame_regex" } }, { "in": "query", "name": "StartTime", "required": false, "description": "Start time of custom time period (only if custom time period is chosen) in YYYY-MM-DD HH:MMformat.", "schema": { "$ref": "#/components/schemas/DateTime_WithoutSeconds_regex" } }, { "in": "query", "name": "EndTime", "required": false, "description": " End time of custom time period (only if custom time period is chosen) in YYYY-MM-DD HH:MMformat.", "schema": { "$ref": "#/components/schemas/DateTime_WithoutSeconds_regex" } }, { "$ref": "#/components/parameters/NFADEparams_collOpt", "description": "" }, { "in": "query", "name": "eeProbeID", "required": false, "description": "Probe ID to be supplied if the device is accessed from OpManager Central.", "schema": { "type": "integer", "format": "int64", "description": "" } } ], "tags": [ "NFA.Inventory" ], "security": [], "x-zenesis-sections": {}, "x-zenesis-doc": { "show": true }, "x-zenesis-envTags": [] } }, "/api/json/nfadevice/getConvData": { "get": { "summary": "Interface Conversation Data", "x-zenesis-title": "Interface Conversation Data", "x-zenesis-security": {}, "description": "Get Conversation data which has source ip , destination IP,port , protocol, Application name , Dscp, Traffic volume and AS data's", "operationId": "getConvData", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "properties": { "IPType": { "type": "string" }, "Type": { "type": "string", "description": "Conversation type (IN/OUT)" }, "TimeZone": { "type": "string" }, "stdEndTime": { "type": "string" }, "startTime": { "type": "string" }, "stdStartTime": { "type": "string" }, "endTime": { "type": "string" }, "nextPage": { "type": "boolean" }, "fromRaw": { "type": "boolean" }, "devDetails": { "type": "object", "properties": { "hdrTitle": { "type": "string" }, "Type": { "type": "string" }, "RouterIP": { "type": "string" }, "Name": { "type": "string" } } }, "Data": { "type": "array", "description": "Conversation traffic details", "items": { "type": "object", "properties": { "app": { "type": "string" }, "src": { "type": "string" }, "dst": { "type": "string" }, "srcport": { "type": "string" }, "dstport": { "type": "string" }, "port": { "type": "string" }, "prot": { "type": "string" }, "dscp": { "type": "string" }, "dscpCode": { "type": "string" }, "traffic": { "type": "string" }, "AvgSpd": { "type": "string" }, "srcAS": { "type": "string" }, "dstAS": { "type": "string" }, "srcASName": { "type": "string" }, "dstASName": { "type": "string" } } } } } }, "examples": { "Example1": { "value": { "IPType": "ALL", "Type": "ConversationIN", "TimeZone": "America/New_York", "stdEndTime": "2026-04-02 20:47", "startTime": "2026-04-02 19:47", "stdStartTime": "2026-04-02 19:47", "endTime": "2026-04-02 20:47", "nextPage": true, "fromRaw": false, "devDetails": { "hdrTitle": "10.5.5.1 ( Gigabit Ethernet 0/0 )", "Type": "ConversationIN", "RouterIP": "10.5.5.1", "Name": "Gigabit Ethernet 0/0" }, "Data": [ { "app": "Mail Service", "src": "10.5.5.1", "dst": "10.5.5.1", "srcport": "1", "dstport": "9", "port": "1", "prot": "TCP", "dscp": "CS1", "dscpCode": "8", "traffic": "1.00 KB", "AvgSpd": "Any", "srcAS": "4", "dstAS": "9", "srcASName": "ISI-AS", "dstASName": "CMU-ROUTER" } ] } } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "DeviceID", "required": false, "description": "single unique Resource ID. Here resource may be interface, ipgroup, interface group.", "schema": { "$ref": "#/components/schemas/NFA_Source_ID_regex" } }, { "in": "query", "name": "IPGroup", "required": false, "description": "true - if the selected resource is IPGroups, false for other resource types", "schema": { "$ref": "#/components/schemas/NFABoolean_regex" } }, { "in": "query", "name": "BussView", "required": false, "description": "true - if the selected resource is Interface Groups, false for other resource types", "schema": { "$ref": "#/components/schemas/NFABoolean_regex" } }, { "in": "query", "name": "IPType", "required": false, "description": "IP Version filter .\nALL - list both v4 and v6 traffic.\nV4 - list only ipv4 traffic.\nV6 - list only IPV6 traffic.", "schema": { "type": "string", "pattern": "^(ALL|V4|V6)$", "description": "" } }, { "in": "query", "name": "GroupBy", "required": false, "description": "Grouping the conversation based on 'none', 'application', 'source', 'destination', 'srcdst'(Source and Destination), 'dscp', 'srcas', 'dstas', 'srcdstas'(Source and Destination AS). Controls how conversation data is aggregated. By default 'none'", "schema": { "$ref": "#/components/schemas/only_alphabets_regex" } }, { "in": "query", "name": "isNetwork", "required": false, "description": "true - to get Network data's instead of individual IP.", "schema": { "$ref": "#/components/schemas/NFABoolean_regex" } }, { "in": "query", "name": "ResolveDNS", "required": false, "description": " true - to get host names instead of IP", "schema": { "$ref": "#/components/schemas/NFAResolveDNS_regex" } }, { "in": "query", "name": "Data", "required": true, "description": "A directional filter for the data set. Set to Ingress to retrieve incoming data or Egress to retrieve outgoing data.", "schema": { "$ref": "#/components/schemas/NFAData_regex" } }, { "in": "query", "name": "TimeFrame", "required": false, "description": "Specifies the period of time for which you want to retrieve data (e.g., last_hour, 6_hours).Possible time frames : 15minute|30minute|hourly|6hour|daily|today|yesterday|weekly|prevweek|monthly|prevmonth|quarterly|custom", "schema": { "$ref": "#/components/schemas/NFATimeFrame_regex" } }, { "in": "query", "name": "StartTime", "required": false, "description": "Start time of custom time period (only if custom time period is chosen) in YYYY-MM-DD HH:MMformat.", "schema": { "$ref": "#/components/schemas/DateTime_WithoutSeconds_regex" } }, { "in": "query", "name": "EndTime", "required": false, "description": " End time of custom time period (only if custom time period is chosen) in YYYY-MM-DD HH:MMformat.", "schema": { "$ref": "#/components/schemas/DateTime_WithoutSeconds_regex" } }, { "$ref": "#/components/parameters/NFADEparams_collOpt", "description": "" }, { "in": "query", "name": "eeProbeID", "required": false, "description": "Probe ID to be supplied if the device is accessed from OpManager Central.", "schema": { "type": "integer", "format": "int64", "description": "" } } ], "tags": [ "NFA.Inventory" ], "security": [], "x-zenesis-sections": {}, "x-zenesis-doc": { "show": true }, "x-zenesis-envTags": [] } }, "/api/json/alarm/unAcknowledgeAlarm": { "post": { "summary": "Unacknowledge Alarms", "x-zenesis-title": "Unacknowledge Alarms", "security": [ {} ], "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "Removes the acknowledgement from one or more previously acknowledged alarms, releasing owner assignment. Requires the entity identifier obtained from listAlarms. Use this when the original investigator is unable to continue or when the alarm needs to be re-triaged by a different operator. The alarm returns to the unacknowledged queue and becomes visible for pickup by any user with alarm access.", "operationId": "unAcknowledgeAlarm", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "", "properties": { "result": { "type": "object", "description": "", "properties": { "message": { "type": "string", "description": "" } } } } }, "examples": { "Example1": { "value": { "result": { "message": "Alarm has been successfully UnAcknowledged" } } } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "entity", "required": true, "description": "Entity of the alarm to unacknowledge. Obtain this from the listAlarms API response.", "schema": { "$ref": "#/components/schemas/entityText_regex" } } ], "tags": [ "OpManager.Alarms" ], "x-zenesis-sections": {}, "x-zenesis-doc": { "show": true }, "x-zenesis-envTags": [] } }, "/api/json/v2/nfadevice/getTrafficData": { "get": { "summary": "Interface Traffic Data", "x-zenesis-title": "Interface Traffic Data", "x-zenesis-security": {}, "description": "Get Inbound and outbound traffic data's", "operationId": "getTrafficData", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "properties": { "stdEndTime": { "type": "string" }, "stdStartTime": { "type": "string" }, "startTime": { "type": "string" }, "endTime": { "type": "string" }, "TimeZone": { "type": "string" }, "granularity": { "type": "string" }, "yAxis": { "type": "string" }, "name": { "type": "string" }, "thresholdText": { "type": "array", "items": { "type": "string" } }, "thresholdLine": { "type": "array", "items": { "type": "string" } }, "TrafficData": { "type": "array", "description": "Time-based traffic table", "items": { "type": "object", "properties": { "Time": { "type": "string" }, "IN": { "type": "string" }, "OUT": { "type": "string" }, "inBytes": { "type": "string" }, "outBytes": { "type": "string" } } } }, "GraphData": { "type": "array", "description": "Graph series data", "items": { "type": "object", "properties": { "seriesname": { "type": "string" }, "data": { "type": "array", "items": { "type": "array", "items": { "type": "number" } } }, "yaxiscolumnorder": { "type": "array", "items": { "type": "integer" } } } } }, "Data": { "type": "object", "description": "Summary and device details", "properties": { "hdrTitle": { "type": "string" }, "routerName": { "type": "string" }, "RouterID": { "type": "string" }, "RouterIP": { "type": "string" }, "Name": { "type": "string" }, "TimeZone": { "type": "string" }, "granularity": { "type": "string" }, "showGranularity": { "type": "boolean" }, "startTime": { "type": "string" }, "endTime": { "type": "string" }, "trafficdata": { "type": "array", "items": { "type": "object", "properties": { "traffic": { "type": "string" }, "total": { "type": "string" }, "avg": { "type": "string" }, "min": { "type": "string" }, "max": { "type": "string" }, "std": { "type": "string" }, "95th": { "type": "string" } } } } } } } }, "examples": { "Example1": { "value": { "stdEndTime": "2026-04-02 21:01", "stdStartTime": "2026-04-02 20:46", "startTime": "2026-04-02 20:46", "endTime": "2026-04-02 21:01", "TimeZone": "America/New_York", "granularity": "1 Minute Average", "yAxis": "bps", "name": "Gigabit Ethernet 0/0", "thresholdText": [ "", "" ], "thresholdLine": [ "-", "-" ], "TrafficData": [ { "Time": "2026-04-02 21:00", "IN": "133.33 bps", "OUT": "133.33 bps", "inBytes": "1000.0", "outBytes": "1000.0" } ], "GraphData": [ { "seriesname": "IN", "data": [ [ 1775177160000, 133.33 ] ], "yaxiscolumnorder": [ 0 ] } ], "Data": { "hdrTitle": "10.5.5.1 ( Gigabit Ethernet 0/0 )", "routerName": "BranchOffice_PaloAlto", "RouterID": "50009", "RouterIP": "10.5.5.1", "Name": "Gigabit Ethernet 0/0", "TimeZone": "America/New_York", "granularity": "1 min", "showGranularity": true, "startTime": "2026-04-02 20:46", "endTime": "2026-04-02 21:01", "trafficdata": [ { "traffic": "Traffic IN", "total": "15.00 KB", "avg": "125.00 bps", "min": "133.33 bps", "max": "133.33 bps", "std": "8.33 bps", "95th": "0.00 bps" } ] } } } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "DeviceID", "required": true, "description": "single unique Resource ID. Here resource may be interface, ipgroup, interface group ", "schema": { "$ref": "#/components/schemas/NFA_Source_ID_regex" } }, { "in": "query", "name": "IPGroup", "required": false, "description": "true - if the selected resource is IPGroups, false for other resource types", "schema": { "$ref": "#/components/schemas/NFABoolean_regex" } }, { "in": "query", "name": "BussView", "required": false, "description": "true - if the selected resource is Interface Groups, false for other resource types", "schema": { "$ref": "#/components/schemas/NFABoolean_regex" } }, { "in": "query", "name": "TimeFrame", "required": false, "description": "Specifies the period of time for which you want to retrieve data (e.g., last_hour, 6_hours).Possible time frames : 15minute|30minute|hourly|6hour|daily|today|yesterday|weekly|prevweek|monthly|prevmonth|quarterly|custom", "schema": { "$ref": "#/components/schemas/NFATimeFrame_regex" } }, { "in": "query", "name": "StartTime", "required": false, "description": "Start time of custom time period (only if custom time period is chosen) in YYYY-MM-DD HH:MMformat.", "schema": { "$ref": "#/components/schemas/DateTime_WithoutSeconds_regex" } }, { "in": "query", "name": "EndTime", "required": false, "description": " End time of custom time period (only if custom time period is chosen) in YYYY-MM-DD HH:MMformat.", "schema": { "$ref": "#/components/schemas/DateTime_WithoutSeconds_regex" } }, { "$ref": "#/components/parameters/NFADEparams_collOpt", "description": "" }, { "in": "query", "name": "eeProbeID", "required": false, "description": "Probe ID to be supplied if the device is accessed from OpManager Central.", "schema": { "type": "integer", "format": "int64", "description": "" } } ], "tags": [ "NFA.Inventory" ], "security": [], "x-zenesis-sections": {}, "x-zenesis-doc": { "show": true }, "x-zenesis-envTags": [] } }, "/api/json/nfadevice/getSourceData": { "get": { "summary": "Interface Source Data", "x-zenesis-title": "Interface Source Data", "x-zenesis-security": {}, "description": "Get traffic data's based on Source IP.", "operationId": "getSourceData", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "properties": { "IPType": { "type": "string", "description": "Type of IP filter" }, "TimeZone": { "type": "string" }, "stdEndTime": { "type": "string" }, "startTime": { "type": "string" }, "stdStartTime": { "type": "string" }, "endTime": { "type": "string" }, "nextPage": { "type": "boolean" }, "result": { "type": "array", "description": "Traffic distribution by IP", "items": { "type": "object", "properties": { "ip": { "type": "string" }, "Name": { "type": "string" }, "volume": { "type": "string" }, "octets": { "type": "integer" }, "traffic": { "type": "string", "description": "Percentage of traffic" } } } }, "devDetails": { "type": "object", "description": "Device details", "properties": { "hdrTitle": { "type": "string" }, "Type": { "type": "string" }, "Total": { "type": "string" }, "RouterIP": { "type": "string" }, "Name": { "type": "string" } } } } }, "examples": { "Example1": { "value": { "IPType": "ALL", "TimeZone": "America/New_York", "stdEndTime": "2026-04-02 21:09", "startTime": "2026-04-02 20:39", "stdStartTime": "2026-04-02 20:39", "endTime": "2026-04-02 21:09", "nextPage": false, "result": [ { "ip": "", "Name": "10.5.5.1", "volume": "1.00 KB", "octets": 1000, "traffic": "2.56 %" } ], "devDetails": { "hdrTitle": "10.5.5.1 ( Gigabit Ethernet 0/0 )", "Type": "SourceIN", "Total": "39.00 KB", "RouterIP": "10.5.5.1", "Name": "Gigabit Ethernet 0/0" } } } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "DeviceID", "required": false, "description": "single unique Resource ID. Here resource may be interface, ipgroup, interface group.", "schema": { "$ref": "#/components/schemas/NFA_Source_ID_regex" } }, { "in": "query", "name": "IPGroup", "required": false, "description": "true - if the selected resource is IPGroups, false for other resource types", "schema": { "$ref": "#/components/schemas/NFABoolean_regex" } }, { "in": "query", "name": "BussView", "required": false, "description": "true - if the selected resource is Interface Groups, false for other resource types", "schema": { "$ref": "#/components/schemas/NFABoolean_regex" } }, { "in": "query", "name": "IPType", "required": false, "description": "IP Version filter .\nALL - list both v4 and v6 traffic.\nV4 - list only ipv4 traffic.\nV6 - list only IPV6 traffic.", "schema": { "type": "string", "pattern": "^(ALL|V4|V6)$", "description": "" } }, { "in": "query", "name": "GroupBy", "required": false, "description": "Grouping the conversation based on 'none', 'application', 'source', 'destination', 'srcdst'(Source and Destination), 'dscp', 'srcas', 'dstas', 'srcdstas'(Source and Destination AS). Controls how conversation data is aggregated. By default 'none'", "schema": { "$ref": "#/components/schemas/only_alphabets_regex" } }, { "in": "query", "name": "isNetwork", "required": false, "description": "true - to get Network data's instead of individual IP.", "schema": { "$ref": "#/components/schemas/NFABoolean_regex" } }, { "in": "query", "name": "ResolveDNS", "required": false, "description": " true - to get host names instead of IP", "schema": { "$ref": "#/components/schemas/NFAResolveDNS_regex" } }, { "in": "query", "name": "Data", "required": true, "description": "A directional filter for the data set. Set to Ingress to retrieve incoming data or Egress to retrieve outgoing data.", "schema": { "$ref": "#/components/schemas/NFAData_regex" } }, { "in": "query", "name": "TimeFrame", "required": false, "description": "Specifies the period of time for which you want to retrieve data (e.g., last_hour, 6_hours).Possible time frames : 15minute|30minute|hourly|6hour|daily|today|yesterday|weekly|prevweek|monthly|prevmonth|quarterly|custom", "schema": { "$ref": "#/components/schemas/NFATimeFrame_regex" } }, { "in": "query", "name": "StartTime", "required": false, "description": "Start time of custom time period (only if custom time period is chosen) in YYYY-MM-DD HH:MMformat.", "schema": { "$ref": "#/components/schemas/DateTime_WithoutSeconds_regex" } }, { "in": "query", "name": "EndTime", "required": false, "description": " End time of custom time period (only if custom time period is chosen) in YYYY-MM-DD HH:MMformat.", "schema": { "$ref": "#/components/schemas/DateTime_WithoutSeconds_regex" } }, { "$ref": "#/components/parameters/NFADEparams_collOpt", "description": "" }, { "in": "query", "name": "eeProbeID", "required": false, "description": "Probe ID to be supplied if the device is accessed from OpManager Central.", "schema": { "type": "integer", "format": "int64", "description": "" } } ], "tags": [ "NFA.Inventory" ], "security": [], "x-zenesis-sections": {}, "x-zenesis-doc": { "show": true }, "x-zenesis-envTags": [] } }, "/api/json/nfadevice/listApGroupIcons": { "get": { "summary": "List Access Point Groups", "x-zenesis-title": "List Access Point Groups", "x-zenesis-security": {}, "description": "Lists all access point groups configured in Flow analysis module", "operationId": "listApGroupIcons", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "properties": { "stdEndTime": { "type": "string" }, "startTime": { "type": "string" }, "stdStartTime": { "type": "string" }, "endTime": { "type": "string" }, "traffic": { "type": "array", "description": "Traffic details per entity", "items": { "type": "object", "properties": { "ID": { "type": "integer" }, "Name": { "type": "string" }, "inTraffic": { "type": "string" }, "outTraffic": { "type": "string" }, "inSpeed": { "type": "string" }, "outSpeed": { "type": "string" }, "SuppressedDetails": { "type": "object", "description": "Additional suppressed details (if any)", "additionalProperties": true } } } } } }, "examples": { "Example1": { "value": { "stdEndTime": "2026-04-02 21:15", "startTime": "2026-04-02 20:15", "stdStartTime": "2026-04-02 20:15", "endTime": "2026-04-02 21:15", "traffic": [ { "ID": 2500014, "Name": "WiFi First Floor", "inTraffic": "253.00 Bytes", "outTraffic": "590.00 Bytes", "inSpeed": "0.07 bps", "outSpeed": "0.16 bps", "SuppressedDetails": {} } ] } } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "TimeFrame", "required": false, "description": "Specifies the period of time for which you want to retrieve data (e.g., last_hour, 6_hours).Possible time frames : 15minute|30minute|hourly|6hour|daily|today|yesterday|weekly|prevweek|monthly|prevmonth|quarterly|custom", "schema": { "$ref": "#/components/schemas/NFATimeFrame_regex" } }, { "$ref": "#/components/parameters/NFADEparams_collOpt", "description": "" }, { "in": "query", "name": "eeProbeID", "required": false, "description": "Probe ID to be supplied if the device is accessed from OpManager Central.", "schema": { "type": "integer", "format": "int64", "description": "" } } ], "tags": [ "NFA.WLC" ], "security": [], "x-zenesis-sections": {}, "x-zenesis-doc": { "show": true }, "x-zenesis-envTags": [] } }, "/api/json/v2/device/getReportData": { "post": { "summary": "Graphical Reports - Get Data", "x-zenesis-title": "Graphical Reports - Get Data", "security": [ {} ], "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "Analyzes key performance metrics and KPIs across infrastructure with customizable metrics, time ranges, and aggregation methods. Provides time-series data for dashboards, supporting Top/Bottom-N comparisons or device-specific analysis for troubleshooting. Used for custom performance insights and bottleneck detection; use GetReportData API for standardized reports.", "operationId": "getReportData", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": {}, "examples": { "Example1": { "value": { "individualGraphs": [ { "instanceCountPerMonitor": 1, "graphs": [ { "seriesname": "Packet Loss", "data": [ [ 1769671800000, 0, "", "Packet Loss" ] ] } ], "policyName": "Packet_Loss", "monitorName": "Packet Loss", "entityMoid": "301", "consolidatedValues": [ { "95thpercentileValue": "0", "maxVal": "0", "minVal": "0", "seriesName": "Packet Loss", "avgVal": "0" } ], "deviceMoName": "", "deviceName": "", "yAxisText": "Percentage" }, { "instanceCountPerMonitor": 1, "graphs": [ { "seriesname": "", "data": [ [ 1769671800000, 100, "", "DevicesAvailability" ] ] } ], "policyName": "DevicesAvailability", "monitorName": "DevicesAvailability - Percentage", "entityMoid": "301", "deviceMoName": "", "deviceName": "", "yAxisText": "Percentage" }, { "instanceCountPerMonitor": 1, "graphs": [ { "seriesname": "Packet Loss", "data": [ [ 1769671800000, 0, "", "Packet Loss" ] ] } ], "policyName": "Packet_Loss", "monitorName": "Packet Loss", "entityMoid": "303", "consolidatedValues": [ { "95thpercentileValue": "0", "maxVal": "0", "minVal": "0", "seriesName": "Packet Loss", "avgVal": "0" } ], "deviceMoName": "", "deviceName": "", "yAxisText": "Percentage" }, { "instanceCountPerMonitor": 1, "graphs": [ { "seriesname": "", "data": [ [ 1769671800000, 100, "", "DevicesAvailability" ] ] } ], "policyName": "DevicesAvailability", "monitorName": "DevicesAvailability - Percentage", "entityMoid": "303", "deviceMoName": "", "deviceName": "", "yAxisText": "Percentage" }, { "instanceCountPerMonitor": 1, "graphs": [ { "seriesname": "", "data": [ [ 1769628600000, 100, "", "DevicesAvailability" ], [ 1769632200000, 100, "", "DevicesAvailability" ], [ 1769635800000, 100, "", "DevicesAvailability" ], [ 1769639400000, 100, "", "DevicesAvailability" ], [ 1769643000000, 100, "", "DevicesAvailability" ], [ 1769646600000, 100, "", "DevicesAvailability" ], [ 1769650200000, 100, "", "DevicesAvailability" ], [ 1769653800000, 100, "", "DevicesAvailability" ] ] } ], "policyName": "DevicesAvailability", "monitorName": "DevicesAvailability - Percentage", "entityMoid": "2", "deviceMoName": "", "deviceName": "", "yAxisText": "Percentage" }, { "instanceCountPerMonitor": 1, "graphs": [ { "seriesname": "Packet Loss", "data": [] } ], "policyName": "Packet_Loss", "monitorName": "Packet Loss", "entityMoid": "2", "consolidatedValues": [ { "95thpercentileValue": "0", "maxVal": "0", "minVal": "0", "seriesName": "Packet Loss", "avgVal": "0" } ], "deviceMoName": "", "deviceName": "", "yAxisText": "Percentage" } ] } } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "deviceMOIDList", "required": true, "description": "Filter performance report by device identifiers. Use comma-separated device identifier list from List Devices API response (use the 'moid' field values) for device-specific graphs. Use when generating graphs for specific devices only.Required when graphReportType is 'Individual'. When provided, rangeType and showOnly parameters must not be included.", "schema": { "$ref": "#/components/schemas/numberWithComma_regex" } }, { "in": "query", "name": "monitorList", "required": true, "description": "Select which performance metrics/monitors to analyze. Use comma-separated policy names obtained from fetchMonitorsList API to specify which performance metrics to include in the analysis. For multiple metrics, use comma-separated values (e.g., 'CPU_Utilization,Memory_Utilization,Disk_Usage' for comprehensive device performance analysis).", "schema": { "type": "string", "description": "" } }, { "in": "query", "name": "timePeriod", "required": true, "description": "Filter report by time period identifier for data range. Use standard time period values for consistent reporting intervals. Available values: 'onehour' (last 1 hour), 'twohours' (last 2 hours), 'fourhours' (last 4 hours), 'sixhours' (last 6 hours), 'eighthours' (last 8 hours), 'twelvehours' (last 12 hours), 'twfourhours' (last 24 hours), 'Today' (from 00:00 to current time today), 'Yesterday' (from 00:00 to 23:59 of previous day), 'Last_7_Days' (last 7 days), 'Last_30_Days' (last 30 days), 'Last_60_Days' (last 60 days), 'Last_90_Days' (last 90 days), 'thisweek' (current week), 'thismonth' (current month from 1st to today), 'This_Quarter' (current quarter), 'lastweek' (previous week), 'Last_Month' (previous complete month), 'Last_3_Months' (last 3 months), 'Last_6_Months' (last 6 months), 'Last_Quarter' (previous complete quarter), 'custom'(Custom Time Period).", "schema": { "$ref": "#/components/schemas/timePeriod_regex" } }, { "in": "query", "name": "startDate", "required": false, "description": "The start date from which the data need to be shown in Report (only if custom time period is selected) in YYYY-MM-DD format.", "schema": { "$ref": "#/components/schemas/date_regex" } }, { "in": "query", "name": "startHour", "required": false, "description": "The hour of the start date from which the data need to be shown in Report (only if custom time period is selected).", "schema": { "type": "integer", "description": "" } }, { "in": "query", "name": "endDate", "required": false, "description": "The end date up to which the data need to be shown in Report (only if custom time period is selected) in YYYY-MM-DD format.", "schema": { "$ref": "#/components/schemas/date_regex" } }, { "in": "query", "name": "endHour", "required": false, "description": "The hour of the end date up to which the data need to be shown in Report (only if custom time period is selected).", "schema": { "type": "integer", "description": "" } }, { "in": "query", "name": "timeWindow", "required": true, "description": "The time window to fetch the report data. '0-24' (Full 24 Hours), '8-20' (8:00 AM - 8:00 PM).", "schema": { "type": "string", "pattern": "^((\\d|1[0-9]|2[0-4])-(\\d|1[0-9]|2[0-4]))$", "description": "" } }, { "in": "query", "name": "view", "required": true, "description": "Formats to view the report [Allowed values : graph].", "schema": { "type": "string", "pattern": "^(table|graph|tile)$", "description": "" } }, { "in": "query", "name": "tableView", "required": false, "description": "Decides Table view is based on instance or monitors or device name or interface [Allowed values : instance, monitor, monitors, interface].", "schema": { "$ref": "#/components/schemas/SMR_TableView_regex" } }, { "in": "query", "name": "rangeType", "required": false, "description": "Range specification for Top-N or Bottom-N reporting. Use 1 for highest/top values, 2 for lowest/bottom values. Required for Top-N/Bottom-N analysis. Required when graphReportType is 'Summary'. Mandatory when deviceMOIDList is not provided. Must not be used when deviceMOIDList is specified.", "schema": { "type": "integer", "description": "" } }, { "in": "query", "name": "showOnly", "required": false, "description": "Filter number of results to display in Top-N or Bottom-N reports. Use numeric value to specify how many top or bottom performers to include in comparative analysis for focused performance reviews. Required for Top-N/Bottom-N analysis.Required when graphReportType is 'Summary'. Mandatory when deviceMOIDList is not provided. Must not be used when deviceMOIDList is specified.", "schema": { "type": "integer", "description": "" } }, { "in": "query", "name": "graphReportType", "required": true, "description": "Graph report category for formatting and display options. Use 'Summary' for aggregated Top-N/Bottom-N analysis across all devices, or 'Individual' for device-specific graphs showing detailed performance metrics of individual monitors for particular devices.", "schema": { "$ref": "#/components/schemas/SMR_graphReportType_regex" } }, { "in": "query", "name": "bhRuleId", "required": false, "description": "ID of the previously created business rule, used to filter data within specific business hours. MUST first call scheduleReportDefaultProps API to get current available business rule, then use the exact values from the API response to filter by business rule.", "schema": { "type": "integer", "description": "" } }, { "in": "query", "name": "isBusinessHour", "required": false, "description": "Boolean value that should be set to true when the report is filtered by businessRuleID.", "schema": { "type": "boolean", "description": "" } }, { "in": "query", "name": "seriesType", "required": true, "description": "Data aggregation method for time series. Use 'AVG' for average values, 'MAX' for peak values, or 'MIN' for minimum values over time periods.", "schema": { "$ref": "#/components/schemas/SMR_SeriesType_regex" } } ], "tags": [ "OpManager.Reports" ], "x-zenesis-sections": {}, "x-zenesis-doc": { "show": true }, "x-zenesis-envTags": [] } }, "/api/json/device/getDeviceSummary": { "get": { "summary": "Get Device Summary", "x-zenesis-security": { "duration": "1M", "threshold": "50", "lock-period": "1M" }, "description": "Retrieves device summary and snapshot information including current status, monitoring configuration, availability and device properties such as IP address, MAC address, DNS name, and related metadata.\nIf name is not provided, the managed object name can be resolved from the ip parameter. Additional parameters such as snapType, virtualEntity, entity, eeProbeID, selCustomerID, and regionID influence the lookup context and the shape of the returned snapDetails.", "operationId": "getDeviceSummary", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDeviceSummaryResponse" }, "examples": { "Example1": { "value": { "name": "router-01", "ipAddress": "10.5.5.1", "category": "Router", "displayName": "Router 01", "snapDetails": {}, "status": "5" } } } } } }, "400": { "description": "Invalid parameter value.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "User is not authorized to view this device.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "name", "required": true, "description": "Unique name for the device assigned by OpManager. This is the primary device identifier.", "schema": { "type": "string", "maxLength": 100, "examples": [ "switch-10.5.5.1" ], "description": "" } }, { "in": "query", "name": "ip", "required": false, "description": "IPv4 address of the device. Used as a fallback when name is not provided.", "schema": { "type": "string", "format": "ipv4", "examples": [ "10.5.5.1" ], "description": "" } }, { "in": "query", "name": "snapType", "required": false, "description": "Determines the snapshot type and provides response under snapDetails. Use MonitoringDevice for an OpManager device snapshot.", "schema": { "type": "string", "maxLength": 100, "description": "" } }, { "in": "query", "name": "virtualEntity", "required": false, "description": "Identifies a virtual entity type when looking up non-standard objects such as Xen pools.", "schema": { "type": "string", "maxLength": 100, "examples": [ "XenPool" ], "description": "" } }, { "in": "query", "name": "entity", "required": false, "description": "Entity ID used together with virtualEntity to locate the target object.", "schema": { "type": "integer", "format": "int64", "description": "" } }, { "in": "query", "name": "eeProbeID", "required": false, "description": "Probe ID to be supplied if the device is accessed from OpManager Central.", "schema": { "type": "integer", "format": "int64", "description": "" } }, { "in": "query", "name": "selCustomerID", "required": false, "description": "Customer ID of the customer to which the device belongs in MSP context. Set as -1 when the device info is fetched from central.", "schema": { "type": "integer", "format": "int64", "description": "" } }, { "in": "query", "name": "regionID", "required": false, "description": "Region ID of the probe to which the device belongs in MSP context. Set as -1 when the device info is fetched from central.", "schema": { "type": "integer", "format": "int64", "description": "" } } ], "tags": [ "OpManager.Devices" ], "security": [], "x-zenesis-sections": {}, "x-zenesis-doc": { "show": true }, "x-zenesis-envTags": [], "x-zenesis-title": "Get Device Summary" } }, "/api/json/nfadevice/listApMacIcons": { "get": { "summary": "List Access Points", "x-zenesis-title": "List Access Points", "x-zenesis-security": {}, "description": "Lists all access points added in Flow analysis module", "operationId": "listApMacIcons", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "properties": { "stdEndTime": { "type": "string" }, "startTime": { "type": "string" }, "stdStartTime": { "type": "string" }, "endTime": { "type": "string" }, "ICONList": { "type": "array", "description": "Access point traffic and status details", "items": { "type": "object", "properties": { "ID": { "type": "integer" }, "RouterID": { "type": "string" }, "Name": { "type": "string" }, "apmac": { "type": "string" }, "inTraffic": { "type": "string" }, "outTraffic": { "type": "string" }, "inSpeed": { "type": "string" }, "outSpeed": { "type": "string" }, "clrCode": { "type": "integer" }, "statuscode": { "type": "integer" }, "StatusTxt": { "type": "string" }, "alert": { "type": "string" }, "state": { "type": "integer" }, "lastContactTime": { "type": "string", "description": "Last contact timestamp (optional)" }, "SuppressedDetails": { "type": "object", "additionalProperties": true } } } } } }, "examples": { "Example1": { "value": { "stdEndTime": "2026-04-02 21:20", "startTime": "2026-04-02 20:20", "stdStartTime": "2026-04-02 20:20", "endTime": "2026-04-02 21:20", "ICONList": [ { "ID": 5000011, "RouterID": "50007", "Name": "00:1A:2B:3C:4D:5E", "apmac": "00:1A:2B:3C:4D:5E", "inTraffic": "96.00 Bytes", "outTraffic": "417.00 Bytes", "inSpeed": "0.03 bps", "outSpeed": "0.12 bps", "clrCode": 3, "statuscode": 3, "StatusTxt": "Unknown", "alert": "0", "state": 0, "SuppressedDetails": {} } ] } } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "TimeFrame", "required": false, "description": "Specifies the period of time for which you want to retrieve data (e.g., last_hour, 6_hours).Possible time frames : 15minute|30minute|hourly|6hour|daily|today|yesterday|weekly|prevweek|monthly|prevmonth|quarterly|custom", "schema": { "$ref": "#/components/schemas/NFATimeFrame_regex" } }, { "$ref": "#/components/parameters/NFADEparams_collOpt", "description": "" }, { "in": "query", "name": "eeProbeID", "required": false, "description": "Probe ID to be supplied if the device is accessed from OpManager Central.", "schema": { "type": "integer", "format": "int64", "description": "" } } ], "tags": [ "NFA.WLC" ], "security": [], "x-zenesis-sections": {}, "x-zenesis-doc": { "show": true }, "x-zenesis-envTags": [] } }, "/api/json/nfadevice/getIndexInterfaceData": { "get": { "summary": "List NFA Network Interfaces", "x-zenesis-title": "List NFA Network Interfaces", "x-zenesis-security": {}, "description": " List all the interface which is added in flow analysis module.", "operationId": "getIndexInterfaceData", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "properties": { "stdEndTime": { "type": "string" }, "startTime": { "type": "string" }, "stdStartTime": { "type": "string" }, "endTime": { "type": "string" }, "showCentralMigrationInfo": { "type": "boolean" }, "showCentralMigrationError": { "type": "boolean" }, "data": { "type": "array", "description": "Interface traffic and status details", "items": { "type": "object", "properties": { "ID": { "type": "string" }, "RouterID": { "type": "integer" }, "rName": { "type": "string" }, "rIP": { "type": "string" }, "opmDeviceName": { "type": "string" }, "Name": { "type": "string" }, "ifindex": { "type": "integer" }, "Type": { "type": "integer" }, "routerType": { "type": "integer" }, "isVPCInterface": { "type": "boolean" }, "Speed": { "type": "number" }, "outSpeed": { "type": "number" }, "sampleRate": { "type": "integer" }, "INTrafficByte": { "type": "number" }, "OUTTrafficByte": { "type": "number" }, "IN": { "type": "string" }, "OUT": { "type": "string" }, "UtilIN": { "type": "integer" }, "UtilOUT": { "type": "integer" }, "clrCode": { "type": "integer" }, "statuscode": { "type": "integer" }, "StatusTxt": { "type": "string" }, "state": { "type": "integer" }, "alert": { "type": "string" }, "lastContactTime": { "type": "string", "description": "Last contact timestamp (optional)" }, "SuppressedDetails": { "type": "object", "additionalProperties": true } } } } } }, "examples": { "Example1": { "value": { "stdEndTime": "2026-04-02 21:24", "startTime": "2026-04-02 20:24", "stdStartTime": "2026-04-02 20:24", "endTime": "2026-04-02 21:24", "showCentralMigrationInfo": false, "showCentralMigrationError": false, "data": [ { "ID": "5000014", "RouterID": 50009, "rName": "BranchOffice_PaloAlto", "rIP": "10.5.5.1", "opmDeviceName": "10.5.5.1", "Name": "Gigabit Ethernet 0/0", "ifindex": 1, "Type": 0, "routerType": 0, "isVPCInterface": false, "Speed": 1000000, "outSpeed": 1000000, "sampleRate": 1, "INTrafficByte": 132.16, "OUTTrafficByte": 132.16, "IN": "132.16 bps", "OUT": "132.16 bps", "UtilIN": 0, "UtilOUT": 0, "clrCode": 5, "statuscode": 0, "StatusTxt": "LDAlertmail.sub2", "state": 0, "alert": "0", "lastContactTime": "2026-04-02 21:24:05", "SuppressedDetails": {} } ] } } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "DeviceID", "required": false, "description": "", "schema": { "$ref": "#/components/schemas/NFA_Router_Cloud_ID_Minus1_regex" } }, { "in": "query", "name": "advancedFilters", "required": false, "description": "Filter to list interfaces based on selected interface type , interface state.sample param :{\"NFA_Interfaces\":[\"active\"],\"NFA_Intf_Type\":[\"tunnel\"]}", "schema": { "$ref": "#/components/schemas/advancedFilterJson" } }, { "in": "query", "name": "TimeFrame", "required": false, "description": "Specifies the period of time for which you want to retrieve data (e.g., last_hour, 6_hours).Possible time frames : 15minute|30minute|hourly|6hour|daily|today|yesterday|weekly|prevweek|monthly|prevmonth|quarterly|custom", "schema": { "$ref": "#/components/schemas/NFATimeFrame_regex" } }, { "$ref": "#/components/parameters/NFADEparams_collOpt", "description": "" }, { "in": "query", "name": "eeProbeID", "required": false, "description": "Probe ID to be supplied if the device is accessed from OpManager Central.", "schema": { "type": "integer", "format": "int64", "description": "" } } ], "tags": [ "NFA.Inventory" ], "security": [], "x-zenesis-sections": {}, "x-zenesis-doc": { "show": true }, "x-zenesis-envTags": [] } }, "/api/json/nfadevice/getDstData": { "get": { "summary": "Interface Destination data", "x-zenesis-title": "Interface Destination data", "x-zenesis-security": {}, "description": "Get traffic data's based on Destination IP.", "operationId": "getDstData", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "properties": { "IPType": { "type": "string", "description": "Type of IP filter" }, "TimeZone": { "type": "string" }, "stdEndTime": { "type": "string" }, "startTime": { "type": "string" }, "stdStartTime": { "type": "string" }, "endTime": { "type": "string" }, "nextPage": { "type": "boolean" }, "result": { "type": "array", "description": "Traffic distribution by destination IP", "items": { "type": "object", "properties": { "ip": { "type": "string" }, "Name": { "type": "string" }, "volume": { "type": "string" }, "octets": { "type": "integer" }, "traffic": { "type": "string", "description": "Percentage of traffic" } } } }, "devDetails": { "type": "object", "description": "Device details", "properties": { "hdrTitle": { "type": "string" }, "Type": { "type": "string" }, "Total": { "type": "string" }, "RouterIP": { "type": "string" }, "Name": { "type": "string" } } } } }, "examples": { "Example1": { "value": { "IPType": "ALL", "TimeZone": "America/New_York", "stdEndTime": "2026-04-03 00:52", "startTime": "2026-04-02 23:52", "stdStartTime": "2026-04-02 23:52", "endTime": "2026-04-03 00:52", "nextPage": false, "result": [ { "ip": "10.5.5.1", "Name": "10.5.5.1", "volume": "2.00 KB", "octets": 2000, "traffic": "3.28 %" } ], "devDetails": { "hdrTitle": "10.5.5.1 ( Gigabit Ethernet 0/0 )", "Type": "DestinationIN", "Total": "61.00 KB", "RouterIP": "10.5.5.1", "Name": "Gigabit Ethernet 0/0" } } } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "DeviceID", "required": false, "description": "single unique Resource ID. Here resource may be interface, ipgroup, interface group.", "schema": { "$ref": "#/components/schemas/NFA_Source_ID_regex" } }, { "in": "query", "name": "IPGroup", "required": false, "description": "true - if the selected resource is IPGroups, false for other resource types", "schema": { "$ref": "#/components/schemas/NFABoolean_regex" } }, { "in": "query", "name": "BussView", "required": false, "description": "true - if the selected resource is Interface Groups, false for other resource types", "schema": { "$ref": "#/components/schemas/NFABoolean_regex" } }, { "in": "query", "name": "IPType", "required": false, "description": "IP Version filter .\nALL - list both v4 and v6 traffic.\nV4 - list only ipv4 traffic.\nV6 - list only IPV6 traffic.", "schema": { "type": "string", "pattern": "^(ALL|V4|V6)$", "description": "" } }, { "in": "query", "name": "GroupBy", "required": false, "description": "Grouping the conversation based on 'none', 'application', 'source', 'destination', 'srcdst'(Source and Destination), 'dscp', 'srcas', 'dstas', 'srcdstas'(Source and Destination AS). Controls how conversation data is aggregated. By default 'none'", "schema": { "$ref": "#/components/schemas/only_alphabets_regex" } }, { "in": "query", "name": "isNetwork", "required": false, "description": "true - to get Network data's instead of individual IP.", "schema": { "$ref": "#/components/schemas/NFABoolean_regex" } }, { "in": "query", "name": "ResolveDNS", "required": false, "description": " true - to get host names instead of IP", "schema": { "$ref": "#/components/schemas/NFAResolveDNS_regex" } }, { "in": "query", "name": "Data", "required": true, "description": "A directional filter for the data set. Set to Ingress to retrieve incoming data or Egress to retrieve outgoing data.", "schema": { "$ref": "#/components/schemas/NFAData_regex" } }, { "in": "query", "name": "TimeFrame", "required": false, "description": "Specifies the period of time for which you want to retrieve data (e.g., last_hour, 6_hours).Possible time frames : 15minute|30minute|hourly|6hour|daily|today|yesterday|weekly|prevweek|monthly|prevmonth|quarterly|custom", "schema": { "$ref": "#/components/schemas/NFATimeFrame_regex" } }, { "in": "query", "name": "StartTime", "required": false, "description": "Start time of custom time period (only if custom time period is chosen) in YYYY-MM-DD HH:MMformat.", "schema": { "$ref": "#/components/schemas/DateTime_WithoutSeconds_regex" } }, { "in": "query", "name": "EndTime", "required": false, "description": " End time of custom time period (only if custom time period is chosen) in YYYY-MM-DD HH:MMformat.", "schema": { "$ref": "#/components/schemas/DateTime_WithoutSeconds_regex" } }, { "$ref": "#/components/parameters/NFADEparams_collOpt", "description": "" }, { "in": "query", "name": "eeProbeID", "required": false, "description": "Probe ID to be supplied if the device is accessed from OpManager Central.", "schema": { "type": "integer", "format": "int64", "description": "" } } ], "tags": [ "NFA.Inventory" ], "security": [], "x-zenesis-sections": {}, "x-zenesis-doc": { "show": true }, "x-zenesis-envTags": [] } }, "/api/json/nfareports/customReport": { "get": { "summary": "Get NFA Conversation Search Report", "x-zenesis-title": "Get NFA Conversation Search Report", "x-zenesis-security": {}, "description": "To list all conversation for the selected criteria", "operationId": "customReport", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "properties": { "nextPageOUT": { "type": "boolean" }, "nextPageIN": { "type": "boolean" }, "totalIN": { "type": "string" }, "totalOUT": { "type": "string" }, "stdEndTime": { "type": "string" }, "startTime": { "type": "string" }, "stdStartTime": { "type": "string" }, "endTime": { "type": "string" }, "isWLC": { "type": "boolean" }, "Data": { "type": "string", "description": "Traffic direction (IN/OUT/BOTH)" }, "trafficIN": { "type": "array", "description": "Incoming application traffic", "items": { "type": "object", "properties": { "app": { "type": "string" }, "src": { "type": "string" }, "dst": { "type": "string" }, "srcport": { "type": "string" }, "dstport": { "type": "string" }, "prot": { "type": "string" }, "dscp": { "type": "string" }, "traffic": { "type": "string" }, "deviceName": { "type": "string" }, "interfaceName": { "type": "string" }, "srcASName": { "type": "string" }, "dstASName": { "type": "string" }, "srcCategory": { "type": "string" }, "dstCategory": { "type": "string" }, "srcResolvedBy": { "type": "string" }, "dstResolvedBy": { "type": "string" } } } }, "trafficOUT": { "type": "array", "description": "Outgoing application traffic", "items": { "type": "object", "properties": { "app": { "type": "string" }, "src": { "type": "string" }, "dst": { "type": "string" }, "srcport": { "type": "string" }, "dstport": { "type": "string" }, "prot": { "type": "string" }, "dscp": { "type": "string" }, "traffic": { "type": "string" }, "deviceName": { "type": "string" }, "interfaceName": { "type": "string" }, "srcASName": { "type": "string" }, "dstASName": { "type": "string" }, "srcCategory": { "type": "string" }, "dstCategory": { "type": "string" }, "srcResolvedBy": { "type": "string" }, "dstResolvedBy": { "type": "string" } } } } } }, "examples": { "Example1": { "value": { "nextPageOUT": true, "nextPageIN": true, "totalIN": "9.29 MB", "totalOUT": "9.29 MB", "stdEndTime": "2026-04-03 01:10", "startTime": "2026-04-03 00:00", "stdStartTime": "2026-04-03 00:00", "endTime": "2026-04-03 01:10", "isWLC": false, "Data": "BOTH", "trafficIN": [ { "app": "dsp", "src": "10.5.5.1", "dst": "10.5.5.1", "srcport": "33", "dstport": "33", "prot": "UDP", "dscp": "AF13", "traffic": "997.61 KB", "deviceName": "NewYork_Cisco_Access_Switch", "interfaceName": "Gigabit Ethernet 0/0", "srcASName": "ISI-AS", "dstASName": "ISI-AS", "srcCategory": "Unknown", "dstCategory": "-", "srcResolvedBy": "None", "dstResolvedBy": "None" } ], "trafficOUT": [ { "app": "dsp", "src": "10.5.5.1", "dst": "10.5.5.1", "srcport": "33", "dstport": "33", "prot": "UDP", "dscp": "AF13", "traffic": "997.61 KB", "deviceName": "NewYork_Cisco_Access_Switch", "interfaceName": "Gigabit Ethernet 0/0" } ] } } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "DeviceID", "required": true, "description": "Accesspoint ID's with comma seperated like [\"1\",\"2\"] . \"-1\" to select all accesspoints", "schema": { "$ref": "#/components/schemas/NFA_Source_ID_Minus1_Array" } }, { "in": "query", "name": "ReportType", "required": true, "description": "Report type for the wireless devices : custom", "schema": { "$ref": "#/components/schemas/custom_regex" } }, { "in": "query", "name": "Data", "required": false, "description": "A directional filter for the data set. Set to Ingress to retrieve incoming data or Egress to retrieve outgoing data.", "schema": { "$ref": "#/components/schemas/NFAData_regex" } }, { "in": "query", "name": "Oper", "required": false, "description": "Criteria combination type . will use this when we have more than one criteria. [OR / AND]", "schema": { "$ref": "#/components/schemas/NFALogic_regex" } }, { "in": "query", "name": "IPGroup", "required": false, "description": "true - if the selected resource is IPGroups, false for other resource types", "schema": { "$ref": "#/components/schemas/NFABoolean_regex" } }, { "in": "query", "name": "BussView", "required": false, "description": "true - if the selected resource is Interface Groups, false for other resource types", "schema": { "$ref": "#/components/schemas/NFABoolean_regex" } }, { "in": "query", "name": "ResolveDNS", "required": false, "description": "true - to get host names instead of IP", "schema": { "$ref": "#/components/schemas/NFABoolean_regex" } }, { "in": "query", "name": "rows", "required": false, "description": "Defines the maximum number of data entries displayed per page.", "schema": { "$ref": "#/components/schemas/NFA_CustomPager_Rows_regex" } }, { "in": "query", "name": "pageCount", "required": false, "description": "Specifies the page number of the results to retrieve.", "schema": { "$ref": "#/components/schemas/NFA_CustomPager_Page_regex" } }, { "in": "query", "name": "rowsIN", "required": false, "description": "Get Number of rows per page", "schema": { "$ref": "#/components/schemas/NFA_CustomPager_Rows_regex" } }, { "in": "query", "name": "rowsOUT", "required": false, "description": "Get Number of rows per page", "schema": { "$ref": "#/components/schemas/NFA_CustomPager_Rows_regex" } }, { "in": "query", "name": "pageCountIN", "required": false, "description": "Get Nth page of the result", "schema": { "$ref": "#/components/schemas/NFA_CustomPager_Page_regex" } }, { "in": "query", "name": "pageCountOUT", "required": false, "description": "Get Nth page of the result", "schema": { "$ref": "#/components/schemas/NFA_CustomPager_Page_regex" } }, { "in": "query", "name": "Criteria", "required": false, "description": "Get report based on particular criteria. we can have SSID, Clientip, cient mac, Application, pre DSCP,post dscp", "schema": { "$ref": "#/components/schemas/WLC_Search_Report_Criteria_List" } }, { "$ref": "#/components/parameters/NFA_Reports_Time_Params_TimeFrame", "description": "Specifies the period of time for which you want to retrieve data (e.g., last_hour, 6_hours).Possible time frames : 15minute|30minute|hourly|6hour|daily|today|yesterday|weekly|prevweek|monthly|prevmonth|quarterly|custom" }, { "$ref": "#/components/parameters/NFA_Reports_Time_Params_StartTime", "description": "Start time of custom time period (only if custom time period is chosen) in YYYY-MM-DD HH:MMformat." }, { "$ref": "#/components/parameters/NFA_Reports_Time_Params_EndTime", "description": "End time of custom time period (only if custom time period is chosen) in YYYY-MM-DD HH:MMformat." }, { "$ref": "#/components/parameters/NFADEparams_collOpt", "description": "" }, { "in": "query", "name": "eeProbeID", "required": false, "description": "Probe ID to be supplied if the device is accessed from OpManager Central.", "schema": { "type": "integer", "format": "int64", "description": "" } } ], "tags": [ "NFA.Reports" ], "security": [], "x-zenesis-sections": {}, "x-zenesis-doc": { "show": true }, "x-zenesis-envTags": [] } }, "/api/json/nfadevice/asGroupData": { "get": { "summary": "AS Group Traffic data", "x-zenesis-title": "AS Group Traffic data", "x-zenesis-security": {}, "description": " List In and Out traffic values for configured AS Group", "operationId": "asGroupData", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "properties": { "stdEndTime": { "type": "string" }, "startTime": { "type": "string" }, "stdStartTime": { "type": "string" }, "endTime": { "type": "string" }, "devname": { "type": "string" }, "data": { "type": "array", "description": "Tabular traffic data [index, name, IN speed, OUT speed]", "items": { "type": "array", "items": [ { "type": "string", "description": "Row index" }, { "type": "string", "description": "Entity name" }, { "type": "string", "description": "Incoming speed" }, { "type": "string", "description": "Outgoing speed" } ] } } } }, "examples": { "Example1": { "value": { "stdEndTime": "2026-04-03 01:18", "startTime": "2026-04-03 00:18", "stdStartTime": "2026-04-03 00:18", "endTime": "2026-04-03 01:18", "devname": "BranchOffice_PaloAlto", "data": [ [ "1", "LLT Group", "106.67 bps", "213.33 bps" ] ] } } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "DeviceID", "required": true, "description": "unique Reource ID. It may be interface / interface group ID.", "schema": { "$ref": "#/components/schemas/NFA_Device_ID_regex" } }, { "in": "query", "name": "isDevice", "required": false, "description": "true - if the resource type is Device", "schema": { "$ref": "#/components/schemas/NFABoolean_regex" } }, { "in": "query", "name": "isLocation", "required": false, "description": "To get all traffic based on location.", "schema": { "$ref": "#/components/schemas/NFABoolean_regex" } }, { "in": "query", "name": "fromInterface", "required": false, "description": "true - if the selected resource is Interface.", "schema": { "$ref": "#/components/schemas/NFABoolean_regex" } }, { "in": "query", "name": "BussView", "required": false, "description": "true - if the selected resource is Interface Groups, false for other resource types", "schema": { "$ref": "#/components/schemas/NFABoolean_regex" } }, { "$ref": "#/components/parameters/NFA_Reports_Time_Params_TimeFrame", "description": "Specifies the period of time for which you want to retrieve data (e.g., last_hour, 6_hours).Possible time frames : 15minute|30minute|hourly|6hour|daily|today|yesterday|weekly|prevweek|monthly|prevmonth|quarterly|custom" }, { "$ref": "#/components/parameters/NFA_Reports_Time_Params_StartTime", "description": "Start time of custom time period (only if custom time period is chosen) in YYYY-MM-DD HH:MMformat." }, { "$ref": "#/components/parameters/NFA_Reports_Time_Params_EndTime", "description": "End time of custom time period (only if custom time period is chosen) in YYYY-MM-DD HH:MMformat." }, { "$ref": "#/components/parameters/NFADEparams_collOpt", "description": "" }, { "in": "query", "name": "eeProbeID", "required": false, "description": "Probe ID to be supplied if the device is accessed from OpManager Central.", "schema": { "type": "integer", "format": "int64", "description": "" } } ], "tags": [ "NFA.Inventory" ], "security": [], "x-zenesis-sections": {}, "x-zenesis-doc": { "show": true }, "x-zenesis-envTags": [] } }, "/api/json/nfadevice/getASView": { "get": { "summary": "AS View Traffic Data", "x-zenesis-title": "AS View Traffic Data", "x-zenesis-security": {}, "description": "List In and Out traffic values for AS ", "operationId": "getASView", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "properties": { "stdEndTime": { "type": "string" }, "startTime": { "type": "string" }, "stdStartTime": { "type": "string" }, "endTime": { "type": "string" }, "devname": { "type": "string" }, "nextPage": { "type": "boolean" }, "data": { "type": "array", "description": "Tabular AS traffic data", "items": { "type": "array", "items": [ { "type": "string", "description": "AS Name (short)" }, { "type": "string", "description": "AS ID" }, { "type": "string", "description": "Organization name" }, { "type": "string", "description": "IN avg speed" }, { "type": "string", "description": "IN max speed" }, { "type": "string", "description": "IN total speed" }, { "type": "string", "description": "OUT avg speed" }, { "type": "string", "description": "OUT max speed" }, { "type": "string", "description": "OUT total speed" }, { "type": "string", "description": "Interface/Record ID" } ] } } } }, "examples": { "Example1": { "value": { "stdEndTime": "2026-04-03 01:22", "startTime": "2026-04-03 00:22", "stdStartTime": "2026-04-03 00:22", "endTime": "2026-04-03 01:22", "devname": "BranchOffice_PaloAlto", "nextPage": false, "data": [ [ "CMU-ROUTER", "9", "Carnegie Mellon University", "17.65 bps", "26.00 bps", "26.00 bps", "0.00 bps", "0.00 bps", "0.00 bps", "5000014" ] ] } } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "DeviceID", "required": true, "description": "unique Reource ID. It may be interface / interface group ID.", "schema": { "$ref": "#/components/schemas/NFA_Device_ID_regex" } }, { "in": "query", "name": "isDevice", "required": false, "description": "true - if the resource type is Device", "schema": { "$ref": "#/components/schemas/NFABoolean_regex" } }, { "in": "query", "name": "isLocation", "required": false, "description": "To get all traffic based on location.", "schema": { "$ref": "#/components/schemas/NFABoolean_regex" } }, { "in": "query", "name": "fromInterface", "required": false, "description": "true - if the selected resource is Interface.", "schema": { "$ref": "#/components/schemas/NFABoolean_regex" } }, { "in": "query", "name": "BussView", "required": false, "description": "true - if the selected resource is Interface Groups, false for other resource types", "schema": { "$ref": "#/components/schemas/NFABoolean_regex" } }, { "$ref": "#/components/parameters/NFA_Reports_Time_Params_TimeFrame", "description": "Specifies the period of time for which you want to retrieve data (e.g., last_hour, 6_hours).Possible time frames : 15minute|30minute|hourly|6hour|daily|today|yesterday|weekly|prevweek|monthly|prevmonth|quarterly|custom" }, { "$ref": "#/components/parameters/NFA_Reports_Time_Params_StartTime", "description": "Start time of custom time period (only if custom time period is chosen) in YYYY-MM-DD HH:MMformat." }, { "$ref": "#/components/parameters/NFA_Reports_Time_Params_EndTime", "description": "End time of custom time period (only if custom time period is chosen) in YYYY-MM-DD HH:MMformat." }, { "$ref": "#/components/parameters/NFADEparams_collOpt", "description": "" }, { "in": "query", "name": "eeProbeID", "required": false, "description": "Probe ID to be supplied if the device is accessed from OpManager Central.", "schema": { "type": "integer", "format": "int64", "description": "" } } ], "tags": [ "NFA.Inventory" ], "security": [], "x-zenesis-sections": {}, "x-zenesis-doc": { "show": true }, "x-zenesis-envTags": [] } }, "/api/json/v2/nfadevice/getIndexIPGroupData": { "get": { "summary": "Get All IP Group List", "x-zenesis-title": "Get All IP Group List", "x-zenesis-security": {}, "description": " List all the IPgroup with IN and OUT traffic", "operationId": "getIndexIPGroupData", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "properties": { "stdEndTime": { "type": "string" }, "startTime": { "type": "string" }, "stdStartTime": { "type": "string" }, "endTime": { "type": "string" }, "traffic": { "type": "array", "description": "Category-based traffic details", "items": { "type": "object", "properties": { "ID": { "type": "string" }, "Name": { "type": "string" }, "desc": { "type": "string" }, "IN": { "type": "string" }, "OUT": { "type": "string" }, "speed": { "type": "string", "description": "Configured bandwidth" }, "bandwidth": { "type": "number", "description": "Bandwidth value (raw)" }, "UtilIN": { "type": "integer" }, "UtilOUT": { "type": "integer" }, "clrCode": { "type": "integer" }, "alert": { "type": "string" }, "sess": { "type": "string", "description": "Session flag" }, "SuppressedDetails": { "type": "object", "additionalProperties": true } } } } } }, "examples": { "Example1": { "value": { "stdEndTime": "2026-04-03 01:27", "startTime": "2026-04-03 00:27", "stdStartTime": "2026-04-03 00:27", "endTime": "2026-04-03 01:27", "traffic": [ { "ID": "2500009", "Name": "HR Traffic", "desc": "HR Department", "IN": "8.72 Kbps", "OUT": "8.72 Kbps", "speed": "10.00 Mbps", "bandwidth": 0, "UtilIN": 0, "UtilOUT": 0, "clrCode": 5, "alert": "-", "sess": "false", "SuppressedDetails": {} } ] } } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "advancedFilters", "required": false, "description": "{\"NFA_Groups\":[\"IPGroups\"]} - here constant filter value", "schema": { "$ref": "#/components/schemas/advancedFilterJson" } }, { "$ref": "#/components/parameters/NFA_Reports_Time_Params_TimeFrame", "description": "Specifies the period of time for which you want to retrieve data (e.g., last_hour, 6_hours).Possible time frames : 15minute|30minute|hourly|6hour|daily|today|yesterday|weekly|prevweek|monthly|prevmonth|quarterly|custom" }, { "$ref": "#/components/parameters/NFADEparams_collOpt", "description": "" }, { "in": "query", "name": "eeProbeID", "required": false, "description": "Probe ID to be supplied if the device is accessed from OpManager Central.", "schema": { "type": "integer", "format": "int64", "description": "" } } ], "tags": [ "NFA.Inventory" ], "security": [], "x-zenesis-sections": {}, "x-zenesis-doc": { "show": true }, "x-zenesis-envTags": [] } }, "/api/json/alarm/listAlarms": { "get": { "summary": "Get Alarms", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "Lists active alarms with filtering, pagination, and sorting. Supports filters by device name, severity, category, alert type, time range, and acknowledgement status. Returns alarm summaries including the entity identifier required by all other alarm APIs (alarmProperties, acknowledgeAlarm, clearAlarm, addNotes, getAnnotation, updateAlarmNote, unAcknowledgeAlarm). Call this first to obtain entity values before acting on individual alarms.", "operationId": "listAlarms", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "description": "", "properties": { "severity": { "type": "string", "description": "" }, "numericSeverity": { "type": "integer", "description": "" }, "deviceType": { "type": "string", "description": "" }, "severityString": { "type": "string", "description": "" }, "statusStr": { "type": "string", "description": "" }, "displayName": { "type": "string", "description": "" }, "eventType": { "type": "string", "description": "" }, "message": { "type": "string", "description": "" }, "deviceName": { "type": "string", "description": "" }, "statusNum": { "type": "integer", "description": "" }, "modTimeLong": { "type": "integer", "description": "" }, "modTime": { "type": "string", "description": "" }, "alarmId": { "type": "string", "description": "" }, "category": { "type": "string", "description": "" }, "entity": { "type": "string", "description": "" }, "alarmcode": { "type": "string", "description": "" }, "status": { "type": "integer", "description": "" }, "who": { "type": "string", "description": "" } } }, "description": "" }, "examples": { "Example1": { "value": [ { "severity": "\u00a0Critical", "numericSeverity": 1, "deviceType": "-", "severityString": "Critical", "statusStr": "Critical", "displayName": "System", "eventType": "SelfMonitoring Alarm", "message": "File Integrity : New files were found during the last scan.", "deviceName": "System", "statusNum": 1, "modTimeLong": 1769665551221, "modTime": "29 Jan 2026 11:15:51 AM IST", "alarmId": "601", "category": "SelfMonitoring", "entity": "localhost_FILEINTEGRITY_BLACKLISTED", "alarmcode": "FILEINTEGRITY_EXTERNALFILES", "status": 1, "who": "Unacknowledged" }, { "severity": "\u00a0Clear", "numericSeverity": 5, "deviceType": "-", "severityString": "Clear", "statusStr": "Clear", "displayName": "System", "eventType": "SelfMonitoring Alarm", "message": "OpManager has detected that it has lost network connectivity and has suspended all monitoring. Monitoring will be automatically resumed once connectivity is established.", "deviceName": "System", "statusNum": 5, "modTimeLong": 1769664511895, "modTime": "29 Jan 2026 10:58:31 AM IST", "alarmId": "301", "category": "SelfMonitoring", "entity": "System_NetworkConnectivity", "alarmcode": "Network_Connectivity_Lost", "status": 5, "who": "Unacknowledged" }, { "severity": "\u00a0Clear", "numericSeverity": 5, "deviceType": "-", "severityString": "Clear", "statusStr": "Clear", "displayName": "System", "eventType": "SelfMonitoring Alarm", "message": "OpManager System CPU is now back to normal, current value is 0%. Top 3 Processes:-java#5 - 33.939%; sqlservr - 11.576%; Taskmgr - 4.473%.", "deviceName": "System", "statusNum": 5, "modTimeLong": 1769081127615, "modTime": "22 Jan 2026 04:55:27 PM IST", "alarmId": "1", "category": "SelfMonitoring", "entity": "12_SystemCpuUtilization", "alarmcode": "SM_THRESHOLD_CLEAR_SystemCpuUtilization", "status": 5, "who": "Unacknowledged" } ] } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "deviceName", "required": false, "description": "Name of the device for which alarms should be listed. Obtain this from the listDevices API response.", "schema": { "type": "string", "description": "" } }, { "in": "query", "name": "probeName", "required": false, "description": "Name of the Probe. Obtain this from the listProbes API response's NAME property.\n\n\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 Applicable only for Central Server.", "schema": { "$ref": "#/components/schemas/probeNameRegex_regex" } }, { "in": "query", "name": "fromTime", "required": false, "description": "Start time for filtering alarms. Format 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'. Must be used together with toTime. toTime must not be before fromTime.", "schema": { "$ref": "#/components/schemas/opmee_dateWithOptionalTime_regex" } }, { "in": "query", "name": "toTime", "required": false, "description": "End time for filtering alarms. Format 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'. Must be used together with fromTime. Must not be before fromTime.", "schema": { "$ref": "#/components/schemas/opmee_dateWithOptionalTime_regex" } }, { "in": "query", "name": "severity", "required": false, "description": "\u00a0Severity of the alarm as an integer. Values: 1 (Critical), 2 (Trouble),\n\n\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 3 (Attention), 4 (Service Down), 5 (Clear).", "schema": { "$ref": "#/components/schemas/numberWithComma_regex" } }, { "in": "query", "name": "alertType", "required": false, "description": "Filters alarms by their source or view. ActiveAlarms returns all current alarms. Other values filter by alarm origin - EventLogAlarms, SyslogAlarms, TrapAlarms (SNMP traps), NCMAlarms (Network Configuration Manager), NFAAlarms (NetFlow Analyzer), WebAlarms (web console push notification alerts), FWAAlarms (Firewall Analyzer), StorageAlarms, APMAlarms (Application Performance), CorrelatedAlarms. Use Server, Network, or Virtualization to filter by device category.", "schema": { "type": "string", "pattern": "^(ActiveAlarms|EventLogAlarms|SyslogAlarms|TrapAlarms|NCMAlarms|NFAAlarms|WebAlarms|FWAAlarms|StorageAlarms|APMAlarms|Server|Network|Virtualization|CorrelatedAlarms)$", "description": "" } }, { "in": "query", "name": "category", "required": false, "description": "\u00a0Category of the device.", "schema": { "$ref": "#/components/schemas/opmee_category_regex" } } ], "tags": [ "OpManager.Alarms" ], "security": [], "x-zenesis-sections": {}, "x-zenesis-doc": { "show": true }, "x-zenesis-envTags": [], "x-zenesis-title": "Get Alarms and Incidents Data" } }, "/api/json/v2/nfadevice/getAppData": { "get": { "summary": "Interface Application Traffic Data", "x-zenesis-title": "Interface Application Traffic Data", "x-zenesis-security": {}, "description": "Get Application / protocol / Application Group with traffic data", "operationId": "getAppData", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "properties": { "IPType": { "type": "string" }, "TimeZone": { "type": "string" }, "granularity": { "type": "string" }, "yAxis": { "type": "string" }, "stdEndTime": { "type": "string" }, "stdStartTime": { "type": "string" }, "startTime": { "type": "string" }, "endTime": { "type": "string" }, "nextPage": { "type": "boolean" }, "isRawEnable": { "type": "boolean" }, "devDetails": { "type": "object", "properties": { "hdrTitle": { "type": "string" }, "Type": { "type": "string" }, "Total": { "type": "string" }, "RouterIP": { "type": "string" }, "Name": { "type": "string" } } }, "result": { "type": "array", "description": "Protocol traffic distribution", "items": { "type": "object", "properties": { "Name": { "type": "string" }, "volume": { "type": "string" }, "octets": { "type": "integer" }, "traffic": { "type": "string", "description": "Percentage of traffic" } } } }, "GraphData": { "type": "array", "description": "Time-series protocol traffic", "items": { "type": "object", "properties": { "seriesname": { "type": "string" }, "data": { "type": "array", "items": { "type": "array", "items": { "type": "number" } } }, "yaxiscolumnorder": { "type": "array", "items": { "type": "integer" } } } } } } }, "examples": { "Example1": { "value": { "IPType": "ALL", "TimeZone": "America/New_York", "granularity": "10 Minute Average", "yAxis": "bps", "stdEndTime": "2026-04-03 01:41", "stdStartTime": "2026-04-03 00:41", "startTime": "2026-04-03 00:41", "endTime": "2026-04-03 01:41", "nextPage": false, "isRawEnable": true, "devDetails": { "hdrTitle": "10.5.5.1 ( Gigabit Ethernet 0/0 )", "Type": "ProtocolIN", "Total": "50.00 KB", "RouterIP": "10.5.5.1", "Name": "Gigabit Ethernet 0/0" }, "result": [ { "Name": "TCP", "volume": "25.00 KB", "octets": 25000, "traffic": "40.98 %" } ], "GraphData": [ { "seriesname": "UDP", "data": [ [ 1775191800000, 66.67 ] ], "yaxiscolumnorder": [ 0 ] } ] } } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "DeviceID", "required": true, "description": "single unique Resource ID. Here resource may be interface, ipgroup, interface group ", "schema": { "$ref": "#/components/schemas/NFA_Source_ID_regex" } }, { "in": "query", "name": "Type", "required": false, "description": "", "schema": { "type": "string", "pattern": "^(Application|Protocol|AppGrp)$", "description": "" } }, { "in": "query", "name": "chartType", "required": false, "description": "", "schema": { "$ref": "#/components/schemas/line_regex" } }, { "in": "query", "name": "Data", "required": false, "description": "", "schema": { "$ref": "#/components/schemas/NFAData_regex" } }, { "in": "query", "name": "IPGroup", "required": false, "description": "true - if the selected resource is IPGroups, false for other resource types", "schema": { "$ref": "#/components/schemas/NFABoolean_regex" } }, { "in": "query", "name": "BussView", "required": false, "description": "true - if the selected resource is Interface Groups, false for other resource types", "schema": { "$ref": "#/components/schemas/NFABoolean_regex" } }, { "in": "query", "name": "TimeFrame", "required": false, "description": "Specifies the period of time for which you want to retrieve data (e.g., last_hour, 6_hours).Possible time frames : 15minute|30minute|hourly|6hour|daily|today|yesterday|weekly|prevweek|monthly|prevmonth|quarterly|custom", "schema": { "$ref": "#/components/schemas/NFATimeFrame_regex" } }, { "in": "query", "name": "StartTime", "required": false, "description": "Start time of custom time period (only if custom time period is chosen) in YYYY-MM-DD HH:MMformat.", "schema": { "$ref": "#/components/schemas/DateTime_WithoutSeconds_regex" } }, { "in": "query", "name": "EndTime", "required": false, "description": " End time of custom time period (only if custom time period is chosen) in YYYY-MM-DD HH:MMformat.", "schema": { "$ref": "#/components/schemas/DateTime_WithoutSeconds_regex" } }, { "$ref": "#/components/parameters/NFADEparams_collOpt", "description": "" }, { "in": "query", "name": "eeProbeID", "required": false, "description": "Probe ID to be supplied if the device is accessed from OpManager Central.", "schema": { "type": "integer", "format": "int64", "description": "" } } ], "tags": [ "NFA.Inventory" ], "security": [], "x-zenesis-sections": {}, "x-zenesis-doc": { "show": true }, "x-zenesis-envTags": [] } }, "/api/json/nfadevice/getIndexIntfGroupData": { "get": { "summary": "List NFA Interface Groups", "x-zenesis-title": "List NFA Interface Groups", "x-zenesis-security": {}, "description": "List all the interface groups with IN and OUT traffic", "operationId": "getIndexIntfGroupData", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "properties": { "stdEndTime": { "type": "string" }, "startTime": { "type": "string" }, "stdStartTime": { "type": "string" }, "endTime": { "type": "string" }, "traffic": { "type": "array", "description": "Traffic details for service links", "items": { "type": "object", "properties": { "ID": { "type": "integer" }, "Name": { "type": "string" }, "IN": { "type": "string" }, "OUT": { "type": "string" }, "speed": { "type": "string", "description": "Configured bandwidth" }, "UtilIN": { "type": "integer" }, "UtilOUT": { "type": "integer" }, "clrCode": { "type": "integer" }, "alert": { "type": "string" }, "isMCast": { "type": "boolean" }, "isAVC": { "type": "boolean" }, "isMNet": { "type": "boolean" }, "SuppressedDetails": { "type": "object", "additionalProperties": true } } } } } }, "examples": { "Example1": { "value": { "stdEndTime": "2026-04-03 02:09", "startTime": "2026-04-03 01:09", "stdStartTime": "2026-04-03 01:09", "endTime": "2026-04-03 02:09", "traffic": [ { "ID": 2500005, "Name": "CRM_Service_UpLinks", "IN": "26.40 Kbps", "OUT": "26.40 Kbps", "speed": "120.00 Mbps", "UtilIN": 0, "UtilOUT": 0, "clrCode": 4, "alert": "-", "isMCast": false, "isAVC": false, "isMNet": false, "SuppressedDetails": {} } ] } } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "advancedFilters", "required": false, "description": "{\"NFA_Groups\":[\"InterfaceGroups\"]} - here constant filter value", "schema": { "$ref": "#/components/schemas/advancedFilterJson" } }, { "$ref": "#/components/parameters/NFA_Reports_Time_Params_TimeFrame", "description": "Specifies the period of time for which you want to retrieve data (e.g., last_hour, 6_hours).Possible time frames : 15minute|30minute|hourly|6hour|daily|today|yesterday|weekly|prevweek|monthly|prevmonth|quarterly|custom" }, { "$ref": "#/components/parameters/NFADEparams_collOpt", "description": "" }, { "in": "query", "name": "eeProbeID", "required": false, "description": "Probe ID to be supplied if the device is accessed from OpManager Central.", "schema": { "type": "integer", "format": "int64", "description": "" } } ], "tags": [ "NFA.Inventory" ], "security": [], "x-zenesis-sections": {}, "x-zenesis-doc": { "show": true }, "x-zenesis-envTags": [] } }, "/api/json/alarm/updateAlarmNote": { "post": { "summary": "Update Alarm Notes", "x-zenesis-title": "Update Alarm Notes", "security": [ {} ], "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "Updates an existing note or comment on an alarm, replacing the previous content of that annotation entry. Requires the entity identifier obtained from listAlarms. Use this to correct errors, add follow-up details, or amend previously recorded investigation notes. Only the specified annotation is modified; other notes on the same alarm and the alarm state\n\nitself remain unchanged.", "operationId": "updateAlarmNote", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "", "properties": { "result": { "type": "object", "description": "", "properties": { "message": { "type": "string", "description": "" } } } } }, "examples": { "Example1": { "value": { "result": { "message": "Note has been successfully updated" } } } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "notes", "required": true, "description": "Notes description to be added.", "schema": { "$ref": "#/components/schemas/text_twoByteSupport_regex" } }, { "in": "query", "name": "noteID", "required": true, "description": "\u00a0ID of the note to be updated. Obtain this from the getAnnotation API response.", "schema": { "type": "integer", "description": "" } } ], "tags": [ "OpManager.Alarms" ], "x-zenesis-sections": {}, "x-zenesis-doc": { "show": true }, "x-zenesis-envTags": [] } }, "/api/json/nfadevice/listSSIDGroupIcons": { "get": { "summary": "list All SSID Groups", "x-zenesis-title": "list All SSID Groups", "x-zenesis-security": {}, "description": "List all the SSID groups with IN and OUT traffic", "operationId": "listSSIDGroupIcons", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "properties": { "stdEndTime": { "type": "string" }, "startTime": { "type": "string" }, "stdStartTime": { "type": "string" }, "endTime": { "type": "string" }, "traffic": { "type": "array", "description": "SSID traffic details", "items": { "type": "object", "properties": { "ID": { "type": "integer" }, "Name": { "type": "string" }, "inTraffic": { "type": "string" }, "outTraffic": { "type": "string" }, "inSpeed": { "type": "string" }, "outSpeed": { "type": "string" }, "alert": { "type": "string" }, "SuppressedDetails": { "type": "object", "additionalProperties": true } } } } } }, "examples": { "Example1": { "value": { "stdEndTime": "2026-04-03 02:11", "startTime": "2026-04-03 01:11", "stdStartTime": "2026-04-03 01:11", "endTime": "2026-04-03 02:11", "traffic": [ { "ID": 2500012, "Name": "Corp Network SSIDs", "inTraffic": "386.00 Bytes", "outTraffic": "1.01 KB", "inSpeed": "0.11 bps", "outSpeed": "0.28 bps", "alert": "0", "SuppressedDetails": {} } ] } } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "advancedFilters", "required": false, "description": "{} - here constant filter value", "schema": { "$ref": "#/components/schemas/advancedFilterJson" } }, { "$ref": "#/components/parameters/NFA_Reports_Time_Params_TimeFrame", "description": "Specifies the period of time for which you want to retrieve data (e.g., last_hour, 6_hours).Possible time frames : 15minute|30minute|hourly|6hour|daily|today|yesterday|weekly|prevweek|monthly|prevmonth|quarterly|custom" }, { "$ref": "#/components/parameters/NFADEparams_collOpt", "description": "" }, { "in": "query", "name": "eeProbeID", "required": false, "description": "Probe ID to be supplied if the device is accessed from OpManager Central.", "schema": { "type": "integer", "format": "int64", "description": "" } } ], "tags": [ "NFA.WLC" ], "security": [], "x-zenesis-sections": {}, "x-zenesis-doc": { "show": true }, "x-zenesis-envTags": [] } }, "/api/json/reports/getReportsList": { "get": { "summary": "Get Available Reports List", "x-zenesis-title": "Get Available Reports List", "x-zenesis-security": {}, "description": "Retrieves a categorized list of all available reports across areas like performance, availability, inventory, and custom reports. Returns report metadata and access details, not actual report data. Used as a discovery API to identify and trigger report generation via corresponding report URLs.", "operationId": "getReportsList", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "description": "", "properties": { "displayName": { "type": "string", "description": "" }, "list": { "type": "array", "items": { "type": "object", "description": "", "properties": { "title": { "type": "string", "description": "" }, "list": { "type": "array", "items": { "type": "object", "description": "", "properties": { "displayName": { "type": "string", "description": "" }, "customStatus": { "type": "string", "description": "" }, "isCustom": { "type": "string", "description": "" }, "id": { "type": "integer", "description": "" }, "url": { "type": "string", "description": "" }, "Name": { "type": "string", "description": "" }, "desc": { "type": "string", "description": "" } } }, "description": "" } } }, "description": "" }, "Name": { "type": "string", "description": "" } } }, "description": "" }, "examples": { "Example1": { "value": [ { "displayName": "System", "list": [ { "title": "", "list": [ { "displayName": "Mail Server Audit", "customStatus": "False", "isCustom": "false", "id": 1054, "url": "/reports/GenerateReports.do?firstTime=true&reportID=1054", "Name": "webclient.reports.Mail.Audit", "desc": "Mail Server Audit" }, { "displayName": "All Alerts with Notes", "customStatus": "False", "isCustom": "false", "id": 721, "url": "/reports/GenerateReports.do?firstTime=true&reportID=721", "Name": "webclient.alert.notes.report", "desc": "Get report for all alerts with Notes" }, { "displayName": "DataCollection Error Logs", "customStatus": "False", "isCustom": "false", "id": 151, "url": "/reports/GenerateReports.do?firstTime=true&reportID=151", "Name": "widget.name.dataCollectionLog", "desc": "Get datacollection failure details" }, { "displayName": "Active Alerts", "customStatus": "False", "isCustom": "false", "id": 149, "url": "/reports/GenerateReports.do?firstTime=true&reportID=149", "Name": "webclient.report.name.activealarms", "desc": "Get report for active alerts" }, { "displayName": "Top SysLog Count by Source", "customStatus": "False", "isCustom": "false", "id": 95, "url": "/reports/GenerateReports.do?firstTime=true&reportID=95", "Name": "webclient.top.syslog.reports", "desc": "Top N devices with most number of SysLogs" }, { "displayName": "Top EventLog Count by Source", "customStatus": "False", "isCustom": "false", "id": 94, "url": "/reports/GenerateReports.do?firstTime=true&reportID=94", "Name": "webclient.top.eventlog.reports", "desc": "Top N devices with most number of EventLogs" }, { "displayName": "Top Trap Count by Source", "customStatus": "False", "isCustom": "false", "id": 93, "url": "/reports/GenerateReports.do?firstTime=true&reportID=93", "Name": "webclient.top.trap.reports", "desc": "Top N devices with most number of Traps" }, { "displayName": "Alarm Suppressed Devices", "customStatus": "False", "isCustom": "false", "id": 92, "url": "/reports/GenerateReports.do?firstTime=true&reportID=92", "Name": "webclient.suppress.devices.reports", "desc": "Get report for suppressed devices" }, { "displayName": "Workflow Logs", "customStatus": "False", "isCustom": "false", "id": 90, "url": "/reports/GenerateReports.do?firstTime=true&reportID=90", "Name": "Workflow Logs", "desc": "Workflow logs report" }, { "displayName": "Syslog Events", "customStatus": "False", "isCustom": "false", "id": 88, "url": "/reports/GenerateReports.do?firstTime=true&reportID=88", "Name": "Syslog Events", "desc": "Get Syslog events report " }, { "displayName": "All Down Alerts", "customStatus": "False", "isCustom": "false", "id": 85, "url": "/reports/GenerateReports.do?firstTime=true&reportID=85", "Name": "All Down Alerts", "desc": "Get report for all down alerts" }, { "displayName": "All Alerts", "customStatus": "False", "isCustom": "false", "id": 84, "isFavourite": "True", "url": "/reports/GenerateReports.do?firstTime=true&reportID=84", "Name": "All Alerts", "desc": "Get report for all alerts" }, { "displayName": "Schedule Reports Log", "customStatus": "False", "isCustom": "false", "id": 8, "url": "/reports/GenerateReports.do?firstTime=true&reportID=8", "Name": "Schedule Reports Log", "desc": "Get report of schedule reports log" }, { "displayName": "Downtime Scheduler Log", "customStatus": "False", "isCustom": "false", "id": 7, "url": "/reports/GenerateReports.do?firstTime=true&reportID=7", "Name": "Downtime Scheduler Log", "desc": "Get report of downtime scheduler log" }, { "displayName": "Notification Profiles Triggered", "customStatus": "False", "isCustom": "false", "id": 6, "url": "/reports/GenerateReports.do?firstTime=true&reportID=6", "Name": "Notification Profiles Triggered", "desc": "Get report of notification profiles triggered" }, { "displayName": "Performance Monitor Error Log", "customStatus": "False", "isCustom": "false", "id": 5, "url": "/reports/GenerateReports.do?firstTime=true&reportID=5", "Name": "Performance Monitor Error Log", "desc": "Get performance monitor error log report" }, { "displayName": "Windows Event Log", "customStatus": "False", "isCustom": "false", "id": 4, "url": "/reports/GenerateReports.do?firstTime=true&reportID=4", "Name": "Windows Event Log", "desc": "Get windows event log report" }, { "displayName": "SNMP Trap Log", "customStatus": "False", "isCustom": "false", "id": 3, "url": "/reports/GenerateReports.do?firstTime=true&reportID=3", "Name": "SNMP Trap Log", "desc": "Get SNMP trap log report" }, { "displayName": "All Down Events", "customStatus": "False", "isCustom": "false", "id": 2, "url": "/reports/GenerateReports.do?firstTime=true&reportID=2", "Name": "All Down Events", "desc": "Get report for all down events" }, { "displayName": "All Events", "customStatus": "False", "isCustom": "false", "id": 1, "isFavourite": "True", "url": "/reports/GenerateReports.do?firstTime=true&reportID=1", "Name": "All Events", "desc": "Get report for all events" }, { "displayName": "DataCollection Error Logs for N Consecutive Time(s)", "id": "ServerHealthReport", "desc": "Get datacollection failure details for N consecutive times" }, { "displayName": "Audit Report", "id": "Audit", "url": "/reports/AuditReport.do", "desc": "Audit Report" } ] } ], "Name": "System" }, { "displayName": "Health and Performance", "list": [ { "title": "", "list": [ { "displayName": "VPN Summary", "customStatus": "False", "isCustom": "false", "id": 921, "url": "/reports/GenerateReports.do?firstTime=true&reportID=921", "Name": "webclient.opm.reports.vpnSummary", "desc": "Get summary report for Site-to-Site VPN devices." }, { "displayName": "Devices with Service Monitors", "customStatus": "False", "isCustom": "false", "id": 797, "url": "/reports/GenerateReports.do?firstTime=true&reportID=797", "Name": "webclient.service.monitors.report", "desc": "Get report for devices with Service monitors" }, { "displayName": "Devices with URL Monitors", "customStatus": "False", "isCustom": "false", "id": 796, "url": "/reports/GenerateReports.do?firstTime=true&reportID=796", "Name": "webclient.url.monitors.report", "desc": "Get report for devices with URL monitors" }, { "displayName": "Devices with NT Service Monitors", "customStatus": "False", "isCustom": "false", "id": 795, "url": "/reports/GenerateReports.do?firstTime=true&reportID=795", "Name": "webclient.ntservice.monitors.report", "desc": "Get report for devices with NT Service monitors" }, { "displayName": "Devices with Exchange Service Monitors", "customStatus": "False", "isCustom": "false", "id": 794, "url": "/reports/GenerateReports.do?firstTime=true&reportID=794", "Name": "webclient.exchangeservice.monitors.report", "desc": "Get report for devices with Exchange Service monitors" }, { "displayName": "Devices with MSSQL Service Monitors", "customStatus": "False", "isCustom": "false", "id": 793, "url": "/reports/GenerateReports.do?firstTime=true&reportID=793", "Name": "webclient.mssqlservice.monitors.report", "desc": "Get report for devices with MSSQL Service monitors" }, { "displayName": "Devices with AD Service Monitors", "customStatus": "False", "isCustom": "false", "id": 792, "url": "/reports/GenerateReports.do?firstTime=true&reportID=792", "Name": "webclient.ADService.monitors.report", "desc": "Get report for devices with AD Service monitors" }, { "displayName": "Devices with MSSQL Monitors", "customStatus": "False", "isCustom": "false", "id": 791, "url": "/reports/GenerateReports.do?firstTime=true&reportID=791", "Name": "webclient.mssql.monitors.report", "desc": "Get report for devices with MSSQL monitors" }, { "displayName": "Devices with Exchange Monitors", "customStatus": "False", "isCustom": "false", "id": 790, "url": "/reports/GenerateReports.do?firstTime=true&reportID=790", "Name": "webclient.exchange.monitors.report", "desc": "Get report for devices with Exchange monitors" }, { "displayName": "Devices with AD Monitors", "customStatus": "False", "isCustom": "false", "id": 789, "url": "/reports/GenerateReports.do?firstTime=true&reportID=789", "Name": "webclient.AD.monitors.report", "desc": "Get report for devices with AD monitors" }, { "displayName": "Devices with Process Monitors", "customStatus": "False", "isCustom": "false", "id": 788, "url": "/reports/GenerateReports.do?firstTime=true&reportID=788", "Name": "webclient.process.monitors.report", "desc": "Get report for devices with Process monitors" }, { "displayName": "Devices with Folder Monitors", "customStatus": "False", "isCustom": "false", "id": 787, "url": "/reports/GenerateReports.do?firstTime=true&reportID=787", "Name": "webclient.folder.monitors.report", "desc": "Get report for devices with Folder monitors" }, { "displayName": "Devices with File Monitors", "customStatus": "False", "isCustom": "false", "id": 786, "url": "/reports/GenerateReports.do?firstTime=true&reportID=786", "Name": "webclient.file.monitors.report", "desc": "Get report for devices with File monitors" }, { "displayName": "Devices with Performance Monitors", "customStatus": "False", "isCustom": "false", "id": 785, "url": "/reports/GenerateReports.do?firstTime=true&reportID=785", "Name": "webclient.perf.monitors.report", "desc": "Get report for devices with Perforamance monitors" }, { "displayName": "Flap Summary", "customStatus": "False", "isCustom": "false", "id": 780, "url": "/reports/GenerateReports.do?firstTime=true&reportID=780", "Name": "webclient.bgp.title.flapSummary", "desc": "Flap Summary for each BGP Peers" }, { "displayName": "Flap Count Summary", "customStatus": "False", "isCustom": "false", "id": 779, "url": "/reports/GenerateReports.do?firstTime=true&reportID=779", "Name": "webclient.bgp.title.flapCount", "desc": "Get Flap Count Summary for BGP Peers" }, { "displayName": "Processes by Absolute Memory", "customStatus": "True", "isCustom": "true", "id": 148, "url": "/reports/GenerateReports.do?firstTime=true&reportID=148", "Name": "Processes by Absolute Memory", "desc": "Identify absolute memory value of the Process" }, { "displayName": "Processes by Memory Utilization", "customStatus": "True", "isCustom": "true", "id": 145, "url": "/reports/GenerateReports.do?firstTime=true&reportID=145", "Name": "Processes by Memory Utilization", "desc": "Identify processes with high Memory Utilization" }, { "displayName": "Processes by CPU Utilization", "customStatus": "True", "isCustom": "true", "id": 144, "url": "/reports/GenerateReports.do?firstTime=true&reportID=144", "Name": "Processes by CPU Utilization", "desc": "Identify processes with high CPU Utilization" }, { "displayName": "Hardware Health Report", "customStatus": "False", "isCustom": "false", "id": 142, "url": "/reports/GenerateReports.do?firstTime=true&reportID=142", "Name": "webclient.reports.hardware.title", "desc": "Get Hardware Health Report" }, { "displayName": "Interfaces By TotalBytes Transferred", "customStatus": "False", "isCustom": "false", "id": 89, "url": "/reports/GenerateReports.do?firstTime=true&reportID=89", "Name": "Interfaces By TotalBytes Transferred", "desc": "Identify interfaces with high total bytes transferred" }, { "displayName": "Top N Errors And Discards", "customStatus": "False", "isCustom": "false", "id": 86, "url": "/reports/GenerateReports.do?firstTime=true&reportID=86", "Name": "Top N Errors And Discards", "desc": "Identify interfaces with high errors and discards" }, { "displayName": "Volumes With High Disk Utilization", "customStatus": "True", "isCustom": "true", "id": 83, "url": "/reports/GenerateReports.do?firstTime=true&reportID=83", "Name": "Volumes With High Disk Utilization", "desc": "Identify volumes with high disk utilization" }, { "displayName": "Volumes With Low Disk Utilization", "customStatus": "True", "isCustom": "true", "id": 82, "url": "/reports/GenerateReports.do?firstTime=true&reportID=82", "Name": "Volumes With Low Disk Utilization", "desc": "Identify volumes with low disk utilization" }, { "displayName": "All Interfaces By Traffic", "customStatus": "True", "isCustom": "true", "id": 81, "url": "/reports/GenerateReports.do?firstTime=true&reportID=81", "Name": "All Interfaces By Traffic", "desc": "Get traffic report of all interfaces" }, { "displayName": "DCs by Disk Utilization", "customStatus": "True", "isCustom": "true", "id": 51, "url": "/reports/GenerateReports.do?firstTime=true&reportID=51", "Name": "DCs by Disk Utilization", "desc": "Identify overloaded DCs with high Disk Utilization" }, { "displayName": "DCs by Memory Utilization", "customStatus": "True", "isCustom": "true", "id": 50, "url": "/reports/GenerateReports.do?firstTime=true&reportID=50", "Name": "DCs by Memory Utilization", "desc": "Identify overloaded DCs with high Memory Utilization" }, { "displayName": "DCs by CPU Utilization", "customStatus": "True", "isCustom": "true", "id": 49, "url": "/reports/GenerateReports.do?firstTime=true&reportID=49", "Name": "DCs by CPU Utilization", "desc": "Identify busy DCs with high CPU Utilization" }, { "displayName": "Ports by Tx Utilization", "customStatus": "True", "isCustom": "true", "id": 48, "url": "/reports/GenerateReports.do?firstTime=true&reportID=48", "Name": "Ports by Tx Utilization", "desc": "Identify ports with high % Transmit utilization" }, { "displayName": "Ports by Rx Utilization", "customStatus": "True", "isCustom": "true", "id": 47, "url": "/reports/GenerateReports.do?firstTime=true&reportID=47", "Name": "Ports by Rx Utilization", "desc": "Identify ports with high % Receive utilization" }, { "displayName": "Ports by Tx Errors", "customStatus": "True", "isCustom": "true", "id": 46, "url": "/reports/GenerateReports.do?firstTime=true&reportID=46", "Name": "Ports by Tx Errors", "desc": "Identify ports with most Transmit errors" }, { "displayName": "Ports by Rx Errors", "customStatus": "True", "isCustom": "true", "id": 45, "url": "/reports/GenerateReports.do?firstTime=true&reportID=45", "Name": "Ports by Rx Errors", "desc": "Identify ports with most Receive errors" }, { "displayName": "Ports by Tx Traffic", "customStatus": "True", "isCustom": "true", "id": 44, "url": "/reports/GenerateReports.do?firstTime=true&reportID=44", "Name": "Ports by Tx Traffic", "desc": "Identify ports with heavy outgoing traffic" }, { "displayName": "Ports by Rx Traffic", "customStatus": "True", "isCustom": "true", "id": 43, "url": "/reports/GenerateReports.do?firstTime=true&reportID=43", "Name": "Ports by Rx Traffic", "desc": "Identify ports with heavy incoming traffic" }, { "displayName": "Switches Health Report", "customStatus": "True", "isCustom": "true", "id": 42, "url": "/reports/GenerateReports.do?firstTime=true&reportID=42", "Name": "Switches Health Report", "desc": "Get health report of switches" }, { "displayName": "Router Interfaces by Tx Utilization", "customStatus": "True", "isCustom": "true", "id": 41, "url": "/reports/GenerateReports.do?firstTime=true&reportID=41", "Name": "Router Interfaces by Tx Utilization", "desc": "Identify interfaces with high % Transmit utilization" }, { "displayName": "Router Interfaces by Rx Utilization", "customStatus": "True", "isCustom": "true", "id": 40, "url": "/reports/GenerateReports.do?firstTime=true&reportID=40", "Name": "Router Interfaces by Rx Utilization", "desc": "Identify interfaces with high % Receive utilization" }, { "displayName": "Router Interfaces by Tx Errors", "customStatus": "True", "isCustom": "true", "id": 39, "url": "/reports/GenerateReports.do?firstTime=true&reportID=39", "Name": "Router Interfaces by Tx Errors", "desc": "Identify interfaces with high incoming errors" }, { "displayName": "Router Interfaces by Rx Errors", "customStatus": "True", "isCustom": "true", "id": 38, "url": "/reports/GenerateReports.do?firstTime=true&reportID=38", "Name": "Router Interfaces by Rx Errors", "desc": "Identify interfaces with high incoming errors" }, { "displayName": "Router Interfaces by Tx Traffic", "customStatus": "True", "isCustom": "true", "id": 37, "url": "/reports/GenerateReports.do?firstTime=true&reportID=37", "Name": "Router Interfaces by Tx Traffic", "desc": "Identify interfaces with heavy outgoing traffic" }, { "displayName": "Router Interfaces by Rx Traffic", "customStatus": "True", "isCustom": "true", "id": 36, "url": "/reports/GenerateReports.do?firstTime=true&reportID=36", "Name": "Router Interfaces by Rx Traffic", "desc": "Identify interfaces with heavy incoming traffic" }, { "displayName": "Routers by Memory Utilization", "customStatus": "True", "isCustom": "true", "id": 35, "url": "/reports/GenerateReports.do?firstTime=true&reportID=35", "Name": "Routers by Memory Utilization", "desc": "Identify overloaded routers with high Memory Utilization" }, { "displayName": "Routers by CPU Utilization", "customStatus": "True", "isCustom": "true", "id": 34, "url": "/reports/GenerateReports.do?firstTime=true&reportID=34", "Name": "Routers by CPU Utilization", "desc": "Identify busy routers with high CPU Utilization" }, { "displayName": "Routers Health Report", "customStatus": "True", "isCustom": "true", "id": 33, "url": "/reports/GenerateReports.do?firstTime=true&reportID=33", "Name": "Routers Health Report", "desc": "Get health report of routers" }, { "displayName": "All Servers Disk Usage Report", "customStatus": "True", "isCustom": "true", "id": 32, "url": "/reports/GenerateReports.do?firstTime=true&reportID=32", "Name": "All Servers Disk Usage Report", "desc": "Get partition wise disk usage report for all servers" }, { "displayName": "Volumes with Most Free Space", "customStatus": "True", "isCustom": "true", "id": 31, "url": "/reports/GenerateReports.do?firstTime=true&reportID=31", "Name": "Volumes with Most Free Space", "desc": "Identify disk partitions with most free space" }, { "displayName": "Volumes with Least Free Space", "customStatus": "True", "isCustom": "true", "id": 30, "url": "/reports/GenerateReports.do?firstTime=true&reportID=30", "Name": "Volumes with Least Free Space", "desc": "Identify disk partitions with least free space" }, { "displayName": "Servers by Tx Utilization", "customStatus": "True", "isCustom": "true", "id": 29, "url": "/reports/GenerateReports.do?firstTime=true&reportID=29", "Name": "Servers by Tx Utilization", "desc": "Identify servers with heavy outgoing traffic utilization" }, { "displayName": "Servers by Rx Utilization", "customStatus": "True", "isCustom": "true", "id": 28, "url": "/reports/GenerateReports.do?firstTime=true&reportID=28", "Name": "Servers by Rx Utilization", "desc": "Identify servers with heavy incoming traffic utilization" }, { "displayName": "Servers by Tx Traffic", "customStatus": "True", "isCustom": "true", "id": 27, "url": "/reports/GenerateReports.do?firstTime=true&reportID=27", "Name": "Servers by Tx Traffic", "desc": "Identify servers with heavy outgoing traffic" }, { "displayName": "Servers by Rx Traffic", "customStatus": "True", "isCustom": "true", "id": 26, "url": "/reports/GenerateReports.do?firstTime=true&reportID=26", "Name": "Servers by Rx Traffic", "desc": "Identify servers with heavy incoming traffic" }, { "displayName": "Servers by Disk Utilization", "customStatus": "True", "isCustom": "true", "id": 25, "url": "/reports/GenerateReports.do?firstTime=true&reportID=25", "Name": "Servers by Disk Utilization", "desc": "Identify overloaded servers with high Disk Utilization" }, { "displayName": "Servers by Memory Utilization", "customStatus": "True", "isCustom": "true", "id": 24, "url": "/reports/GenerateReports.do?firstTime=true&reportID=24", "Name": "Servers by Memory Utilization", "desc": "Identify overloaded servers with high Memory Utilization" }, { "displayName": "Servers by CPU Utilization", "customStatus": "True", "isCustom": "true", "id": 23, "url": "/reports/GenerateReports.do?firstTime=true&reportID=23", "Name": "Servers by CPU Utilization", "desc": "Identify busy servers with high CPU Utilization" }, { "displayName": "Servers Health Report", "customStatus": "True", "isCustom": "true", "id": 22, "isFavourite": "True", "url": "/reports/GenerateReports.do?firstTime=true&reportID=22", "Name": "Servers Health Report", "desc": "Get health report of servers" }, { "displayName": "Interfaces by Tx Errors", "customStatus": "False", "isCustom": "false", "id": 21, "url": "/reports/GenerateReports.do?firstTime=true&reportID=21", "Name": "Interfaces by Tx Errors", "desc": "Identify interfaces with high outgoing errors" }, { "displayName": "Interfaces by Rx Errors", "customStatus": "False", "isCustom": "false", "id": 20, "url": "/reports/GenerateReports.do?firstTime=true&reportID=20", "Name": "Interfaces by Rx Errors", "desc": "Identify interfaces with high incoming errors" }, { "displayName": "Interfaces by Tx Utilization", "customStatus": "False", "isCustom": "false", "id": 19, "url": "/reports/GenerateReports.do?firstTime=true&reportID=19", "Name": "Interfaces by Tx Utilization", "desc": "Identify devices with heavy outgoing traffic utilization" }, { "displayName": "Interfaces by Rx Utilization", "customStatus": "False", "isCustom": "false", "id": 18, "url": "/reports/GenerateReports.do?firstTime=true&reportID=18", "Name": "Interfaces by Rx Utilization", "desc": "Identify devices with heavy incoming traffic utilization" }, { "displayName": "Interfaces by Tx Traffic", "customStatus": "False", "isCustom": "false", "id": 17, "url": "/reports/GenerateReports.do?firstTime=true&reportID=17", "Name": "Interfaces by Tx Traffic", "desc": "Identify devices with heavy outgoing traffic" }, { "displayName": "Interfaces by Rx Traffic", "customStatus": "False", "isCustom": "false", "id": 16, "url": "/reports/GenerateReports.do?firstTime=true&reportID=16", "Name": "Interfaces by Rx Traffic", "desc": "Identify devices with heavy incoming traffic" }, { "displayName": "WAN Links by Utilization", "customStatus": "False", "isCustom": "false", "id": 15, "isFavourite": "True", "url": "/reports/GenerateReports.do?firstTime=true&reportID=15", "Name": "WAN Links by Utilization", "desc": "Identify WAN links with heavy traffic utilization" }, { "displayName": "All Interfaces by Utilization", "customStatus": "False", "isCustom": "false", "id": 14, "url": "/reports/GenerateReports.do?firstTime=true&reportID=14", "Name": "All Interfaces by Utilization", "desc": "Identify devices with heavy traffic utilization" }, { "displayName": "Disk Usage by Drives", "customStatus": "False", "isCustom": "false", "id": 13, "url": "/reports/GenerateReports.do?firstTime=true&reportID=13", "Name": "Disk Usage by Drives", "desc": "Identify overloaded devices with high Disk Utilization by drives" }, { "displayName": "Devices by Disk Utilization", "customStatus": "False", "isCustom": "false", "id": 12, "url": "/reports/GenerateReports.do?firstTime=true&reportID=12", "Name": "Devices by Disk Utilization", "desc": "Identify overloaded devices with high Disk Utilization" }, { "displayName": "Devices by Memory Utilization", "customStatus": "False", "isCustom": "false", "id": 11, "url": "/reports/GenerateReports.do?firstTime=true&reportID=11", "Name": "Devices by Memory Utilization", "desc": "Identify overloaded devices with high Memory Utilization" }, { "displayName": "Devices by CPU Utilization", "customStatus": "False", "isCustom": "false", "id": 10, "url": "/reports/GenerateReports.do?firstTime=true&reportID=10", "Name": "Devices by CPU Utilization", "desc": "Identify overloaded devices with high CPU Utilization" }, { "displayName": "Health Report", "customStatus": "False", "isCustom": "false", "id": 9, "url": "/reports/GenerateReports.do?firstTime=true&reportID=9", "Name": "Health Report", "desc": "Get health report of all devices" } ] } ], "Name": "Health and Performance" }, { "displayName": "Availability and Response", "list": [ { "title": "", "list": [ { "displayName": "Stack Switch Availability", "customStatus": "False", "isCustom": "false", "id": 1059, "url": "/reports/GenerateReports.do?firstTime=true&reportID=1059", "Name": "Stack Switch Availability", "desc": "Get availability report for all the Switches in a stack" }, { "displayName": "DownTime Report For Interfaces", "customStatus": "False", "isCustom": "false", "id": 724, "url": "/reports/GenerateReports.do?firstTime=true&reportID=724", "Name": "DownTime Report For Interfaces", "desc": "DownTime history for all interfaces" }, { "displayName": "Windows Service Monitors Availability", "customStatus": "True", "isCustom": "true", "id": 147, "url": "/reports/GenerateReports.do?firstTime=true&reportID=147", "Name": "Windows Service Monitors Availability", "desc": "Get availability report for all windows service monitors" }, { "displayName": "Process Monitors Availability", "customStatus": "True", "isCustom": "true", "id": 146, "url": "/reports/GenerateReports.do?firstTime=true&reportID=146", "Name": "Process Monitors Availability", "desc": "Get availability report for all process monitors" }, { "displayName": "DownTime Report", "customStatus": "False", "isCustom": "false", "id": 91, "url": "/reports/GenerateReports.do?firstTime=true&reportID=91", "Name": "DownTime Report", "desc": "DownTime history for all devices" }, { "displayName": "All Interfaces Availability", "customStatus": "False", "isCustom": "false", "id": 87, "isFavourite": "True", "url": "/reports/GenerateReports.do?firstTime=true&reportID=87", "Name": "All Interfaces Availability", "desc": "Get availability report for all interfaces" }, { "displayName": "Telnet Servers by Response Time", "customStatus": "True", "isCustom": "true", "id": 68, "url": "/reports/GenerateReports.do?firstTime=true&reportID=68", "Name": "Telnet Servers by Response Time", "desc": "Identify Telnet servers with high Response Time" }, { "displayName": "FTP Servers by Response Time", "customStatus": "True", "isCustom": "true", "id": 67, "url": "/reports/GenerateReports.do?firstTime=true&reportID=67", "Name": "FTP Servers by Response Time", "desc": "Identify FTP servers with high Response Time" }, { "displayName": "MySQL Servers by Response Time", "customStatus": "True", "isCustom": "true", "id": 66, "url": "/reports/GenerateReports.do?firstTime=true&reportID=66", "Name": "MySQL Servers by Response Time", "desc": "Identify MySQL servers with high Response Time" }, { "displayName": "SMTP Servers by Response Time", "customStatus": "True", "isCustom": "true", "id": 65, "url": "/reports/GenerateReports.do?firstTime=true&reportID=65", "Name": "SMTP Servers by Response Time", "desc": "Identify SMTP servers with high Response Time" }, { "displayName": "HTTP Servers by Response Time", "customStatus": "True", "isCustom": "true", "id": 64, "url": "/reports/GenerateReports.do?firstTime=true&reportID=64", "Name": "HTTP Servers by Response Time", "desc": "Identify Web servers with high Response Time" }, { "displayName": "Web Servers Availability", "customStatus": "True", "isCustom": "true", "id": 63, "url": "/reports/GenerateReports.do?firstTime=true&reportID=63", "Name": "Web Servers Availability", "desc": "Get availability report for all web servers" }, { "displayName": "DCs Availability Report", "customStatus": "True", "isCustom": "true", "id": 62, "url": "/reports/GenerateReports.do?firstTime=true&reportID=62", "Name": "DCs Availability Report", "desc": "Get availability report for all DCs" }, { "displayName": "Servers Availability Report", "customStatus": "True", "isCustom": "true", "id": 61, "url": "/reports/GenerateReports.do?firstTime=true&reportID=61", "Name": "Servers Availability Report", "desc": "Get availability report for all services" }, { "displayName": "Services by Response Time", "customStatus": "False", "isCustom": "false", "id": 60, "url": "/reports/GenerateReports.do?firstTime=true&reportID=60", "Name": "Services by Response Time", "desc": "Identify services with high response time" }, { "displayName": "URLs by Response Time", "customStatus": "False", "isCustom": "false", "id": 59, "url": "/reports/GenerateReports.do?firstTime=true&reportID=59", "Name": "URLs by Response Time", "desc": "Identify URLs with high response time" }, { "displayName": "Devices by Packet Loss", "customStatus": "False", "isCustom": "false", "id": 58, "url": "/reports/GenerateReports.do?firstTime=true&reportID=58", "Name": "Devices by Packet Loss", "desc": "Identify devices with high packet loss" }, { "displayName": "Devices by Response Time", "customStatus": "False", "isCustom": "false", "id": 57, "url": "/reports/GenerateReports.do?firstTime=true&reportID=57", "Name": "Devices by Response Time", "desc": "Identify devices with high response time" }, { "displayName": "Service Monitors Availability", "customStatus": "False", "isCustom": "false", "id": 56, "isFavourite": "True", "url": "/reports/GenerateReports.do?firstTime=true&reportID=56", "Name": "Service Monitors Availability", "desc": "Get availability report for all service monitors" }, { "displayName": "URLs Availability", "customStatus": "False", "isCustom": "false", "id": 55, "url": "/reports/GenerateReports.do?firstTime=true&reportID=55", "Name": "URLs Availability", "desc": "Get availability report for all URLs" }, { "displayName": "WAN Links Availability", "customStatus": "False", "isCustom": "false", "id": 54, "isFavourite": "True", "url": "/reports/GenerateReports.do?firstTime=true&reportID=54", "Name": "WAN Links Availability", "desc": "Get availability report for all interfaces" }, { "displayName": "Devices Availability Dashboard", "customStatus": "False", "isCustom": "false", "id": 53, "url": "/reports/GenerateReports.do?firstTime=true&reportID=53", "Name": "Devices Availability Dashboard", "desc": "Get availability report for all devices" }, { "displayName": "Devices Availability", "customStatus": "False", "isCustom": "false", "id": 52, "url": "/reports/GenerateReports.do?firstTime=true&reportID=52", "Name": "Devices Availability", "desc": "Get availability report for all devices" } ] } ], "Name": "Availability and Response" }, { "displayName": "Inventory", "list": [ { "title": "", "list": [ { "displayName": "Devices Summary Report", "customStatus": "False", "isCustom": "false", "id": 984, "url": "/reports/GenerateReports.do?firstTime=true&reportID=984", "Name": "webclient.report.name.devicesummaryreport", "desc": "Get the devices count summary report" }, { "displayName": "Performance Monitors By Devices", "customStatus": "False", "isCustom": "false", "id": 983, "url": "/reports/GenerateReports.do?firstTime=true&reportID=983", "Name": "webclient.report.name.devicemonitorreports", "desc": "Get all performance monitors for all of the devices" }, { "displayName": "Agent-monitored devices", "customStatus": "False", "isCustom": "false", "id": 876, "url": "/reports/GenerateReports.do?firstTime=true&reportID=876", "Name": "Agent Devices", "desc": "Get an Inventory report of all agent-monitored devices" }, { "displayName": "Credentials Associated Devices", "customStatus": "False", "isCustom": "false", "id": 772, "url": "/reports/GenerateReports.do?firstTime=true&reportID=772", "Name": "webclient.credential.devices.report", "desc": "Get report of credentials associated to devices" }, { "displayName": "Uplink Dependency Devices", "customStatus": "False", "isCustom": "false", "id": 727, "url": "/reports/GenerateReports.do?firstTime=true&reportID=727", "Name": "Up Link Dependency Devices", "desc": "Get inventory report of all dependent devices" }, { "displayName": "Devices by Added Time", "customStatus": "False", "isCustom": "false", "id": 725, "url": "/reports/GenerateReports.do?firstTime=true&reportID=725", "Name": "Devices by Added Time", "desc": "Get Devices with its Added Time" }, { "displayName": "IPMI Information", "customStatus": "False", "isCustom": "false", "id": 723, "url": "/reports/GenerateReports.do?firstTime=true&reportID=723", "Name": "webclient.reports.ipmi.info.title", "desc": "Get a report of your IPMI devices and related hardware" }, { "displayName": "Devices Down", "customStatus": "True", "isCustom": "true", "id": 722, "url": "/reports/GenerateReports.do?firstTime=true&reportID=722", "Name": "widget.name.devicesdown", "desc": "Get report for all devices down" }, { "displayName": "Hardware Information", "customStatus": "False", "isCustom": "false", "id": 155, "url": "/reports/GenerateReports.do?firstTime=true&reportID=155", "Name": "webclient.reports.hardwareinfo.title", "desc": "Get report of Hardware Information" }, { "displayName": "Threshold Details of Devices", "customStatus": "False", "isCustom": "false", "id": 150, "url": "/reports/GenerateReports.do?firstTime=true&reportID=150", "Name": "webclient.report.name.thresholdreports", "desc": "Get report of all thresholds configured" }, { "displayName": "Non SNMP Devices", "customStatus": "True", "isCustom": "true", "id": 80, "url": "/reports/GenerateReports.do?firstTime=true&reportID=80", "Name": "Non SNMP Devices", "desc": "Get inventory report of all SNMP not enabled devices" }, { "displayName": "SNMP Enabled Devices", "customStatus": "True", "isCustom": "true", "id": 79, "url": "/reports/GenerateReports.do?firstTime=true&reportID=79", "Name": "SNMP Enabled Devices", "desc": "Get inventory report of all SNMP enabled devices" }, { "displayName": "Desktop", "customStatus": "True", "isCustom": "true", "id": 78, "url": "/reports/GenerateReports.do?firstTime=true&reportID=78", "Name": "Desktops", "desc": "Get inventory report of desktops" }, { "displayName": "Server", "customStatus": "True", "isCustom": "true", "id": 77, "url": "/reports/GenerateReports.do?firstTime=true&reportID=77", "Name": "Servers", "desc": "Get inventory report of servers" }, { "displayName": "All Devices", "customStatus": "True", "isCustom": "true", "id": 76, "url": "/reports/GenerateReports.do?firstTime=true&reportID=76", "Name": "All Devices", "desc": "Get inventory report of all devices" }, { "displayName": "Interfaces by Type", "customStatus": "False", "isCustom": "false", "id": 75, "url": "/reports/GenerateReports.do?firstTime=true&reportID=75", "Name": "Interfaces by Type", "desc": "Get report of all interfaces by type" }, { "displayName": "Interface Speed Report", "customStatus": "False", "isCustom": "false", "id": 74, "url": "/reports/GenerateReports.do?firstTime=true&reportID=74", "Name": "Interface Speed Report", "desc": "Get report of interface bandwidth" }, { "displayName": "Notification Profiles Applied by Device", "customStatus": "False", "isCustom": "false", "id": 73, "url": "/reports/GenerateReports.do?firstTime=true&reportID=73", "Name": "Notification Profiles Applied by Device", "desc": "Get report of all notification profiles applied by device" }, { "displayName": "Notification Profiles Applied by Type", "customStatus": "False", "isCustom": "false", "id": 72, "url": "/reports/GenerateReports.do?firstTime=true&reportID=72", "Name": "Notification Profiles Applied by Type", "desc": "Get report of all notification profiles applied by profile type" }, { "displayName": "Notification Profiles Applied", "customStatus": "False", "isCustom": "false", "id": 71, "url": "/reports/GenerateReports.do?firstTime=true&reportID=71", "Name": "Notification Profiles Applied", "desc": "Get report of all notification profiles applied" }, { "displayName": "Devices by Category", "customStatus": "False", "isCustom": "false", "id": 70, "isFavourite": "True", "url": "/reports/GenerateReports.do?firstTime=true&reportID=70", "Name": "Devices by Category", "desc": "Get inventory report of devices by device category" }, { "displayName": "Devices by Device Type", "customStatus": "False", "isCustom": "false", "id": 69, "url": "/reports/GenerateReports.do?firstTime=true&reportID=69", "Name": "Devices by Device Type", "desc": "Get inventory report of devices by device type" } ] } ], "Name": "Inventory" }, { "displayName": "WAN IP Reports", "list": [ { "title": "", "list": [ { "displayName": "WAN IP Summary", "customStatus": "False", "isCustom": "false", "id": 1090, "url": "/reports/GenerateReports.do?firstTime=true&reportID=1090", "Name": "webclient.opm.reports.wanIp.Summary", "desc": "Get inventory reports of WAN IP Summary." }, { "displayName": "Site Summary", "customStatus": "False", "isCustom": "false", "id": 1089, "url": "/reports/GenerateReports.do?firstTime=true&reportID=1089", "Name": "webclient.opm.reports.wanIp.siteSummary", "desc": "Get inventory reports of Site Summary." } ] } ], "Name": "WAN IP Reports" }, { "displayName": "WAN RTT Monitors", "list": [ { "title": "", "list": [ { "displayName": "Top paths with maximum RTT", "customStatus": "False", "isCustom": "false", "id": 101, "url": "/reports/GenerateReports.do?firstTime=true&reportID=101", "Name": "Top paths with maximum RTT", "desc": "The paths with the highest round trip time" }, { "displayName": "Top paths with Maximum Threshold Violation", "customStatus": "False", "isCustom": "false", "id": 100, "url": "/reports/GenerateReports.do?firstTime=true&reportID=100", "Name": "Top paths with Maximum Threshold Violation", "desc": "The paths with maximum threshold violation" }, { "displayName": "Least available paths", "customStatus": "False", "isCustom": "false", "id": 99, "url": "/reports/GenerateReports.do?firstTime=true&reportID=99", "Name": "Least available paths", "desc": "The paths with the least availability" }, { "displayName": "Availability History", "customStatus": "False", "isCustom": "false", "id": 98, "url": "/reports/GenerateReports.do?firstTime=true&reportID=98", "Name": "Link Availability and Error Statistics", "desc": "Show availability of destination also show type of errors in case of failed operation" }, { "displayName": "Round Trip Time History Report", "customStatus": "False", "isCustom": "false", "id": 97, "url": "/reports/GenerateReports.do?firstTime=true&reportID=97", "Name": "Round Trip Time Trend Report", "desc": "Show RTT of icmp packets between source and destination host" }, { "displayName": "RTT Threshold Violation Report", "customStatus": "False", "isCustom": "false", "id": 96, "url": "/reports/GenerateReports.do?firstTime=true&reportID=96", "Name": "RTT Threshold Violation Report", "desc": "Shows threshold violation of icmp packets between source and destination host" } ] } ], "Name": "WAN RTT Monitors" }, { "displayName": "VoIP Monitors", "list": [ { "title": "", "list": [ { "displayName": "Top N Call Paths by Latency", "customStatus": "False", "isCustom": "false", "id": 111, "url": "/reports/GenerateReports.do?firstTime=true&reportID=111", "Name": "Top N Call Paths by Latency", "desc": "Top call paths with maximum Latency" }, { "displayName": "Top N Call Paths by Jitter", "customStatus": "False", "isCustom": "false", "id": 110, "url": "/reports/GenerateReports.do?firstTime=true&reportID=110", "Name": "Top N Call Paths by Jitter", "desc": "Top call paths with maximum Jitter" }, { "displayName": "Top N Call Paths by Packet Loss", "customStatus": "False", "isCustom": "false", "id": 109, "url": "/reports/GenerateReports.do?firstTime=true&reportID=109", "Name": "Top N Call Paths by Packet Loss", "desc": "Top call paths with maximum Packet Loss" }, { "displayName": "Top N Call Paths by MOS", "customStatus": "False", "isCustom": "false", "id": 108, "url": "/reports/GenerateReports.do?firstTime=true&reportID=108", "Name": "Top N Call Paths by MOS", "desc": "Top call paths with minimum MOS" }, { "displayName": "Round Trip Time History Report", "customStatus": "False", "isCustom": "false", "id": 107, "url": "/reports/GenerateReports.do?firstTime=true&reportID=107", "Name": "Round Trip Time History Report", "desc": "Shows RTT (Round Trip Time) of VoIP packets in both directions" }, { "displayName": "MOS History Report", "customStatus": "False", "isCustom": "false", "id": 106, "url": "/reports/GenerateReports.do?firstTime=true&reportID=106", "Name": "MOS History Report", "desc": "Report shows MOS (Mean Opinion Score) of VoIP traffic. MOS is the key quality indicator of VoIP traffic" }, { "displayName": "VoIP Errors History Report", "customStatus": "False", "isCustom": "false", "id": 105, "url": "/reports/GenerateReports.do?firstTime=true&reportID=105", "Name": "VoIP Errors History Report", "desc": "Shows various errors (timeout, tail drop,MIA etc.,) generated in the VoIP traffic" }, { "displayName": "Packet Loss History Report", "customStatus": "False", "isCustom": "false", "id": 104, "url": "/reports/GenerateReports.do?firstTime=true&reportID=104", "Name": "Packet Loss History Report", "desc": "Shows packetloss of VoIP packets in both directions" }, { "displayName": "Jitter History Report", "customStatus": "False", "isCustom": "false", "id": 103, "url": "/reports/GenerateReports.do?firstTime=true&reportID=103", "Name": "Jitter History Report", "desc": "Shows jitter (inter packet delay) of VoIP packets in bonfa.overview.Qos=QoS" }, { "displayName": "Latency History Report", "customStatus": "False", "isCustom": "false", "id": 102, "url": "/reports/GenerateReports.do?firstTime=true&reportID=102", "Name": "Latency History Report", "desc": "Shows latency of VoIP packets in both directions" } ] } ], "Name": "VoIP Monitors" }, { "displayName": "Virtual Servers Report", "list": [ { "title": "", "list": [ { "displayName": "All Virtual Machines", "customStatus": "False", "isCustom": "false", "id": 726, "url": "/reports/GenerateReports.do?firstTime=true&reportID=726", "Name": "widget.name.vmware.vmsList", "desc": "List of virtual machines based on virtual type" }, { "displayName": "Top VMware VMs by Memory Over Allocated", "customStatus": "False", "isCustom": "false", "id": 160, "url": "/reports/GenerateReports.do?firstTime=true&reportID=160", "Name": "widget.name.vmware.vmOverAllocatedMemory", "desc": "VMs with memory over allocated" }, { "displayName": "Top VMware VMs by Memory Under Allocated", "customStatus": "False", "isCustom": "false", "id": 159, "url": "/reports/GenerateReports.do?firstTime=true&reportID=159", "Name": "widget.name.vmware.vmUnderAllocatedMemory", "desc": "VMs with memory under allocated" }, { "displayName": "Top VMware VMs by CPU Over Allocated", "customStatus": "False", "isCustom": "false", "id": 158, "url": "/reports/GenerateReports.do?firstTime=true&reportID=158", "Name": "widget.name.vmware.vmOverAllocatedCPU", "desc": "VMs with CPU over allocated" }, { "displayName": "Top VMware VMs by CPU Under Allocated", "customStatus": "False", "isCustom": "false", "id": 157, "url": "/reports/GenerateReports.do?firstTime=true&reportID=157", "Name": "widget.name.vmware.vmUnderAllocatedCPU", "desc": "vms with under allocated CPU" }, { "displayName": "VMware Idle VMs", "customStatus": "False", "isCustom": "false", "id": 156, "url": "/reports/GenerateReports.do?firstTime=true&reportID=156", "Name": "widget.name.vmware.idleVms", "desc": "List of Idle VMs" }, { "displayName": "HyperV-Host vs Disk Mapping", "customStatus": "False", "isCustom": "false", "id": 154, "url": "/reports/GenerateReports.do?firstTime=true&reportID=154", "Name": "webclient.virtual.hyperv.hostdisk.report", "desc": "Get report for all Monitored HyperV-Host Vs Disk Mappings" }, { "displayName": "Datastore vs VMware-Host Mapping", "customStatus": "False", "isCustom": "false", "id": 153, "url": "/reports/GenerateReports.do?firstTime=true&reportID=153", "Name": "webclient.virtual.vmware.datastorehost.report", "desc": "Get report for all Datastore Vs Monitored VMware-Host Mappings" }, { "displayName": "Datastore vs VMware-VM Mapping", "customStatus": "False", "isCustom": "false", "id": 152, "url": "/reports/GenerateReports.do?firstTime=true&reportID=152", "Name": "webclient.virtual.vmware.datastorevm.report", "desc": "Get report for all Datastore Vs Monitored VMware-VM Mappings" } ] } ], "Name": "Virtual Servers Report" }, { "displayName": "Storage Reports", "list": [ { "title": "", "list": [ { "displayName": "Storage Utilization", "customStatus": "False", "isCustom": "false", "id": 755, "url": "/reports/GenerateReports.do?firstTime=true&reportID=755", "Name": "opmanager.storage.utilizationreport.name", "desc": "Get the Utilization for Storage Devices/Components" }, { "displayName": "Storage Latency", "customStatus": "False", "isCustom": "false", "id": 754, "url": "/reports/GenerateReports.do?firstTime=true&reportID=754", "Name": "opmanager.storage.latencyreport.name", "desc": "Get the Latency for Storage Devices/Components" }, { "displayName": "Storage Throughput", "customStatus": "False", "isCustom": "false", "id": 753, "url": "/reports/GenerateReports.do?firstTime=true&reportID=753", "Name": "opmanager.storage.throughputreport.name", "desc": "Get the Throughput for Storage Devices/Components" }, { "displayName": "Storage IOPS", "customStatus": "False", "isCustom": "false", "id": 752, "url": "/reports/GenerateReports.do?firstTime=true&reportID=752", "Name": "opmanager.storage.iopsreport.name", "desc": "Get the IOPS for Storage Devices/Components" }, { "displayName": "Growth Trend", "customStatus": "False", "isCustom": "false", "id": 174, "url": "/reports/GenerateReports.do?firstTime=true&reportID=174", "Name": "webclient.reports.growthtrend.title", "desc": "Growth Trend" }, { "displayName": "RAID Forecast By Utilization", "customStatus": "False", "isCustom": "false", "id": 173, "url": "/reports/GenerateReports.do?firstTime=true&reportID=173", "Name": "webclient.reports.forecast.title", "desc": "RAID Forecast By Utilization" }, { "displayName": "Disk Writes/Sec", "customStatus": "False", "isCustom": "false", "id": 172, "url": "/reports/GenerateReports.do?firstTime=true&reportID=172", "Name": "webclient.reports.topndiskwrites", "desc": "Disk Writes/Sec" }, { "displayName": "Disk Reads/Sec", "customStatus": "False", "isCustom": "false", "id": 171, "url": "/reports/GenerateReports.do?firstTime=true&reportID=171", "Name": "webclient.reports.topndiskreads", "desc": "Disk Reads/Sec" }, { "displayName": "Disk IOPS", "customStatus": "False", "isCustom": "false", "id": 170, "url": "/reports/GenerateReports.do?firstTime=true&reportID=170", "Name": "webclient.reports.topndiskiops", "desc": "Disk IOPS" }, { "displayName": "RAID Controller Writes/Sec", "customStatus": "False", "isCustom": "false", "id": 169, "url": "/reports/GenerateReports.do?firstTime=true&reportID=169", "Name": "webclient.reports.topnraidcontrollerwrites", "desc": "RAID Controller Writes/Sec" }, { "displayName": "RAID Controller Reads/Sec", "customStatus": "False", "isCustom": "false", "id": 168, "url": "/reports/GenerateReports.do?firstTime=true&reportID=168", "Name": "webclient.reports.topnraidcontrollerreads", "desc": "RAID Controller Reads/Sec" }, { "displayName": "RAID Controller IOPS", "customStatus": "False", "isCustom": "false", "id": 167, "url": "/reports/GenerateReports.do?firstTime=true&reportID=167", "Name": "webclient.reports.topnraidcontrolleriops", "desc": "RAID Controller IOPS" }, { "displayName": "RAID Latency", "customStatus": "False", "isCustom": "false", "id": 166, "url": "/reports/GenerateReports.do?firstTime=true&reportID=166", "Name": "webclient.reports.topnraidlatency", "desc": "RAID Latency" }, { "displayName": "RAID Writes/Sec", "customStatus": "False", "isCustom": "false", "id": 165, "url": "/reports/GenerateReports.do?firstTime=true&reportID=165", "Name": "webclient.reports.topnraidwrites", "desc": "RAID Writes/Sec" }, { "displayName": "RAID Reads/Sec", "customStatus": "False", "isCustom": "false", "id": 164, "url": "/reports/GenerateReports.do?firstTime=true&reportID=164", "Name": "webclient.reports.topnraidreads", "desc": "RAID Reads/Sec" }, { "displayName": "RAID IOPS ", "customStatus": "False", "isCustom": "false", "id": 163, "url": "/reports/GenerateReports.do?firstTime=true&reportID=163", "Name": "webclient.reports.topnraidiops", "desc": "RAID IOPS " }, { "displayName": "RAID Capacity Utilization", "customStatus": "False", "isCustom": "false", "id": 162, "url": "/reports/GenerateReports.do?firstTime=true&reportID=162", "Name": "webclient.reports.topncapacity", "desc": "RAID Capacity Utilization" }, { "displayName": "Storage Summary", "customStatus": "False", "isCustom": "false", "id": 161, "url": "/reports/GenerateReports.do?firstTime=true&reportID=161", "Name": "webclient.reports.storagesummary.title", "desc": "Storage Summary" } ] } ], "Name": "Storage Reports" }, { "displayName": "Forecast Reports", "list": [ { "title": "", "list": [ { "displayName": "Monitor forecasting trend", "customStatus": "False", "isCustom": "false", "id": 974, "url": "/reports/GenerateReports.do?firstTime=true&reportID=974", "Name": "webclient.opm.reports.forecasttrend.name", "desc": "Performance monitor forecasting trend" }, { "displayName": "CPU Forecast", "customStatus": "False", "isCustom": "false", "id": 178, "url": "/reports/GenerateReports.do?firstTime=true&reportID=178", "Name": "CPU Forecast", "desc": "Forecasts the CPU utilization" }, { "displayName": "Memory Forecast", "customStatus": "False", "isCustom": "false", "id": 177, "url": "/reports/GenerateReports.do?firstTime=true&reportID=177", "Name": "Memory Forecast", "desc": "Forecasts the Memory Utilization" }, { "displayName": "Disk Forecast By Usage", "customStatus": "False", "isCustom": "false", "id": 175, "url": "/reports/GenerateReports.do?firstTime=true&reportID=175", "Name": "Disk Forecast By Usage", "desc": "Disk Forecast By Usage" } ] } ], "Name": "Forecast Reports" }, { "displayName": "Nutanix Reports", "list": [ { "title": "", "list": [ { "displayName": "Top N Hosts by IO Bandwidth", "customStatus": "False", "isCustom": "false", "id": 743, "url": "/reports/GenerateReports.do?firstTime=true&reportID=743", "Name": "webclient.nutanix.hostUnderBandwidth.report", "desc": "Get report for Top Disks with IO Bandwidth rate" }, { "displayName": "Top N Hosts by Latency", "customStatus": "False", "isCustom": "false", "id": 742, "url": "/reports/GenerateReports.do?firstTime=true&reportID=742", "Name": "webclient.nutanix.hostUnderLatency.report", "desc": "Get report for Top Hosts with Latency" }, { "displayName": "Top N Disks by free space", "customStatus": "False", "isCustom": "false", "id": 741, "url": "/reports/GenerateReports.do?firstTime=true&reportID=741", "Name": "webclient.nutanix.diskUnderFreespace.report", "desc": "Get report for Top Disks with Free space" }, { "displayName": "Top N Hosts by IOPS", "customStatus": "False", "isCustom": "false", "id": 740, "url": "/reports/GenerateReports.do?firstTime=true&reportID=740", "Name": "webclient.nutanix.hostsUnderIOPS.report", "desc": "Get report for Top Hosts with IOPS rate" }, { "displayName": "Disk Inventory", "customStatus": "False", "isCustom": "false", "id": 739, "url": "/reports/GenerateReports.do?firstTime=true&reportID=739", "Name": "webclient.nutanix.disk.report", "desc": "Get report for all Disk Inventory Details" }, { "displayName": "Storage Containers", "customStatus": "False", "isCustom": "false", "id": 738, "url": "/reports/GenerateReports.do?firstTime=true&reportID=738", "Name": "webclient.nutanix.storagecontainers", "desc": "Get report for all Storage Container Details" }, { "displayName": "Host Summary", "customStatus": "False", "isCustom": "false", "id": 737, "url": "/reports/GenerateReports.do?firstTime=true&reportID=737", "Name": "webclient.nutanix.clusterToHostMap.report", "desc": "Get report for all Host Details based on its Cluster" }, { "displayName": "Cluster Latency", "customStatus": "False", "isCustom": "false", "id": 736, "url": "/reports/GenerateReports.do?firstTime=true&reportID=736", "Name": "webclient.nutanix.cluster.latency.report", "desc": "Get report for all Cluster Latency Data" }, { "displayName": "Cluster IOPS", "customStatus": "False", "isCustom": "false", "id": 735, "url": "/reports/GenerateReports.do?firstTime=true&reportID=735", "Name": "webclient.nutanix.cluster.iops.report", "desc": "Get report for all Cluster IOPS Data" }, { "displayName": "Cluster Inventory", "customStatus": "False", "isCustom": "false", "id": 734, "url": "/reports/GenerateReports.do?firstTime=true&reportID=734", "Name": "webclient.nutanix.cluster.report", "desc": "Get report for all Cluster details" }, { "displayName": "VM Summary by Host", "customStatus": "False", "isCustom": "false", "id": 733, "url": "/reports/GenerateReports.do?firstTime=true&reportID=733", "Name": "webclient.nutanix.hostToVmMap.report", "desc": "Get report for VMs Details based on its Host" }, { "displayName": "VM Summary by Cluster", "customStatus": "False", "isCustom": "false", "id": 732, "url": "/reports/GenerateReports.do?firstTime=true&reportID=732", "Name": "webclient.nutanix.clusterToVMMap.report", "desc": "Get report for VM Details based on its Cluster" } ] } ], "Name": "Nutanix Reports" }, { "displayName": "WLC Reports", "list": [ { "title": "", "list": [ { "displayName": "Rogue SSID Details", "customStatus": "False", "isCustom": "false", "id": 852, "url": "/reports/GenerateReports.do?firstTime=true&reportID=852", "Name": "webclient.inventory.RougeAP.report", "desc": "Get inventory report of Rogue SSIDs" }, { "displayName": "AP Details", "customStatus": "False", "isCustom": "false", "id": 851, "url": "/reports/GenerateReports.do?firstTime=true&reportID=851", "Name": "webclient.inventory.accessPoints.report", "desc": "Get inventory report of Access points" }, { "displayName": "AP Availability", "customStatus": "False", "isCustom": "false", "id": 850, "url": "/reports/GenerateReports.do?firstTime=true&reportID=850", "Name": "webclient.availability.accessPoints.report", "desc": "Get availability report for Access points" } ] } ], "Name": "WLC Reports" }, { "displayName": "Meraki Reports", "list": [ { "title": "", "list": [ { "displayName": "Meraki Sensor Details", "customStatus": "False", "isCustom": "false", "id": 875, "url": "/reports/GenerateReports.do?firstTime=true&reportID=875", "Name": "webclient.opm.reports.meraki.mtdetails", "desc": "Get summary reports of Meraki Sensor devices." }, { "displayName": "Down Meraki Devices", "customStatus": "False", "isCustom": "false", "id": 874, "url": "/reports/GenerateReports.do?firstTime=true&reportID=874", "Name": "webclient.opm.reports.meraki.down", "desc": "Get reports for all Meraki devices that are down." }, { "displayName": "Meraki AP Details", "customStatus": "False", "isCustom": "false", "id": 873, "url": "/reports/GenerateReports.do?firstTime=true&reportID=873", "Name": "webclient.opm.reports.meraki.apDetails", "desc": "Get inventory reports of Meraki Access Points." }, { "displayName": "Meraki Rogue SSID Details", "customStatus": "False", "isCustom": "false", "id": 872, "url": "/reports/GenerateReports.do?firstTime=true&reportID=872", "Name": "webclient.opm.reports.meraki.rogue", "desc": "Get inventory reports of Meraki Rogue SSIDs." }, { "displayName": "Meraki Cellular Gateway Details", "customStatus": "False", "isCustom": "false", "id": 871, "url": "/reports/GenerateReports.do?firstTime=true&reportID=871", "Name": "webclient.opm.reports.meraki.mgdetails", "desc": "Get summary reports of Meraki Gateway devices." }, { "displayName": "Meraki MV Details", "customStatus": "False", "isCustom": "false", "id": 870, "url": "/reports/GenerateReports.do?firstTime=true&reportID=870", "Name": "webclient.opm.reports.meraki.mvdetails", "desc": "Get summary reports of Meraki Vision devices." }, { "displayName": "Meraki MR Details", "customStatus": "False", "isCustom": "false", "id": 869, "url": "/reports/GenerateReports.do?firstTime=true&reportID=869", "Name": "webclient.opm.reports.meraki.mrdetails", "desc": "Get summary reports of Meraki Radio devices." }, { "displayName": "Meraki MS Details", "customStatus": "False", "isCustom": "false", "id": 868, "url": "/reports/GenerateReports.do?firstTime=true&reportID=868", "Name": "webclient.opm.reports.meraki.msdetails", "desc": "Get summary reports of Meraki Switch devices." }, { "displayName": "Meraki MX Details", "customStatus": "False", "isCustom": "false", "id": 867, "url": "/reports/GenerateReports.do?firstTime=true&reportID=867", "Name": "webclient.opm.reports.meraki.mxdetails", "desc": "Get summary reports of Meraki Security appliances." }, { "displayName": "Meraki Organization Summary", "customStatus": "False", "isCustom": "false", "id": 866, "url": "/reports/GenerateReports.do?firstTime=true&reportID=866", "Name": "webclient.opm.reports.meraki.orgSummary", "desc": "Get inventory reports of devices in each organization" } ] } ], "Name": "Meraki Reports" }, { "displayName": "Capacity Planning Reports", "list": [ { "title": "", "list": [ { "displayName": "Idle interfaces", "customStatus": "False", "isCustom": "false", "id": 1027, "url": "/reports/GenerateReports.do?firstTime=true&reportID=1027", "Name": "opm.reports.interface.cpr.idle.name", "desc": "Lists the idle interfaces in the network" }, { "displayName": "Underutilized interfaces", "customStatus": "False", "isCustom": "false", "id": 1026, "url": "/reports/GenerateReports.do?firstTime=true&reportID=1026", "Name": "opm.reports.interface.cpr.underutilized.name", "desc": "Lists the interfaces with over allocated resources" }, { "displayName": "Overutilized interfaces", "customStatus": "False", "isCustom": "false", "id": 1025, "url": "/reports/GenerateReports.do?firstTime=true&reportID=1025", "Name": "opm.reports.interface.cpr.overutilized.name", "desc": "Lists the heavily used interfaces with insufficient resources" }, { "displayName": "Overutilized devices", "customStatus": "False", "isCustom": "false", "id": 1024, "url": "/reports/GenerateReports.do?firstTime=true&reportID=1024", "Name": "webclient.reports.cpr.overutilized.name", "desc": "Lists the heavily used devices with insufficient resources" }, { "displayName": "Underutilized devices", "customStatus": "False", "isCustom": "false", "id": 1023, "url": "/reports/GenerateReports.do?firstTime=true&reportID=1023", "Name": "webclient.reports.cpr.underutilized.name", "desc": "Lists the devices with over allocated resources" }, { "displayName": "Idle devices", "customStatus": "False", "isCustom": "false", "id": 1022, "url": "/reports/GenerateReports.do?firstTime=true&reportID=1022", "Name": "webclient.reports.cpr.idle.name", "desc": "Lists the idle devices in the network" } ] } ], "Name": "webclient.reports.cpreports" }, { "displayName": "Trend Reports", "list": [ { "title": "", "list": [ { "displayName": "Interface Utilization Trends", "customStatus": "False", "isCustom": "false", "id": 1053, "url": "/reports/GenerateReports.do?firstTime=true&reportID=1053", "Name": "opmanager.intftrendreport.name", "desc": "Get the hourly/daily/weekly data of Interface Utilization" }, { "displayName": "Event Trends", "customStatus": "False", "isCustom": "false", "id": 1052, "url": "/reports/GenerateReports.do?firstTime=true&reportID=1052", "Name": "opmanager.eventreport.name", "desc": "Get the hourly/daily/weekly Events count." }, { "displayName": "Memory Utilization Trends", "customStatus": "False", "isCustom": "false", "id": 1051, "url": "/reports/GenerateReports.do?firstTime=true&reportID=1051", "Name": "opmanager.memoryreport.name", "desc": "Get the hourly/daily/weekly data of Memory utilization" }, { "displayName": "Disk Utilization Trends", "customStatus": "False", "isCustom": "false", "id": 1050, "url": "/reports/GenerateReports.do?firstTime=true&reportID=1050", "Name": "opmanager.diskreport.name", "desc": "Get the hourly/daily/weekly data of Disk utilization" }, { "displayName": "CPU Utilization Trends", "customStatus": "False", "isCustom": "false", "id": 1049, "url": "/reports/GenerateReports.do?firstTime=true&reportID=1049", "Name": "opmanager.cpureport.name", "desc": "Get the hourly/daily/weekly data of CPU utilization" } ] } ], "Name": "opmanager.periodicReports.title" }, { "displayName": "Load Balancer Reports", "list": [ { "title": "", "list": [ { "displayName": "F5 Pool Member Availability Reports", "customStatus": "False", "isCustom": "false", "id": 1068, "url": "/reports/GenerateReports.do?firstTime=true&reportID=1068", "Name": "webclient.f5lb.pm.avail.report", "desc": "Get Availability Report for Pool Members." }, { "displayName": "F5 Virtual Server Availability Reports", "customStatus": "False", "isCustom": "false", "id": 1067, "url": "/reports/GenerateReports.do?firstTime=true&reportID=1067", "Name": "webclient.f5lb.vs.avail.report", "desc": "Get Availability Report for Virtual Servers." }, { "displayName": "F5 Pool Member Consolidated Reports", "customStatus": "False", "isCustom": "false", "id": 1066, "url": "/reports/GenerateReports.do?firstTime=true&reportID=1066", "Name": "webclient.f5lb.pm.consolidated.report", "desc": "Get consolidated report for Pool Members." }, { "displayName": "F5 Virtual Server Consolidated Reports", "customStatus": "False", "isCustom": "false", "id": 1065, "url": "/reports/GenerateReports.do?firstTime=true&reportID=1065", "Name": "webclient.f5lb.vs.consolidated.report", "desc": "Get consolidated report for Virtual Servers." }, { "displayName": "Kemp Real Server Availability Reports", "customStatus": "False", "isCustom": "false", "id": 1063, "url": "/reports/GenerateReports.do?firstTime=true&reportID=1063", "Name": "webclient.lb.rs.avail.report", "desc": "Get Availability Report for Real Servers." }, { "displayName": "Kemp Virtual Service Availability Reports", "customStatus": "False", "isCustom": "false", "id": 1062, "url": "/reports/GenerateReports.do?firstTime=true&reportID=1062", "Name": "webclient.lb.vs.avail.report", "desc": "Get Availability Report for Virtual Services." }, { "displayName": "Kemp Real Server Consolidated Reports", "customStatus": "False", "isCustom": "false", "id": 1061, "url": "/reports/GenerateReports.do?firstTime=true&reportID=1061", "Name": "webclient.lb.rs.consolidated.report", "desc": "Get consolidated report for Real Servers." }, { "displayName": "Kemp Virtual Service Consolidated Reports", "customStatus": "False", "isCustom": "false", "id": 1060, "url": "/reports/GenerateReports.do?firstTime=true&reportID=1060", "Name": "webclient.lb.vs.consolidated.report", "desc": "Get consolidated report for Virtual Services." } ] } ], "Name": "webclient.reports.loadbalancer" }, { "ScheduleReports": false, "FavoriteReports": false, "CustomReports": true } ] } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "isFavouriteNeeded", "required": false, "description": "Boolean value that must be set to true when favorite reports are to be listed under a separate report type, \u201cMy Favorites\u201d.", "schema": { "type": "boolean", "description": "" } } ], "tags": [ "OpManager.Reports" ], "security": [], "x-zenesis-sections": {}, "x-zenesis-doc": { "show": true }, "x-zenesis-envTags": [] } }, "/api/json/v2/nfadevice/getWLCApmacReport": { "get": { "summary": "Get Access Point Traffic", "x-zenesis-title": "Get Access Point Traffic", "x-zenesis-security": {}, "description": "Get all the traffic information for the access point like traffic , top SSID, Top client, applications etc.", "operationId": "getWLCApmacReport", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "properties": { "stdEndTime": { "type": "string" }, "stdStartTime": { "type": "string" }, "startTime": { "type": "string" }, "endTime": { "type": "string" }, "TimeZone": { "type": "string" }, "granularity": { "type": "string" }, "yaxis": { "type": "string" }, "thresholdText": { "type": "array", "items": { "type": "string" }, "description": "Threshold descriptions" }, "thresholdLine": { "type": "array", "items": { "type": "number" }, "description": "Threshold values" }, "TrafficData": { "type": "array", "description": "Tabular time-based traffic", "items": { "type": "object", "properties": { "Time": { "type": "string" }, "IN": { "type": "string" }, "OUT": { "type": "string" } } } }, "GraphData": { "type": "array", "description": "Graph series data", "items": { "type": "object", "properties": { "seriesname": { "type": "string" }, "data": { "type": "array", "items": { "type": "array", "items": { "type": "number" } } }, "yaxiscolumnorder": { "type": "array", "items": { "type": "integer" } } } } }, "Data": { "type": "object", "description": "Summary statistics", "properties": { "RouterIP": { "type": "string" }, "Name": { "type": "string" }, "showGranularity": { "type": "boolean" }, "trafficdata": { "type": "array", "description": "Summary table", "items": { "type": "array", "items": [ { "type": "string", "description": "Traffic type (IN/OUT)" }, { "type": "string", "description": "95th percentile" }, { "type": "string", "description": "Average" }, { "type": "string", "description": "Total" }, { "type": "string", "description": "Max" }, { "type": "string", "description": "Std Dev" }, { "type": "string", "description": "Min" } ] } } } }, "resultdata": { "type": "object", "description": "Duplicate summary data (legacy)", "properties": { "RouterIP": { "type": "string" }, "Name": { "type": "string" }, "showGranularity": { "type": "boolean" }, "trafficdata": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } } } } } }, "examples": { "Example1": { "value": { "stdEndTime": "2026-04-03 02:28", "stdStartTime": "2026-04-03 01:28", "startTime": "2026-04-03 01:28", "endTime": "2026-04-03 02:28", "TimeZone": "America/New_York", "granularity": "1 Minute Average", "yaxis": "bytes", "thresholdText": [ "IN 95th Percentile : 49.00bytes", "OUT 95th Percentile : 75.00bytes" ], "thresholdLine": [ 49, 75 ], "TrafficData": [ { "Time": "2026-04-03 02:28", "IN": "0.00 Bytes", "OUT": "24.00 Bytes" } ], "GraphData": [ { "seriesname": "IN", "data": [ [ 1775195340000, 30 ] ], "yaxiscolumnorder": [ 0 ] } ], "Data": { "RouterIP": "00:1A:2B:3C:4D:5E", "Name": "00:1A:2B:3C:4D:5E", "showGranularity": true, "trafficdata": [ [ "Traffic IN", "49.00 Bytes", "22.37 Bytes", "397.00 Bytes", "113.00 Bytes", "6.51 Bytes", "0.00 Bytes" ] ] } } } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "apMacID", "required": false, "description": "unique Access point ID", "schema": { "$ref": "#/components/schemas/NFA_Source_ID_regex" } }, { "in": "query", "name": "ReportType", "required": false, "description": "Type of report.\nPossible values : graph , topIPHost , topHost , topSSID , topApp , topConv , topDSCP", "schema": { "$ref": "#/components/schemas/only_alphabets_regex" } }, { "in": "query", "name": "graphoption", "required": false, "description": "Format Traffic data like volume / speed / Packets", "schema": { "$ref": "#/components/schemas/only_alphabets_regex" } }, { "in": "query", "name": "type", "required": false, "description": "Data direction IN/ OUT", "schema": { "$ref": "#/components/schemas/NFAData_regex" } }, { "in": "query", "name": "isSSIDGrp", "required": false, "description": "true - if the resource is ssidgroup", "schema": { "$ref": "#/components/schemas/NFABoolean_regex" } }, { "in": "query", "name": "isApGrp", "required": false, "description": "true - if the resource is Access point group", "schema": { "$ref": "#/components/schemas/NFABoolean_regex" } }, { "$ref": "#/components/parameters/NFA_Reports_Time_Params_TimeFrame", "description": "Specifies the period of time for which you want to retrieve data (e.g., last_hour, 6_hours).Possible time frames : 15minute|30minute|hourly|6hour|daily|today|yesterday|weekly|prevweek|monthly|prevmonth|quarterly|custom" }, { "$ref": "#/components/parameters/NFA_Reports_Time_Params_StartTime", "description": "Start time of custom time period (only if custom time period is chosen) in YYYY-MM-DD HH:MMformat." }, { "$ref": "#/components/parameters/NFA_Reports_Time_Params_EndTime", "description": "End time of custom time period (only if custom time period is chosen) in YYYY-MM-DD HH:MMformat." }, { "$ref": "#/components/parameters/NFADEparams_collOpt", "description": "" }, { "in": "query", "name": "eeProbeID", "required": false, "description": "Probe ID to be supplied if the device is accessed from OpManager Central.", "schema": { "type": "integer", "format": "int64", "description": "" } } ], "tags": [ "NFA.WLC" ], "security": [], "x-zenesis-sections": {}, "x-zenesis-doc": { "show": true }, "x-zenesis-envTags": [] } }, "/api/json/nfaee/getAllCollInfo": { "get": { "summary": "List Probes", "x-zenesis-title": "List Probes", "x-zenesis-security": {}, "description": " List all probes with basic info of the probes like name , ip, state, isHttp , url ,port and etc", "operationId": "getAllCollInfo", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "IP": { "type": "string" }, "url": { "type": "string" }, "port": { "type": "integer" }, "state": { "type": "integer" }, "collStatus": { "type": "string" }, "isInternalColl": { "type": "boolean" }, "colDPI": { "type": "boolean" }, "dpiAvailable": { "type": "boolean" }, "colIntf": { "type": "boolean" }, "interfaceAvailable": { "type": "boolean" }, "isHttp": { "type": "boolean" } } } }, "examples": { "Example1": { "value": [ { "id": 1, "name": "Probe_1", "IP": "localhost", "url": "https://localhost:8071", "port": 8071, "state": 0, "collStatus": "Up", "isInternalColl": false, "colDPI": true, "dpiAvailable": true, "colIntf": true, "interfaceAvailable": true, "isHttp": false } ] } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "$ref": "#/components/parameters/NFADEparams_collOpt", "description": "" } ], "tags": [ "NFA.Settings" ], "security": [], "x-zenesis-sections": {}, "x-zenesis-doc": { "show": true }, "x-zenesis-envTags": [] } }, "/api/json/enterprise/listProbes": { "get": { "summary": "Get List of Probes", "x-zenesis-title": "Get List of Probes", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "25" }, "description": "Retrieves all probes configured in the central server for distributed environments. Returns PROBEID (unique probe identifier), DISPLAYNAME (probe name), IPADDRESS (probe IP), STATUS (true indicates available, false indicates unavailable), and SITEID (site identifier). Use this API to discover probes and obtain required identifiers for probe-specific operations.", "operationId": "listProbes", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "description": "", "properties": { "DISPLAYNAME": { "type": "string", "description": "" }, "STATUS": { "type": "boolean", "description": "" }, "PROBEID": { "type": "string", "description": "" }, "ISWINDOWS": { "type": "boolean", "description": "" }, "IPADDRESS": { "type": "string", "description": "" }, "SITEID": { "type": "string", "description": "" }, "TIMEZONE": { "type": "string", "description": "" }, "NAME": { "type": "string", "description": "" } } }, "description": "" }, "examples": { "Example1": { "value": [ { "DISPLAYNAME": "Demo_1", "STATUS": false, "PROBEID": "20000000001", "ISWINDOWS": true, "IPADDRESS": "", "SITEID": "2", "TIMEZONE": "Asia/Calcutta", "NAME": "Demo_3" }, { "DISPLAYNAME": "Demo_2", "STATUS": true, "PROBEID": "30000000001", "ISWINDOWS": true, "IPADDRESS": "", "SITEID": "301", "TIMEZONE": "Asia/Calcutta", "NAME": "Demo_2" } ] } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "selCustomerID", "required": false, "description": "Optional parameter that refers to the Customer ID. This is applicable in MSP Central and is used to filter the Probes associated with the specified customer.", "schema": { "type": "integer", "description": "" } } ], "tags": [ "OpManager.Enterprise" ], "security": [], "x-zenesis-sections": {}, "x-zenesis-doc": { "show": true }, "x-zenesis-envTags": [] } }, "/api/json/reports/scheduleReportDefaultProps": { "get": { "summary": " Report Filter Configurations API", "x-zenesis-title": " Report Filter Configurations API", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "60" }, "description": "This API is used to retrieve the Report Configuration Options, which include businessRuleID, category, logicalGroup, bview, and perfGroupId.", "operationId": "scheduleReportDefaultProps", "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } } ], "tags": [ "OpManager.Reports" ], "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "description": "", "properties": { "hourlyCleanUpInterval": { "type": "string", "description": "" }, "DaysList": { "type": "array", "items": { "type": "string", "description": "" }, "description": "" }, "daysNameList": { "type": "array", "items": { "type": "string", "description": "" }, "description": "" }, "bvList": { "type": "object", "description": "", "additionalProperties": { "type": "string", "description": "" } }, "BusinessRuleNames": { "type": "object", "description": "", "additionalProperties": { "type": "string", "description": "" } }, "ReportFormatList": { "type": "array", "items": { "type": "string", "description": "" }, "description": "" }, "timeWindows": { "type": "array", "items": { "type": "string", "description": "" }, "description": "" }, "TimePeriodList": { "type": "array", "items": { "type": "string", "description": "" }, "description": "" }, "reportTypeList": { "type": "object", "description": "", "additionalProperties": { "type": "string", "description": "" } }, "perfGroups": { "type": "array", "items": { "type": "object", "description": "", "additionalProperties": { "type": "string", "description": "" } }, "description": "" }, "periodList": { "type": "array", "items": { "type": "string", "description": "" }, "description": "" }, "StorageOpTypes": { "type": "array", "items": { "type": "string", "description": "" }, "description": "" }, "MinutesList": { "type": "array", "items": { "type": "string", "description": "" }, "description": "" }, "groupList": { "type": "object", "description": "", "additionalProperties": { "type": "string", "description": "" } }, "StorageOpTypesDisplay": { "type": "array", "items": { "type": "string", "description": "" }, "description": "" }, "daysDisplay": { "type": "array", "items": { "type": "string", "description": "" }, "description": "" }, "StorageComponentsDisplay": { "type": "object", "description": "", "additionalProperties": { "type": "string", "description": "" } }, "TimePeriodDispList": { "type": "array", "items": { "type": "string", "description": "" }, "description": "" }, "profileList": { "type": "object", "description": "", "additionalProperties": { "type": "string", "description": "" } }, "HoursList": { "type": "array", "items": { "type": "string", "description": "" }, "description": "" }, "RangeListDisplay": { "type": "array", "items": { "type": "string", "description": "" }, "description": "" }, "RangeList": { "type": "array", "items": { "type": "string", "description": "" }, "description": "" }, "periodListDisp": { "type": "array", "items": { "type": "string", "description": "" }, "description": "" } } }, "description": "" }, "examples": { "Example1": { "value": { "StorageComponents": { "0": "Array", "2": "Port", "8": "Pool", "9": "Volume", "15": "LUN" }, "hourlyCleanUpInterval": 7776000000, "DaysList": [ "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30", "31" ], "timeWindowsDisplay": [ "Full 24 hours", "8:00 AM - 8:00 PM" ], "daysNameList": [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ], "bvList": { "sundari_bv": "sundari", "newBV2_bv": "newBV2", "TopologyVIew_bv": "TopologyVIew", "test_bv": "test", "new1_bv": "new1", "yuva_bv": "yuva", "Sample BusinessView_bv": "Sample BusinessView" }, "BusinessRuleNames": { "1": "b h r 1 _", "2": "ss", "301": "MonToFri", "601": "122", "901": "montoffriday", "1201": "montofriday 8am to 8pm", "1501": "nfatest", "1801": "testBHR", "2101": "yryry", "2402": "tessttst", "2403": "tetstt", "2701": "A" }, "ReportFormatList": [ "PDF (.pdf, Portable Document Format)", "HTML (.html,webpage)", "CSV (.csv, Comma Separated Values)" ], "timeWindows": [ "0-24", "8-20" ], "TimePeriodList": [ "onehour", "twohours", "fourhours", "sixhours", "eighthours", "twelvehours", "twfourhours", "Today", "Yesterday", "Last_7_Days", "Last_30_Days", "Last_60_Days", "Last_90_Days", "thisweek", "thismonth", "This_Quarter", "lastweek", "Last_Month", "Last_3_Months", "Last_6_Months", "Last_Quarter", "Next_30_days", "Next_60_days", "Next_90_days" ], "reportTypeList": { "DEVICESAVAILABILITY": "Device specific Availability reports", "ALLREPORTS": "Top N Reports / All Devices reports" }, "categoryList": { "Wireless": "Wireless", "Server": "Server", "UCS": "UCS", "WirelessLANController": "Wireless LAN Controller", "DomainController": "DomainController", "Printer": "Printer", "ATM Machine": "ATM Machine", "IoT": "IoT", "MerakiRadio": "Meraki Radio", "Container": "Container", "Unknown": "Unknown", "MerakiCellularGateway": "Meraki Cellular Gateway", "UPS": "UPS", "WirelessAccessPoint": "Wireless Access Point", "MerakiVision": "Meraki Vision", "SDN": "SDN", "TapeLibrary": "TapeLibrary", "PDU": "PDU", "ss": "ss", "IPMI": "IPMI", "MerakiSwitch": "Meraki Switch", "SDWAN": "SDWAN", "MerakiSensor": "MerakiSensor", "FCSwitch": "FCSwitch", "custom desktop": "custom desktop", "Router": "Router", "LoadBalancer": "Load Balancer", "custom storage": "custom storage", "RAID": "RAID", "Firewall": "Firewall", "Storage": "Storage", "Switch": "Switch", "Desktop": "Desktop", "MerakiController": "Meraki Controller", "WANAccelerator": "WAN Accelerator", "MerakiSecurity": "Meraki Security" }, "perfGroups": [ { "PERFGROUPNAME": "CPU Utilization", "PERFGROUPID": "1", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "Disk Utilization", "PERFGROUPID": "2", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "Memory Utilization", "PERFGROUPID": "3", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "sss", "PERFGROUPID": "301", "PERFGROUPTYPE": "2" }, { "PERFGROUPNAME": "Memroy Usage", "PERFGROUPID": "601", "PERFGROUPTYPE": "2" }, { "PERFGROUPNAME": "Partition Details", "PERFGROUPID": "901", "PERFGROUPTYPE": "2" }, { "PERFGROUPNAME": "Total Disk Bandwidth", "PERFGROUPID": "1201", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "Free Disk Space (GB)", "PERFGROUPID": "1202", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "UPS Output Voltage", "PERFGROUPID": "1203", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "Concurrent Sessions", "PERFGROUPID": "1204", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "UPS Charge", "PERFGROUPID": "1205", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "Storage Utilization", "PERFGROUPID": "1206", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "Disk Reads", "PERFGROUPID": "1207", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "System Voltage", "PERFGROUPID": "1208", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "Network Usage", "PERFGROUPID": "1209", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "System Temperature", "PERFGROUPID": "1210", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "Output Current", "PERFGROUPID": "1211", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "Bandwidth Utilization", "PERFGROUPID": "1212", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "Used Disk Space (GB)", "PERFGROUPID": "1213", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "Input Voltage", "PERFGROUPID": "1214", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "Port IOps", "PERFGROUPID": "1215", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "Switch Role", "PERFGROUPID": "1216", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "RAID Capacity Utilization", "PERFGROUPID": "1217", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "UPS Load", "PERFGROUPID": "1218", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "Controller IO Rate", "PERFGROUPID": "1219", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "Volume Write Percent", "PERFGROUPID": "1220", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "CPU Temperature", "PERFGROUPID": "1221", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "SMTP Hits", "PERFGROUPID": "1222", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "Disk Write Speed", "PERFGROUPID": "1223", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "Disk Writes", "PERFGROUPID": "1224", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "Storagepool Utilization", "PERFGROUPID": "1225", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "Total Packets Received", "PERFGROUPID": "1226", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "Total Pages Printed", "PERFGROUPID": "1227", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "Switch Errors", "PERFGROUPID": "1228", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "Fan speed", "PERFGROUPID": "1229", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "Battery Voltage", "PERFGROUPID": "1230", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "SSL Sessions", "PERFGROUPID": "1231", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "Power supply status", "PERFGROUPID": "1232", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "Active User Count", "PERFGROUPID": "1233", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "System Status", "PERFGROUPID": "1234", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "Tx Utilization", "PERFGROUPID": "1235", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "RAID IOPS", "PERFGROUPID": "1236", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "Sensor Temperature", "PERFGROUPID": "1237", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "Load Average", "PERFGROUPID": "1238", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "Total Disk Read Throughput", "PERFGROUPID": "1239", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "Rx Utilization", "PERFGROUPID": "1240", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "Volume Read Percent", "PERFGROUPID": "1241", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "Swap Memory Utilization", "PERFGROUPID": "1242", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "Fan State", "PERFGROUPID": "1243", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "Volume Utilization", "PERFGROUPID": "1244", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "PSU Voltage", "PERFGROUPID": "1245", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "UPS Output Frequency", "PERFGROUPID": "1246", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "Disk Status", "PERFGROUPID": "1247", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "UPS Output Power", "PERFGROUPID": "1248", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "Total Packets Transmitted", "PERFGROUPID": "1249", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "Battery Status", "PERFGROUPID": "1250", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "Disk I/O Writes", "PERFGROUPID": "1251", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "Disk I/O Reads", "PERFGROUPID": "1252", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "Receive Traffic", "PERFGROUPID": "1253", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "Battery Temperature", "PERFGROUPID": "1254", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "Transmit Traffic", "PERFGROUPID": "1255", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "Access Point Active Users", "PERFGROUPID": "1256", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "Remaining Battery Time", "PERFGROUPID": "1257", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "Power Consumption", "PERFGROUPID": "1258", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "Active Session Count", "PERFGROUPID": "1259", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "Temperature Status", "PERFGROUPID": "1260", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "HA State", "PERFGROUPID": "1501", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "HA Status", "PERFGROUPID": "1801", "PERFGROUPTYPE": "2" }, { "PERFGROUPNAME": "Total Disk Space (GB)", "PERFGROUPID": "2401", "PERFGROUPTYPE": "1" }, { "PERFGROUPNAME": "CPU ready", "PERFGROUPID": "2701", "PERFGROUPTYPE": "2" }, { "PERFGROUPNAME": "SysUpTime", "PERFGROUPID": "2702", "PERFGROUPTYPE": "2" }, { "PERFGROUPNAME": "SysUpTimePerf", "PERFGROUPID": "3001", "PERFGROUPTYPE": "2" } ], "periodList": [ "36", "37", "38", "39", "40", "16", "3", "6", "7", "4", "5", "60", "61", "8", "9", "10", "11", "63", "62", "64", "65" ], "StorageOpTypes": [ "Total", "Read", "Write" ], "MinutesList": [ "00", "05", "10", "15", "20", "25", "30", "35", "40", "45", "50", "55" ], "groupList": { "adg1-73509": "ADG11111212", "test2-63904": "test2", "intf group-60302": "INtf Group", "group2-66905": "group4", "fgjff-63601": "fgjff", "aig1-73511": "AIG1", "recentnoalarmig-73506": "recentNoAlarmIG", "finland-67805": "FINLAND", "support test 17 dec-72601": "support test 17 dec", "campinas-dc-brz-67806": "Campinas-DC-BRZ", "windows partition-75902": "Windows Partition", "recentig-73504": "recentIG", "device group 3-60308": "Device Group 3", "interface group1-61808": "Interface Group1", "recentalarmsissue-73502": "recentalarmsissue", "dev2-73802": "dev2", "nfa-76201": "NFA", "testingssss-66904": "testingssss", "intf2-69584": "intf2", "yuva-72027": "yuva", "empty1-68867": "empty1", "alldevices-78301": "AllDevices", "ak-68115": "AK", "sivag-73803": "sivag", "test_group-72014": "Test_Group", "hp-67786": "hp", "sdssd-66903": "sdssd", "aig2-73512": "AIG2", "device group 1-60306": "Device Group 1", "ds-66811": "ds", "dev1-73508": "dev1", "intfgrouptest-74401": "IntfGroupTest", "wmi working devices-73801": "WMI working devices", "intf 1-69583": "intf 1", "linux partition-75901": "Linux Partition", "h1parent1-67654": "h1Parent1", "adg2-73510": "Tes", "interfacegrp-77101": "INTERFACEGRP", "sbbb-71104": "sbbb", "interfacegroupsnow-67638": "InterfaceGroupSnow", "dev-73501": "dev", "device group 2-60307": "Device Group 2", "test-63903": "test", "topo-test-grp-1-69901": "topo-test-grp-1" }, "StorageOpTypesDisplay": [ "Total", "Read", "Write" ], "daysDisplay": { "Monday": "", "Thursday": "", "Friday": "", "Sunday": "", "Wednesday": "", "Tuesday": "", "Saturday": "" }, "StorageComponentsDisplay": { "0": "Array", "2": "Port", "8": "Pool", "9": "Volume", "15": "LUN" }, "TimePeriodDispList": [ "Last 1 hour", "Last 2 hours", "Last 4 hours", "Last 6 hours", "Last 8 Hours", "Last 12 hours", "Last 24 hours", "Today", "Yesterday", "Last 7 days", "Last 30 days", "Last 60 days", "Last 90 days", "This week", "This month", "This Quarter", "Last week", "Last month", "Last 3 months", "Last 6 months", "Last Quarter", "Next 30 days", "Next 60 days", "Next 90 days" ], "profileList": { "1": "Play Sound", "3902": "testing renamed", "4801": "AAAA", "5401": "TrapProfile", "6301": "sdf", "6901": "webalarm", "7501": "Priyan recurring", "7801": "Testing alarm action", "7802": "Testing alarm action 2", "8101": "sendTrap" }, "HoursList": [ "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23" ], "RangeListDisplay": [ "All", "Top 10", "Top 25", "Top 50", "Top 100", "Top 1000", "Bottom 10", "Bottom 25", "Bottom 50", "Bottom 100", "Bottom 1000" ], "RangeList": [ "All", "Top 10", "Top 25", "Top 50", "Top 100", "Top 1000", "Bottom 10", "Bottom 25", "Bottom 50", "Bottom 100", "Bottom 1000" ], "periodListDisp": [ "Last 1 hour", "Last 2 hours", "Last 4 hours", "Last 6 hours", "Last 8 Hours", "Last 12 hours", "Last 24 hours", "Today", "Yesterday", "Last 7 days", "Last 30 days", "Last 60 days", "Last 90 days", "This week", "Last week", "This month", "Last month", "This Quarter", "Last Quarter", "Last 3 months", "Last 6 months" ] } } } } } } }, "security": [], "x-zenesis-sections": {}, "x-zenesis-doc": { "show": true }, "x-zenesis-envTags": [] } }, "/api/json/v2/device/listDevices": { "get": { "summary": "Get devices", "x-zenesis-title": "List Devices v2", "security": [], "x-zenesis-security": { "duration": "1M", "threshold": "500", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Lists all devices monitored by OpManager. Enhanced Version 2 API with additional response fields (total, page, rows, records wrapper) compared to v1. Supports extensive filtering by category, type, protocol, severity, virtual type, group, business view, storage, and custom fields. Supports pagination, sorting, and batch fetching. Rate limit: 500 requests per minute.\nAGENT INSTRUCTION - Device Name Resolution (MANDATORY): Whenever a device name or IP address is mentioned by the user, ALWAYS call this listDevicesV2 API first. Match the user-provided name against the 'displayName', 'ipaddress', or 'deviceName' fields in the response. Use the 'deviceName' value from the matched record in all subsequent API calls (e.g., getDeviceInfo, getDeviceAssociatedMonitors, getGraphData, etc.). Never assume the user-provided name is the internal deviceName \u2014 always resolve it.\nAGENT INSTRUCTION - Filtering (category vs classification): Both 'category' and 'classification' parameters can be used for filtering. Use 'category' for device category filtering. Valid category values are: Server, Desktop, DomainController, Container, MerakiVision, SDN, WirelessLANController, Unknown, MerakiController, MerakiSecurity, IPMI, Storage, MerakiRadio, Firewall, PDU, Router, MerakiSwitch, UCS, UPS, IoT, Switch, MerakiSensor, Printer, WirelessAccessPoint, SDWAN, MerakiCellularGateway, LoadBalancer, WANAccelerator, Wireless. Use 'classification' for classification group filtering. Valid classification values are: Network, Router, Switch, Printer, Server, PhysicalServer, Windows, Linux, MSSQL, Exchange, DomainController, Wireless, Firewall, IPMI, MonitoringAgent. The 'filters' parameter is NOT currently applicable and should not be used.\n", "operationId": "listDevicesV2", "responses": { "200": { "description": "Successful paginated response containing the device list.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListDevicesV2Response", "description": "" }, "examples": { "Example1": { "summary": "Two Windows devices", "value": { "total": 0, "page": 1, "rows": [ { "isSNMP": true, "ipaddress": "10.5.5.1", "isSuppressed": false, "statusStr": "Clear", "prettyTime": "5 hours ago", "displayName": "10.5.5.1", "isNew": false, "type": "Windows 10", "vendorName": "Microsoft", "deviceName": "10.5.5.1", "moid": 341, "statusNum": "5", "suppressedMessage": "", "addedTime": "7 Oct 2025 11:08:30 AM IST", "interfaceCount": 0, "id": "341", "category": "Desktop" }, { "isSNMP": true, "ipaddress": "10.5.5.1", "isSuppressed": false, "statusStr": "Clear", "prettyTime": "5 hours ago", "displayName": "10.5.5.1", "isNew": false, "type": "Windows 2019", "vendorName": "Microsoft", "deviceName": "10.5.5.1", "moid": 362, "statusNum": "5", "suppressedMessage": "", "addedTime": "7 Oct 2025 11:08:31 AM IST", "interfaceCount": 0, "id": "362", "category": "Server" } ], "records": 2 } } } } } }, "400": { "description": "Invalid or missing request parameter.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized." }, "403": { "description": "Forbidden." }, "429": { "description": "Too many requests. Rate limit is 500 requests per minute." } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "name": "subnet", "schema": { "type": "string", "maxLength": 50, "description": "" }, "description": "Filters devices by specific IP Subnet.", "in": "query", "required": false }, { "name": "excludeAP", "schema": { "type": "boolean", "description": "" }, "description": "Excludes Access Point devices from the results.", "in": "query", "required": false }, { "name": "type", "schema": { "type": "string", "maxLength": 200 }, "description": "Fetches devices of the given Device Type (e.g., Cisco2081, Windows 2019).", "in": "query", "required": false }, { "name": "deviceName", "schema": { "type": "string", "maxLength": 100, "description": "" }, "description": "Name of the device to filter by.", "in": "query", "required": false }, { "name": "pageName", "schema": { "type": "string", "enum": [ "Inventory" ], "description": "" }, "description": "Identifies the UI page or view requesting the data.", "in": "query", "required": false }, { "name": "getMonitors", "schema": { "type": "boolean", "description": "" }, "description": "When true, includes device monitor details in the response.", "in": "query", "required": false }, { "name": "protocol", "schema": { "type": "string", "enum": [ "all", "SNMP", "WMI", "CLI", "VIWebService", "VIWMI", "XenService", "PrismAPI", "NetAppAPI", "SMI" ], "description": "" }, "description": "Filter devices by monitoring protocol. Allowed values: all, SNMP, WMI, CLI, VIWebService, VIWMI, XenService, PrismAPI, NetAppAPI, SMI.\n", "in": "query", "required": false }, { "name": "storageCategory", "schema": { "type": "string", "enum": [ "RAID", "TapeLibrary", "FCSwitch" ] }, "description": "Storage category filter (case-insensitive).", "in": "query", "required": false }, { "name": "state", "schema": { "type": "string", "pattern": "^([1-9]|1[01])(,([1-9]|1[01]))*$" }, "description": "Filter devices by state. Comma-separated numeric state values.", "in": "query", "required": false }, { "name": "app", "schema": { "type": "string", "maxLength": 100, "description": "" }, "description": "Fetches devices with the given application monitored in OpManager (e.g., MSSQL, Exchange, Domain Controller).\n", "in": "query", "required": false }, { "name": "bvName", "schema": { "type": "string", "maxLength": 200, "description": "" }, "description": "Fetches devices under the given Business View map name.", "in": "query", "required": false }, { "name": "getInterfaces", "schema": { "type": "boolean", "description": "" }, "description": "When true, includes associated interface details in the response.", "in": "query", "required": false }, { "name": "hideEmptyDevices", "schema": { "type": "boolean", "description": "" }, "description": "Hides devices with no monitors or collected data.", "in": "query", "required": false }, { "name": "classification", "schema": { "type": "string", "enum": [ "Network", "Router", "Switch", "Printer", "Server", "PhysicalServer", "Windows", "Linux", "MSSQL", "Exchange", "DomainController", "Wireless", "Firewall", "IPMI", "MonitoringAgent" ] }, "description": "Filters devices by classification group.", "in": "query", "required": false }, { "name": "vendorName", "schema": { "type": "string", "maxLength": 200 }, "description": "Fetches devices with the given vendor name.", "in": "query", "required": false }, { "name": "_search", "schema": { "type": "boolean", "description": "" }, "description": "Flag indicating whether a search operation is being performed.", "in": "query", "required": false }, { "name": "isSubnet", "schema": { "type": "boolean", "description": "" }, "description": "Filters devices by IP Subnet.", "in": "query", "required": false }, { "name": "isManaged", "schema": { "type": "boolean", "description": "" }, "description": "When true, returns only managed devices.", "in": "query", "required": false }, { "name": "selectedMonType", "schema": { "type": "string", "maxLength": 100, "description": "" }, "description": "Filters devices by specific monitor type.", "in": "query", "required": false }, { "name": "groupName", "schema": { "type": "string", "maxLength": 200 }, "description": "Filter devices by Group name.", "in": "query", "required": false }, { "name": "fileTemplate", "schema": { "type": "integer", "format": "int64", "description": "" }, "description": "Filters devices linked with a specific file monitoring template ID.", "in": "query", "required": false }, { "name": "nd", "schema": { "type": "integer", "format": "int64", "description": "" }, "description": "Request timestamp for cache-busting (epoch milliseconds).", "in": "query", "required": false }, { "name": "page", "schema": { "$ref": "#/components/schemas/dt_page_regex", "description": "" }, "description": "Page number for batch fetching. Use together with rows. Example: page=1, rows=200.\n", "in": "query", "required": false }, { "name": "isFluidic", "schema": { "type": "boolean", "description": "" }, "description": "Set value as true by default (for internal use).", "in": "query", "required": false }, { "name": "probe_customer_id", "schema": { "type": "integer", "format": "int64", "minimum": 1, "description": "" }, "description": "Filters devices by probe or customer ID (MSP Central). Value must be >= 1.", "in": "query", "required": false }, { "name": "isLicenseView", "schema": { "type": "boolean", "description": "" }, "description": "Shows device data based on license view.", "in": "query", "required": false }, { "name": "isMapView", "schema": { "type": "boolean", "description": "" }, "description": "Set to true when request is made from the Maps page.", "in": "query", "required": false }, { "name": "customFields", "schema": { "type": "string", "maxLength": 500 }, "description": "Comma-separated list of custom field names to include in the response. Example: Building,Comments,Floor.\n", "in": "query", "required": false }, { "name": "excludeAgent", "schema": { "type": "boolean", "description": "" }, "description": "Excludes agent-based devices from the results.", "in": "query", "required": false }, { "name": "subnetName", "schema": { "type": "string", "maxLength": 100, "description": "" }, "description": "Name of the subnet to filter devices by.", "in": "query", "required": false }, { "name": "isStorage", "schema": { "type": "boolean", "description": "" }, "description": "Filter to only storage devices.", "in": "query", "required": false }, { "name": "vendor", "schema": { "type": "string", "maxLength": 200 }, "description": "Fetches devices with the given vendor name (alias for vendorName).", "in": "query", "required": false }, { "name": "selectedVTypes", "schema": { "$ref": "#/components/schemas/virtualTypes_regex" }, "description": "Filter devices by virtual device type.", "in": "query", "required": false }, { "name": "sortByType", "schema": { "type": "string", "pattern": "^(asc|desc)$", "description": "" }, "description": "Sort direction.", "in": "query", "required": false }, { "name": "severity", "schema": { "type": "string", "pattern": "^([1-9]|1[01])(,([1-9]|1[01]))*$", "examples": [ "1,2,3" ] }, "description": "Filter devices by severity. Comma-separated numeric values. 1=Critical, 2=Trouble, 3=Attention, 4=Service Down, 5=Clear, 7=Unmanaged.\n", "in": "query", "required": false }, { "name": "excludeStorage", "schema": { "type": "boolean", "description": "" }, "description": "Whether to exclude storage devices.", "in": "query", "required": false }, { "name": "skipLocalhost", "schema": { "type": "boolean", "description": "" }, "description": "Excludes the OpManager server (localhost) from the device list.", "in": "query", "required": false }, { "name": "filters", "schema": { "type": "string", "description": "" }, "description": "Applies custom filter conditions to narrow device results (JSON filter object).", "in": "query", "required": false }, { "name": "rows", "schema": { "$ref": "#/components/schemas/dt_page_regex", "description": "" }, "description": "Number of rows per page for batch fetching. Use together with page. Example: page=1, rows=200.\n", "in": "query", "required": false }, { "name": "excludeIPMI", "schema": { "type": "boolean", "description": "" }, "description": "Excludes IPMI devices from the results.", "in": "query", "required": false }, { "name": "folderTemplate", "schema": { "type": "integer", "format": "int64", "description": "" }, "description": "Filters devices linked with a specific folder monitoring template ID.", "in": "query", "required": false }, { "name": "sortByColumn", "schema": { "type": "string", "maxLength": 100 }, "description": "Column name to sort by (e.g., displayName, ipaddress, type, interfaceCount).", "in": "query", "required": false }, { "name": "category", "schema": { "type": "string", "pattern": "^[A-Za-z0-9 _\\-.]+$", "maxLength": 100 }, "description": "Fetches devices in the given category (e.g., Server, Switch).", "in": "query", "required": false }, { "in": "query", "name": "excludeOpenFWDevice", "required": false, "description": "Exclude OpenFW devices from result.", "schema": { "type": "boolean", "description": "" } } ], "tags": [ "OpManager.Devices" ], "x-zenesis-doc": { "show": true } } }, "/api/json/v2/device/fetchMonitorsList": { "post": { "summary": "Get Available Performance Monitors", "x-zenesis-title": "Get Available Performance Monitors", "security": [ {} ], "x-zenesis-security": {}, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Get the details of Performance Monitors names along with availability monitors that are associated with the devices. Details include Monitor Name and Policy Name of monitors.", "operationId": "fetchMonitorsList", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "description": "", "properties": { "policyName": { "type": "string", "description": "" }, "monitorName": { "type": "string", "description": "" } } }, "description": "" }, "examples": { "Example1": { "value": [ { "policyName": "DevicesAvailability", "monitorName": "Devices Availability" }, { "policyName": "Packet_Loss", "monitorName": "Packet Loss" }, { "policyName": "ResponseTime", "monitorName": "Response Time" }, { "policyName": "MSSQL2005CacheHitRatio", "monitorName": "Cache Hit Ratio(SQL 2005 Server)(MSSQL)" }, { "policyName": "MSSQLActiveTransactions", "monitorName": "Active Transactions(MSSQL)" }, { "policyName": "MSSQLAvgLockWaitTimems", "monitorName": "Average Lock Wait Time(MSSQL)" }, { "policyName": "MSSQLBuffercachehitratio", "monitorName": "Buffer Cache Hit Ratio(MSSQL)" }, { "policyName": "MSSQLCacheHitRatio", "monitorName": "Cache Hit Ratio(MSSQL)" }, { "policyName": "MSSQLDataFilesSizeKB", "monitorName": "Data Files Size(MSSQL)" }, { "policyName": "MSSQLGrantedWorkspaceMemory", "monitorName": "Granted WorkSpace Memory(MSSQL)" }, { "policyName": "MSSQLLazyWritesPerSec", "monitorName": "Lazy Writes per second(MSSQL)" }, { "policyName": "MSSQLLogFilesUsedPercent", "monitorName": "Log Files Used Percentage(MSSQL)" }, { "policyName": "MSSQLLoginsPersec", "monitorName": "Logins per second(MSSQL)" }, { "policyName": "MSSQLNumberofDeadlocksPersec", "monitorName": "Number of Deadlocks per second(MSSQL)" }, { "policyName": "MSSQLPagereadsPersec", "monitorName": "Page reads per second(MSSQL)" }, { "policyName": "MSSQLPageSplitsPersec", "monitorName": "Page Splits per second(MSSQL)" }, { "policyName": "MSSQLPagewritesPersec", "monitorName": "Page writes per second(MSSQL)" }, { "policyName": "MSSQLSQLCacheMemory", "monitorName": "SQL Cache Memory(MSSQL)" }, { "policyName": "MSSQLSQLCompilationsPersec", "monitorName": "SQL Compilations per second(MSSQL)" }, { "policyName": "MSSQLTotMemNeeded", "monitorName": "Excess Total committed memory needed(MSSQL)" }, { "policyName": "MSSQLUserConns", "monitorName": "Active database connections(MSSQL)" } ] } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "groupMOID", "required": false, "description": "MOID of a group for which the monitors list details needs to be fetched. If mentioned it will fetch the monitors list associated to devices in that group.", "schema": { "type": "integer", "description": "" } }, { "in": "query", "name": "deviceList", "required": false, "description": " List of devices for which the associated monitors list details needs to be fetched.", "schema": { "type": "string", "description": "" } }, { "in": "query", "name": "isAvailabilityView", "required": false, "description": " if mentioned then only Availability metrics details will be fetched ignoring Performance Monitors details.", "schema": { "type": "boolean", "description": "" } } ], "tags": [ "OpManager.Devices" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/getDeviceCategories": { "get": { "summary": "Get Device Categories", "x-zenesis-title": "Get Device Categories", "security": [], "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "100" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Returns the list of device categories available in OpManager. Device categories represent the classification of managed devices such as routers, switches, servers, desktops, and other infrastructure components. These categories are used for device organization, filtering, and UI representation.", "operationId": "getDeviceCategories", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": {}, "examples": { "Example1": { "value": { "Business View": { "bv_29114": "Jodhpur", "bv_29115": "Amristar", "bv_29112": "Ajmeer", "bv_29113": "Jaipur", "bv_29118": "Tamilnadu", "bv_29119": "Madurai", "bv_29116": "Delhi", "bv_60313": "US Primary Healthcenters", "bv_29117": "Chennai", "bv_60314": "Colorado PHC", "bv_60311": "Illinois PHC", "bv_60312": "Atlanta PHC", "bv_60310": "Texas PHC", "bv_29121": "Vishakapatnam", "bv_29122": "Karnataka", "bv_29120": "Andhra Pradhesh", "bv_7810": "Production Site", "bv_29125": "Kolkata", "bv_29126": "Silguri", "bv_60309": "Phoenix PHC", "bv_29123": "Bangalore", "bv_29124": "West Bengal", "bv_23228": "Site1 Layer2 Map", "bv_29129": "Gujarat", "bv_27301": "Regional Offices", "bv_29127": "Odissa", "bv_29128": "Cuttak", "bv_11578": "Layer2Map", "bv_29132": "Maharashtra", "bv_29133": "Mumbai", "bv_29130": "Gandhinagar", "bv_29131": "Surat", "bv_28801": "India Regional View", "bv_44130": "WANMonitorTest_WAN_View", "bv_29136": "Distribution Map", "bv_29134": "MadhyaPradhesh", "bv_29135": "Bhopal", "bv_29109": "Haryana", "bv_27001": "Business Sites", "bv_29103": "Western Zone", "bv_29104": "Eastern Zone", "bv_29101": "Northern Zone", "bv_29102": "Southern Zone", "bv_29107": "Punjab", "bv_29702": "IndiaZonalCritical", "bv_29108": "Patiala", "bv_44126": "BackofficeVOIP_VoIP_View", "bv_29105": "UttarPradesh", "bv_29106": "Lucknow", "bv_29110": "Faridabad", "bv_29111": "Rajasthan", "bv_35701": "Applications View", "bv_30012": "Coimbatore", "bv_30013": "Assam" }, "Groups": { "group_30016": "West Bengal", "group_28201": "ProductionNetwork", "group_29596": "Southern Region", "group_29595": "Eastern Region", "group_29594": "Western Region", "group_29593": "Northern Region", "group_44709": "NetworkGroup", "group_30011": "Karnataka", "group_30010": "Andhra Pradesh", "group_30015": "Odissa", "group_30014": "Assam", "group_17701": "HyperVisors Group", "group_29703": "IndiaZonalView", "group_60316": "Atlanta", "group_60315": "US PHC Group", "group_29701": "India Region", "group_30006": "West Region", "group_27003": "Regional NOC", "group_30005": "UttarPradhesh", "group_30008": "Gujarat", "group_30007": "Maharashtra", "group_27002": "Production Servers", "group_30009": "Tamilnadu", "group_30002": "Haryana", "group_30001": "Rajasthan", "group_30004": "Punjab", "group_30003": "Delhi" }, "General": { "1": "All Windows Devices", "2": "All Unix Devices", "3": "Networking Devices", "4": "All Devices", "6": "Layer2 Devices", "7": "All Racks", "8": "All Floors", "15": "Applications" }, "Infrastructure View": { "iv_19": "Wireless LAN Controller", "APM_EMO": "Site24x7 Monitors", "iv_17": "FCSwitch", "iv_18": "TapeLibrary", "iv_15": "UCS", "APM_MOM": "Middleware/Portal", "iv_16": "RAID", "iv_13": "Storage", "iv_14": "PDU", "iv_11": "Printer", "APM_CAM": "Custom Monitors", "iv_12": "Unknown", "iv_10": "UPS", "iv_3": "Switch", "iv_2": "Router", "iv_5": "Firewall", "iv_4": "Desktop", "iv_7": "Load Balancer", "iv_6": "DomainController", "iv_9": "Wireless", "iv_8": "WAN Accelerator", "APM_CLD": "Cloud Apps", "APM_VIR": "Virtualization", "APM_SER": "Services", "APM_ERP": "ERP", "APM_APP": "Application Servers", "iv_28": "SDN", "iv_29": "IoT", "iv_26": "Meraki Vision", "iv_27": "Meraki Cellular Gateway", "iv_24": "Meraki Switch", "iv_25": "Meraki Radio", "iv_22": "Meraki Controller", "APM_URL": "Web Server/Services", "iv_23": "Meraki Security", "iv_20": "Wireless Access Point", "iv_1": "Server", "iv_21": "IPMI", "APM_MS": "Mail Servers", "iv_601": "SDWAN", "iv_302": "IP Camera", "iv_301": "Barcode scanner", "APM_DBS": "Database Servers", "APM_NWD": "Network Devices", "APM_CIF": "Converged Infrastructure", "iv_902": "MerakiSensor", "iv_901": "Container" } }, "description": "Response for status 200" } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "excludeStorage", "required": false, "description": "A flag to exclude storage-related device categories from the response. When set to true, categories associated with storage devices are filtered out.", "schema": { "type": "boolean", "description": "" } }, { "in": "query", "name": "excludeAP", "required": false, "description": "When true, excludes Access Point (AP) device categories from the returned results.", "schema": { "type": "boolean", "description": "" } }, { "in": "query", "name": "type", "required": false, "description": "Type of device category to filter in the response.", "schema": { "type": "string", "pattern": "^group$", "description": "" } }, { "in": "query", "name": "excludeWLC", "required": false, "description": "Boolean flag indicating whether Wireless LAN Controller (WLC) device categories should be excluded from the response.", "schema": { "type": "boolean", "description": "" } }, { "in": "query", "name": "excludeIPMI", "required": false, "description": "Boolean flag indicating whether IPMI device categories should be excluded from the response.", "schema": { "type": "boolean", "description": "" } }, { "in": "query", "name": "showNotificationProfileEntities", "required": false, "description": "Boolean flag indicating whether entities associated with notification profiles should be included in the response.", "schema": { "type": "boolean", "description": "" } }, { "in": "query", "name": "showAPM", "required": false, "description": "Boolean flag indicating whether APM related device categories should be included in the response.", "schema": { "type": "boolean", "description": "" } }, { "in": "query", "name": "embodyDCDevices", "required": false, "description": "Boolean flag indicating whether Data Center (DC) devices should be included in the response.", "schema": { "type": "boolean", "description": "" } }, { "in": "query", "name": "showAPMServer", "required": false, "description": "Boolean flag indicating whether APM Server related entities should be included in the response.", "schema": { "type": "boolean", "description": "" } } ], "tags": [ "OpManager.Devices" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/getPingResponse": { "post": { "summary": "Get Ping Response", "x-zenesis-security": { "duration": "1M", "threshold": "500", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Executes ping command against a device or multiple devices and returns the ping results. Supports both single device ping and bulk ping operations. Can handle regular devices and WAN link monitors.", "tags": [ "OpManager.Devices" ], "x-zenesis-doc": { "show": true }, "x-zenesis-title": "Get Ping Response", "security": [], "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "deviceName": { "type": "string", "description": "Name or IP address of the device to ping (comma-separated for bulk operations)", "maxLength": 100000 }, "fromAddDevice": { "type": "boolean", "description": "Whether this ping is from add device operation. It should be true by default." } }, "required": [ "deviceName" ] } } } }, "operationId": "getPingResponse", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "getPing": { "type": "string", "description": "Ping command output for single device" } } }, { "type": "array", "items": { "type": "object", "properties": { "deviceName": { "type": "string", "description": "Name of the device" }, "pingResponse": { "type": "string", "description": "Ping command output" } } } } ] }, "examples": { "SinglePingExample": { "value": { "getPing": "PING 192.168.1.1 (192.168.1.1): 56 data bytes\n64 bytes from 192.168.1.1: icmp_seq=0 ttl=64 time=0.123 ms\n64 bytes from 192.168.1.1: icmp_seq=1 ttl=64 time=0.145 ms\n\n--- 192.168.1.1 ping statistics ---\n2 packets transmitted, 2 packets received, 0.0% packet loss\nround-trip min/avg/max/stddev = 0.123/0.134/0.145/0.011 ms" } }, "BulkPingExample": { "value": [ { "deviceName": "server1.example.com", "pingResponse": "PING server1.example.com (10.5.5.1): 56 data bytes\n64 bytes from 10.5.5.1: icmp_seq=0 ttl=64 time=1.234 ms\n\n--- server1.example.com ping statistics ---\n1 packets transmitted, 1 packets received, 0.0% packet loss" }, { "deviceName": "server2.example.com", "pingResponse": "PING server2.example.com (10.5.5.1): 56 data bytes\nRequest timeout for icmp_seq 0\n\n--- server2.example.com ping statistics ---\n1 packets transmitted, 0 packets received, 100.0% packet loss" } ] } } } } } }, "parameters": [ { "name": "apikey", "schema": { "$ref": "#/components/schemas/apikey_regex" }, "description": "API Key to access your OpManager server.", "in": "header", "required": true } ] } }, "/api/json/admin/getDowntimeSchedule": { "get": { "summary": "Get Downtime Schedule Details", "x-zenesis-title": "Get Downtime Schedule Details", "security": [], "x-zenesis-security": { "duration": "1M", "threshold": "50", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Retrieves detailed information for a specific downtime schedule by schedule name or ID. Returns schedule configuration including timezone information, schedules list, and edit permissions. Special case: scheduleName=\"-1\" returns timezone and server information.", "operationId": "getDowntimeSchedule", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "", "properties": { "schedulesList": { "type": "array", "items": {}, "description": "List of all available schedules" }, "serverTimeZone": { "type": "string", "description": "Server's current timezone" }, "MS_INSTANCEID": { "type": "string", "description": "Maintenance schedule instance ID" }, "editable": { "type": "boolean", "description": "Whether the schedule is editable by current user" }, "allTimeZones": { "type": "object", "description": "All available timezones" } } }, "examples": { "Example1": { "value": { "scheduleName": "Weekend Maintenance", "schedulesList": [ { "name": "Daily Backup", "id": 1 }, { "name": "Weekly Restart", "id": 2 } ], "MS_INSTANCEID": "12345", "scheduleType": "Weekly", "editable": true, "allTimeZones": { "UTC": "Coordinated Universal Time", "EST": "Eastern Standard Time" }, "serverTimeZone": "America/New_York", "isActive": true } } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "scheduleName", "required": true, "description": "Name of the downtime schedule to retrieve.", "schema": { "$ref": "#/components/schemas/ScheduleName_regex" } }, { "in": "query", "name": "suppressType", "required": false, "description": "Type of suppression (Alarm or Monitoring)", "schema": { "type": "string", "pattern": "^(Alarm|Monitoring)$", "description": "" } }, { "in": "query", "name": "scheduleId", "required": false, "description": "Unique identifier for the downtime schedule. The scheduleId should be fetched from the listDownTimeSchedules API.", "schema": { "type": "integer", "format": "int64", "description": "" } } ], "tags": [ "OpManager.Downtime Scheduler" ], "x-zenesis-doc": { "show": true } } }, "/api/json/businessview/getBusinessDetailsView": { "get": { "summary": "List All Devices in a Business View", "x-zenesis-title": "List All Devices in a Business View", "security": [], "x-zenesis-security": {}, "description": "Lists all the devices available in the given business view, including each device's status, type, IP address. Supports pagination via startPoint and viewLength.\n", "operationId": "getBusinessDetailsView", "responses": { "200": { "description": "Successful response containing device list for the business view.", "content": { "application/json": { "schema": { "type": "object", "description": "Top-level response wrapper.", "properties": { "totalRecords": { "type": "string", "description": "Total number of devices in the business view." }, "getBusinessDetailsView": { "type": "array", "description": "List of device objects belonging to the business view.", "items": { "type": "object", "description": "Properties of a single device in the business view.", "properties": { "severity": { "type": "string", "description": "Numeric severity code. 1=Critical, 2=Attention, 3=Trouble, 4=Service Down, 5=Clear.\n" }, "CPUUtilization": { "type": "integer", "description": "Current CPU utilization percentage of the device." }, "MemUtilization": { "type": "integer", "description": "Current memory utilization percentage of the device." }, "displayName": { "type": "string", "description": "Human-readable display name of the device (truncated to 25 characters).\n" }, "name": { "type": "string", "description": "Internal managed-object name of the device." }, "IpAddress": { "type": "string", "description": "IP address of the device." }, "type": { "type": "string", "description": "Device type string (e.g., vendor or model info)." }, "status": { "type": "string", "description": "Severity status string (e.g., \"Critical\", \"Clear\").\n" } } } } } }, "examples": { "Example1": { "value": { "totalRecords": "3", "getBusinessDetailsView": [ { "severity": "5", "CPUUtilization": 32, "MemUtilization": 58, "displayName": "Core Switch 01", "name": "switch-core-01", "IpAddress": "10.5.5.1", "type": "Cisco Catalyst 9300", "status": "Clear" }, { "severity": "1", "CPUUtilization": 89, "MemUtilization": 92, "displayName": "Web Server 01", "name": "server-web-01", "IpAddress": "10.5.5.1", "type": "Dell PowerEdge R740", "status": "Critical" } ] } } } } } } }, "parameters": [ { "name": "apikey", "schema": { "$ref": "#/components/schemas/apikey_regex" }, "description": "API Key to access your OpManager server.", "in": "header", "required": true }, { "name": "bvName", "schema": { "type": "string", "description": "", "maxLength": 100 }, "description": "Name of the business view whose device details should be fetched. Can be obtained from the getBusinessView API (the \"name\" field without the \"_bv\" suffix).\n", "in": "query", "required": true }, { "name": "startPoint", "schema": { "type": "integer" }, "description": "Starting index for pagination (1-based). Defaults to 1 if not provided.\n", "in": "query", "required": false }, { "name": "viewLength", "schema": { "type": "integer" }, "description": "Number of records to return per page. Defaults to 250 if not provided.\n", "in": "query", "required": false } ], "tags": [ "OpManager.BusinessViews" ] } }, "/api/json/device/getInterfaces": { "get": { "summary": "Get Interfaces for a Device", "x-zenesis-title": "Get Interfaces for a Device", "security": [], "x-zenesis-security": { "duration": "1M", "threshold": "20", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Retrieves the list of interfaces for a specific device identified by its managed object name. Returns interface details including status, speed, traffic utilization, and connected device info. Also includes summary counts of total and down interfaces.", "operationId": "getInterfaces", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetInterfacesResponse" }, "examples": { "Example1": { "value": { "interfaceList": { "isSNMP": true, "interfaceCount": "12", "downCount": "1", "interfaces": [ { "ifIndex": "1", "statusStr": "Clear", "ifType": "L3 Interface", "displayName": "GigabitEthernet0/0", "imagePath": "/images/interface/l3.png", "RouterPortType": "Eth", "outSpeed": "1.0 Gbps", "inSpeed": "1.0 Gbps", "type": "2", "outTraffic": "89.2 Mbps", "moid": "50001", "nfEnabled": "false", "bgColor": "#00CC00", "isSubInterface": "false", "ifAdminStatus": "1", "ifIndexNum": 1, "inUtil": "12.5", "isSuppressed": false, "trimmedDispName": "GigabitEthernet0/0", "ipAddress": "10.5.5.1", "statusNum": "1", "inTraffic": "125.5 Mbps", "outUtil": "8.9", "statusString": "Clear", "name": "intf_router1_GigabitEthernet0/0", "ifOperStatus": "1", "errors": "0", "status": "1" } ], "showPollingStatusColumn": false } } } } } } }, "400": { "description": "Invalid parameter", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InvalidName": { "value": { "error": { "message": "Invalid value for parameter - name", "code": 5009 } } } } } } } }, "parameters": [ { "name": "apikey", "schema": { "$ref": "#/components/schemas/apikey_regex" }, "description": "API Key to access your OpManager server.", "in": "header", "required": true }, { "name": "name", "schema": { "type": "string", "maxLength": 100 }, "description": "Device managed object name.", "in": "query", "required": true } ], "tags": [ "OpManager.Devices" ], "x-zenesis-doc": { "show": true } } }, "/api/json/businessview/getBusinessView": { "get": { "summary": "List All Business Views", "x-zenesis-title": "List All Business Views", "security": [], "x-zenesis-security": {}, "description": "Lists all the business views created in OpManager. Each business view entry includes its display name, device count, error count, alarm count, and current status.\n", "operationId": "getBusinessView", "responses": { "200": { "description": "Successful response containing the list of all business views.", "content": { "application/json": { "schema": { "type": "object", "description": "Top-level response wrapper.", "properties": { "BusinessView": { "type": "object", "description": "Contains business view data.", "properties": { "Details": { "type": "array", "description": "List of business views.", "items": { "type": "object", "description": "Properties of a single business view.", "properties": { "name": { "type": "string", "description": "Internal name identifier of the business view.\n" }, "total": { "type": "string", "description": "Total number of devices in the business view.\n" }, "error": { "type": "string", "description": "Number of devices currently in an error state.\n" }, "displayName": { "type": "string", "description": "Human-readable display name of the business view.\n" }, "status": { "type": "string", "description": "Current status code of the business view.\n" }, "alarms": { "type": "string", "description": "Number of active alarms associated with the business view.\n" } } } } } } } }, "examples": { "Example1": { "value": { "BusinessView": { "Details": [ { "name": "New BusinessView_bv", "total": "3", "error": "0", "displayName": "New BusinessView", "status": "5", "alarms": "0" }, { "name": "Production_Servers_bv", "total": "12", "error": "2", "displayName": "Production Servers", "status": "1", "alarms": "3" } ] } } } } } } } }, "parameters": [ { "name": "apikey", "schema": { "$ref": "#/components/schemas/apikey_regex" }, "description": "API Key to access your OpManager server.", "in": "header", "required": true }, { "name": "customerID", "schema": { "type": "integer", "format": "int64", "description": "" }, "description": "Optional parameter that refers to the Customer ID. This is applicable in MSP Central and is used to get the businessview associated with the specified customer.\n", "in": "query", "required": false } ], "tags": [ "OpManager.BusinessViews" ] } }, "/api/json/v2/wireless/getWirelessNetworkDetails": { "get": { "summary": "Get Wireless Network Details", "x-zenesis-title": "Get Wireless Network Details", "security": [], "x-zenesis-security": { "duration": "1M", "threshold": "40", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Returns a list of wireless networks (SSIDs) associated with the given WLC device, including AP count, client count, and total network usage.", "operationId": "getWirelessNetworkDetails", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WirelessNetworkDetail" } }, "examples": { "Example1": { "value": [ { "SSIDName": "Corporate-WiFi", "APCount": "12", "ClientCount": "85", "TotalBytes": "1.5 MBps" }, { "SSIDName": "Guest-WiFi", "APCount": "8", "ClientCount": "32", "TotalBytes": "512.0 KBps" } ] } } } } } }, "parameters": [ { "name": "apikey", "schema": { "$ref": "#/components/schemas/apikey_regex" }, "description": "API Key to access your OpManager server.", "in": "header", "required": true }, { "name": "deviceName", "schema": { "type": "string", "maxLength": 100 }, "description": "Name of the WLC device.", "in": "query", "required": true } ], "tags": [ "OpManager.Wireless" ], "x-zenesis-doc": { "show": true } } }, "/api/json/v2/wireless/getAllRogueAPs": { "get": { "summary": "Get All Rogue SSIDs", "x-zenesis-title": "Get All Rogue SSIDs", "security": [], "x-zenesis-security": { "duration": "1M", "threshold": "40", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Returns a list of rogue SSIDs detected by the given WLC device.", "operationId": "getAllRogueAPs", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RogueAPResponse" }, "examples": { "Example1": { "value": { "showAPName": true, "rogueAPList": [ { "macAddress": "AA:BB:CC:DD:EE:FF", "channels": "6", "rougeclient": "3", "ipAddress": "10.5.5.1", "time": "2026-03-20 10:30:00", "SSIDName": "FreeWiFi", "apName": "Rogue-AP-1" }, { "macAddress": "AA:BB:CC:DD:EE:FF", "channels": "11", "rougeclient": "0", "ipAddress": "10.5.5.1", "time": "2026-03-20 11:15:00", "SSIDName": "OpenNet", "apName": "" } ] } } } } } } }, "parameters": [ { "name": "apikey", "schema": { "$ref": "#/components/schemas/apikey_regex" }, "description": "API Key to access your OpManager server.", "in": "header", "required": true }, { "name": "deviceName", "schema": { "type": "string", "maxLength": 100 }, "description": "Name of the WLC device.", "in": "query", "required": true } ], "tags": [ "OpManager.Wireless" ], "x-zenesis-doc": { "show": true } } }, "/api/json/v2/pathanalysis/getPathwayGraph": { "get": { "summary": "Get Pathway Graph Data", "x-zenesis-title": "Get Pathway Graph Data", "security": [], "x-zenesis-security": { "duration": "1M", "threshold": "50", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Returns the pathway topology graph for a given network path monitor, including node details, link details, threshold information, and all discovered path variations within the specified time period.", "operationId": "getPathwayGraph", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PathwayGraphResponse" }, "examples": { "Example1": { "value": { "pathGraphTime": 1710921600000, "nodeDetails": [ { "nodeName": "10.5.5.1", "nodeDisplayName": "Office-Router", "nodeLocation": "start", "status": "1" }, { "nodeName": "10.5.5.2", "maxRTT": "10 ms", "country": "United States", "avgRTT": "5.5 ms", "nodeDisplayName": "10.5.5.2", "minRTT": "2 ms", "geoLoaded": true, "ASName": "AS15169", "packetLossPercent": 0, "nodeLocation": "intermediate", "status": "1" }, { "nodeName": "10.5.5.1", "maxRTT": "25 ms", "avgRTT": "12.5 ms", "nodeDisplayName": "DataCenter-GW", "minRTT": "5 ms", "packetLossPercent": 0, "nodeLocation": "end", "status": "1", "destinationReachable": true } ], "thresholdDetails": { "latency": { "Trouble": 200, "Critical": 500, "type": "static", "Attention": 100 } }, "destinationUnreachablePaths": [], "paths": { "1": [ "10.5.5.1:10.5.5.2", "10.5.5.2:192.168.1.1" ] }, "networkPathDetails": { "pathName": "networkpath_10.5.5.1_192.168.1.1", "pathDestinationPort": 80, "pathStatus": 1, "pathSource": "10.5.5.1", "pathSourceDisplayName": "Office-Router", "pathDestination": "192.168.1.1", "moID": 100001, "pathDisplayName": "Office to DataCenter" }, "hopVsPaths": { "10.5.5.2": [ 1 ] }, "pathDetails": [ { "maxRTT": "10 ms", "timeOutHopCount": "0", "avgRTT": "5.5 ms", "destination": "10.5.5.2", "source": "10.5.5.1", "minRTT": "2 ms", "packetLossPercent": 0, "likelyPathCount": 100 } ] } }, "NoDataExample": { "value": { "networkPathDetails": { "pathName": "networkpath_10.5.5.1_192.168.1.1", "pathDestinationPort": 80, "pathStatus": 1, "pathSource": "10.5.5.1", "pathSourceDisplayName": "Office-Router", "pathDestination": "192.168.1.1", "moID": 100001, "pathDisplayName": "Office to DataCenter" }, "ERROR": "NO_DATA_FOUND" } } } } } } }, "parameters": [ { "name": "apikey", "schema": { "$ref": "#/components/schemas/apikey_regex" }, "description": "API Key to access your OpManager server.", "in": "header", "required": true }, { "name": "moID", "schema": { "type": "integer", "format": "int64" }, "description": "Managed Object ID of the network path.", "in": "query", "required": true }, { "name": "period", "schema": { "type": "string", "pattern": "^(Today|Last 24 hours|Yesterday|customDate|customTime)$", "description": "" }, "description": "Time period for graph data. One of: Today, Last 24 hours, Yesterday, customDate, customTime.", "in": "query", "required": true }, { "name": "date", "schema": { "type": "string", "format": "date" }, "description": "Date in yyyy-MM-dd format. Required when period is \"customDate\".", "in": "query", "required": false }, { "name": "time", "schema": { "type": "integer", "format": "int64" }, "description": "Epoch timestamp in milliseconds. Required when period is \"customTime\".", "in": "query", "required": false } ], "tags": [ "OpManager.NetworkPath" ], "x-zenesis-doc": { "show": true } } }, "/api/json/admin/listLogicalGroupMembers": { "get": { "summary": "List Logical Group Members", "x-zenesis-title": "List Logical Group Members", "security": [], "x-zenesis-security": { "duration": "1M", "threshold": "100", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Retrieves the list of members (devices, interfaces, etc.) belonging to a specific logical group. Requires the group name as a mandatory parameter.", "operationId": "listLogicalGroupMembers", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "memberName": { "type": "string", "description": "Name of the group member" }, "memberType": { "type": "string", "description": "Type of the member (Device, Interface, etc.)" }, "status": { "type": "string", "description": "Current status of the member" } } } }, "examples": { "Example1": { "value": [ { "memberName": "server1.example.com", "memberType": "Device", "status": "Up" }, { "memberName": "server2.example.com", "memberType": "Device", "status": "Down" } ] } } } } } }, "parameters": [ { "name": "apikey", "schema": { "$ref": "#/components/schemas/apikey_regex" }, "description": "API Key to access your OpManager server.", "in": "header", "required": true }, { "name": "groupName", "schema": { "$ref": "#/components/schemas/text_basic_symbols_two_byte_support_regex" }, "description": "Unique name of the logical group", "in": "query", "required": true } ], "tags": [ "OpManager.Groups" ], "x-zenesis-doc": { "show": true } } }, "/api/json/admin/getIpslaMonitors": { "get": { "summary": "List All IP SLA Monitors", "x-zenesis-title": "List All IP SLA Monitors", "security": [], "x-zenesis-security": { "duration": "1M", "threshold": "100", "lock-period": "1M" }, "description": "Retrieves the list of all IPSLA monitors of the specified type (VoIP, WAN, or Video). Each monitor entry includes probe details, source and target device names, severity status, availability, next poll time, and type-specific performance metrics such as latency, jitter, MOS, packet loss, and RTT.\n", "operationId": "getIpslaMonitors", "responses": { "200": { "description": "Successful response containing the list of IP SLA monitors. Response fields vary depending on the monitorType requested.\n", "content": { "application/json": { "schema": { "type": "array", "description": "List of IP SLA monitor objects.", "items": { "type": "object", "description": "Properties of a single IP SLA monitor. Fields vary by monitor type (VoIP, WAN, or Video).\n", "properties": { "statusStr": { "type": "string", "description": "Severity status string (e.g., \"Critical\", \"Clear\")." }, "ipslaMonDispName": { "type": "string", "description": "Composite display name in the format \"Source \u2794 Target ( MonitorName )\".\n" }, "lastpolltime": { "type": "integer", "format": "int64", "description": "Last poll time as epoch milliseconds." }, "Nextpolltime": { "type": "string", "description": "Formatted next poll time string, or \"Data Not Collected\" if performance data is not yet available.\n" }, "availability": { "description": "Availability percentage or value for the monitor.", "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "thresholdViolation": { "type": "string", "description": "Threshold violation percentage. WAN monitors only. Format \"X.XX %\".\n" }, "totalPacketLoass": { "description": "Total packet loss count. Video monitors only. \"-\" if data not collected.\n", "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "sourceDeviceName": { "type": "string", "description": "Internal name of the source device." }, "noOfAlerts": { "type": "integer", "description": "Number of active alerts. VoIP and Video monitors only.\n" }, "packetLossSD": { "type": "string", "description": "Packet loss percentage (Source to Destination). VoIP monitors only. Format \"X.XX %\".\n" }, "jitterSD": { "type": "string", "description": "Jitter in milliseconds (Source to Destination). VoIP monitors only. Format \"X msec\".\n" }, "jitterDS": { "type": "string", "description": "Jitter in milliseconds (Destination to Source). VoIP monitors only. Format \"X msec\".\n" }, "latencySD": { "type": "string", "description": "Latency in milliseconds (Source to Destination). VoIP monitors only. Format \"X msec\".\n" }, "packetLossDS": { "type": "string", "description": "Packet loss percentage (Destination to Source). VoIP monitors only. Format \"X.XX %\".\n" }, "latencyDS": { "type": "string", "description": "Latency in milliseconds (Destination to Source). VoIP monitors only. Format \"X msec\".\n" }, "maxRTT": { "type": "string", "description": "Maximum Round Trip Time. WAN monitors only. Format \"X msec\".\n" }, "avgPositiveGitter": { "description": "Average positive jitter. Video monitors only. \"-\" if data not collected.\n", "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "monitorName": { "type": "string", "description": "Name of the IP SLA monitor/collector." }, "probeId": { "type": "integer", "format": "int64", "description": "Unique probe ID of the IP SLA monitor." }, "srcDisplayName": { "type": "string", "description": "Display name of the source device." }, "avgMOS": { "type": "number", "description": "Average Mean Opinion Score. VoIP monitors only. \"-\" if data not collected.\n" }, "statusNum": { "type": "integer", "description": "Numeric severity status. 1=Critical, 2=Attention, 3=Trouble, 4=Service Down, 5=Clear.\n" }, "avgNegativeGitter": { "description": "Average negative jitter. Video monitors only. \"-\" if data not collected.\n", "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "avgOwTT": { "description": "Average one-way trip time. Video monitors only. \"-\" if data not collected.\n", "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "avgRTT": { "type": "string", "description": "Average Round Trip Time. VoIP and WAN monitors. Format \"X msec\".\n" }, "minRTT": { "type": "string", "description": "Minimum Round Trip Time. WAN monitors only. Format \"X msec\".\n" }, "targetDeviceName": { "type": "string", "description": "Display name of the target device." } } } }, "examples": { "WANExample": { "summary": "WAN monitor response", "value": [ { "maxRTT": "350 msec", "statusStr": "Critical", "monitorName": "WAN_Monitor_1", "ipslaMonDispName": "HQ Switch \u2794 DC Switch ( WAN_Monitor_1 )", "lastpolltime": 1774012500000, "probeId": 201, "Nextpolltime": "14:35:00 Mar 20,26", "srcDisplayName": "HQ Switch", "availability": "85", "statusNum": 1, "thresholdViolation": "22.50 %", "sourceDeviceName": "hq-switch-01", "avgRTT": "120 msec", "minRTT": "45 msec", "targetDeviceName": "DC Switch" } ] }, "VoIPExample": { "summary": "VoIP monitor response", "value": [ { "statusStr": "Clear", "monitorName": "VoIP_Monitor_1", "ipslaMonDispName": "Core Router \u2794 Branch Router ( VoIP_Monitor_1 )", "lastpolltime": 1774012200000, "probeId": 101, "Nextpolltime": "14:30:00 Mar 20,26", "srcDisplayName": "Core Router", "availability": 99, "avgMOS": 4.25, "statusNum": 5, "sourceDeviceName": "core-router-01", "noOfAlerts": 0, "packetLossSD": "0.12 %", "jitterSD": "3 msec", "jitterDS": "2 msec", "avgRTT": "27 msec", "latencySD": "15 msec", "packetLossDS": "0.08 %", "latencyDS": "12 msec", "targetDeviceName": "Branch Router" } ] }, "VideoExample": { "summary": "Video monitor response", "value": [ { "avgPositiveGitter": 5, "statusStr": "Clear", "monitorName": "Video_Monitor_1", "ipslaMonDispName": "Media Server \u2794 Endpoint ( Video_Monitor_1 )", "lastpolltime": 1774012800000, "probeId": 301, "Nextpolltime": "14:40:00 Mar 20,26", "srcDisplayName": "Media Server", "availability": 100, "statusNum": 5, "totalPacketLoass": 0, "sourceDeviceName": "media-server-01", "avgNegativeGitter": 3, "noOfAlerts": 0, "avgOwTT": 18, "targetDeviceName": "Endpoint" } ] } } } } } }, "parameters": [ { "name": "apikey", "schema": { "$ref": "#/components/schemas/apikey_regex" }, "description": "API Key to access your OpManager server.", "in": "header", "required": true }, { "name": "monitorType", "schema": { "type": "string", "enum": [ "voip", "wan", "video" ] }, "description": "Type of IP SLA monitor to retrieve. Must be one of \"voip\", \"wan\", or \"video\".\n", "in": "query", "required": true }, { "name": "selCustomerID", "schema": { "type": "integer", "format": "int64", "description": "" }, "description": "Optional parameter that refers to the Customer ID. Applicable in MSP Central to filter monitors for a specific customer.\n", "in": "query", "required": false }, { "name": "regionID", "schema": { "$ref": "#/components/schemas/onlyNumber_regex" }, "description": "Optional parameter that refers to the Probe/Region ID. Applicable in MSP Central deployments.\n", "in": "query", "required": false }, { "name": "severity", "schema": { "type": "string", "description": "" }, "description": "Filter monitors by severity status code (comma-separated).\n", "in": "query", "required": false } ], "tags": [ "OpManager.IPSLA" ] } }, "/api/json/admin/listDownTimeSchedules": { "get": { "summary": "List Downtime Schedules", "x-zenesis-title": "List Downtime Schedules", "security": [], "x-zenesis-security": { "duration": "1M", "threshold": "100", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Retrieves a list of downtime schedules based on the specified filter type. Returns device downtime schedules when filterType is \"Device\", or all schedules for other filter types. Supports both inventory and settings operation contexts.", "operationId": "listDownTimeSchedules", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "description": "Downtime schedule object containing schedule details and configuration" } }, "examples": { "Example1": { "summary": "List of downtime schedules", "value": [ { "scheduleName": "Weekend Maintenance", "createdTime": "2024-01-15T10:30:00Z", "filterType": "Device", "isActive": true, "scheduleId": 123 }, { "scheduleName": "Monthly Patch Updates", "createdTime": "2024-02-01T09:00:00Z", "filterType": "Device", "isActive": false, "scheduleId": 124 } ] } } } } } }, "parameters": [ { "name": "apikey", "schema": { "$ref": "#/components/schemas/apikey_regex" }, "description": "API Key to access your OpManager server.", "in": "header", "required": true }, { "name": "filterType", "schema": { "$ref": "#/components/schemas/devicesMethod_regex" }, "description": "Type of filter to apply for listing downtime schedules", "in": "query", "required": true } ], "tags": [ "OpManager.Downtime Scheduler" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/getInterfaceSummary": { "get": { "summary": "Get Interface Summary", "x-zenesis-title": "Get Interface Summary", "security": [], "x-zenesis-security": { "duration": "1M", "threshold": "50", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Retrieves comprehensive summary information for a specific network interface. Includes interface properties, traffic counters, bandwidth settings, polling configuration, availability data, and optional snapshot details.", "operationId": "getInterfaceSummary", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InterfaceSummaryResponse" }, "examples": { "Example1": { "value": { "isAgentMonitoring": false, "recBandwidth": "1000000000", "NFA_ID": "12345", "isAddedToNFA": "true", "displayName": "Main Router", "availability": { "downtime": "0.1", "uptime": "99.9" }, "pollingStatus": "1", "pollInterval": "300", "intfMoName": "router1.example.com_GigabitEthernet0/1", "managed": "true", "name": "router1.example.com", "transBandwidth": "1000000000", "category": "Router", "statusPollEnabled": "true", "trafficCounter": "64 bit", "availabilityTimeLine": [ { "timestamp": "2026-03-19T00:00:00Z", "availability": 100 } ] } } } } } }, "400": { "description": "Missing or invalid parameter.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "parameters": [ { "name": "apikey", "schema": { "$ref": "#/components/schemas/apikey_regex" }, "description": "API Key to access your OpManager server.", "in": "header", "required": true }, { "name": "interfaceName", "schema": { "type": "string", "maxLength": 100 }, "description": "Name of the interface to retrieve summary.", "in": "query", "required": true } ], "tags": [ "OpManager.Interfaces" ], "x-zenesis-doc": { "show": true } } }, "/api/json/admin/listAllLogicalGroups": { "get": { "summary": "List All Logical Groups", "x-zenesis-title": "List All Logical Groups", "security": [], "x-zenesis-security": { "duration": "1M", "threshold": "100", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Retrieves a list of all logical groups in the system. Can return a simple list or paginated results based on the isGroupPage parameter. Supports filtering, sorting, and searching capabilities for logical groups.", "operationId": "listAllLogicalGroups", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "oneOf": [ { "type": "array", "items": { "type": "object", "properties": { "count": { "type": "integer", "description": "Number of members in the group" }, "groupName": { "type": "string", "description": "Name of the logical group" }, "groupType": { "type": "string", "description": "Type of the logical group" } } } }, { "type": "object", "properties": { "total": { "type": "integer", "description": "Total number of pages" }, "page": { "type": "integer", "description": "Current page number" }, "rows": { "type": "array", "items": { "type": "object" }, "description": "Paginated group data" }, "records": { "type": "integer", "description": "Total number of records" } } } ] }, "examples": { "Example1": { "value": [ { "count": 15, "groupName": "Web Servers", "groupType": "Logical Device Group" }, { "count": 8, "groupName": "Database Servers", "groupType": "Logical Device Group" } ] } } } } } }, "parameters": [ { "name": "apikey", "schema": { "$ref": "#/components/schemas/apikey_regex" }, "description": "API Key to access your OpManager server.", "in": "header", "required": true }, { "name": "isGroupPage", "schema": { "type": "boolean" }, "description": "Whether this is for group page display. It will be used to list all the groups without pagination when it is true.", "in": "query", "required": false } ], "tags": [ "OpManager.Groups" ], "x-zenesis-doc": { "show": true } } }, "/api/json/v2/pathanalysis/listNetworkPaths": { "get": { "summary": "List All Network Path Monitors", "x-zenesis-title": "List All Network Path Monitors", "security": [], "x-zenesis-security": { "duration": "1M", "threshold": "60", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Returns a list of all configured network path monitors along with their status and managed-object details. In Central Server mode, results can be filtered by probe ID.", "operationId": "listNetworkPaths", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkPathListItem" } }, "examples": { "Example1": { "value": [ { "pathName": "Office to DataCenter", "destinationPort": "80", "sourceDisplayName": "Office-Router", "sourceMOName": "10.5.5.1", "managed": "true", "name": "networkpath_10.5.5.1_192.168.1.1", "source": "10.5.5.1", "destinationHost": "192.168.1.1", "moID": "100001", "status": "1", "sourceManaged": "true" }, { "pathName": "Office to Cloud Gateway", "destinationPort": "-1", "sourceDisplayName": "Office-Router", "sourceMOName": "10.5.5.1", "managed": "true", "name": "networkpath_10.5.5.1_192.168.1.1", "source": "10.5.5.1", "destinationHost": "192.168.1.1", "moID": "100002", "status": "5", "sourceManaged": "true" } ] } } } } } }, "parameters": [ { "name": "apikey", "schema": { "$ref": "#/components/schemas/apikey_regex" }, "description": "API Key to access your OpManager server.", "in": "header", "required": true }, { "name": "probeID", "schema": { "type": "integer", "format": "int64" }, "description": "Filter network paths by probe ID (applicable in Central Server mode).", "in": "query", "required": false } ], "tags": [ "OpManager.NetworkPath" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/getDeviceNotes": { "get": { "summary": "Get Device Notes and Custom Fields", "x-zenesis-title": "Get Device Notes and Custom Fields", "security": [], "x-zenesis-security": { "duration": "1M", "threshold": "100", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Retrieves custom fields (notes) associated with a specific device. Returns device-specific custom field values along with field metadata including data types, editability status, and monitor availability. Supports integration with NCM and OpUtils custom fields.", "operationId": "getDeviceNotes", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "properties": { "deviceDetails": { "type": "array", "items": { "type": "object", "properties": { "FIELDVALUE": { "type": "string", "description": "Current value of the custom field for this device" }, "DATATYPE": { "type": "string", "description": "Data type of the field (Text, Numeric, Date)" }, "ISMONAVAIL": { "type": "boolean", "description": "Whether monitoring is available for this field" }, "ISEDITABLE": { "type": "boolean", "description": "Whether the field can be edited" }, "DESCRIPTION": { "type": "string", "description": "Description of the custom field" }, "FIELDNAME": { "type": "string", "description": "Display name of the custom field" }, "ALIASNAME": { "type": "string", "description": "Alias name for the custom field" }, "FIELDLENGTH": { "type": "integer", "description": "Maximum length of the field value" } } } } } }, "examples": { "Example1": { "value": { "deviceDetails": [ { "FIELDVALUE": "Data Center A", "DATATYPE": "Text", "ISMONAVAIL": false, "ISEDITABLE": true, "DESCRIPTION": "Device location information", "FIELDNAME": "Location", "ALIASNAME": "UDF1", "FIELDLENGTH": 250 }, { "FIELDVALUE": "AT-001234", "DATATYPE": "Text", "ISMONAVAIL": false, "ISEDITABLE": true, "DESCRIPTION": "Asset tag number", "FIELDNAME": "Asset Tag", "ALIASNAME": "UDF2", "FIELDLENGTH": 50 } ] } } } } } } }, "parameters": [ { "name": "apikey", "schema": { "$ref": "#/components/schemas/apikey_regex" }, "description": "API Key to access your OpManager server.", "in": "header", "required": true }, { "name": "name", "schema": { "type": "string", "maxLength": 100 }, "description": "Name of the device", "in": "query", "required": true } ], "tags": [ "OpManager.Devices" ], "x-zenesis-doc": { "show": true } } }, "/api/json/v2/wireless/getWirelessAPList": { "get": { "summary": "Get Wireless AP List", "x-zenesis-title": "Get Wireless AP List", "security": [], "x-zenesis-security": { "duration": "1M", "threshold": "40", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Returns a list of access points (APs) discovered under the given WLC device. Results can optionally be filtered by status or type.", "operationId": "getWirelessAPList", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WirelessAPDetail" } }, "examples": { "Example1": { "value": [ { "macAddress": "00:1A:2B:3C:4D:5E", "channels": "1, 36", "statusStr": "Clear", "ipAddress": "10.5.5.1", "apDisplayName": "Floor 1 - AP 01", "apName": "ap_floor1_01", "statusNum": "1", "advanceMonitoringEnabled": "true" }, { "macAddress": "00:1A:2B:3C:4D:5F", "channels": "6, 40", "statusStr": "UnManaged", "ipAddress": "10.5.5.1", "apDisplayName": "Floor 2 - AP 01", "apName": "ap_floor2_01", "statusNum": "7", "advanceMonitoringEnabled": "false" } ] } } } } } }, "parameters": [ { "name": "apikey", "schema": { "$ref": "#/components/schemas/apikey_regex" }, "description": "API Key to access your OpManager server.", "in": "header", "required": true }, { "name": "deviceName", "schema": { "type": "string", "maxLength": 100 }, "description": "Name of the WLC device.", "in": "query", "required": true }, { "name": "filterBy", "schema": { "type": "string" }, "description": "Optional filter criteria for the AP list.", "in": "query", "required": false } ], "tags": [ "OpManager.Wireless" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/getInterfaceNotes": { "get": { "summary": "Get Interface Notes and Custom Fields", "x-zenesis-title": "Get Interface Notes and Custom Fields", "security": [], "x-zenesis-security": { "duration": "1M", "threshold": "50", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Retrieves custom fields (notes) associated with a specific network interface. Returns interface-specific custom field values along with field metadata including data types and field properties. Supports both viewing and editing modes.", "operationId": "getInterfaceNotes", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "FIELDVALUE": { "type": "string", "description": "Current value of the custom field for this interface" }, "CUSTOMFIELDID": { "type": "string", "description": "Unique identifier for the custom field" }, "DATATYPE": { "type": "string", "description": "Data type of the field (Text, Numeric, Date)" }, "DESCRIPTION": { "type": "string", "description": "Description of the custom field" }, "FIELDNAME": { "type": "string", "description": "Display name of the custom field" }, "ALIASNAME": { "type": "string", "description": "Alias name for the custom field" }, "FIELDLENGTH": { "type": "integer", "description": "Maximum length of the field value" } } } }, "examples": { "Example1": { "value": [ { "FIELDVALUE": "WAN Connection", "CUSTOMFIELDID": "1", "DATATYPE": "Text", "DESCRIPTION": "Purpose of the network interface", "FIELDNAME": "Interface Purpose", "ALIASNAME": "UDF1", "FIELDLENGTH": 250 }, { "FIELDVALUE": "CIR-5678", "CUSTOMFIELDID": "2", "DATATYPE": "Text", "DESCRIPTION": "Circuit identifier", "FIELDNAME": "Circuit ID", "ALIASNAME": "UDF2", "FIELDLENGTH": 100 } ] } } } } } }, "parameters": [ { "name": "apikey", "schema": { "$ref": "#/components/schemas/apikey_regex" }, "description": "API Key to access your OpManager server.", "in": "header", "required": true }, { "name": "interfaceName", "schema": { "type": "string", "maxLength": 100 }, "description": "Name of the interface", "in": "query", "required": true } ], "tags": [ "OpManager.Interfaces" ], "x-zenesis-doc": { "show": true } } }, "/api/json/admin/getIpslaMonitorData": { "get": { "summary": "Get IP SLA Monitor Snapshot Data", "x-zenesis-title": "Get IP SLA Monitor Snapshot Data", "security": [], "x-zenesis-security": { "duration": "1M", "threshold": "100", "lock-period": "1M" }, "description": "Retrieves detailed snapshot data for a specific IP SLA monitor identified by its probe ID. Returns comprehensive monitor configuration, status, availability pie-chart data, dial gauges, digital meter values, threshold settings, and notification profiles. The response varies based on monitor type (VoIP, WAN, or Video).\n", "operationId": "getIpslaMonitorData", "responses": { "200": { "description": "Successful response containing detailed monitor snapshot data. Fields vary based on monitor type (VoIP, WAN, or Video).\n", "content": { "application/json": { "schema": { "type": "object", "description": "Detailed IP SLA monitor snapshot object.", "properties": { "successPercent": { "type": "string", "description": "Percentage of successful operations (e.g., \"98.5 % Success\") or \"Not Monitored\".\n" }, "monIntervalNoUnit": { "type": "integer", "description": "Monitoring interval value in minutes (without unit)." }, "monInterval": { "type": "string", "description": "Monitoring interval with unit (e.g., \"5 mins\", \"1 min\")." }, "digitalMeters": { "type": "array", "description": "Digital meter values for the monitor. VoIP: Latency and PacketLoss meters. WAN: SLA Violation and Errors meters. Video: Latency and Jitter meters.\n", "items": { "type": "object" } }, "markedForDeletion": { "type": "boolean", "description": "Whether the monitor is marked for deletion. Only present in RMM edition.\n" }, "deviceName": { "type": "string", "description": "Source device name (internal name or display name if available)." }, "enabled": { "type": "string", "description": "Whether the monitor is managed (\"true\" or \"false\")." }, "timeout": { "type": "string", "description": "Timeout value with unit (e.g., \"5 sec\"). WAN (Icmp Echo) monitors only.\n" }, "frequency": { "type": "string", "description": "Frequency description string. VoIP monitors only.\n" }, "targetIP": { "type": "string", "description": "IP address of the target device." }, "lastUpdated": { "description": "Last collection timestamp. \"-\" if data not yet collected, otherwise a Timestamp object.\n", "oneOf": [ { "type": "string" }, { "type": "object" } ] }, "notificationProfiles": { "type": "array", "description": "List of notification profiles associated with this monitor.", "items": { "type": "object", "description": "Notification profile details." } }, "avilability": { "type": "array", "description": "Availability pie-chart data with percentage of time monitor is Available, Unavailable and Not Monitored for today.\n", "items": { "type": "object" } }, "snapDetails": { "type": "object", "description": "Snapshot tab layout details. Only present when the snapType query parameter is provided.\n" }, "pathEchoEnabled": { "type": "string", "description": "Whether IP Path Echo is enabled (\"true\" or \"false\"). WAN (Icmp Echo) monitors only.\n" }, "monitorName": { "type": "string", "description": "Name of the IP SLA collector/monitor." }, "probeId": { "type": "integer", "format": "int64", "description": "Unique probe ID of the IP SLA monitor." }, "hopByHopStatus": { "type": "string", "description": "Hop-by-hop monitoring status (\"Enabled\" or \"Disabled\"). WAN (Icmp Echo) monitors only.\n" }, "targetDisplayName": { "type": "string", "description": "Display name of the target device." }, "sourceIntf": { "type": "string", "description": "Source interface used for the probe." }, "srcDisplayName": { "type": "string", "description": "Display name of the source device." }, "iosVersion": { "type": "string", "description": "IOS version of the source device." }, "packetSize": { "type": "string", "description": "Packet size with unit (e.g., \"160 bytes\"). VoIP and WAN (Icmp Echo) monitors.\n" }, "saaVersion": { "type": "string", "description": "SAA (RTR) agent version." }, "statusNum": { "type": "string", "description": "Numeric severity status code." }, "codec": { "type": "string", "description": "Codec display text (e.g., \"g711alaw\", \"NotApplicable\"). VoIP monitors only.\n" }, "dials": { "type": "array", "description": "Dial gauge data points for the monitor. Contents vary by monitor type (Jitter/RTT for VoIP, RTT for WAN, Jitter metrics for Video).\n", "items": { "type": "object" } }, "thresholdDetails": { "type": "array", "description": "List of threshold configurations for the monitor. Includes RTT, MOS, Jitter, PacketLoss, Latency, and Availability thresholds.\n", "items": { "type": "object", "properties": { "displayUnit": { "type": "string", "description": "Unit of the threshold (e.g., \"msec\", \"%\", or empty).\n" }, "thresholdName": { "type": "string", "description": "Threshold metric name (RTT, MOS, JITTER, PACKETLOSS, LATENCY, AVAILABILITY).\n" }, "risingThreshold": { "type": "number", "description": "Rising (attention/critical) threshold value." }, "fallingThreshold": { "type": "number", "description": "Falling (clear) threshold value." } } } }, "markedForUnmanage": { "type": "boolean", "description": "Whether the monitor is marked for unmanage. Only present in RMM edition.\n" }, "vrfName": { "type": "string", "description": "VRF name associated with the source interface." }, "status": { "type": "string", "description": "Severity status string (e.g., \"Critical\", \"Clear\")." } } }, "examples": { "VoIPMonitorSnapshot": { "summary": "VoIP monitor snapshot response", "value": { "successPercent": "99.5 % Success", "monIntervalNoUnit": 5, "monInterval": "5 mins", "digitalMeters": [ { "LatencySD": 15 }, { "PacketLossSD": 0 } ], "deviceName": "Core Router", "enabled": "true", "frequency": "Send 1000 packets of 160 bytes at 20ms intervals", "targetIP": "10.5.5.1", "lastUpdated": "2026-03-20 14:30:00.0", "notificationProfiles": [], "avilability": [ { "value": 995, "label": "Success" }, { "value": 5, "label": "Failure" } ], "monitorName": "VoIP_Jitter_Monitor_1", "probeId": 101, "targetDisplayName": "Branch Router", "sourceIntf": "GigabitEthernet0/0", "srcDisplayName": "Core Router", "iosVersion": "15.2(4)M", "packetSize": "160 bytes", "saaVersion": "2.0", "statusNum": "5", "codec": "g711alaw", "dials": [ { "JitterSD": 5 }, { "JitterDS": 3 }, { "RTT": 27 } ], "thresholdDetails": [ { "displayUnit": "msec", "thresholdName": "RTT", "risingThreshold": 300, "fallingThreshold": 100 }, { "displayUnit": "", "thresholdName": "MOS", "risingThreshold": 2, "fallingThreshold": 3 } ], "vrfName": "Not Available", "status": "Clear" } }, "WANMonitorSnapshot": { "summary": "WAN (Icmp Echo) monitor snapshot response", "value": { "successPercent": "85.0 % Success", "monIntervalNoUnit": 1, "monInterval": "1 min", "digitalMeters": [ { "SLAViolation": 22 }, { "Errors": 15 } ], "deviceName": "HQ Switch", "enabled": "true", "timeout": "5 sec", "targetIP": "10.5.5.1", "lastUpdated": "2026-03-20 14:35:00.0", "notificationProfiles": [], "avilability": [ { "value": 850, "label": "Success" }, { "value": 150, "label": "Failure" } ], "pathEchoEnabled": "true", "monitorName": "WAN_Echo_Monitor_1", "probeId": 201, "hopByHopStatus": "Enabled", "targetDisplayName": "DC Switch", "sourceIntf": "FastEthernet0/1", "srcDisplayName": "HQ Switch", "iosVersion": "15.1(4)M", "packetSize": "512 bytes", "saaVersion": "1.0", "statusNum": "1", "dials": [ { "RTT": 120 } ], "thresholdDetails": [ { "displayUnit": "msec", "thresholdName": "RTT", "risingThreshold": 500, "fallingThreshold": 200 }, { "displayUnit": "%", "thresholdName": "AVAILABILITY", "risingThreshold": 90, "fallingThreshold": 95 } ], "vrfName": "Not Available", "status": "Critical" } } } } } } }, "parameters": [ { "name": "apikey", "schema": { "$ref": "#/components/schemas/apikey_regex" }, "description": "API Key to access your OpManager server.", "in": "header", "required": true }, { "name": "monitorType", "schema": { "type": "string", "enum": [ "voip", "wan", "video" ] }, "description": "Type of IP SLA monitor. Must be one of \"voip\", \"wan\", or \"video\".\n", "in": "query", "required": true }, { "name": "probeId", "schema": { "type": "integer", "format": "int64" }, "description": "The unique probe ID of the IP SLA monitor to retrieve data for.\n", "in": "query", "required": true }, { "name": "isGlobal", "schema": { "type": "boolean" }, "description": "Whether to include global notification profiles. Defaults to false.\n", "in": "query", "required": false }, { "name": "snapType", "schema": { "type": "string", "enum": [ "IPSLAVoIP", "IPSLAWAN", "IPSLAVideo" ] }, "description": "If provided, includes snapshot tab layout details in the response. Must match the monitor type snapshot name.\n", "in": "query", "required": false }, { "name": "expand", "schema": { "type": "boolean" }, "description": "Boolean flag for expanded view mode.\n", "in": "query", "required": false }, { "name": "period", "schema": { "type": "string" }, "description": "Time period for availability and report data. Applicable values like \"today\", \"thisWeek\", \"thisMonth\", \"lastWeek\", \"lastMonth\", \"last7Days\", \"last30Days\", \"custom\".\n", "in": "query", "required": false }, { "name": "startDate", "schema": { "type": "string" }, "description": "Start date for custom period. Required when period is \"custom\".\n", "in": "query", "required": false }, { "name": "endDate", "schema": { "type": "string" }, "description": "End date for custom period. Required when period is \"custom\".\n", "in": "query", "required": false } ], "tags": [ "OpManager.IPSLA" ] } }, "/api/json/device/getTraceResponse": { "post": { "summary": "Get Trace Route Response", "x-zenesis-security": { "duration": "1M", "threshold": "500", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Executes traceroute command to trace the network path to a device and returns the route information. Shows the hop-by-hop path that packets take to reach the destination device.", "tags": [ "OpManager.Devices" ], "x-zenesis-doc": { "show": true }, "x-zenesis-title": "Get Trace Route Response", "security": [], "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "deviceName": { "type": "string", "description": "Name or IP address of the destination device", "maxLength": 100 } }, "required": [ "deviceName" ] } } } }, "operationId": "getTraceResponse", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "properties": { "getTrace": { "type": "string", "description": "Traceroute command output showing network path" } } }, "examples": { "Example1": { "value": { "getTrace": "traceroute to 192.168.1.1 (192.168.1.1), 30 hops max, 60 byte packets\n 1 gateway (192.168.0.1) 0.123 ms 0.145 ms 0.167 ms\n 2 10.5.5.1 1.234 ms 1.456 ms 1.567 ms\n 3 192.168.1.1 2.345 ms 2.456 ms 2.567 ms" } } } } } } }, "parameters": [ { "name": "apikey", "schema": { "$ref": "#/components/schemas/apikey_regex" }, "description": "API Key to access your OpManager server.", "in": "header", "required": true } ] } }, "/api/json/admin/getIpslaReportData": { "get": { "summary": "Get IP SLA Report Graph Data", "x-zenesis-title": "Get IP SLA Report Graph Data", "security": [], "x-zenesis-security": { "duration": "1M", "threshold": "100", "lock-period": "1M" }, "description": "Retrieves time-series graph data for a specific IP SLA monitor report. Returns chart data points, axis labels, and graph name for rendering performance graphs. Supports VoIP reports (MOS history, jitter, packet loss, latency, call-path availability, packet errors, RTT), WAN reports (RTT threshold violations, RTT history, availability, path-hop RTT), and Video reports (positive/negative jitter, average jitter, IA jitter at source/destination, latency, availability & errors).\n", "operationId": "getIpslaReportData", "responses": { "200": { "description": "Successful response containing time-series graph data for the requested report.\n", "content": { "application/json": { "schema": { "type": "object", "description": "Report graph data object containing chart data points, axis labels, and graph name.\n", "properties": { "xyTitles": { "type": "array", "items": { "type": "string", "description": "" }, "description": "Two-element array containing the X-axis label (typically \"Time\") and Y-axis label (e.g., \"Jitter (msec)\", \"RTT (msec)\", \"Latency (msec)\", \"MOS\", \"SLA %\").\n" }, "graphName": { "type": "string", "description": "Identifier name for the graph (e.g., \"mosHistory\", \"jitterHistorySD\", \"rttThresholdViolation\", \"PostiveNegativeJitter\", \"LatencyReport\").\n" }, "graphData": { "type": "array", "items": { "type": "object", "description": "A single data point in the time series. Contains a timestamp and metric value(s) keyed by display name.\n" }, "description": "List of time-series data point objects for the graph. Each entry contains a collection time and one or more metric values with their display names. The metric keys vary by report type.\n" } } }, "examples": { "Example1": { "value": { "graphName": "rttThresholdViolation", "xyTitles": [ "Time", "SLA %" ], "graphData": [ { "seriesname": "Success", "data": [ [ 1774332462750, 43 ], [ 1774334262782, 40 ] ] }, { "seriesname": " SLA Violation", "data": [ [ 1774332462750, 29 ], [ 1774334262782, 40 ] ] }, { "seriesname": " Failed", "data": [ [ 1774332462750, 29 ], [ 1774334262782, 20 ] ] } ] } } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "probeId", "required": true, "description": "The unique probe ID of the IP SLA monitor to retrieve report data for.\n", "schema": { "type": "integer", "format": "int64", "description": "" } }, { "in": "query", "name": "reportName", "required": true, "description": "The name of the report to retrieve graph data for. VoIP reports: mosHistory, jitterHistorySD, jitterHistoryDS, packetLossSD, packetLossDS, latencySD, latencyDS, callPathAvailability, packetErrorStats, voipRttHistory. WAN reports: rttThresholdViolationHistory, wanRttHistory, wanAvailabilityHistory, pathHopRttHistory. Video reports: VideoPosNegJitterReport, VideoAvgPosNegJitterReport, VideoAvgIAJitterSrc, VideoAvgIAJitterDst, VideoLatencyReport, VideoAvailabilityAndErrReport, VideoErrorPacketGraph.\n", "schema": { "type": "string", "enum": [ "mosHistory", "jitterHistorySD", "jitterHistoryDS", "packetLossSD", "packetLossDS", "latencySD", "latencyDS", "callPathAvailability", "packetErrorStats", "voipRttHistory", "rttThresholdViolationHistory", "wanRttHistory", "wanAvailabilityHistory", "pathHopRttHistory", "VideoPosNegJitterReport", "VideoAvgPosNegJitterReport", "VideoAvgIAJitterSrc", "VideoAvgIAJitterDst", "VideoLatencyReport", "VideoAvailabilityAndErrReport", "VideoErrorPacketGraph" ], "description": "" } }, { "in": "query", "name": "period", "required": false, "description": "Time period for the report data. When set to \"custom\", the startDate and endDate parameters become required. Defaults to last 12 hours if not specified.\n", "schema": { "type": "string", "enum": [ "today", "thisWeek", "thisMonth", "lastWeek", "lastMonth", "last7Days", "last30Days", "custom" ], "description": "" } }, { "in": "query", "name": "startDate", "required": false, "description": "Start date for custom period range. Required when period is \"custom\".\n", "schema": { "type": "string", "description": "" } }, { "in": "query", "name": "endDate", "required": false, "description": "End date for custom period range. Required when period is \"custom\".\n", "schema": { "type": "string", "description": "" } } ], "tags": [ "OpManager.IPSLA" ], "x-zenesis-sections": {}, "x-zenesis-doc": { "show": true }, "x-zenesis-envTags": [] } }, "/api/json/admin/getLogicalGroupInfo": { "get": { "summary": "Get Logical Group Information", "x-zenesis-title": "Get Logical Group Information", "security": [], "x-zenesis-security": { "duration": "1M", "threshold": "50", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Retrieves detailed information for a specific logical group. Includes group summary, snapshot details, and alarm profile information.", "operationId": "getLogicalGroupInfo", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "properties": { "summary": { "type": "object", "description": "Group summary information" }, "groupName": { "type": "string", "description": "Name of the logical group" }, "groupType": { "type": "string", "description": "Type of the logical group" }, "snapDetails": { "type": "array", "items": { "type": "object" }, "description": "Snapshot details list" }, "alarmProfileDetails": { "type": "object", "description": "Associated alarm profile information" } } }, "examples": { "Example1": { "value": { "summary": { "totalMembers": 15, "downMembers": 1, "upMembers": 14 }, "groupName": "Web Servers", "groupType": "Logical Device Group" } } } } } } }, "parameters": [ { "name": "apikey", "schema": { "$ref": "#/components/schemas/apikey_regex" }, "description": "API Key to access your OpManager server.", "in": "header", "required": true }, { "name": "groupName", "schema": { "$ref": "#/components/schemas/text_basic_symbols_two_byte_support_regex" }, "description": "Name of the logical group", "in": "query", "required": true }, { "name": "period", "schema": { "type": "string", "pattern": "^3$", "description": "" }, "description": "Time period for snapshot (must be 3)", "in": "query", "required": true } ], "tags": [ "OpManager.Groups" ], "x-zenesis-doc": { "show": true } } }, "/api/json/admin/listAdditionalFields": { "get": { "summary": "List Additional Fields by Object Type", "x-zenesis-title": "List Additional Fields by Object Type", "security": [], "x-zenesis-security": { "duration": "1M", "threshold": "500", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Retrieves a list of additional custom fields configured for the specified object type. Supports Device, Interface, CustFieldToGraph, WANLinkMonitor, WANLinkSite, and WANLinkProps types. Returns custom field definitions including field names, aliases, data types, and properties.", "operationId": "listAdditionalFields", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "FIELDNAME": { "type": "string", "description": "Display name of the custom field" }, "CUSTOMFIELDID": { "type": "string", "description": "Unique identifier for the custom field" }, "ALIASNAME": { "type": "string", "description": "Alias name for the custom field" }, "DATATYPE": { "type": "string", "description": "Data type of the field (Text, Numeric, Date)" }, "DESCRIPTION": { "type": "string", "description": "Description of the custom field" }, "FIELDLENGTH": { "type": "integer", "description": "Maximum length of the field value" } } } }, "examples": { "Example1": { "value": [ { "FIELDNAME": "Location", "CUSTOMFIELDID": "1", "ALIASNAME": "UDF1", "DATATYPE": "Text", "DESCRIPTION": "Device location information", "FIELDLENGTH": 250 }, { "FIELDNAME": "Asset Tag", "CUSTOMFIELDID": "2", "ALIASNAME": "UDF2", "DATATYPE": "Text", "DESCRIPTION": "Asset tag number", "FIELDLENGTH": 50 } ] } } } } } }, "parameters": [ { "name": "apikey", "schema": { "$ref": "#/components/schemas/apikey_regex" }, "description": "API Key to access your OpManager server.", "in": "header", "required": true }, { "name": "type", "schema": { "type": "string", "pattern": "^(Device|Interface)$" }, "description": "Type of object to retrieve additional fields for", "in": "query", "required": true } ], "tags": [ "OpManager.Downtime Scheduler" ], "x-zenesis-doc": { "show": true } } }, "/api/json/discovery/getDownDevices": { "get": { "summary": "Get Down Devices", "x-zenesis-title": "Get Down Devices", "security": [], "x-zenesis-security": {}, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Returns the list of devices that are currently down. This API does not require query parameters.", "operationId": "getDownDevices", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDownDevicesResponse" }, "examples": { "Example1": { "value": { "getDownDevices": [ { "type": "router", "displayName": "router-01" }, { "type": "switch", "displayName": "switch-02" } ] } } } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } } ], "tags": [ "OpManager.Devices" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/getAvailabilityGraphData": { "get": { "summary": "Get availability graph data for devices, interfaces, and monitors", "x-zenesis-title": "Get Availability Graph Data", "security": [], "x-zenesis-security": { "duration": "1M", "threshold": "50", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Fetches the Availability graphs for the given device, interface, or monitor. Returns uptime data and availability time-series data for graphing.", "operationId": "getAvailabilityGraphData", "responses": { "200": { "description": "Availability graph data retrieved successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AvailabilityGraphDataResponse" }, "example": { "uptimeData": { "This Week": 100, "Today": 100, "Last Week": 100, "This Month": 99.98, "Last Quarter": 100, "Yesterday": 100, "Last Month": 100, "This Year": 99.98, "Last Year": 0, "This Quarter": 99.98 }, "availabilityData": [ { "name": "Last 24 Hours", "points": [ { "x": 1661392800000, "y": 100, "color": "#1A8F47", "toolTipKey": "Aug 25, 12:00 AM" }, { "x": 1661479200000, "y": 99.5, "color": "#1A8F47", "toolTipKey": "Aug 26, 12:00 AM" } ] } ] } } } }, "400": { "description": "Invalid request parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized." }, "403": { "description": "Forbidden." }, "429": { "description": "Too many requests. Rate limit is 100 requests per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "parameters": [ { "name": "apikey", "schema": { "$ref": "#/components/schemas/apikey_regex" }, "description": "API Key to access your OpManager server.", "in": "header", "required": true }, { "name": "name", "schema": { "type": "string", "maxLength": 100 }, "description": "Name of the device or interface - Managed Entity name as seen in the URL or 'deviceName' property value from listDevices API. IMPORTANT: Do not pass the user-provided name directly. Always call listDevicesV2 first, match the user input against displayName/ipaddress/deviceName in the response, and use the matched 'deviceName' value here.", "in": "query", "required": true }, { "name": "elementID", "schema": { "type": "integer", "format": "int64" }, "description": "Unique element ID of the windows/process/service monitors associated with the device.", "in": "query", "required": false }, { "name": "isFluidic", "schema": { "type": "boolean" }, "description": "Set value as TRUE by default (for internal purpose).", "in": "query", "required": true }, { "name": "instance", "schema": { "type": "string", "enum": [ "Interface", "URL", "winService", "service", "process", "MerakiUplink", "WANLinkMonitor" ] }, "description": "Instance type for availability data. Mandatory if fetching interface data. Allows filters for specific monitor types.", "in": "query", "required": false } ], "tags": [ "OpManager.Devices" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/getCategoryList": { "get": { "summary": "Get Category List", "x-zenesis-title": "Get Category List", "security": [], "x-zenesis-security": {}, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Returns the available device category list. This API does not require query parameters.", "operationId": "getCategoryList", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCategoryListResponse" }, "examples": { "Example1": { "value": { "Routers": "Routers", "Switches": "Switches" } } } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } } ], "tags": [ "OpManager.Devices" ], "x-zenesis-doc": { "show": true } } }, "/api/json/admin/getURLSummary": { "get": { "summary": "Get URL Monitor Summary", "x-zenesis-title": "Get URL Monitor Summary", "security": [], "x-zenesis-security": {}, "description": "Retrieves comprehensive summary information for a specific URL monitor. Returns the URL monitor's full configuration (URL string, polling interval, timeout, failure threshold, content match, HTTP method, query string, cookie policy), current status, response time, availability chart data, last/next poll times, parent device association, active alarms, and snapshot layout details. Use this API when an MCP/AI agent needs to inspect the health or configuration of an individual URL monitor, check its latest response time, or display its alarm history.\nAGENT INSTRUCTION - Obtaining urlName: The required 'urlName' parameter must be obtained from the listAllURLs API. Call listAllURLs first, then use the value from the 'name' field of the matching URL monitor record as the 'urlName' value here. Do NOT call this API without first resolving the urlName via listAllURLs.\n", "operationId": "getURLSummary", "responses": { "200": { "description": "Successful response containing URL monitor summary data.", "content": { "application/json": { "schema": { "type": "object", "description": "Top-level URL summary response wrapper.", "properties": { "viewData": { "oneOf": [ { "type": "array", "items": { "type": "object" }, "description": "List of active alarm objects for the URL monitor." }, { "type": "string", "description": "\"NODATA\" when no active alarms exist.\n" } ] }, "details": { "type": "object", "description": "Full URL monitor properties including configuration, status, and timing information.\n", "properties": { "urlName": { "type": "string", "description": "URL monitor name as configured by the user." }, "displayName": { "type": "string", "description": "Human-readable display name of the URL monitor." }, "matchContent": { "type": "string", "description": "Expected content string in the response body. If set, the URL is marked down when this string is not found in the response.\n" }, "parentDispName": { "type": "string", "description": "Display name of the parent device, or \"-\" for global URLs." }, "timeout": { "type": "string", "description": "Connection timeout in seconds for each poll." }, "responseCode": { "type": "string", "description": "Last received HTTP response code (e.g., \"200\", \"404\")." }, "suppressedMessage": { "type": "string", "description": "Alarm suppression interval message (e.g., \"Suppressed until 2026-04-01 10:00\"). Present only when suppressed.\n" }, "failureThreshold": { "type": "string", "description": "Number of consecutive failures required before marking the URL as down.\n" }, "errorContent": { "type": "string", "description": "Error content string. If this string is found in the response body, the URL is marked as errored.\n" }, "managed": { "type": "string", "description": "Whether the URL monitor is currently managed (\"true\" or \"false\")." }, "smartUrl": { "type": "string", "description": "Compact/truncated version of the URL for display purposes." }, "SSLMonitorID": { "type": "string", "description": "SSL certificate monitor ID associated with this URL. Present only when SSL monitoring is enabled.\n" }, "lastPolled": { "type": "string", "description": "Formatted timestamp of the last poll." }, "method": { "type": "string", "description": "HTTP method used for monitoring \u2014 \"G\" (GET) or \"P\" (POST)." }, "isSuppressed": { "type": "boolean", "description": "Whether alarm suppression is currently active." }, "responseTime": { "type": "string", "description": "Last recorded response time in milliseconds. \"NA\" if data is not yet collected, or a localized \"not polled\" string for unmonitored URLs.\n" }, "AvailabilityImagePath": { "type": "object", "description": "Availability chart data/properties for rendering." }, "userAgent": { "type": "string", "description": "User-Agent header string sent during HTTP polling." }, "queryString": { "type": "string", "description": "Query string appended to the URL during polling." }, "url": { "type": "string", "description": "The monitored URL string (http:// or https://)." }, "acceptCookie": { "type": "string", "description": "Cookie policy \u2014 \"0\" (Accept) or \"1\" (Reject)." }, "pollInterval": { "type": "string", "description": "Polling interval in minutes." }, "parentKey": { "type": "string", "description": "Managed object name of the parent device. \"NULL\" for global (non-device-specific) URL monitors.\n" }, "nextPoll": { "type": "string", "description": "Formatted timestamp of the next scheduled poll." }, "name": { "type": "string", "description": "Internal managed-object name of the URL monitor." }, "status": { "type": "string", "description": "Numeric status code. 1=Critical, 2=Attention, 3=Trouble, 4=Service Down, 5=Clear.\n" } } }, "LastAlarm": { "type": "object", "description": "Most recent alarm object. Present only when at least one active alarm exists.\n" }, "snapDetails": { "type": "object", "description": "Snapshot tab layout details for the URL monitor snapshot page. Always present because snapType is required.\n" } } }, "examples": { "Example1": { "value": { "viewData": [ { "alarmId": "5001", "severity": "1", "message": "URL response time exceeded threshold", "modTime": "2026-03-24 10:28:00" } ], "details": { "urlName": "WebApp Health Check", "lastPolled": "Mar 24, 2026 10:30:00 AM", "method": "G", "isSuppressed": false, "displayName": "WebApp Health Check", "responseTime": "142", "matchContent": "ok", "parentDispName": "Web Server 01", "userAgent": "OpManager/12.8", "queryString": "", "url": "https://app.example.com/health", "timeout": "30", "acceptCookie": "0", "responseCode": "200", "pollInterval": "5", "parentKey": "server-web-01", "failureThreshold": "3", "errorContent": "", "managed": "true", "nextPoll": "Mar 24, 2026 10:35:00 AM", "smartUrl": "https://app.example.com/he...", "name": "WebApp_Health_Check_URL", "status": "5" }, "LastAlarm": { "alarmId": "5001", "severity": "1", "message": "URL response time exceeded threshold", "modTime": "2026-03-24 10:28:00" }, "snapDetails": { "tabs": [ { "name": "Summary" } ] } } } } } } } }, "parameters": [ { "name": "apikey", "schema": { "$ref": "#/components/schemas/apikey_regex" }, "description": "API Key to access your OpManager server.", "in": "header", "required": true }, { "name": "urlName", "schema": { "type": "string", "pattern": "^[\\w\\s\\-\\.\\(\\)]+$", "maxLength": 100 }, "description": "Display name of the URL monitor whose summary should be fetched. This is the human-readable name assigned when the URL monitor was created (not the internal managed-object name). Can be obtained from the listAllURLs API (the \"urlName\" or \"displayName\" field).\n", "in": "query", "required": true }, { "name": "snapType", "schema": { "type": "string", "enum": [ "MonitoringURL" ] }, "description": "Snapshot type identifier. Must be \"MonitoringURL\" to retrieve the URL monitor snapshot layout (tab structure and widget placement). This parameter is always required and tells the server which snapshot template to include in the response.\n", "in": "query", "required": true }, { "name": "deviceName", "schema": { "type": "string", "description": "", "maxLength": 100 }, "description": "Managed object name of the parent device for device-specific URL monitors. If omitted, the server resolves the parent device automatically from the URL monitor's association. Provide this for faster lookups, or when the URL monitor name alone is ambiguous across multiple devices.\n", "in": "query", "required": false } ], "tags": [ "OpManager.URLMonitors" ] } }, "/api/json/device/getDeviceAssociatedMonitors": { "get": { "summary": "Get Device Associated Monitors", "x-zenesis-title": "Get Device Associated Monitors", "security": [], "x-zenesis-security": { "duration": "1M", "threshold": "500", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Lists all monitors associated with the given device, including performance, server, URL, script, process, event log, and service monitor groups when applicable for the device type.\nThis API is useful when an MCP/AI agent needs a snapshot of monitor coverage and current state for a single device from the snapshot context.\n", "operationId": "getDeviceAssociatedMonitors", "responses": { "200": { "description": "Successful response containing associated monitor groups.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceAssociatedMonitorsResponse" }, "examples": { "Example1": { "value": { "performanceMonitors": { "statusIcon": "images/servicestatus5.gif", "total": 15, "down": 0, "monitors": [ { "YAXISTEXT": "%", "checkNumeric": "true", "data": [ { "value": 38, "instance": "-1" } ], "Instance": "", "THRESHOLDENABLED": "false", "GRAPHID": "205", "type": "multiple", "thresholdImg": "images/thresholdNonConfigured.gif", "suppressedMessage": "", "pollId": "3704", "Protocol": "WMI", "DISPLAYNAME": "Disk Utilization", "graphType": "multiple", "isSuppressed": "false", "policyName": "WMI-DiskUtilization", "dataType": "1", "active": "true", "thresholdStatus": "Not Enabled", "isMultiple": "true", "sSave": "true", "pollingStatus": "0", "lastCollectedTime": "25 Mar 2026 08:08:42 PM SGT", "groupName": "WMI", "DisplayColumn": "", "name": "WMI-DiskUtilization", "interval": "60", "numericType": "1", "Id": "3704" } ] }, "deviceProtocol": "WMI", "serverMonitors": { "down": 0, "total": 19, "monitors": [ { "suppressedMessage": "", "portNo": "53", "failureThreshold": 1, "isSuppressed": "false", "responseTime": "12", "statusText": "Up", "name": "DNS", "THRESHOLDENABLED": "false", "thresholdStatus": "Not Enabled", "moid": "5107", "statusNum": "5" } ] }, "ntServiceMonitors": { "statusIcon": "images/servicestatus1.gif", "total": 24, "down": 14, "monitors": [ { "suppressedMessage": "", "statusStr": "Clear", "isSuppressed": "false", "name": "Alerter", "serviceName": "Alerter", "serviceID": "2", "moid": "5139", "statusNum": "5", "status": "/images/devices/status5.gif" } ] }, "urlMonitors": { "statusIcon": "images/servicestatus5.gif", "total": 1, "down": 0, "monitors": [ { "urlName": "ZohoMail", "isSuppressed": "false", "stringstatus": "Clear", "completeURL": "https://mail.zoho.com", "deviceName": "10.5.5.1", "url": "https://mail.zoho.com", "moid": "65119", "statusNum": "5", "compactURL": "https://mail.zoho.com", "availPercentage": "84.85", "suppressedMessage": "", "name": "ZohoMail_10.5.5.1_URL", "RESPONSETIME": "444" } ] }, "processMonitors": { "statusIcon": "images/servicestatus5.gif", "total": 3, "down": 0, "monitors": [ { "isSuppressed": "false", "statusStr": "Clear", "statusIcon": "/webclient/devices/images/servicestatus5.gif", "pcpu": "13.11", "trimName": "MSSQL", "statusNum": "5", "path": "C:\\Program Files\\Microsoft SQL Server\\MSSQL\\Binn\\sqlservr.exe", "pmem": "53.28", "suppressedMessage": "", "cmdLineArgs": "", "abspmem": "8592 M", "name": "MSSQL", "id": "5151", "proName": "sqlservr.exe", "numofinstances": "4", "state": "1", "status": "5" } ] }, "showPollingStatusColumn": true, "fileMonitors": { "statusIcon": "images/servicestatus5.gif", "total": 2, "down": 0, "monitors": [ { "FileAge": "15 day(s)", "filemonitorid": "2298", "isSuppressed": "false", "statusStr": "Clear", "statusIcon": "/webclient/devices/images/servicestatus5.gif", "FileExist": true, "statusNum": 5, "suppressedMessage": "", "monitorname": "Windows MediaPlayer exe", "filepath": "C:\\Program Files\\Windows Media Player\\en-US\\wmplayer.exe.mui", "state": "1", "status": "5", "FileSize": "26.06 KB" } ] }, "eventlogMonitors": { "statusIcon": "images/servicestatus5.gif", "period": "300", "total": 50, "isActive": "false", "down": 0, "monitors": [ { "ruleName": "Any Application failure", "suppressedMessage": "", "id": "2", "isSuppressed": "false" } ] }, "isDCMEnabled": true, "folderMonitors": { "statusIcon": "images/servicestatus5.gif", "total": 2, "down": 0, "monitors": [ { "foldermonitorid": "2362", "folderpath": "Z:\\Test Folder", "FileCount": "6 Files", "isSuppressed": "false", "statusStr": "Clear", "statusIcon": "/webclient/devices/images/servicestatus5.gif", "statusNum": 5, "suppressedMessage": "", "monitorname": "Sample Folder", "FolderSize": "34.11 KB", "state": "1", "FolderExist": true, "status": "5" } ] }, "scriptMonitors": { "statusIcon": "images/servicestatus5.gif", "total": 0, "down": 0, "monitors": [] } } } } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized." }, "403": { "description": "Forbidden." }, "429": { "description": "Too many requests. Rate limit is 500 requests per minute." } }, "parameters": [ { "name": "apikey", "schema": { "$ref": "#/components/schemas/apikey_regex" }, "description": "API Key to access your OpManager server.", "in": "header", "required": true }, { "name": "name", "schema": { "type": "string", "maxLength": 100 }, "description": "Name of the device (managed entity name as seen in the URL of the device snapshot page). IMPORTANT: Do not pass the user-provided name directly. Always call listDevicesV2 first, match the user input against displayName/ipaddress/deviceName in the response, and use the matched 'deviceName' value here.\n", "in": "query", "required": true }, { "name": "isSiteView", "schema": { "type": "boolean" }, "description": "Indicates whether monitor data should be fetched grouped by site view.\n", "in": "query", "required": false } ], "tags": [ "OpManager.Devices" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/getLastCollectedValues": { "get": { "summary": "Get Last Collected Values", "x-zenesis-title": "Get Last Collected Values", "security": [], "x-zenesis-security": { "duration": "1M", "threshold": "300", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Lists the last collected values of performance, application (AD, Exchange, MSSQL), and script monitors for multiple devices.\nReturns a map keyed by device MOID where each value is an array of monitor metric objects with the latest collected data points, graph metadata, and threshold/severity context.\n", "operationId": "getLastCollectedValues", "responses": { "200": { "description": "Successful response containing last collected monitor values by MOID.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LastCollectedValuesResponse" }, "examples": { "Example1": { "value": { "1802": [ { "NumericType": 1, "ProtocolName": "WMI", "Description": "Monitors the Memory Utilization using WMI", "GraphName": "WMI-MemoryUtilization", "GraphTypeName": "multiple", "data": [ { "value": 32, "instance": "-1" } ], "GraphId": 204, "PollId": 405, "OID": "Memory Utilization", "previousSeverity": 5, "YAxisText": "%", "deviceName": "10.5.5.1", "lastCollectedTime": "23 Jan 2025 06:21:46 PM IST", "failureThreshold": 1, "PolicyName": "WMI-MemoryUtilization", "lastPolledCounterValue": 0, "DataType": "1", "failureCount": 0 } ], "1804": [ { "NumericType": 1, "ProtocolName": "WMI", "Description": "Monitors the CPU Utilization using WMI", "GraphName": "WMI-CPUUtilization", "GraphTypeName": "multiple", "data": [ { "value": 6, "instance": "-1" } ], "GraphId": 203, "PollId": 422, "OID": "CPU Utilization ProcessorInformation", "previousSeverity": 5, "YAxisText": "%", "deviceName": "server1.test.com", "lastCollectedTime": "23 Jan 2025 06:22:49 PM IST", "failureThreshold": 1, "PolicyName": "WMI-CPUUtilization", "lastPolledCounterValue": 0, "DataType": "1", "failureCount": 0 } ] } } } } } }, "400": { "description": "Invalid or missing request parameter.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized." }, "403": { "description": "Forbidden." }, "429": { "description": "Too many requests. Rate limit is 300 requests per minute." } }, "parameters": [ { "name": "apikey", "schema": { "$ref": "#/components/schemas/apikey_regex" }, "description": "API Key to access your OpManager server.", "in": "header", "required": true }, { "name": "deviceMOIDList", "schema": { "$ref": "#/components/schemas/numberWithComma_regex" }, "description": "Comma-separated device MOID values from listDevices response. It is recommended to pass up to 500 device MOIDs in one request.\n", "in": "query", "required": true } ], "tags": [ "OpManager.Devices" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/getVMWareVMs": { "get": { "summary": "List VMware VMs", "x-zenesis-title": "List VMware VMs", "security": [], "x-zenesis-security": {}, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Retrieves list of VMware Virtual Machines along with their status, device details and virtualization specific data of the given VMware parent entity. The type parameter controls the context of the parent entity.\n", "operationId": "getVMWareVMs", "responses": { "200": { "description": "Successful response containing the list of VMware VMs.", "content": { "application/json": { "schema": { "type": "array", "description": "List of VMware VM objects.", "items": { "$ref": "#/components/schemas/VMwareVMDetail" } }, "examples": { "Example1": { "value": [ { "VM_CONNECTIONSTATE": "connected", "DISPLAYNAME": "oracle-vm", "VM_ID": 609, "VIRTUAL_TYPE": "VMware-VM", "NUM_ETHERNET": 1, "VM_POWERSTATE": "On", "MAX_CPU_MHZ": 2194, "OS_NAME": "Oracle Solaris 11 (64-bit)", "NUM_VDISK": 16, "VHOST_ID": 608, "MEMORY_MB": 2560, "MOID": -4, "MAX_MEMORY_MB": 2560, "IS_ORPHANED": "false", "NUM_VCPU": 1 }, { "VM_CONNECTIONSTATE": "connected", "DISPLAYNAME": "testVM1", "STATUS_STR": "Attention", "VM_ID": 610, "VIRTUAL_TYPE": "VMware-VM", "NUM_ETHERNET": 1, "VM_POWERSTATE": "On", "MAX_CPU_MHZ": 13169, "IPADDRESS": "10.5.5.1", "OS_NAME": "Microsoft Windows Server 2016 (64-bit)", "NUM_VDISK": 1, "NAME": "testVM1.example.com", "VHOST_ID": 608, "MEMORY_MB": 24000, "STATUS": 3, "MOID": 914, "MAX_MEMORY_MB": 24000, "IS_ORPHANED": "false", "NUM_VCPU": 6 } ] } } } } } }, "parameters": [ { "name": "apikey", "schema": { "$ref": "#/components/schemas/apikey_regex" }, "description": "API Key to access your OpManager server.", "in": "header", "required": true }, { "name": "name", "schema": { "type": "string", "maxLength": 100 }, "description": "Managed object name of the VMware parent entity whose VMs should be retrieved. IMPORTANT: Do not pass the user-provided name directly. Always call listDevicesV2 first, match the user input against displayName/ipaddress/deviceName in the response, and use the matched 'deviceName' value here.\n", "in": "query", "required": true }, { "name": "type", "schema": { "type": "string", "enum": [ "VCENTER", "HOST", "DATASTORE", "VXRAIL" ] }, "description": "Type of VMware entity for listing its virtual machines.\n", "in": "query", "required": false } ], "tags": [ "OpManager.Virtualization" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/listVirtualDevices": { "get": { "summary": "List Virtual Devices", "x-zenesis-title": "List Virtual Devices", "security": [], "x-zenesis-security": {}, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Retrieves a paginated list of virtual devices along with their status, device details and virtualization specific data based on virtualDeviceType parameter discovered and monitored in OpManager. Supports filtering, sorting, and searching.\n", "operationId": "listVirtualDevices", "responses": { "200": { "description": "Successful paginated response containing the virtual device list.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VirtualDeviceListResponse" }, "examples": { "listVirtualDevices": { "summary": "List of VMware VMs", "value": { "total": 1, "page": 1, "rows": [ { "DISPLAYNAME": "WebServer-VM01", "VM_ID": 310, "statusStr": "Attention", "IPADDRESS": "10.5.5.1", "VM_POWERSTATE": "poweredOn", "MAX_CPU_MHZ": 2400, "OS_NAME": "Ubuntu 20.04 LTS", "statusNum": 3, "MEMORY_MB": 8192, "STATUS": " Attention", "HOSTNAME": "esxi-host-01", "CPU_CORES": 4, "MOID": 605, "id": 105 }, { "DISPLAYNAME": "DBServer-VM01", "VM_ID": 311, "statusStr": "Attention", "IPADDRESS": "10.5.5.1", "VM_POWERSTATE": "poweredOn", "MAX_CPU_MHZ": 3200, "OS_NAME": "CentOS 7", "statusNum": 3, "MEMORY_MB": 16384, "STATUS": " Attention", "HOSTNAME": "esxi-host-01", "CPU_CORES": 8, "MOID": 606, "id": 106 } ], "records": 2 } } } } } } }, "parameters": [ { "name": "apikey", "schema": { "$ref": "#/components/schemas/apikey_regex" }, "description": "API Key to access your OpManager server.", "in": "header", "required": true }, { "name": "virtualDeviceType", "schema": { "$ref": "#/components/schemas/virtualTypes_regex" }, "description": "Type of virtual entity to apply for listing the virtual devices. Must be one of the supported virtual entity types.\n", "in": "query", "required": true }, { "name": "page", "schema": { "$ref": "#/components/schemas/dt_page_regex" }, "description": "Page number for pagination.", "in": "query", "required": false }, { "name": "rows", "schema": { "$ref": "#/components/schemas/dt_page_regex" }, "description": "Number of rows to return per page.", "in": "query", "required": false }, { "name": "isMapView", "schema": { "type": "boolean" }, "description": "Whether the request is for a map view context.", "in": "query", "required": false }, { "name": "_search", "schema": { "type": "boolean" }, "description": "Whether a search/filter is being applied.", "in": "query", "required": false }, { "name": "nd", "schema": { "type": "integer", "format": "int64" }, "description": "Cache-busting timestamp (epoch milliseconds).", "in": "query", "required": false }, { "name": "sortByColumn", "schema": { "$ref": "#/components/schemas/listVirtualDevSortColumn_regex" }, "description": "Column name to sort the result by.\n", "in": "query", "required": false }, { "name": "sortByType", "schema": { "type": "string", "pattern": "^(asc|desc)$", "description": "" }, "description": "Sort direction \u2013 ascending or descending.", "in": "query", "required": false }, { "name": "filters", "schema": { "type": "string", "description": "Serialised JSON filter object, e.g. {\"groupOp\":\"AND\",\"rules\":[{\"field\":\"DISPLAYNAME\",\"op\":\"cn\",\"data\":\"web\"}]}\n" }, "description": "JSON object containing filter rules to narrow the virtual device list. Structure follows the virtualDevRulesTemplate format with a groupOp (AND) and a rules array, each rule specifying a field, op, and data value.\n", "in": "query", "required": false } ], "tags": [ "OpManager.Virtualization" ], "x-zenesis-doc": { "show": true } } }, "/api/json/admin/listPerformanceMonitors": { "get": { "summary": "List Performance Monitors", "x-zenesis-title": "List Performance Monitors", "security": [], "x-zenesis-security": { "duration": "1M", "threshold": "500", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Returns the list of performance monitor templates available in OpManager with monitor metadata such as protocol, identifier/OID or expression, associated device count, description, and graph id.\nOptional flags can be used to filter custom monitors and custom-field monitors.\n", "operationId": "listPerformanceMonitors", "responses": { "200": { "description": "Successful response containing performance monitor definitions.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PerformanceMonitorDefinition" } }, "examples": { "Example1": { "value": [ { "graphName": "Win-CPUUtilization", "protocol": "SNMP", "custFieldGraph": "false", "Identifier": ".1.3.6.1.2.1.25.3.3.1.2", "customGraph": "false", "associatedDeviceCount": "7", "monitorName": "CPU Utilization", "displayName": "CPU Utilization", "vendor": "-", "description": "Monitors the CPU Utilization based on HOSTRESOURCE MIB", "graphId": "35" }, { "graphName": "WMI-MemoryUtilization", "protocol": "WMI", "custFieldGraph": "false", "Identifier": "wmicpuutilzation", "customGraph": "false", "associatedDeviceCount": "7", "monitorName": "Memory Utilization", "displayName": "Memory Utilization", "vendor": "-", "description": "Monitors the Memory Utilization", "graphId": "36" }, { "graphName": "Nutanix-vmStorageUtilization", "protocol": "PrismAPI", "custFieldGraph": "false", "Identifier": "(controller_user_bytes*100)/diskCapacityInBytes", "customGraph": "false", "associatedDeviceCount": 0, "monitorName": "Storage Utilization", "displayName": "Storage Utilization", "vendor": "Nutanix", "description": "Percent of storage space currently being used by the VM.", "graphId": "5309" } ] } } } } }, "401": { "description": "Unauthorized." }, "403": { "description": "Forbidden." }, "429": { "description": "Too many requests. Rate limit is 500 requests per minute." } }, "parameters": [ { "name": "apikey", "schema": { "$ref": "#/components/schemas/apikey_regex" }, "description": "API Key to access your OpManager server.", "in": "header", "required": true }, { "name": "isCustomMonitor", "schema": { "type": "boolean" }, "description": "Filter and return only custom monitors when true.", "in": "query", "required": false }, { "name": "isCustFieldMonitor", "schema": { "type": "boolean" }, "description": "Filter and return only custom-field monitors when true.", "in": "query", "required": false } ], "tags": [ "OpManager.Monitoring" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/getNutanixVMs": { "get": { "summary": "Get Nutanix VMs", "x-zenesis-title": "Get Nutanix VMs", "security": [], "x-zenesis-security": {}, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Retrieves the list of virtual machines under the specified Nutanix cluster or host along with their status, device details and virtualization specific data.\n", "operationId": "getNutanixVMs", "responses": { "200": { "description": "Successful response containing the list of Nutanix VMs.", "content": { "application/json": { "schema": { "type": "array", "description": "List of Nutanix VM detail objects.", "items": { "$ref": "#/components/schemas/NutanixVMDetail" } }, "examples": { "ClusterVMs": { "summary": "VMs in a Nutanix cluster", "value": [ { "NUMNETWORKADAPTERS": 1, "DISPLAYNAME": "NutanixVM2", "VCPUCOUNT": 2, "VM_ID": 2002000000020102, "statusStr": "Clear", "OS": "Nutanix Virtual Machine", "DISKCAPACITY": "150", "IPADDRESS": "10.5.5.1", "VMSTATE": "Powered On", "MEMORYCAPACITY": "6", "statusNum": 5, "NAME": "NutanixVM2", "ISCONTROLLERVM": false, "SELECTIONSTATE": 1 }, { "NUMNETWORKADAPTERS": 1, "DISPLAYNAME": "NutanixVM3", "ISCONTROLLERVM": false, "VCPUCOUNT": 2, "VM_ID": 2002000000020103, "DISKCAPACITY": "150", "SELECTIONSTATE": -1, "VMSTATE": "Powered On", "MEMORYCAPACITY": "6" } ] } } } } } }, "parameters": [ { "name": "apikey", "schema": { "$ref": "#/components/schemas/apikey_regex" }, "description": "API Key to access your OpManager server.", "in": "header", "required": true }, { "name": "name", "schema": { "type": "string", "maxLength": 100 }, "description": "Managed object name of the Nutanix cluster or host whose VMs should be retrieved. IMPORTANT: Do not pass the user-provided name directly. Always call listDevicesV2 first, match the user input against displayName/ipaddress/deviceName in the response, and use the matched 'deviceName' value here.\n", "in": "query", "required": true }, { "name": "type", "schema": { "type": "string", "enum": [ "Nutanix-Cluster", "Nutanix-Host" ] }, "description": "Type of the parent Nutanix entity.\n", "in": "query", "required": true } ], "tags": [ "OpManager.Virtualization" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/getDeviceInfo": { "get": { "summary": "Get Device Metric Info", "x-zenesis-title": "Get Device Metric Info", "security": [], "x-zenesis-security": { "duration": "1M", "threshold": "60", "lock-period": "1M" }, "description": "Retrieves inventory/asset metric information for a specific device. Returns hardware-level details such as serial number, model, OS name and version, RAM size, hard disk size, MAC address, manufacturer, and service tag. The device can be identified by its managed object name, IP address, DNS name, or a combination of IP and DNS. Use this API when an MCP/AI agent needs to look up asset inventory data for a device \u2014 for example, to check the hardware model, verify the OS version, retrieve the serial number for warranty lookup, or gather MAC addresses for network mapping. At least one of deviceName, ipAddress, or dnsName must be provided.\n", "operationId": "getDeviceInfo", "responses": { "200": { "description": "Successful response containing device metric/inventory data.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceMetricsInfo" }, "examples": { "Example1": { "value": { "macAddress": "00:1A:2B:3C:4D:5E", "serialNumber": "SN-2024-ABC123", "osVersion": "10.0.17763", "serviceTag": "FGHIJK7", "model": "PowerEdge R740", "osName": "Microsoft Windows Server 2019", "ramSize": "65536", "hddSize": "1024000", "manufacturer": "Dell Inc." } } } } } }, "400": { "description": "No identifier provided or invalid parameter.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "NoParam": { "value": { "error": { "message": "Invalid parameters. Provide deviceName, ipAddress, or dnsName.", "code": 5000 } } } } } } }, "404": { "description": "Device not found with the given identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "DeviceNotFound": { "value": { "error": { "message": "Device does not exist - 10.5.5.99", "code": 5011 } } } } } } } }, "parameters": [ { "name": "apikey", "schema": { "$ref": "#/components/schemas/apikey_regex" }, "description": "API Key to access your OpManager server.", "in": "header", "required": true }, { "name": "deviceName", "schema": { "type": "string", "maxLength": 100 }, "description": "Managed object name of the device. This is the internal name used by OpManager (e.g., \"server-web-01\"). If not provided, at least ipAddress or dnsName must be given so the server can resolve the device. IMPORTANT: Do not pass the user-provided name directly. Always call listDevicesV2 first, match the user input against displayName/ipaddress/deviceName in the response, and use the matched 'deviceName' value here.\n", "in": "query", "required": false }, { "name": "ipAddress", "schema": { "type": "string", "pattern": "^((25[0-5]|2[0-4]\\d|[01]?\\d\\d?)\\.){3}(25[0-5]|2[0-4]\\d|[01]?\\d\\d?)$", "maxLength": 100 }, "description": "IP address of the device. Used to resolve the device when deviceName is not provided. Can be combined with dnsName for more precise resolution when multiple devices share the same IP or DNS name.\n", "in": "query", "required": false }, { "name": "dnsName", "schema": { "type": "string", "maxLength": 100 }, "description": "DNS name (hostname) of the device. Used to resolve the device when deviceName is not provided. Can be combined with ipAddress for more precise resolution.\n", "in": "query", "required": false } ], "tags": [ "OpManager.Devices" ] } }, "/api/json/device/getGraphData": { "get": { "summary": "Get Graph Data", "x-zenesis-title": "Get Graph Data", "security": [], "x-zenesis-security": { "duration": "1M", "threshold": "500", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Retrieves time-series graph data for a device monitor policy/index. Supports predefined periods and custom time range. Returns graph series, consolidated statistics, and display metadata for chart rendering.\nAGENT INSTRUCTION - index parameter: The 'index' parameter must always equal the 'policyName' parameter value. Do NOT use poll IDs (numeric values like 75, 139) as the index. Example: policyName=WMI-CPUUtilization, index=WMI-CPUUtilization. For URL monitors: policyName=urlResponseTime, index=urlResponseTime.\nAGENT INSTRUCTION - Epoch Timestamps in Response: The graphData points returned contain epoch millisecond timestamps as the first element of each [timestamp, value] pair. When presenting results to the user, always convert these to a human-readable local time. Use IST (UTC+5:30) unless the user specifies another timezone. PowerShell conversion: [System.DateTimeOffset]::FromUnixTimeMilliseconds($ms)\n .ToOffset([System.TimeSpan]::FromHours(5.5)).ToString(\"dd MMM yyyy hh:mm:ss tt\")\n", "operationId": "getGraphData", "responses": { "200": { "description": "Successful response containing graph series and consolidated metrics.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GraphDataResponse" }, "examples": { "Example1": { "value": { "showForecastIcon": true, "showInsightsIcon": true, "thresholds": {}, "displayName": "CPU Utilization [WMI]", "pollID": "3702", "consolidatedValues": [ { "maxVal": "98", "minVal": "1", "currVal": "52", "seriesName": "CPU0", "95thpercRawVal": "41.8974358974359", "avgVal": "45.61", "95thperc": "41.89", "95thpercVal": "41.9" }, { "maxVal": "87", "minVal": "0", "currVal": "27", "seriesName": "CPU1", "95thpercRawVal": "24.564102564102566", "avgVal": "28.5", "95thperc": "24.56", "95thpercVal": "24.56" } ], "format": "d MMM yyyy hh:mm:ss a z", "xyTitles": [ "Time", "%" ], "timeZone": "Asia/Singapore", "RMName": "WMI-CPUUtilization", "showGraphFilters": false, "graphData": [ { "data": [ [ 1774368463837, 84 ], [ 1774370263841, 77 ], [ 1774372063966, 13 ] ], "seriesname": "CPU0" }, { "data": [ [ 1774368463837, 6 ], [ 1774370263841, 13 ], [ 1774372063966, 25 ] ], "seriesname": "CPU1" } ] } } } } } }, "400": { "description": "Invalid or missing request parameter.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized." }, "403": { "description": "Forbidden." }, "429": { "description": "Too many requests. Rate limit is 500 requests per minute." } }, "parameters": [ { "name": "apikey", "schema": { "$ref": "#/components/schemas/apikey_regex" }, "description": "API Key to access your OpManager server.", "in": "header", "required": true }, { "name": "name", "schema": { "type": "string", "maxLength": 100 }, "description": "Device name (managed object name). IMPORTANT: Do not pass the user-provided name directly. Always call listDevicesV2 first, match the user input against displayName/ipaddress/deviceName in the response, and use the matched 'deviceName' value here.\n", "in": "query", "required": true }, { "name": "policyName", "schema": { "type": "string", "maxLength": 250 }, "description": "Monitor policy name (for example, WMI-CPUUtilization).", "in": "query", "required": true }, { "name": "index", "schema": { "type": "string", "maxLength": 250 }, "description": "Monitor index or data key used to fetch graph points.", "in": "query", "required": true }, { "name": "period", "schema": { "type": "string" }, "description": "Time period key. Supported values include onehour, twohours, fourhours, sixhours, twelvehours, twfourhours, Today, Last_7_Days, Last_30_Days, Last_60_Days, Last_90_Days, Yesterday, thisweek, lastweek, thismonth, Last_Month, Last_Quarter, This_Quarter, Last_3_Months, Last_6_Months, custom.\n", "in": "query", "required": false }, { "name": "instance", "schema": { "type": "string", "maxLength": 250 }, "description": "Optional monitor instance identifier.", "in": "query", "required": false }, { "name": "parentObj", "schema": { "type": "string", "maxLength": 100 }, "description": "Optional parent object for monitor types like Meraki uplink.", "in": "query", "required": false }, { "name": "withMMA", "schema": { "type": "boolean" }, "description": "Include MMA trend data when true.", "in": "query", "required": false }, { "name": "isHardwareGraph", "schema": { "type": "boolean" }, "description": "Fetch hardware graph response when true.", "in": "query", "required": false }, { "name": "parameterName", "schema": { "type": "string", "maxLength": 50 }, "description": "Hardware sensor parameter name when isHardwareGraph=true.", "in": "query", "required": false }, { "name": "startDate", "schema": { "type": "string" }, "description": "Required when period=custom. Format dd/MM/yyyy HH:mm.", "in": "query", "required": false }, { "name": "endDate", "schema": { "type": "string" }, "description": "Required when period=custom. Format dd/MM/yyyy HH:mm.", "in": "query", "required": false }, { "name": "graphFilterType", "schema": { "type": "string", "enum": [ "min", "max", "avg" ] }, "description": "Graph filter operation.", "in": "query", "required": false } ], "tags": [ "OpManager.Devices" ], "x-zenesis-doc": { "show": true } } }, "/api/json/v2/dashboard/getWidgetData": { "get": { "summary": "Get Widget Data", "x-zenesis-title": "Get Widget Data", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "Fetches the data to be loaded for a given widget ID. Use getWidgetsList to retrieve available widget IDs.", "operationId": "getWidgetData", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" }, "examples": { "Example1": { "value": { "623": { "WidgetName": "Devices by Availability", "WidgetData": [ { "displayName": "SampleDevice", "availability": "99.5%" } ], "Name": "widget.name.topnavail" } } } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "widgetID", "required": true, "description": "The widget ID for which data is to be fetched. Can be retrieved from the API: getWidgetsList.", "schema": { "type": "string", "pattern": "^[0-9]+(,[0-9]+)*$", "description": "" } }, { "in": "query", "name": "widgetName", "required": false, "description": "Name of the widget for which data needs to be fetched.", "schema": { "type": "string", "description": "" } }, { "in": "query", "name": "widgetType", "required": false, "description": "Type of the widget as defined in the widget configuration.", "schema": { "type": "string", "enum": [ "Heatmap", "DeviceTree", "Grid" ], "description": "" } } ], "tags": [ "OpManager.Dashboard" ] } }, "/api/json/discovery/addDevice": { "post": { "summary": "Add Device", "x-zenesis-title": "Add Device", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "10" }, "description": "Allows you to add individual devices to OpManager for monitoring.", "operationId": "addDevice", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" }, "examples": { "Example1": { "value": { "result": { "deviceIp": "10.10.10.1", "message": "Device added successfully", "deviceName": "10.10.10.1", "moid": 3125 } } } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "deviceName", "required": true, "description": "Name of the device to add.", "schema": { "type": "string", "description": "" } }, { "in": "query", "name": "netmask", "required": false, "description": "Subnet mask of the device network.", "schema": { "type": "string", "pattern": "^((25[0-5]|2[0-4]\\d|[01]?\\d\\d?)\\.){3}(25[0-5]|2[0-4]\\d|[01]?\\d\\d?)$", "description": "" } }, { "in": "query", "name": "networkAddress", "required": false, "description": "Network address for discovery.", "schema": { "type": "string", "description": "" } }, { "in": "query", "name": "credentialName", "required": false, "description": "Credential profile to use for discovery (SNMP, WMI, etc.).", "schema": { "type": "string", "description": "" } }, { "in": "query", "name": "addDeviceToNCM", "required": false, "description": "Adds the device to Network Configuration Manager.", "schema": { "type": "boolean", "description": "" } }, { "in": "query", "name": "addDeviceToIPAM", "required": false, "description": "Adds the device to IP Address Manager.", "schema": { "type": "boolean", "description": "" } }, { "in": "query", "name": "addType", "required": false, "description": "Type of addition.", "schema": { "type": "string", "enum": [ "addVMwareVC", "addVMwareESX", "addXen", "addHyperv", "addNutanix", "addVxRail", "addProxmox" ], "description": "" } }, { "in": "query", "name": "addDeviceType", "required": false, "description": "Specifies device category.", "schema": { "type": "string", "enum": [ "UCS" ], "description": "" } }, { "in": "query", "name": "displayName", "required": false, "description": "Display Name of the device.", "schema": { "type": "string", "description": "" } }, { "in": "query", "name": "type", "required": false, "description": "Device type.", "schema": { "type": "string", "description": "" } }, { "in": "query", "name": "isNonSNMP", "required": false, "description": "Indicates if SNMP discovery is used.", "schema": { "type": "boolean", "description": "" } }, { "in": "query", "name": "DEVICE_BEHAVIOUR", "required": false, "description": "Defines monitoring behavior or role of device.", "schema": { "type": "string", "description": "" } }, { "in": "query", "name": "SERIES", "required": false, "description": "Device series line.", "schema": { "type": "string", "description": "" } }, { "in": "query", "name": "MODEL", "required": false, "description": "Specific model name of the device.", "schema": { "type": "string", "description": "" } }, { "in": "query", "name": "newgroupname", "required": false, "description": "Name of new device group to create.", "schema": { "type": "string", "description": "" } }, { "in": "query", "name": "addGroupNameID", "required": false, "description": "ID of existing group to add the device to.", "schema": { "type": "string", "description": "" } }, { "in": "query", "name": "parentID", "required": false, "description": "ID of parent device.", "schema": { "type": "integer", "description": "" } }, { "in": "query", "name": "pollerID", "required": false, "description": "Poller ID handling the device.", "schema": { "type": "integer", "description": "" } }, { "in": "query", "name": "autoVmDiscovery", "required": false, "description": "Enables automatic discovery of VMs on the device.", "schema": { "type": "boolean", "description": "" } }, { "in": "query", "name": "availabilityNode", "required": false, "description": "Specifies the node used to track the device's availability status.", "schema": { "type": "boolean", "description": "" } } ], "tags": [ "OpManager.Discovery" ] } }, "/api/json/events/listEvents": { "get": { "summary": "List Events", "x-zenesis-title": "List Events", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "50" }, "description": "Lists all the events generated in OpManager. Supports filtering by device, severity, category, entity, and time period.", "operationId": "listEvents", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" }, "examples": { "Example1": { "value": [ { "severity": "Critical", "eventMessage": "Device is down", "source": "192.168.1.1", "eventType": "System", "entity": "Device_Poll", "timeStamp": "2022-10-26 14:30:00" } ] } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "deviceName", "required": false, "description": "Name of the device for which the events should be listed. Can be retrieved using the listDevices API.", "schema": { "type": "string", "description": "" } }, { "in": "query", "name": "entity", "required": false, "description": "Entity of the event for which the events should be listed.", "schema": { "type": "string", "description": "" } }, { "in": "query", "name": "period", "required": false, "description": "Time period for which events should be listed.", "schema": { "type": "string", "enum": [ "custom", "Today", "onehour", "twohours", "fourhours", "sixhours", "eighthours", "twelvehours", "twfourhours", "Last_7_Days", "WEEK", "Last_30_Days", "MONTH", "Last_60_Days", "Last_90_Days", "Yesterday", "thisweek", "lastweek", "thismonth", "Last_Month" ], "description": "" } }, { "in": "query", "name": "severity", "required": false, "description": "Severity of the event.", "schema": { "type": "string", "enum": [ "Attention", "Trouble", "Critical", "Info" ], "description": "" } }, { "in": "query", "name": "category", "required": false, "description": "Device category of the event.", "schema": { "$ref": "#/components/schemas/opmee_category_regex" } } ], "tags": [ "OpManager.Events" ] } }, "/api/json/events/addEvent": { "post": { "summary": "Add Event", "x-zenesis-title": "Add Event", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "50" }, "description": "Creates a new event in OpManager.", "operationId": "addEvent", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" }, "examples": { "Example1": { "value": { "result": { "message": "Event added successfully" } } } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "deviceName", "required": true, "description": "Name of the device for which the event should be created.", "schema": { "type": "string", "description": "" } }, { "in": "query", "name": "message", "required": true, "description": "Event message text.", "schema": { "type": "string", "description": "" } }, { "in": "query", "name": "severity", "required": false, "description": "Severity of the event.", "schema": { "type": "string", "enum": [ "Attention", "Trouble", "Critical", "Info" ], "description": "" } }, { "in": "query", "name": "category", "required": false, "description": "Category of the event.", "schema": { "type": "string", "description": "" } } ], "tags": [ "OpManager.Events" ] } }, "/api/json/admin/listNotificationProfiles": { "get": { "summary": "List Notification Profiles", "x-zenesis-title": "List Notification Profiles", "x-zenesis-security": { "duration": "5M", "lock-period": "5M", "threshold": "50" }, "description": "Lists all the Notification Profiles created in OpManager. Supports filtering by global/device-specific profiles and action type.", "operationId": "listNotificationProfiles", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" }, "examples": { "Example1": { "value": [ { "profileName": "Play Sound", "hasSubProfiles": false, "profileType": "Run Program", "profileLabel": "Run Program", "profileID": "1", "hasCriteria": false, "isDevice": false, "status": "true" }, { "profileName": "testProfile", "hasSubProfiles": false, "profileType": "Send Email", "profileLabel": "Send Email", "profileID": "301", "isDevice": false, "hasAssociated": true, "status": "true" } ] } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "isGlobal", "required": false, "description": "Boolean flag indicating whether to fetch only global profiles. true = global only, false = device-specific.", "schema": { "type": "boolean", "description": "" } }, { "in": "query", "name": "profileFilter", "required": false, "description": "Specifies the filter used to list profiles based on the action type.", "schema": { "type": "string", "enum": [ "All", "Send Email", "Send SMS", "Run Program", "Webhook", "Log a Ticket", "Chat", "Send Trap", "Syslog" ], "description": "" } }, { "in": "query", "name": "deviceName", "required": false, "description": "Specifies the name of the device to check which global profiles are associated with it.", "schema": { "type": "string", "description": "" } }, { "in": "query", "name": "groupName", "required": false, "description": "Specifies the name of the device group, if profiles are queried based on a specific group.", "schema": { "type": "string", "description": "" } }, { "in": "query", "name": "profileAssociationType", "required": false, "description": "Defines the type of association between profiles and devices or groups.", "schema": { "type": "string", "enum": [ "MANUAL", "BY_DEVICE_GROUP", "BY_INTERFACE_GROUP" ], "description": "" } } ], "tags": [ "OpManager.Notifications" ] } }, "/api/json/admin/associateNotificationProfiles": { "post": { "summary": "Associate Notification Profiles", "x-zenesis-title": "Associate Notification Profiles", "x-zenesis-security": { "duration": "5M", "lock-period": "5M", "threshold": "50" }, "description": "Associates notification profiles with devices or groups.", "operationId": "associateNotificationProfiles", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" }, "examples": { "Example1": { "value": { "result": { "message": "Profile associated successfully" } } } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "profileID", "required": true, "description": "ID of the notification profile to associate.", "schema": { "type": "string", "description": "" } }, { "in": "query", "name": "deviceName", "required": false, "description": "Name of the device to associate the profile with.", "schema": { "type": "string", "description": "" } }, { "in": "query", "name": "groupName", "required": false, "description": "Name of the group to associate the profile with.", "schema": { "type": "string", "description": "" } } ], "tags": [ "OpManager.Notifications" ] } }, "/api/json/admin/updateNotificationProfileStatus": { "post": { "summary": "Update Notification Profile Status", "x-zenesis-title": "Update Notification Profile Status", "x-zenesis-security": { "duration": "5M", "lock-period": "5M", "threshold": "50" }, "description": "Enables or disables a notification profile.", "operationId": "updateNotificationProfileStatus", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" }, "examples": { "Example1": { "value": { "result": { "message": "Profile status updated successfully" } } } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "profileID", "required": true, "description": "ID of the notification profile to update.", "schema": { "type": "string", "description": "" } }, { "in": "query", "name": "status", "required": true, "description": "New status of the profile.", "schema": { "type": "string", "enum": [ "true", "false" ], "description": "" } } ], "tags": [ "OpManager.Notifications" ] } }, "/api/json/admin/getNotificationProfiles": { "get": { "summary": "Get Notification Profile Details", "x-zenesis-title": "Get Notification Profile Details", "x-zenesis-security": { "duration": "5M", "lock-period": "5M", "threshold": "50" }, "description": "Retrieves detailed configuration of a specific notification profile.", "operationId": "getNotificationProfiles", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "profileID", "required": true, "description": "ID of the notification profile.", "schema": { "type": "string", "description": "" } } ], "tags": [ "OpManager.Notifications" ] } }, "/api/json/device/listSubnets": { "get": { "summary": "List Subnets", "x-zenesis-title": "List Subnets", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "300" }, "description": "Lists all the Subnets monitored in OpManager.", "operationId": "listSubnets", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" }, "examples": { "Example1": { "value": { "10.5.5.1": { "data": [ { "Status": "5", "Label": "Clear", "Count": "1" } ], "displayName": "10.5.5.1", "subnetDisplayName": "" }, "10.5.5.2": { "data": [ { "Status": "5", "Label": "Clear", "Count": "1" } ], "displayName": "10.5.5.2", "subnetDisplayName": "" } } } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } } ], "tags": [ "OpManager.Subnets" ] } }, "/api/json/workflow/getWorkflowList": { "get": { "summary": "Get Workflow List", "x-zenesis-title": "Get Workflow List", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "25" }, "description": "Lists all the workflows created in an OpManager setup.", "operationId": "getWorkflowList", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" }, "examples": { "Example1": { "value": [ { "reportID": 90, "name": "Instant Device Check", "description": "This Workflow updates the alarm notes with results of PING and NSLOOKUP when triggered from a device down alarm", "triggerdesc": "Schedule or Alarm Trigger is not configured for this Workflow", "workflowType": 0, "triggerType": 3, "rbID": 1 }, { "reportID": 90, "name": "Test WMI Credentials", "description": "Execute Windows Script", "triggerdesc": "Schedule or Alarm Trigger is not configured for this Workflow", "workflowType": 1, "triggerType": 3, "rbID": 3 } ] } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } } ], "tags": [ "OpManager.Workflow" ] } }, "/api/json/workflow/getWorkFlows": { "get": { "summary": "Get Workflow Details", "x-zenesis-title": "Get Workflow Details", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "25" }, "description": "Retrieves detailed configuration and properties of a specific workflow.", "operationId": "getWorkFlows", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "rbID", "required": true, "description": "ID of the workflow to retrieve details for.", "schema": { "type": "integer", "description": "" } } ], "tags": [ "OpManager.Workflow" ] } }, "/api/json/workflow/triggerWorkflow": { "post": { "summary": "Trigger Workflow", "x-zenesis-title": "Trigger Workflow", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "25" }, "description": "Manually triggers a workflow by its ID.", "operationId": "triggerWorkflow", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" }, "examples": { "Example1": { "value": { "result": { "message": "Workflow triggered successfully" } } } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "rbID", "required": true, "description": "ID of the workflow to trigger.", "schema": { "type": "integer", "description": "" } }, { "in": "query", "name": "deviceName", "required": false, "description": "Name of the device on which to run the workflow.", "schema": { "type": "string", "description": "" } } ], "tags": [ "OpManager.Workflow" ] } }, "/api/json/workflow/triggerWorkflowToAlarm": { "post": { "summary": "Trigger Workflow on Alarm", "x-zenesis-title": "Trigger Workflow on Alarm", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "25" }, "description": "Triggers a workflow in response to a specific alarm.", "operationId": "triggerWorkflowToAlarm", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" }, "examples": { "Example1": { "value": { "result": { "message": "Workflow triggered for alarm successfully" } } } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "rbID", "required": true, "description": "ID of the workflow to trigger.", "schema": { "type": "integer", "description": "" } }, { "in": "query", "name": "entity", "required": true, "description": "Alarm entity identifier. Obtain from listAlarms API response.", "schema": { "type": "string", "description": "" } } ], "tags": [ "OpManager.Workflow" ] } }, "/api/json/alarm/deleteAlarm": { "post": { "summary": "Delete Alarm", "x-zenesis-title": "Delete Alarm", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "100" }, "description": "Deletes a specific alarm from OpManager by its entity identifier.", "operationId": "deleteAlarm", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" }, "examples": { "Example1": { "value": { "result": { "message": "Alarm deleted successfully" } } } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "entity", "required": true, "description": "Entity identifier of the alarm to delete. Obtain from listAlarms API response.", "schema": { "$ref": "#/components/schemas/entityText_regex" } } ], "tags": [ "OpManager.Alarms" ] } }, "/api/json/alarm/ConfigureSuppressAlarm": { "post": { "summary": "Configure Suppress Alarm", "x-zenesis-title": "Configure Suppress Alarm", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "100" }, "description": "Configures alarm suppression for a specific device or entity to prevent repetitive alarm notifications.", "operationId": "ConfigureSuppressAlarm", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" }, "examples": { "Example1": { "value": { "result": { "message": "Alarm suppression configured successfully" } } } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "entity", "required": true, "description": "Entity identifier of the alarm. Obtain from listAlarms API response.", "schema": { "$ref": "#/components/schemas/entityText_regex" } }, { "in": "query", "name": "deviceName", "required": false, "description": "Name of the device.", "schema": { "type": "string", "description": "" } }, { "in": "query", "name": "suppressDuration", "required": false, "description": "Duration in minutes to suppress alarms.", "schema": { "type": "integer", "description": "" } } ], "tags": [ "OpManager.Alarms" ] } }, "/api/json/alarm/GetSuppressAlarmDetails": { "get": { "summary": "Get Suppress Alarm Details", "x-zenesis-title": "Get Suppress Alarm Details", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "100" }, "description": "Retrieves the suppression configuration details for a specific alarm.", "operationId": "GetSuppressAlarmDetails", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "entity", "required": true, "description": "Entity identifier of the alarm. Obtain from listAlarms API response.", "schema": { "$ref": "#/components/schemas/entityText_regex" } } ], "tags": [ "OpManager.Alarms" ] } }, "/api/json/admin/addDowntimeSchedule": { "post": { "summary": "Add Downtime Schedule", "x-zenesis-title": "Add Downtime Schedule", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "100" }, "description": "Creates a new downtime schedule for a device or group to suppress monitoring during planned maintenance windows.", "operationId": "addDowntimeSchedule", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" }, "examples": { "Example1": { "value": { "result": { "message": "Downtime schedule added successfully" } } } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "scheduleName", "required": true, "description": "Name of the downtime schedule.", "schema": { "$ref": "#/components/schemas/ScheduleName_regex" } }, { "in": "query", "name": "deviceName", "required": false, "description": "Name of the device for the downtime schedule.", "schema": { "type": "string", "description": "" } }, { "in": "query", "name": "groupName", "required": false, "description": "Name of the group for the downtime schedule.", "schema": { "type": "string", "description": "" } }, { "in": "query", "name": "startTime", "required": true, "description": "Start time of the downtime window. Format: yyyy-MM-dd HH:mm:ss", "schema": { "$ref": "#/components/schemas/opmee_dateWithOptionalTime_regex" } }, { "in": "query", "name": "endTime", "required": true, "description": "End time of the downtime window. Format: yyyy-MM-dd HH:mm:ss", "schema": { "$ref": "#/components/schemas/opmee_dateWithOptionalTime_regex" } }, { "in": "query", "name": "isRecurring", "required": false, "description": "Whether the schedule is recurring.", "schema": { "type": "boolean", "description": "" } } ], "tags": [ "OpManager.Downtime Scheduler" ] } }, "/api/json/admin/updateDowntimeSchedule": { "post": { "summary": "Update Downtime Schedule", "x-zenesis-title": "Update Downtime Schedule", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "100" }, "description": "Updates an existing downtime schedule configuration.", "operationId": "updateDowntimeSchedule", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" }, "examples": { "Example1": { "value": { "result": { "message": "Downtime schedule updated successfully" } } } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "scheduleID", "required": true, "description": "ID of the downtime schedule to update.", "schema": { "type": "integer", "description": "" } }, { "in": "query", "name": "scheduleName", "required": false, "description": "Updated name of the downtime schedule.", "schema": { "$ref": "#/components/schemas/ScheduleName_regex" } }, { "in": "query", "name": "startTime", "required": false, "description": "Updated start time. Format: yyyy-MM-dd HH:mm:ss", "schema": { "$ref": "#/components/schemas/opmee_dateWithOptionalTime_regex" } }, { "in": "query", "name": "endTime", "required": false, "description": "Updated end time. Format: yyyy-MM-dd HH:mm:ss", "schema": { "$ref": "#/components/schemas/opmee_dateWithOptionalTime_regex" } } ], "tags": [ "OpManager.Downtime Scheduler" ] } }, "/api/json/device/setManaged": { "post": { "summary": "Set Device Managed Status", "x-zenesis-title": "Set Device Managed Status", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "Sets the managed or unmanaged status for a device. Unmanaged devices are excluded from monitoring.", "operationId": "setManaged", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" }, "examples": { "Example1": { "value": { "result": { "message": "Device managed status updated successfully" } } } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "deviceName", "required": true, "description": "Name of the device.", "schema": { "type": "string", "description": "" } }, { "in": "query", "name": "status", "required": true, "description": "Managed status: true to manage, false to unmanage.", "schema": { "type": "boolean", "description": "" } } ], "tags": [ "OpManager.Devices" ] } }, "/api/json/device/setDeviceInfo": { "post": { "summary": "Set Device Info", "x-zenesis-title": "Set Device Info", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "Updates device properties such as display name, type, custom fields, and other metadata.", "operationId": "setDeviceInfo", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" }, "examples": { "Example1": { "value": { "result": { "message": "Device info updated successfully" } } } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "deviceName", "required": true, "description": "Name of the device to update.", "schema": { "type": "string", "description": "" } }, { "in": "query", "name": "displayName", "required": false, "description": "New display name for the device.", "schema": { "type": "string", "description": "" } }, { "in": "query", "name": "type", "required": false, "description": "Device type to set.", "schema": { "type": "string", "description": "" } }, { "in": "query", "name": "category", "required": false, "description": "Device category.", "schema": { "$ref": "#/components/schemas/opmee_category_regex" } } ], "tags": [ "OpManager.Devices" ] } }, "/api/json/device/getInfrastructureDetailsView": { "get": { "summary": "Get Infrastructure Details View", "x-zenesis-title": "Get Infrastructure Details View", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "Retrieves the infrastructure details view for a device, including hardware, software, and configuration information.", "operationId": "getInfrastructureDetailsView", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "deviceName", "required": true, "description": "Name of the device.", "schema": { "type": "string", "description": "" } } ], "tags": [ "OpManager.Devices" ] } }, "/api/json/device/getDeviceCompleteDetails": { "get": { "summary": "Get Device Complete Details", "x-zenesis-title": "Get Device Complete Details", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "Retrieves comprehensive details of a device including all monitored data, configuration, and status information.", "operationId": "getDeviceCompleteDetails", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "deviceName", "required": true, "description": "Name of the device.", "schema": { "type": "string", "description": "" } } ], "tags": [ "OpManager.Devices" ] } }, "/api/json/device/getVMWareHosts": { "get": { "summary": "Get VMware Hosts", "x-zenesis-title": "Get VMware Hosts", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "Lists all VMware ESXi hosts monitored by OpManager.", "operationId": "getVMWareHosts", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "deviceName", "required": false, "description": "Name of the vCenter device.", "schema": { "type": "string", "description": "" } } ], "tags": [ "OpManager.Virtualization" ] } }, "/api/json/device/getDataCenterDetails": { "get": { "summary": "Get Data Center Details", "x-zenesis-title": "Get Data Center Details", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "Retrieves VMware data center details for a vCenter.", "operationId": "getDataCenterDetails", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "deviceName", "required": true, "description": "Name of the vCenter device.", "schema": { "type": "string", "description": "" } } ], "tags": [ "OpManager.Virtualization" ] } }, "/api/json/device/getClusterDetails": { "get": { "summary": "Get Cluster Details", "x-zenesis-title": "Get Cluster Details", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "Retrieves cluster details for a VMware vCenter or Nutanix cluster.", "operationId": "getClusterDetails", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "deviceName", "required": true, "description": "Name of the vCenter or cluster device.", "schema": { "type": "string", "description": "" } } ], "tags": [ "OpManager.Virtualization" ] } }, "/api/json/device/getVMWareDataStores": { "get": { "summary": "Get VMware Data Stores", "x-zenesis-title": "Get VMware Data Stores", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "Lists all VMware data stores for a vCenter.", "operationId": "getVMWareDataStores", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "deviceName", "required": true, "description": "Name of the vCenter device.", "schema": { "type": "string", "description": "" } } ], "tags": [ "OpManager.Virtualization" ] } }, "/api/json/device/getNutanixVDisks": { "get": { "summary": "Get Nutanix Virtual Disks", "x-zenesis-title": "Get Nutanix Virtual Disks", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "Lists all Nutanix virtual disks.", "operationId": "getNutanixVDisks", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "deviceName", "required": true, "description": "Name of the Nutanix cluster device.", "schema": { "type": "string", "description": "" } } ], "tags": [ "OpManager.Virtualization" ] } }, "/api/json/device/getNutanixDetails": { "get": { "summary": "Get Nutanix Details", "x-zenesis-title": "Get Nutanix Details", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "Retrieves detailed information about a Nutanix cluster.", "operationId": "getNutanixDetails", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "deviceName", "required": true, "description": "Name of the Nutanix device.", "schema": { "type": "string", "description": "" } } ], "tags": [ "OpManager.Virtualization" ] } }, "/api/json/device/addVxRailTovCenter": { "post": { "summary": "Add VxRail to vCenter", "x-zenesis-title": "Add VxRail to vCenter", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "Associates a VxRail device with a vCenter for unified monitoring.", "operationId": "addVxRailTovCenter", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" }, "examples": { "Example1": { "value": { "result": { "message": "VxRail added to vCenter successfully" } } } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "deviceName", "required": true, "description": "Name of the VxRail device.", "schema": { "type": "string", "description": "" } }, { "in": "query", "name": "vCenterName", "required": true, "description": "Name of the target vCenter device.", "schema": { "type": "string", "description": "" } } ], "tags": [ "OpManager.Virtualization" ] } }, "/api/json/device/EditPerformanceMonitor": { "post": { "summary": "Edit Performance Monitor", "x-zenesis-title": "Edit Performance Monitor", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "Edits the configuration of an existing performance monitor associated with a device.", "operationId": "EditPerformanceMonitor", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" }, "examples": { "Example1": { "value": { "result": { "message": "Performance monitor updated successfully" } } } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "deviceName", "required": true, "description": "Name of the device.", "schema": { "type": "string", "description": "" } }, { "in": "query", "name": "monitorName", "required": true, "description": "Name of the performance monitor to edit.", "schema": { "type": "string", "description": "" } }, { "in": "query", "name": "interval", "required": false, "description": "Polling interval in minutes.", "schema": { "type": "integer", "description": "" } } ], "tags": [ "OpManager.Monitoring" ] } }, "/api/json/device/getDeviceAssociatedProcessMonitors": { "get": { "summary": "Get Device Associated Process Monitors", "x-zenesis-title": "Get Device Associated Process Monitors", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "Lists all process monitors associated with a specific device.", "operationId": "getDeviceAssociatedProcessMonitors", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "deviceName", "required": true, "description": "Name of the device.", "schema": { "type": "string", "description": "" } } ], "tags": [ "OpManager.Devices" ] } }, "/api/json/device/getDeviceAssociatedServiceMonitors": { "get": { "summary": "Get Device Associated Service Monitors", "x-zenesis-title": "Get Device Associated Service Monitors", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "Lists all service monitors associated with a specific device.", "operationId": "getDeviceAssociatedServiceMonitors", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "deviceName", "required": true, "description": "Name of the device.", "schema": { "type": "string", "description": "" } } ], "tags": [ "OpManager.Devices" ] } }, "/api/json/device/getGraphNames": { "get": { "summary": "Get Graph Names", "x-zenesis-title": "Get Graph Names", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "Retrieves the list of available graph names for a device's performance monitors.", "operationId": "getGraphNames", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "deviceName", "required": true, "description": "Name of the device.", "schema": { "type": "string", "description": "" } } ], "tags": [ "OpManager.Devices" ] } }, "/api/json/device/getNutanixDisks": { "get": { "summary": "Get Nutanix Disks", "x-zenesis-title": "Get Nutanix Disks", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "Lists physical disks in a Nutanix cluster.", "operationId": "getNutanixDisks", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "deviceName", "required": true, "description": "Name of the Nutanix device.", "schema": { "type": "string", "description": "" } } ], "tags": [ "OpManager.Virtualization" ] } }, "/api/json/device/getNutanixHosts": { "get": { "summary": "Get Nutanix Hosts", "x-zenesis-title": "Get Nutanix Hosts", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "Lists all hosts in a Nutanix cluster.", "operationId": "getNutanixHosts", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "deviceName", "required": true, "description": "Name of the Nutanix cluster device.", "schema": { "type": "string", "description": "" } } ], "tags": [ "OpManager.Virtualization" ] } }, "/api/json/device/getNutanixOrphanedVMs": { "get": { "summary": "Get Nutanix Orphaned VMs", "x-zenesis-title": "Get Nutanix Orphaned VMs", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "Lists orphaned virtual machines in a Nutanix cluster.", "operationId": "getNutanixOrphanedVMs", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "deviceName", "required": true, "description": "Name of the Nutanix cluster device.", "schema": { "type": "string", "description": "" } } ], "tags": [ "OpManager.Virtualization" ] } }, "/api/json/device/getNutanixStorageContainers": { "get": { "summary": "Get Nutanix Storage Containers", "x-zenesis-title": "Get Nutanix Storage Containers", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "Lists storage containers in a Nutanix cluster.", "operationId": "getNutanixStorageContainers", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "deviceName", "required": true, "description": "Name of the Nutanix cluster device.", "schema": { "type": "string", "description": "" } } ], "tags": [ "OpManager.Virtualization" ] } }, "/api/json/device/getNutanixStoragePools": { "get": { "summary": "Get Nutanix Storage Pools", "x-zenesis-title": "Get Nutanix Storage Pools", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "Lists storage pools in a Nutanix cluster.", "operationId": "getNutanixStoragePools", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "deviceName", "required": true, "description": "Name of the Nutanix cluster device.", "schema": { "type": "string", "description": "" } } ], "tags": [ "OpManager.Virtualization" ] } }, "/api/json/device/getNutanixVGroups": { "get": { "summary": "Get Nutanix Volume Groups", "x-zenesis-title": "Get Nutanix Volume Groups", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "Lists volume groups in a Nutanix cluster.", "operationId": "getNutanixVGroups", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "deviceName", "required": true, "description": "Name of the Nutanix cluster device.", "schema": { "type": "string", "description": "" } } ], "tags": [ "OpManager.Virtualization" ] } }, "/api/json/device/listApplicationServices": { "get": { "summary": "List Application Services", "x-zenesis-title": "List Application Services", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "Lists all application services monitored on a device.", "operationId": "listApplicationServices", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "deviceName", "required": true, "description": "Name of the device.", "schema": { "type": "string", "description": "" } } ], "tags": [ "OpManager.Devices" ] } }, "/api/json/device/mapEntity": { "post": { "summary": "Map Entity", "x-zenesis-title": "Map Entity", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "Maps a monitoring entity to a device.", "operationId": "mapEntity", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" }, "examples": { "Example1": { "value": { "result": { "message": "Entity mapped successfully" } } } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "deviceName", "required": true, "description": "Name of the device.", "schema": { "type": "string", "description": "" } }, { "in": "query", "name": "entity", "required": true, "description": "Entity identifier to map.", "schema": { "type": "string", "description": "" } } ], "tags": [ "OpManager.Devices" ] } }, "/api/json/device/suppressVSANDiskAlarm": { "post": { "summary": "Suppress VSAN Disk Alarm", "x-zenesis-title": "Suppress VSAN Disk Alarm", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "Suppresses alarms for a specific VSAN disk.", "operationId": "suppressVSANDiskAlarm", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" }, "examples": { "Example1": { "value": { "result": { "message": "VSAN disk alarm suppressed successfully" } } } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "deviceName", "required": true, "description": "Name of the device.", "schema": { "type": "string", "description": "" } }, { "in": "query", "name": "entity", "required": true, "description": "Entity identifier of the VSAN disk.", "schema": { "type": "string", "description": "" } } ], "tags": [ "OpManager.Devices" ] } }, "/api/json/device/unMapEntity": { "post": { "summary": "Unmap Entity", "x-zenesis-title": "Unmap Entity", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "Unmaps a monitoring entity from a device.", "operationId": "unMapEntity", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" }, "examples": { "Example1": { "value": { "result": { "message": "Entity unmapped successfully" } } } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "deviceName", "required": true, "description": "Name of the device.", "schema": { "type": "string", "description": "" } }, { "in": "query", "name": "entity", "required": true, "description": "Entity identifier to unmap.", "schema": { "type": "string", "description": "" } } ], "tags": [ "OpManager.Devices" ] } }, "/api/json/admin/getLogicalGroupAlerts": { "get": { "summary": "Get Group Alerts", "x-zenesis-title": "Get Group Alerts", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "100" }, "description": "Retrieves alerts for a specific logical group.", "operationId": "getLogicalGroupAlerts", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "groupName", "required": true, "description": "Name of the logical group.", "schema": { "type": "string", "description": "" } } ], "tags": [ "OpManager.Groups" ] } }, "/api/json/admin/addToGroup": { "post": { "summary": "Add to Group", "x-zenesis-title": "Add to Group", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "100" }, "description": "Adds devices or interfaces to an existing logical group.", "operationId": "addToGroup", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" }, "examples": { "Example1": { "value": { "result": { "message": "Added to group successfully" } } } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "groupName", "required": true, "description": "Name of the logical group.", "schema": { "type": "string", "description": "" } }, { "in": "query", "name": "deviceName", "required": false, "description": "Name of the device to add to the group.", "schema": { "type": "string", "description": "" } }, { "in": "query", "name": "interfaceName", "required": false, "description": "Name of the interface to add to the group.", "schema": { "type": "string", "description": "" } } ], "tags": [ "OpManager.Groups" ] } }, "/api/json/device/listInterfaces": { "get": { "summary": "List Interfaces", "x-zenesis-title": "List Interfaces", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "Lists all the interfaces monitored in OpManager. Supports filtering, pagination, and sorting.", "operationId": "listInterfaces", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" }, "examples": { "Example1": { "value": { "total": "2", "records": "2", "page": "1", "rows": [ { "interfaceDisplayName": "Switch loopback interface-lo0", "isSuppressed": false, "statusStr": "Trouble", "displayName": "10.5.5.1", "ipAddress": "", "outSpeed": "0 bps", "inSpeed": "0 bps", "type": "Software Loopback", "deviceName": "10.5.5.1", "interfaceStatus": 2, "statusNum": 2, "adminStatus": "Up", "operStatus": "Up", "id": "494", "interfaceName": "IF-10.5.5.1-494" } ] } } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "page", "required": false, "description": "Page number for pagination. Use with 'rows' parameter.", "schema": { "type": "integer", "description": "" } }, { "in": "query", "name": "rows", "required": true, "description": "Number of records per page. Use with 'page' parameter.", "schema": { "type": "integer", "description": "" } }, { "in": "query", "name": "sortByType", "required": false, "description": "Sort order.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "description": "" } }, { "in": "query", "name": "sortByColumn", "required": false, "description": "Column name to sort by.", "schema": { "type": "string", "enum": [ "statusNum", "interfaceDisplayName", "displayName", "adminStatus", "operStatus", "ipAddress", "type", "inSpeed", "outSpeed", "inTraffic", "outTraffic", "isSuppressed", "probeName" ], "description": "" } }, { "in": "query", "name": "isFluidic", "required": false, "description": "Set value as 'true' by default (for internal purpose).", "schema": { "type": "boolean", "description": "" } }, { "in": "query", "name": "classification", "required": false, "description": "Classification of Device.", "schema": { "type": "string", "enum": [ "Network", "Router", "Switch", "Printer", "Server", "PhysicalServer", "Windows", "Linux", "MSSQL", "Exchange", "DomainController", "Wireless", "Firewall", "IPMI", "MonitoringAgent" ], "description": "" } }, { "in": "query", "name": "severity", "required": false, "description": "Filter interfaces by severity.", "schema": { "$ref": "#/components/schemas/numberWithComma_regex" } }, { "in": "query", "name": "type", "required": false, "description": "Filter interface by interface type.", "schema": { "type": "string", "description": "" } }, { "in": "query", "name": "isIdleInterface", "required": false, "description": "Filters only idle or inactive interfaces.", "schema": { "type": "boolean", "description": "" } }, { "in": "query", "name": "intfProps", "required": false, "description": "Fetch additional interface properties (ifName, moid, physAddress).", "schema": { "type": "boolean", "description": "" } }, { "in": "query", "name": "intfGroupID", "required": false, "description": "Filters interfaces belonging to a specific interface group.", "schema": { "type": "integer", "description": "" } }, { "in": "query", "name": "customFields", "required": false, "description": "Filter by custom fields.", "schema": { "type": "string", "description": "" } } ], "tags": [ "OpManager.Interfaces" ] } }, "/api/json/device/getIntfAtAGlanceReportDetails": { "get": { "summary": "Get Interface At-a-Glance Report", "x-zenesis-title": "Get Interface At-a-Glance Report", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "Retrieves the at-a-glance report for a specific interface, including traffic, speed, and status details.", "operationId": "getIntfAtAGlanceReportDetails", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "interfaceName", "required": true, "description": "Name of the interface.", "schema": { "type": "string", "description": "" } }, { "in": "query", "name": "period", "required": false, "description": "Time period for the report.", "schema": { "$ref": "#/components/schemas/timePeriod_regex" } } ], "tags": [ "OpManager.Interfaces" ] } }, "/api/json/device/getIntfBWOutageReportDetails": { "get": { "summary": "Get Interface Bandwidth Outage Report", "x-zenesis-title": "Get Interface Bandwidth Outage Report", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "Retrieves the bandwidth outage report for a specific interface.", "operationId": "getIntfBWOutageReportDetails", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "interfaceName", "required": true, "description": "Name of the interface.", "schema": { "type": "string", "description": "" } }, { "in": "query", "name": "period", "required": false, "description": "Time period for the report.", "schema": { "$ref": "#/components/schemas/timePeriod_regex" } } ], "tags": [ "OpManager.Interfaces" ] } }, "/api/json/device/getInterfaceGraphs": { "get": { "summary": "Get Interface Graphs", "x-zenesis-title": "Get Interface Graphs", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "Retrieves graph data for a specific interface.", "operationId": "getInterfaceGraphs", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "interfaceName", "required": true, "description": "Name of the interface.", "schema": { "type": "string", "description": "" } }, { "in": "query", "name": "period", "required": false, "description": "Time period for the graph.", "schema": { "$ref": "#/components/schemas/timePeriod_regex" } } ], "tags": [ "OpManager.Interfaces" ] } }, "/api/json/device/getPerformanceMonitors": { "get": { "summary": "Get Performance Monitors", "x-zenesis-title": "Get Performance Monitors", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "Retrieves performance monitors associated with a specific device.", "operationId": "getPerformanceMonitors", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "deviceName", "required": true, "description": "Name of the device.", "schema": { "type": "string", "description": "" } } ], "tags": [ "OpManager.Monitoring" ] } }, "/api/json/admin/getPerformanceMonitorDetails": { "get": { "summary": "Get Performance Monitor Details", "x-zenesis-title": "Get Performance Monitor Details", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "Retrieves detailed configuration and properties of a specific performance monitor.", "operationId": "getPerformanceMonitorDetails", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "monitorName", "required": true, "description": "Name of the performance monitor.", "schema": { "type": "string", "description": "" } } ], "tags": [ "OpManager.Monitoring" ] } }, "/api/json/admin/addPerformanceMonitors": { "post": { "summary": "Add Performance Monitors", "x-zenesis-title": "Add Performance Monitors", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "Associates performance monitors with a device.", "operationId": "addPerformanceMonitors", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" }, "examples": { "Example1": { "value": { "result": { "message": "Performance monitors added successfully" } } } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "deviceName", "required": true, "description": "Name of the device.", "schema": { "type": "string", "description": "" } }, { "in": "query", "name": "monitorName", "required": true, "description": "Name of the performance monitor to associate.", "schema": { "type": "string", "description": "" } } ], "tags": [ "OpManager.Monitoring" ] } }, "/api/json/admin/deletePerformanceMonitors": { "post": { "summary": "Delete Performance Monitors", "x-zenesis-title": "Delete Performance Monitors", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "Removes performance monitors from a device.", "operationId": "deletePerformanceMonitors", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" }, "examples": { "Example1": { "value": { "result": { "message": "Performance monitors deleted successfully" } } } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "deviceName", "required": true, "description": "Name of the device.", "schema": { "type": "string", "description": "" } }, { "in": "query", "name": "monitorName", "required": true, "description": "Name of the performance monitor to remove.", "schema": { "type": "string", "description": "" } } ], "tags": [ "OpManager.Monitoring" ] } }, "/api/json/device/TestMonitor": { "post": { "summary": "Test Monitor", "x-zenesis-title": "Test Monitor", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "Tests a performance monitor by executing a single poll against the target device.", "operationId": "TestMonitor", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "deviceName", "required": true, "description": "Name of the device.", "schema": { "type": "string", "description": "" } }, { "in": "query", "name": "monitorName", "required": true, "description": "Name of the performance monitor to test.", "schema": { "type": "string", "description": "" } } ], "tags": [ "OpManager.Monitoring" ] } }, "/api/json/device/getAssociatedProcessMonitors": { "get": { "summary": "Get Associated Process Monitors", "x-zenesis-title": "Get Associated Process Monitors", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "Lists all process monitors associated with a device.", "operationId": "getAssociatedProcessMonitors", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "deviceName", "required": true, "description": "Name of the device.", "schema": { "type": "string", "description": "" } } ], "tags": [ "OpManager.Monitoring" ] } }, "/api/json/device/associateProcessMonitor": { "post": { "summary": "Associate Process Monitor", "x-zenesis-title": "Associate Process Monitor", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "Associates a process monitor with a device for monitoring specific processes.", "operationId": "associateProcessMonitor", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" }, "examples": { "Example1": { "value": { "result": { "message": "Process monitor associated successfully" } } } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "deviceName", "required": true, "description": "Name of the device.", "schema": { "type": "string", "description": "" } }, { "in": "query", "name": "processName", "required": true, "description": "Name of the process to monitor.", "schema": { "type": "string", "description": "" } } ], "tags": [ "OpManager.Monitoring" ] } }, "/api/json/device/getAssociatedServiceMonitors": { "get": { "summary": "Get Associated Service Monitors", "x-zenesis-title": "Get Associated Service Monitors", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "Lists all Windows service monitors associated with a device.", "operationId": "getAssociatedServiceMonitors", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "deviceName", "required": true, "description": "Name of the device.", "schema": { "type": "string", "description": "" } } ], "tags": [ "OpManager.Monitoring" ] } }, "/api/json/device/associateServiceMonitor": { "post": { "summary": "Associate Service Monitor", "x-zenesis-title": "Associate Service Monitor", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "Associates a Windows service monitor with a device.", "operationId": "associateServiceMonitor", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" }, "examples": { "Example1": { "value": { "result": { "message": "Service monitor associated successfully" } } } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "deviceName", "required": true, "description": "Name of the device.", "schema": { "type": "string", "description": "" } }, { "in": "query", "name": "serviceName", "required": true, "description": "Name of the Windows service to monitor.", "schema": { "type": "string", "description": "" } } ], "tags": [ "OpManager.Monitoring" ] } }, "/api/json/device/getDeviceAssociatedWindowsServiceMonitors": { "get": { "summary": "Get Device Associated Windows Service Monitors", "x-zenesis-title": "Get Device Associated Windows Service Monitors", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "Lists all Windows service monitors associated with a device, including their status.", "operationId": "getDeviceAssociatedWindowsServiceMonitors", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "deviceName", "required": true, "description": "Name of the device.", "schema": { "type": "string", "description": "" } } ], "tags": [ "OpManager.Monitoring" ] } }, "/api/json/admin/listURLMonitors": { "get": { "summary": "List URL Monitors", "x-zenesis-title": "List URL Monitors", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "Lists all URL monitors configured in OpManager.", "operationId": "listURLMonitors", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "deviceName", "required": false, "description": "Filter URL monitors by device name.", "schema": { "type": "string", "description": "" } } ], "tags": [ "OpManager.Monitoring" ] } }, "/api/json/admin/listAllDevicesSpecificURLs": { "get": { "summary": "List All Devices Specific URLs", "x-zenesis-title": "List All Devices Specific URLs", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "Lists URL monitors specific to all devices.", "operationId": "listAllDevicesSpecificURLs", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } } ], "tags": [ "OpManager.Monitoring" ] } }, "/api/json/device/listScriptMonitors": { "get": { "summary": "List Script Monitors", "x-zenesis-title": "List Script Monitors", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "Lists all script monitors associated with a device.", "operationId": "listScriptMonitors", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "deviceName", "required": true, "description": "Name of the device.", "schema": { "type": "string", "description": "" } } ], "tags": [ "OpManager.Monitoring" ] } }, "/api/json/v2/pathanalysis/getAvailabilityGraph": { "get": { "summary": "Get Availability Graph", "x-zenesis-title": "Get Availability Graph", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "50" }, "description": "Retrieves the availability graph of a network path.", "operationId": "getAvailabilityGraph", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" }, "examples": { "Example1": { "value": { "availability": [ "UP,1760877460629,1760963860629,Up" ] } } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "moID", "required": true, "description": "MOID of the Network path.", "schema": { "type": "integer", "description": "" } }, { "in": "query", "name": "period", "required": true, "description": "Time range for the availability graph data.", "schema": { "type": "string", "enum": [ "customDate", "customTime", "Today", "Last 24 hours", "Yesterday" ], "description": "" } }, { "in": "query", "name": "date", "required": false, "description": "Specific date for graph data. Format: yyyy-MM-dd", "schema": { "$ref": "#/components/schemas/date_regex" } } ], "tags": [ "OpManager.NetworkPath" ] } }, "/api/json/v2/pathanalysis/getLatencyPacketLossGraph": { "get": { "summary": "Get Latency and Packet Loss Graph", "x-zenesis-title": "Get Latency and Packet Loss Graph", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "50" }, "description": "Retrieves latency and packet loss graph data for a network path.", "operationId": "getLatencyPacketLossGraph", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "moID", "required": true, "description": "MOID of the Network path.", "schema": { "type": "integer", "description": "" } }, { "in": "query", "name": "period", "required": true, "description": "Time range for the graph data.", "schema": { "type": "string", "enum": [ "customDate", "customTime", "Today", "Last 24 hours", "Yesterday" ], "description": "" } }, { "in": "query", "name": "date", "required": false, "description": "Specific date for graph data. Format: yyyy-MM-dd", "schema": { "$ref": "#/components/schemas/date_regex" } } ], "tags": [ "OpManager.NetworkPath" ] } }, "/api/json/reports/getAdvancedReportData": { "get": { "summary": "Get Advanced Report Data", "x-zenesis-title": "Get Advanced Report Data", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "60" }, "description": "Fetches advanced report data using lazy loading. First call with getColumnDetails=true returns metadata (row count, headers). Subsequent calls fetch data in batches up to 1000 rows per call.", "operationId": "getAdvancedReportData", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" }, "examples": { "Example1": { "value": { "rows": [ { "Status": "Clear", "Availability (%)": "100", "name": "Desktop-3", "Device Name": "Desktop-3", "moid": 67802 }, { "Status": "Clear", "Availability (%)": "85.574", "name": "Desktop-2", "Device Name": "Desktop-2", "moid": 69039 } ] } } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "reportId", "required": true, "description": "Unique report ID. Can be fetched from listAllAdvancedReports API.", "schema": { "type": "integer", "description": "" } }, { "in": "query", "name": "getColumnDetails", "required": true, "description": "If true, returns report metadata. If false, returns report data based on fetchFromRowNumber and rowsToFetch.", "schema": { "type": "boolean", "description": "" } }, { "in": "query", "name": "rowsToFetch", "required": false, "description": "Number of rows to fetch. Range: 1-1000. Required if getColumnDetails is false.", "schema": { "type": "integer", "description": "" } }, { "in": "query", "name": "fetchFromRowNumber", "required": false, "description": "Starting row number to fetch data from. Required if getColumnDetails is false.", "schema": { "type": "integer", "description": "" } }, { "in": "query", "name": "reportRequestId", "required": false, "description": "If returned in the first API call response, use it for subsequent calls for the same report.", "schema": { "type": "integer", "description": "" } } ], "tags": [ "OpManager.Reports" ] } }, "/api/json/reports/listAllAdvancedReports": { "get": { "summary": "List All Advanced Reports", "x-zenesis-title": "List All Advanced Reports", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "60" }, "description": "Lists all advanced reports available in OpManager. Use the reportId from the response to fetch report data via getAdvancedReportData.", "operationId": "listAllAdvancedReports", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } } ], "tags": [ "OpManager.Reports" ] } }, "/api/json/v2/wireless/getSSIDClientList": { "get": { "summary": "Get SSID Client List", "x-zenesis-title": "Get SSID Client List", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "40" }, "description": "Lists all clients connected to a specific SSID on a Wireless LAN Controller.", "operationId": "getSSIDClientList", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "deviceName", "required": true, "description": "Name of the WLC device.", "schema": { "type": "string", "description": "" } }, { "in": "query", "name": "ssidName", "required": true, "description": "Name of the SSID.", "schema": { "type": "string", "description": "" } } ], "tags": [ "OpManager.Wireless" ] } }, "/api/json/v2/wireless/getClientDetails": { "get": { "summary": "Get Wireless Client Details", "x-zenesis-title": "Get Wireless Client Details", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "40" }, "description": "Retrieves detailed information about a specific wireless client.", "operationId": "getClientDetails", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } }, { "in": "query", "name": "deviceName", "required": true, "description": "Name of the WLC device.", "schema": { "type": "string", "description": "" } }, { "in": "query", "name": "clientMac", "required": true, "description": "MAC address of the wireless client.", "schema": { "type": "string", "description": "" } } ], "tags": [ "OpManager.Wireless" ] } }, "/api/json/v2/dashboard/getWidgetsList": { "get": { "summary": "Get Widgets List", "x-zenesis-title": "Get Widgets List", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "Lists all the available dashboard widgets configured in OpManager.", "operationId": "getWidgetsList", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "" }, "examples": { "Example1": { "value": [ { "widgetID": "495", "widgetName": "Devices by Availability", "widgetType": "Grid" }, { "widgetID": "496", "widgetName": "Top CPU Utilization", "widgetType": "Grid" } ] } } } } } }, "parameters": [ { "in": "header", "name": "apikey", "required": true, "description": "API Key to access your OpManager server.", "schema": { "$ref": "#/components/schemas/apikey_regex" } } ], "tags": [ "OpManager.Dashboard" ] } } }, "components": { "schemas": { "DateTime_WithoutSeconds_regex": { "pattern": "(([0-9]{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1]) ([01][0-9]|2[0-3]):([0-5][0-9]))", "description": "", "type": "string" }, "onlyNumber_regex": { "type": "string", "pattern": "^[?:0-9]+$", "description": "Only numeric digits are allowed." }, "NFA_Collector_ID_regex": { "pattern": "^(-1|[0-9]|[1-9][0-9]{1,2}|1[0-9]{3}|2000)$", "description": "", "type": "string" }, "alphanumeric_regex": { "description": "", "type": "string" }, "dateFormat_regex": { "pattern": "^([0][1-9]|[1|2]\\d|[3][0|1])\\/([0][1-9]|[1][0-2])\\/\\d{4}\\s([0-1]\\d|[2][0-3])\\:[0-5]\\d$", "description": "", "type": "string" }, "SMR_SeriesType_regex": { "pattern": "^(MIN|MAX|AVG)$", "description": "", "type": "string" }, "NFAPort_regex": { "type": "string" }, "SMR_TableView_regex": { "pattern": "^(instance|monitor|monitors|interface)$", "description": "", "type": "string" }, "NFA_Router_Cloud_ID_Minus1_regex": { "pattern": "^(-1|([0-9]*))$", "description": "Router, WLC Controller ID and AWS Region ID", "type": "string" }, "WLC_Report_Criteria": { "description": "", "type": "object", "properties": { "IPHost": { "description": "", "$ref": "#/components/schemas/NFA_IP_V4_V6_Address_regex" }, "IPHostNet": { "description": "", "$ref": "#/components/schemas/NFA_Criteria_Network" }, "Host": { "description": "", "$ref": "#/components/schemas/NFA_MAC_Address_regex" }, "NBARApplication": { "description": "", "$ref": "#/components/schemas/NFA_NBAR_App_Name_regex" }, "DSCPIn": { "description": "", "$ref": "#/components/schemas/NFA_DSCP_Name_regex" }, "IPHostNodes": { "description": "", "$ref": "#/components/schemas/NFA_Criteria_Nodes" }, "SSID": { "description": "", "$ref": "#/components/schemas/NFA_SSID_Name_regex" }, "DSCPOut": { "description": "", "$ref": "#/components/schemas/NFA_DSCP_Name_regex" } } }, "numberWithComma_regex": { "type": "string", "pattern": "^[0-9]+(,[0-9]+)*$", "description": "Comma-separated numeric values (for example, 1802,1804)." }, "NFASearchWithSpecialChar_regex": { "description": "Pattern to match all serach values", "type": "string" }, "opmee_category_regex": { "description": "", "type": "string" }, "NFA_Source_ID_Minus1_Array": { "description": "", "type": "array", "items": { "description": "", "$ref": "#/components/schemas/NFA_Source_ID_Minus1_regex" } }, "text_basic_symbols_two_byte_support_regex": { "description": "", "type": "string" }, "probeNameRegex_regex": { "type": "string", "description": "Device or probe name consisting of letters, numbers, underscores, and spaces." }, "NFA_NBAR_App_Name_regex": { "description": "", "type": "string" }, "listVirtualDevSortColumn_regex": { "type": "string", "description": "Column names by which the virtual device list can be sorted.\n" }, "opmee_reportIdWithAudit_regex": { "description": "", "type": "string" }, "NFA_IP_V4_V6_Address_regex": { "pattern": "^(?:(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])))$", "description": "", "type": "string" }, "virtualTypes_regex": { "type": "string", "pattern": "^(VHOST|VDATASTORE|VM|VCENTER|VxRail|HyperV-Host|HyperV-VM|HyperV-Disk|Xen-Host|Xen-VM|Xen-SR|Xen-Pool|Nutanix-Cluster|Nutanix-Host|Nutanix-VM|VMware-Parent|Proxmox-Node|Proxmox-VM|Proxmox-Container|Proxmox-Cluster)$", "description": "Virtual entity types supported across all hypervisors in OpManager." }, "NFAProtocolName_regex": { "pattern": "^[-/._A-Za-z0-9]+$", "type": "string" }, "NFA_SSID_Name_regex": { "pattern": "^[^\"?$\\[\\]\\\\+]+$", "description": "", "type": "string" }, "NFALogic_regex": { "pattern": "^(?:AND|OR)$", "description": "", "type": "string" }, "NFA_DSCP_Name_regex": { "description": "", "type": "string" }, "NFA_Criteria_Nodes": { "description": "", "type": "array", "items": { "anyOf": [ { "type": "boolean" }, { "type": "integer" }, { "type": "number" }, { "type": "string" } ] } }, "defaultRepViewAs_regex": { "pattern": "^(PDF|XLS|DOCX|json|EMAIL)$", "description": "", "type": "string" }, "advancedFilterJson": { "description": "To list device based on the selected device group and selected device types.sample param value: {\"NFADevices_Group\":[4],\"NFADevices_Type\":[\"NSEL\"]}", "type": "object", "properties": { "NFADevices_Type": { "description": "", "$ref": "#/components/schemas/strJsonArr" }, "NFA_Attacks_State": { "description": "", "$ref": "#/components/schemas/strJsonArr" }, "NFA_Wlc": { "description": "", "$ref": "#/components/schemas/strJsonArr" }, "nfaQosInterfaces": { "description": "", "$ref": "#/components/schemas/strJsonArr" }, "DeviceID": { "description": "", "$ref": "#/components/schemas/numberJson" }, "nfaQosDevices": { "description": "", "$ref": "#/components/schemas/numberJson" }, "DPIList": { "description": "", "$ref": "#/components/schemas/JsonStringWithSpecialChar" }, "NFA_FlowFiltered_Intf": { "description": "", "$ref": "#/components/schemas/NFA_FlowFilter_ID" }, "NFA_Intf_Type": { "description": "", "$ref": "#/components/schemas/strJsonArrWithColon" }, "NFADevices_Group": { "description": "", "$ref": "#/components/schemas/numberJsonArr" }, "NFA_Interfaces": { "description": "", "$ref": "#/components/schemas/strJsonArr" }, "NFA_Apps": { "description": "", "$ref": "#/components/schemas/strJsonArr" }, "NFA_Attacks": { "description": "", "$ref": "#/components/schemas/JsonStringWithSpecialChar" }, "NFA_Groups": { "description": "", "$ref": "#/components/schemas/strJsonArr" }, "dpiEngineID": { "description": "", "$ref": "#/components/schemas/numberJson" } } }, "excludedDaysRegex_regex": { "pattern": "^(?:Monday|Tuesday|Wednesday|Thursday|Friday|Saturday|Sunday)(?:,(?:Monday|Tuesday|Wednesday|Thursday|Friday|Saturday|Sunday))*$", "description": "", "type": "string" }, "NFATimeZone_regex": { "pattern": "^(?:[-_a-zA-Z0-9]+[\\/-_a-zA-Z0-9]+?)+$", "description": "Pattern to match all TimeZone values", "type": "string" }, "opmee_dateWithOptionalTime_regex": { "pattern": "(([0-9]{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])( ([01][0-9]|2[0-3]))?(:([0-5][0-9]))?(:([0-5][0-9]))?)", "description": "", "type": "string" }, "NFATextWithBasicSymbols_regex": { "type": "string" }, "searchFilterJson": { "description": "", "type": "object", "properties": { "apMacCount": { "description": "", "$ref": "#/components/schemas/JsonStringWithSpecialChar" }, "packetCount": { "description": "", "$ref": "#/components/schemas/JsonStringWithSpecialChar" }, "inTraff": { "description": "", "$ref": "#/components/schemas/JsonStringWithSpecialChar" }, "dscpName": { "description": "", "$ref": "#/components/schemas/JsonStringWithSpecialChar" }, "inVolume": { "description": "", "$ref": "#/components/schemas/JsonStringWithSpecialChar" }, "outSpeed": { "description": "", "$ref": "#/components/schemas/JsonStringWithSpecialChar" }, "inSpeed": { "description": "", "$ref": "#/components/schemas/JsonStringWithSpecialChar" }, "AppName": { "description": "", "$ref": "#/components/schemas/JsonStringWithSpecialChar" }, "routerName": { "description": "", "$ref": "#/components/schemas/JsonStringWithSpecialChar" }, "alert": { "description": "", "$ref": "#/components/schemas/JsonStringWithSpecialChar" }, "outTraff": { "description": "", "$ref": "#/components/schemas/JsonStringWithSpecialChar" }, "interfaceCount": { "description": "", "$ref": "#/components/schemas/JsonStringWithSpecialChar" }, "interfaceName": { "description": "", "$ref": "#/components/schemas/JsonStringWithSpecialChar" }, "cloudServiceCategory": { "description": "", "$ref": "#/components/schemas/JsonStringWithSpecialChar" }, "routerIP": { "description": "", "$ref": "#/components/schemas/JsonStringWithSpecialChar" }, "asName": { "description": "", "$ref": "#/components/schemas/JsonStringWithSpecialChar" }, "probeName": { "description": "", "$ref": "#/components/schemas/JsonStringWithSpecialChar" }, "asNumber": { "description": "", "$ref": "#/components/schemas/JsonStringWithSpecialChar" }, "apMac": { "description": "", "$ref": "#/components/schemas/JsonStringWithSpecialChar" }, "ipName": { "description": "", "$ref": "#/components/schemas/JsonStringWithSpecialChar" }, "volume": { "description": "", "$ref": "#/components/schemas/JsonStringWithSpecialChar" }, "outVolume": { "description": "", "$ref": "#/components/schemas/JsonStringWithSpecialChar" }, "util": { "description": "", "$ref": "#/components/schemas/JsonStringWithSpecialChar" }, "name": { "description": "", "$ref": "#/components/schemas/JsonStringWithSpecialChar" }, "category": { "description": "", "$ref": "#/components/schemas/JsonStringWithSpecialChar" }, "utilizeIN": { "description": "", "$ref": "#/components/schemas/JsonStringWithSpecialChar" }, "utilizeOUT": { "description": "", "$ref": "#/components/schemas/JsonStringWithSpecialChar" }, "flowType": { "description": "", "$ref": "#/components/schemas/strJsonArr" } } }, "SMR_graphReportType_regex": { "pattern": "^(Normal|Average|Individual|Summary|PieChart)$", "description": "", "type": "string" }, "dt_page_regex": { "type": "string", "pattern": "^([1-9][0-9]{0,2}|1000|2000)$", "description": "Page number or row count for paginated requests." }, "NFA_Report_TimeFrames_regex": { "pattern": "^(15minute|30minute|hourly|6hour|daily|today|yesterday|weekly|prevweek|monthly|prevmonth|quarterly|custom)$", "description": "", "type": "string" }, "date_regex": { "pattern": "^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\\d|3[0-1])$", "description": "", "type": "string" }, "numberJsonArr": { "description": "", "type": "array", "items": { "format": "int64", "description": "", "type": "integer" } }, "NFAResolveDNS_regex": { "pattern": "^(?:true|false|0|1)$", "description": "true/false value", "type": "string" }, "NFABoolean_regex": { "pattern": "^(?:true|false)$", "description": "", "type": "string" }, "WLC_Search_Report_Criteria_Array": { "description": "", "type": "array", "items": { "description": "", "$ref": "#/components/schemas/WLC_Report_Criteria" } }, "NFA_CustomPager_Page_regex": { "pattern": "^([1-9]|[1-9][0-9]{1,2}|1000)$", "type": "string" }, "alphanumeric_basic_regex": { "description": "", "type": "string" }, "only_alphabets_regex": { "pattern": "^[a-zA-Z]+$", "description": "", "type": "string" }, "NFA_Criteria_Network": { "description": "", "type": "array", "items": { "anyOf": [ { "type": "boolean" }, { "type": "integer" }, { "type": "number" }, { "type": "string" } ] } }, "devicesMethod_regex": { "pattern": "^(Category|BV|Device|URL|GROUP|PROCESS|SCRIPT|EVENTLOG|PERFORMANCE|MSSQL|AD|EXCHANGE|SERVICE|NTSERVICE|MSSQL_SERVICE|AD_SERVICE|EXCHANGE_SERVICE|FILE|FOLDER|DEVICE_SPECIFIC_URL|SYSLOG|TRAP)$", "type": "string", "description": "" }, "NFA_CustomPager_Rows_regex": { "pattern": "^([1-9]|[1-9][0-9]{1,5}|1000)$", "type": "string" }, "NFA_Device_ID_regex": { "pattern": "^([0-9]*)$", "description": " Unique identifier of the interface/Interface group/IP group", "type": "string" }, "JsonStringWithSpecialChar": { "description": "", "type": "array", "items": { "description": "", "$ref": "#/components/schemas/NFASearchWithSpecialChar_regex" } }, "NFAData_regex": { "pattern": "^(IN|OUT|BOTH)$", "type": "string" }, "NFAStringwithspecialChar_regex": { "description": "Pattern to match reporttile and reportsubtitle", "type": "string" }, "NFA_MAC_Address_regex": { "pattern": "^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$", "description": "", "type": "string" }, "NFATimeFrame_regex": { "pattern": "^(8:00 AM to 8:00 PM|7Days|30Days|Last 15 Minutes|Last Week|Previous Week|Previous Month|Last Quarter|Custom Selection|eight|Custom|custom|15Minute|30Minute|Last 30 Minutes|Hourly|hourly|Last Hour|today|6Hour|Last 6 Hour|Last 6 Hours|2Hour|Last 2Hour|Daily|Last 24 Hour|Last 24 hours|24Hour|Last 7 days|Weekly|Monthly|Quarterly|PrevMonth|PrevWeek|Yesterday|Today|DayBeforeYesterday|ThisWeek|ThisMonth|Last Month|yesterday|daily|Last 30 days|Last 90 days|Every Day Report For Last 5 day|4Hour)$", "description": "", "type": "string" }, "NFA_Source_ID_Minus1_regex": { "pattern": "^(-1|([0-9]*))$", "description": "Interface,AP,Cloud Interface,IPGroup,InterfaceGroup,APGroup and SSIDGroup ID", "type": "string" }, "WLC_Search_Report_Criteria_List": { "description": "", "type": "object", "properties": { "includeList": { "description": "", "$ref": "#/components/schemas/WLC_Search_Report_Criteria_Array" }, "excludeList": { "description": "", "$ref": "#/components/schemas/WLC_Search_Report_Criteria_Array" } } }, "timePeriod_regex": { "pattern": "^(custom|Today|onehour|twohours|fourhours|sixhours|eighthours|twelvehours|twfourhours|before_12_hours|before_24_hours|before_48_hours|Last_7_Days|WEEK|Last_30_Days|MONTH|Last_60_Days|Last_90_Days|Yesterday|thisweek|lastweek|thismonth|Last_Month|Last 12 hours|Last 24 hours|Last 7 days|This week|Last week|This month|Last month|Last 30 days|last_7_days|last_30_days|last_90_days|Last_12_hours|Last_24_hours|This_Week|This_Month|Last_Week|Next_7_days|Next_14_days|Next_30_days|Next_60_days|Next_90_days|Next_12_hours|Next_24_hours|This_Week|This_Quarter|Last_Quarter|Last_3_Months|Last_6_Months)$", "description": "", "type": "string" }, "NFA_Source_ID_regex": { "pattern": "^([0-9]*)$", "type": "string" }, "NFA_AS_Number_Minus1_regex": { "pattern": "^(?:(-1)|(?:(([0-9]|[1-9][0-9]{1,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])))|(13107[2-9]|1310[89][0-9]|131[1-9][0-9]{2}|13[2-9][0-9]{3}|1[4-9][0-9]{4}|[2-9][0-9]{5}|[1-9][0-9]{6,8}|[1-3][0-9]{9}|4[01][0-9]{8}))$", "description": "", "type": "string" }, "valueTypeRegex_regex": { "pattern": "^(MINIMUM|MAXIMUM|AVERAGE)$", "description": "", "type": "string" }, "numberJson": { "description": "", "type": "array", "items": { "description": "", "$ref": "#/components/schemas/onlyNumber_regex" } }, "strJsonArrWithColon": { "description": "", "type": "array", "items": { "description": "", "$ref": "#/components/schemas/NFAStringwithspecialChar_regex" } }, "NFA_Inv_TimeFrames_1_regex": { "pattern": "^(15minute|30minute|hourly|6hour|today|daily|weekly|monthly)$", "description": "Specifies the period of time for which you want to retrieve data (e.g., last_hour, 6_hours).\nEx :15minute|30minute|hourly|6hour|today|daily|weekly|monthly", "type": "string" }, "strJsonArr": { "description": "", "type": "array", "items": { "description": "", "$ref": "#/components/schemas/alphanumeric_basic_regex" } }, "ScheduleName_regex": { "pattern": "^-1$|[^#~!@*&!+%(){}=\\<>$\\[\\]'\":,./;^\\-|?]+", "type": "string", "description": "" }, "entityText_regex": { "description": "", "type": "string" }, "text_twoByteSupport_regex": { "description": "", "type": "string" }, "apikey_regex": { "type": "string", "pattern": "^[a-f0-9]{32}$", "description": "32-character hexadecimal API key for OpManager authentication." }, "NFA_FlowFilter_ID": { "description": "", "type": "array", "items": { "pattern": "^(?:1|2|4|5)$", "description": "", "type": "string" } }, "custom_regex": { "type": "string", "description": "" }, "line_regex": { "type": "string", "description": "" }, "ErrorResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string", "description": "Human-readable error message." }, "code": { "type": "integer", "description": "Error code. Common values: 5003 (parameter missing), 5006 (parameter empty), 5009 (invalid value), 5011 (value not exists), 5000 (general error), 5800 (Lite edition unauthorized)." } } } } }, "WirelessAPDetail": { "type": "object", "properties": { "macAddress": { "type": "string", "description": "MAC address of the access point." }, "channels": { "type": "string", "description": "Channel information for the access point." }, "statusStr": { "type": "string", "description": "Localized status name (e.g. \"UnManaged\", \"notmonitored\", or a severity name)." }, "ipAddress": { "type": "string", "description": "IP address of the access point." }, "apDisplayName": { "type": "string", "description": "Display name of the access point." }, "apName": { "type": "string", "description": "Internal device name of the access point." }, "statusNum": { "type": "string", "description": "Numeric status code as a string (e.g. \"7\")." }, "advanceMonitoringEnabled": { "type": "string", "description": "Whether advance monitoring is enabled for this AP (\"true\" or \"false\")." } } }, "NetworkPathInfo": { "type": "object", "description": "Basic metadata of the network path monitor.", "properties": { "pathName": { "type": "string", "description": "Internal path name." }, "disableEdit": { "type": "string", "description": "Present with value \"true\" when the source display name matches the source IP (no managed device found)." }, "pathDestinationPort": { "type": "integer", "description": "Destination port number." }, "pathStatus": { "type": "integer", "description": "Numeric status of the path." }, "pathSource": { "type": "string", "description": "Source IP or hostname." }, "pathSourceDisplayName": { "type": "string", "description": "Display name of the source." }, "pathDestination": { "type": "string", "description": "Destination IP or hostname." }, "moID": { "type": "integer", "format": "int64", "description": "ManagedObject ID." }, "pathDisplayName": { "type": "string", "description": "Display name of the path." } } }, "PathwayGraphResponse": { "type": "object", "properties": { "pathGraphTime": { "type": "integer", "format": "int64", "description": "Epoch timestamp (ms) of the collected graph data." }, "nodeDetails": { "type": "array", "description": "List of node (hop) details.", "items": { "$ref": "#/components/schemas/NodeDetail" } }, "thresholdDetails": { "$ref": "#/components/schemas/ThresholdDetails" }, "destinationUnreachablePaths": { "type": "array", "description": "Set of link strings (\"hopA:hopB\") where the destination was unreachable across all traced paths.", "items": { "type": "string" } }, "paths": { "type": "object", "description": "Map of request ID to ordered list of link strings (\"hopA:hopB\") representing each discovered path variation.", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "networkPathDetails": { "$ref": "#/components/schemas/NetworkPathInfo" }, "hopVsPaths": { "type": "object", "description": "Map of hop IP to the set of request IDs (path numbers) the hop belongs to.", "additionalProperties": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, "ERROR": { "type": "string", "description": "Present instead of graph data when no data is available. Values: \"NO_DATA_FOUND\" or \"NO_DATA_FOUND_FOR_TIME\"." }, "pathDetails": { "type": "array", "description": "List of link details between hops.", "items": { "$ref": "#/components/schemas/LinkDetail" } } } }, "RogueAPDetail": { "type": "object", "properties": { "macAddress": { "type": "string", "description": "MAC address of the rogue access point." }, "channels": { "type": "string", "description": "Channel on which the rogue AP was detected." }, "rougeclient": { "type": "string", "description": "Number of clients connected to the rogue AP." }, "ipAddress": { "type": "string", "description": "IP address of the rogue access point." }, "time": { "type": "string", "description": "Detection timestamp of the rogue access point." }, "SSIDName": { "type": "string", "description": "SSID of the rogue access point." }, "apName": { "type": "string", "description": "Name of the rogue access point (may be empty)." } } }, "ThresholdDetails": { "type": "object", "description": "Threshold configuration for the network path's monitors.", "properties": { "packetLoss": { "$ref": "#/components/schemas/ThresholdEntry" }, "linkLatency": { "$ref": "#/components/schemas/ThresholdEntry" }, "linkPacketLoss": { "$ref": "#/components/schemas/ThresholdEntry" }, "latency": { "$ref": "#/components/schemas/ThresholdEntry" } } }, "InterfaceListData": { "type": "object", "description": "Interface list data including summary counts and interface details for a device.", "properties": { "isSNMP": { "type": "boolean", "description": "Whether the device supports SNMP." }, "interfaceCount": { "type": "string", "description": "Total number of interfaces." }, "downCount": { "type": "string", "description": "Number of down interfaces." }, "interfaces": { "type": "array", "description": "List of interface detail objects.", "items": { "$ref": "#/components/schemas/DeviceInterfaceDetail" } }, "showPollingStatusColumn": { "type": "boolean", "description": "Whether to show the polling status column in UI." } } }, "LinkDetail": { "type": "object", "description": "Details of a link between two hops in the network path.", "properties": { "maxRTT": { "type": "string", "description": "Maximum round-trip time (e.g. \"18 ms\")." }, "country": { "type": "string", "description": "Country name for the destination hop (when geo data is loaded)." }, "destination": { "type": "string", "description": "Destination hop IP of the link." }, "source": { "type": "string", "description": "Source hop IP of the link." }, "packetLossPercent": { "type": "number", "format": "double", "description": "Average packet loss percentage for the link." }, "linkLatencyAlarmSeverity": { "type": "string", "description": "Alarm severity for link latency." }, "timeOutHopCount": { "type": "string", "description": "Number of timed-out hops on this link." }, "avgRTT": { "type": "string", "description": "Average round-trip time (e.g. \"9.2 ms\")." }, "linkPacketLossAlarmMessage": { "type": "string", "description": "Alarm message for link packet loss." }, "linkPacketLossAlarmID": { "type": "string", "description": "Alarm ID for link packet loss (present when an alarm exists)." }, "linkLatencyAlarmID": { "type": "string", "description": "Alarm ID for link latency (present when an alarm exists)." }, "minRTT": { "type": "string", "description": "Minimum round-trip time (e.g. \"3 ms\")." }, "geoLoaded": { "type": "boolean", "description": "Whether GeoIP data was available." }, "ASName": { "type": "string", "description": "Autonomous System name or number for the destination hop." }, "linkLatencyAlarmMessage": { "type": "string", "description": "Alarm message for link latency." }, "linkPacketLossAlarmSeverity": { "type": "string", "description": "Alarm severity for link packet loss." }, "likelyPathCount": { "type": "number", "format": "double", "description": "Percentage indicating how often this link appears across traced paths." } } }, "RogueAPResponse": { "type": "object", "properties": { "showAPName": { "type": "boolean", "description": "Indicates whether any rogue AP in the list has a non-empty AP name. When false, the AP name column can be hidden in the UI." }, "rogueAPList": { "type": "array", "description": "List of detected rogue access points.", "items": { "$ref": "#/components/schemas/RogueAPDetail" } } } }, "GetInterfacesResponse": { "type": "object", "description": "Response wrapper for the getInterfaces API.", "properties": { "interfaceList": { "$ref": "#/components/schemas/InterfaceListData" } } }, "ThresholdEntry": { "description": "Threshold configuration for a metric. Contains a \"type\" field and severity-level keys (e.g. \"Attention\", \"Trouble\", \"Critical\") mapped to their threshold values.", "additionalProperties": { "type": "number", "description": "Severity name mapped to its threshold value." }, "type": "object", "properties": { "type": { "type": "string", "description": "Threshold type (e.g. \"static\")." } } }, "WirelessNetworkDetail": { "type": "object", "properties": { "SSIDName": { "type": "string", "description": "Name of the wireless network (SSID)." }, "APCount": { "type": "string", "description": "Number of access points broadcasting this SSID, or \"NA\" if unavailable." }, "ClientCount": { "type": "string", "description": "Number of clients connected to this SSID, or \"NA\" if unavailable." }, "TotalBytes": { "type": "string", "description": "Total network usage formatted as a speed string with \"Bps\" suffix." } } }, "NodeDetail": { "type": "object", "description": "Details of a single hop (node) in the network path.", "properties": { "nodeName": { "type": "string", "description": "IP address of the hop." }, "maxRTT": { "type": "string", "description": "Maximum round-trip time (e.g. \"25 ms\")." }, "country": { "type": "string", "description": "Country name from GeoIP lookup (when geo data is loaded)." }, "nodeDisplayName": { "type": "string", "description": "Display name of the hop." }, "moName": { "type": "string", "description": "ManagedObject name if the hop is a managed device." }, "packetLossPercent": { "type": "number", "format": "double", "description": "Average packet loss percentage." }, "nodeLocation": { "type": "string", "description": "Position of the node in the path (start, intermediate, or end)." }, "avgRTT": { "type": "string", "description": "Average round-trip time (e.g. \"12.5 ms\")." }, "minRTT": { "type": "string", "description": "Minimum round-trip time (e.g. \"5 ms\")." }, "geoLoaded": { "type": "boolean", "description": "Whether GeoIP data was available for lookup." }, "ASName": { "type": "string", "description": "Autonomous System name or number for the hop." }, "status": { "type": "string", "description": "Severity status of the node (numeric string, e.g. \"1\" = Clear)." }, "destinationReachable": { "type": "boolean", "description": "Whether the destination was reachable at this end node (present only for end nodes)." } } }, "NetworkPathListItem": { "type": "object", "properties": { "pathName": { "type": "string", "description": "Display name of the network path." }, "destinationPort": { "type": "string", "description": "Destination port number." }, "sourceDisplayName": { "type": "string", "description": "Display name for the source device." }, "sourceMOName": { "type": "string", "description": "ManagedObject name of the source device (present only when the source is a managed device)." }, "probeID": { "type": "string", "description": "Probe ID (Central Server mode only)." }, "source": { "type": "string", "description": "Source IP address or hostname." }, "moID": { "type": "string", "description": "ManagedObject ID." }, "sourceManaged": { "type": "string", "description": "Managed state of the source device (empty string if not applicable)." }, "managed": { "type": "string", "description": "Whether the path is managed (\"true\" or \"false\")." }, "probeURL": { "type": "string", "description": "Probe URL (Central Server mode only)." }, "name": { "type": "string", "description": "ManagedObject name (internal identifier)." }, "probeDisplayName": { "type": "string", "description": "Probe display name (Central Server mode only)." }, "destinationHost": { "type": "string", "description": "Destination IP address or hostname." }, "status": { "type": "string", "description": "Current monitoring status of the path." } } }, "DeviceInterfaceDetail": { "type": "object", "description": "Details of a single interface on a device.", "properties": { "ifIndex": { "type": "string", "description": "Interface index." }, "statusStr": { "type": "string", "description": "Localized severity name." }, "ifType": { "type": "string", "description": "Interface type name (from InterfaceDefinitionTemplate) or \"NA\"." }, "displayName": { "type": "string", "description": "Display name of the interface." }, "imagePath": { "type": "string", "description": "Path to the interface type icon." }, "RouterPortType": { "type": "string", "description": "Port type derived from interface description (\"Eth\", \"Serial\", or empty)." }, "outSpeed": { "type": "string", "description": "Formatted output speed (e.g. \"1.0 Gbps\")." }, "inSpeed": { "type": "string", "description": "Formatted input speed (e.g. \"1.0 Gbps\")." }, "type": { "type": "string", "description": "Interface type ID." }, "outTraffic": { "type": "string", "description": "Formatted outbound traffic or \"NA\" if unavailable." }, "moid": { "type": "string", "description": "Managed object ID." }, "nfEnabled": { "type": "string", "description": "Whether NetFlow is enabled (\"true\" or \"false\")." }, "suppressedMessage": { "type": "string", "description": "Alarm suppression message (present only when suppressed)." }, "bgColor": { "type": "string", "description": "HTML hex color representing the status." }, "isSubInterface": { "type": "string", "description": "Whether this is a sub-interface." }, "connected-device": { "type": "string", "description": "Connected device MAC address (from switch port mapping, when available)." }, "ifAdminStatus": { "type": "string", "description": "Administrative status code." }, "ifIndexNum": { "type": "integer", "format": "int64", "description": "Interface index as number." }, "inUtil": { "type": "string", "description": "Inbound utilization percentage or \"NA\"." }, "isSuppressed": { "type": "boolean", "description": "Whether alarm suppression is active for this interface." }, "spmresourceid": { "type": "string", "description": "SPM resource ID (when switch port mapping data is available)." }, "trimmedDispName": { "type": "string", "description": "Display name trimmed to 25 characters." }, "ipAddress": { "type": "string", "description": "IP address of the interface (if available)." }, "pollingStatus": { "type": "string", "description": "Polling/DCM status code (present when showPollingStatusColumn is true)." }, "statusNum": { "type": "string", "description": "Numeric status code." }, "inTraffic": { "type": "string", "description": "Formatted inbound traffic or \"NA\" if unavailable." }, "outUtil": { "type": "string", "description": "Outbound utilization percentage or \"NA\"." }, "statusString": { "type": "string", "description": "Severity name string." }, "name": { "type": "string", "description": "Interface managed object name." }, "ifOperStatus": { "type": "string", "description": "Operational status code." }, "errors": { "type": "string", "description": "Error count or \"NA\"." }, "status": { "type": "string", "description": "Status code." } } }, "GetDownDevicesResponse": { "type": "object", "properties": { "getDownDevices": { "type": "array", "description": "List of down devices.", "items": { "$ref": "#/components/schemas/DownDevice" } } } }, "GetCategoryListResponse": { "type": "object", "description": "Category list response.", "additionalProperties": { "type": "string" } }, "AvailabilityGraphDataResponse": { "description": "Response object containing availability graph data for visualization.", "additionalProperties": true, "type": "object", "properties": { "uptimeData": { "type": "object", "description": "Uptime percentages for predefined time periods (Today, Yesterday, This Week, Last Week, This Month, etc.).", "additionalProperties": { "oneOf": [ { "type": "integer" }, { "type": "number" } ] } }, "availabilityData": { "type": "array", "items": { "$ref": "#/components/schemas/AvailabilityDataSeries" }, "description": "Array of availability time-series data for graphing." } } }, "GetDeviceSummaryResponse": { "description": "Comprehensive device summary object. Fields present depend on device type, category, and edition.", "additionalProperties": true, "type": "object", "properties": { "name": { "type": "string", "description": "Unique managed object name of the device." }, "ipAddress": { "type": "string", "description": "Device IP address." }, "category": { "type": "string", "description": "Device category." }, "displayName": { "type": "string", "description": "Human-readable display name of the device." }, "snapDetails": { "type": "object", "description": "Snapshot data returned based on snapType and object type.", "additionalProperties": true }, "status": { "type": "string", "description": "Device status code." } } }, "DownDevice": { "type": "object", "properties": { "type": { "type": "string", "examples": [ "router" ] }, "displayName": { "type": "string", "examples": [ "router-01" ] } }, "additionalProperties": true }, "InterfaceSummaryResponse": { "description": "Summary information for a network interface.", "additionalProperties": true, "type": "object", "properties": { "isAgentMonitoring": { "type": "boolean", "description": "Whether agent monitoring is enabled." }, "recBandwidth": { "type": "string", "description": "Reception bandwidth." }, "NFA_ID": { "type": "string", "description": "NetFlow Analyzer interface ID." }, "isAddedToNFA": { "type": "string", "description": "Whether interface is added to NetFlow Analyzer." }, "displayName": { "type": "string", "description": "Display name of the device." }, "availability": { "type": "object", "description": "Availability statistics for the interface.", "additionalProperties": true }, "pollingStatus": { "type": "string", "description": "Current polling status." }, "pollInterval": { "type": "string", "description": "Polling interval for the interface." }, "intfMoName": { "type": "string", "description": "Interface managed object name." }, "regionID": { "type": "string", "description": "Region or probe ID in MSP environments." }, "managed": { "type": "string", "description": "Whether the interface is managed." }, "snapDetails": { "type": "object", "description": "Snapshot details included when requested.", "additionalProperties": true }, "name": { "type": "string", "description": "Device name containing this interface." }, "transBandwidth": { "type": "string", "description": "Transmission bandwidth." }, "customerID": { "type": "string", "description": "Customer ID in MSP environments." }, "category": { "type": "string", "description": "Device category." }, "statusPollEnabled": { "type": "string", "description": "Whether status polling is enabled." }, "trafficCounter": { "type": "string", "description": "Traffic counter type, such as 32 bit or 64 bit." }, "availabilityTimeLine": { "type": "array", "description": "Historical availability data.", "items": { "type": "object", "additionalProperties": true } } } }, "VirtualDeviceRow": { "type": "object", "description": "A single row in the virtual device list. The set of fields varies by virtualDeviceType. Common fields are listed below; additional columns depend on the entity type requested.\n", "properties": { "DISPLAYNAME": { "type": "string", "description": "Display name of the virtual entity." }, "VM_ID": { "type": "integer", "format": "int64", "description": "Internal virtual machine identifier." }, "statusStr": { "type": "string", "description": "Plain-text severity label (e.g., \"Clear\", \"Attention\", \"Critical\")." }, "IPADDRESS": { "type": "string", "description": "IP address of the virtual entity (if available)." }, "VM_POWERSTATE": { "type": "string", "description": "Power state of the virtual machine as reported by the hypervisor (e.g., poweredOn, poweredOff, Running, Halted, on, off).\n" }, "MAX_CPU_MHZ": { "type": "integer", "description": "Maximum CPU clock speed allocated to the virtual entity in MHz." }, "OS_NAME": { "type": "string", "description": "Guest operating system name." }, "statusNum": { "type": "integer", "description": "Numeric severity status. 1=Critical, 2=Attention, 3=Trouble, 4=Service Down, 5=Clear, 7=UnManaged.\n" }, "MEMORY_MB": { "type": "integer", "description": "Memory allocated to the virtual entity in MB." }, "STATUS": { "type": "string", "description": "HTML-formatted status string containing a status icon image and the severity label (e.g., \" Attention\").\n" }, "HOSTNAME": { "type": "string", "description": "Name of the host on which the virtual entity resides." }, "CPU_CORES": { "type": "integer", "description": "Number of CPU cores allocated to the virtual entity." }, "MOID": { "type": "integer", "format": "int64", "description": "Managed object ID of the virtual entity (same as id)." }, "id": { "type": "integer", "format": "int64", "description": "ID of the virtual entity." } } }, "VMwareVMDetail": { "type": "object", "description": "Details of a single VMware virtual machine.", "properties": { "VM_CONNECTIONSTATE": { "type": "string", "description": "Connection state of the VM as reported by vCenter (e.g., connected, disconnected, orphaned).\n" }, "DISPLAYNAME": { "type": "string", "description": "Display name of the VM." }, "STATUS_STR": { "type": "string", "description": "Plain-text severity label (e.g., \"Clear\", \"Attention\", \"Critical\"). Present only when the VM is monitored." }, "VM_ID": { "type": "integer", "format": "int64", "description": "Internal virtual machine identifier in OpManager." }, "VIRTUAL_TYPE": { "type": "string", "description": "Virtual entity type." }, "NUM_ETHERNET": { "type": "integer", "description": "Number of virtual ethernet (NIC) adapters attached to the VM." }, "VM_POWERSTATE": { "type": "string", "description": "Power state of the VM as reported by vCenter (e.g., On, Off, Suspended).\n" }, "MAX_CPU_MHZ": { "type": "integer", "description": "Maximum CPU clock speed allocated to the VM in MHz." }, "IPADDRESS": { "type": "string", "description": "Primary IP address of the VM guest OS. Present only when available." }, "OS_NAME": { "type": "string", "description": "Guest operating system full name." }, "NUM_VDISK": { "type": "integer", "description": "Number of virtual disks attached to the VM." }, "NAME": { "type": "string", "description": "Managed object name of the VM. Present only when available." }, "VHOST_ID": { "type": "integer", "format": "int64", "description": "Internal identifier of the ESXi host on which the VM resides." }, "MEMORY_MB": { "type": "integer", "description": "Memory allocated to the VM in MB." }, "STATUS": { "type": "integer", "description": "Numeric severity status code. Present only when the VM is monitored. 1=Critical, 2=Attention, 3=Trouble, 4=Service Down, 5=Clear.\n" }, "MOID": { "type": "integer", "format": "int64", "description": "OpManager managed object ID of the VM. -4 indicates the VM is not yet managed/monitored." }, "MAX_MEMORY_MB": { "type": "integer", "description": "Maximum memory configured for the VM in MB." }, "IS_ORPHANED": { "type": "string", "description": "Whether the VM is orphaned (not associated with a running host). \"true\" or \"false\"." }, "NUM_VCPU": { "type": "integer", "description": "Number of virtual CPUs allocated to the VM." } } }, "LastCollectedValueData": { "description": "Instance-wise collected data point for a monitor.", "additionalProperties": true, "type": "object", "properties": { "value": { "oneOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" } ] }, "instance": { "type": "string" } } }, "DataPoint": { "description": "Single data point in an availability graph.", "additionalProperties": true, "type": "object", "properties": { "x": { "type": "integer", "format": "int64", "description": "Timestamp in milliseconds since epoch." }, "y": { "description": "Availability percentage value (0-100).", "oneOf": [ { "type": "integer" }, { "type": "number" } ] }, "color": { "type": "string", "description": "Hex color code for the data point (e.g., \"#1A8F47\" for up/available, \"#E74C3C\" for down)." }, "toolTipKey": { "type": "string", "description": "Formatted display text for tooltip (e.g., \"Aug 25, 12:00 AM\")." } } }, "DeviceAssociatedMonitorGroup": { "description": "Generic monitor group wrapper for associated monitor categories.", "additionalProperties": true, "type": "object", "properties": { "statusIcon": { "type": "string", "description": "Relative icon path representing aggregate group status." }, "total": { "type": "integer", "description": "Total number of monitors in this group." }, "period": { "type": "string", "description": "Optional period value for groups like event logs." }, "isActive": { "type": "string", "description": "Optional active state flag for some monitor groups." }, "down": { "type": "integer", "description": "Number of monitors in down/trouble state in this group." }, "monitors": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceAssociatedMonitorItem" } } } }, "DeviceAssociatedMonitorDataPoint": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" } ] }, "instance": { "type": "string" } }, "additionalProperties": true }, "GraphConsolidatedValue": { "type": "object", "properties": { "maxVal": { "type": "string" }, "minVal": { "type": "string" }, "currVal": { "type": "string" }, "seriesName": { "type": "string" }, "avgVal": { "type": "string" }, "95thpercRawVal": { "type": "string" }, "95thperc": { "type": "string" }, "95thpercVal": { "type": "string" } }, "additionalProperties": true }, "ListDevicesV2Response": { "description": "Paginated response wrapper for the v2 listDevices endpoint. Contains the total page count, current page, total matching record count, and the array of device rows.\n", "additionalProperties": true, "type": "object", "properties": { "total": { "type": "integer", "description": "Total number of pages available for the current filter/page-size combination. Returns 0 when results fit in a single page.\n" }, "page": { "type": "integer", "description": "Current page number returned (1-based)." }, "rows": { "type": "array", "description": "Array of device objects for the current page.", "items": { "$ref": "#/components/schemas/DeviceRow" } }, "records": { "type": "integer", "description": "Total number of matching device records across all pages." } } }, "PerformanceMonitorDefinition": { "description": "Metadata describing a performance monitor template.", "additionalProperties": true, "type": "object", "properties": { "graphName": { "type": "string", "description": "Internal graph policy name." }, "protocol": { "type": "string", "description": "Monitor protocol (for example SNMP, WMI, PrismAPI)." }, "custFieldGraph": { "description": "Whether monitor belongs to custom-field graph category.", "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "Identifier": { "type": "string", "description": "OID or expression used by the monitor." }, "customGraph": { "description": "Whether this is a custom monitor.", "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "associatedDeviceCount": { "description": "Number of devices currently associated to this monitor.", "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "monitorName": { "type": "string", "description": "Monitor display label in monitor catalog." }, "displayName": { "type": "string", "description": "Display name shown in UI lists." }, "vendor": { "type": "string", "description": "Vendor classification for monitor template." }, "description": { "type": "string", "description": "Monitor description text." }, "graphId": { "description": "Unique graph identifier.", "oneOf": [ { "type": "string" }, { "type": "integer" } ] } } }, "GraphSeries": { "type": "object", "properties": { "data": { "type": "array", "items": { "minItems": 2, "maxItems": 2, "type": "array", "items": { "oneOf": [ { "type": "integer" }, { "type": "number" } ] } } }, "seriesname": { "type": "string" } }, "additionalProperties": true }, "GraphDataResponse": { "description": "Graph response payload for monitor chart rendering.", "additionalProperties": true, "type": "object", "properties": { "showForecastIcon": { "type": "boolean" }, "showInsightsIcon": { "type": "boolean" }, "thresholds": { "type": "object", "additionalProperties": true }, "displayName": { "type": "string" }, "pollID": { "type": "string" }, "consolidatedValues": { "type": "array", "items": { "$ref": "#/components/schemas/GraphConsolidatedValue" } }, "format": { "type": "string" }, "xyTitles": { "type": "array", "items": { "type": "string" } }, "timeZone": { "type": "string" }, "RMName": { "type": "string" }, "showGraphFilters": { "type": "boolean" }, "graphData": { "type": "array", "items": { "$ref": "#/components/schemas/GraphSeries" } } } }, "LastCollectedValuesResponse": { "type": "object", "description": "Map of device MOID to collected monitor records.", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/LastCollectedValueItem" } } }, "DeviceMetricsInfo": { "type": "object", "description": "Inventory/asset metric information for a device. Contains hardware-level details discovered via WMI, SNMP, or other protocols. Useful for MCP/AI agents performing asset inventory lookups, warranty checks, or OS compliance audits.\n", "properties": { "macAddress": { "type": "string", "description": "Primary MAC address of the device (e.g., \"00:1A:2B:3C:4D:5E\"). Empty string if not discovered.\n" }, "serialNumber": { "type": "string", "description": "Hardware serial number of the device (from BIOS/firmware). Empty string if not discovered.\n" }, "osVersion": { "type": "string", "description": "Operating system version string (e.g., \"10.0.17763\", \"15.2(4)M\"). Empty string if not discovered.\n" }, "serviceTag": { "type": "string", "description": "Hardware service tag or asset tag. Vendor-specific identifier used for support/warranty lookups. Empty string if not discovered.\n" }, "model": { "type": "string", "description": "Hardware model name (e.g., \"PowerEdge R740\", \"Catalyst 9300\"). Empty string if not discovered.\n" }, "osName": { "type": "string", "description": "Operating system name (e.g., \"Microsoft Windows Server 2019\", \"Cisco IOS\"). Empty string if not discovered.\n" }, "ramSize": { "type": "string", "description": "Total RAM size in megabytes. Empty string if not discovered.\n" }, "hddSize": { "type": "string", "description": "Total hard disk size in megabytes. Empty string if not discovered.\n" }, "manufacturer": { "type": "string", "description": "Hardware manufacturer name (e.g., \"Dell Inc.\", \"Cisco\", \"Hewlett Packard Enterprise\"). Empty string if not discovered.\n" } } }, "NutanixVMDetail": { "type": "object", "description": "Details of a single Nutanix virtual machine. \n", "properties": { "NUMNETWORKADAPTERS": { "type": "integer", "description": "Number of virtual network adapters attached to the VM." }, "DISPLAYNAME": { "type": "string", "description": "Display name of the VM." }, "VCPUCOUNT": { "type": "integer", "description": "Number of virtual CPUs allocated to the VM." }, "VM_ID": { "type": "integer", "format": "int64", "description": "Internal virtual machine identifier in OpManager." }, "statusStr": { "type": "string", "description": "Plain-text severity label (e.g., \"Clear\", \"Attention\", \"Critical\"). Present only for monitored VMs.\n" }, "OS": { "type": "string", "description": "Guest operating system name. Present only for monitored VMs." }, "DISKCAPACITY": { "type": "string", "description": "Total disk capacity allocated to the VM in GB." }, "IPADDRESS": { "type": "string", "description": "Primary IP address of the VM. Present only for monitored VMs." }, "VMSTATE": { "type": "string", "description": "Power state of the VM (e.g., \"Powered On\", \"Powered Off\")." }, "MEMORYCAPACITY": { "type": "string", "description": "Memory allocated to the VM in GB." }, "statusNum": { "type": "integer", "description": "Numeric severity status code. Present only for monitored VMs. 1=Critical, 2=Attention, 3=Trouble, 4=Service Down, 5=Clear.\n" }, "NAME": { "type": "string", "description": "Managed object name of the VM in the Nutanix cluster. Present only for monitored VMs." }, "ISCONTROLLERVM": { "type": "boolean", "description": "Whether this VM is a Nutanix Controller VM (CVM)." }, "SELECTIONSTATE": { "type": "integer", "description": "Indicates whether the VM is monitored in OpManager. 1 = monitored, -1 = not monitored / unmanaged.\n" } } }, "DeviceAssociatedMonitorItem": { "description": "Generic associated monitor item with monitor-specific attributes.", "additionalProperties": true, "type": "object", "properties": { "DISPLAYNAME": { "type": "string" }, "lastCollectedTime": { "type": "string" }, "graphType": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceAssociatedMonitorDataPoint" } }, "policyName": { "type": "string" }, "displayName": { "type": "string" }, "pollId": { "type": "string" }, "name": { "type": "string" }, "GRAPHID": { "type": "string" }, "thresholdStatus": { "type": "string" }, "Protocol": { "type": "string" }, "statusNum": { "oneOf": [ { "type": "string" }, { "type": "integer" } ] } } }, "LastCollectedValueItem": { "description": "Last collected value details for a single monitor poll entry.", "additionalProperties": true, "type": "object", "properties": { "NumericType": { "type": "integer", "description": "Numeric type used by the monitor value model." }, "ProtocolName": { "type": "string" }, "Description": { "type": "string" }, "GraphName": { "type": "string" }, "GraphTypeName": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/LastCollectedValueData" } }, "GraphId": { "type": "integer" }, "PollId": { "type": "integer" }, "OID": { "type": "string" }, "previousSeverity": { "type": "integer" }, "YAxisText": { "type": "string" }, "deviceName": { "type": "string" }, "lastCollectedTime": { "type": "string" }, "failureThreshold": { "type": "integer" }, "PolicyName": { "type": "string" }, "lastPolledCounterValue": { "oneOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" } ] }, "DataType": { "type": "string" }, "failureCount": { "type": "integer" } } }, "DeviceAssociatedMonitorsResponse": { "description": "Top-level associated monitor response for a single device.", "additionalProperties": true, "type": "object", "properties": { "performanceMonitors": { "$ref": "#/components/schemas/DeviceAssociatedMonitorGroup" }, "deviceProtocol": { "type": "string", "description": "Monitoring protocol used by the device (e.g., SNMP, WMI, NCM)." }, "ntServiceMonitors": { "$ref": "#/components/schemas/DeviceAssociatedMonitorGroup" }, "storageMonitors": { "$ref": "#/components/schemas/DeviceAssociatedMonitorGroup" }, "showPollingStatusColumn": { "type": "boolean" }, "fileMonitors": { "$ref": "#/components/schemas/DeviceAssociatedMonitorGroup" }, "mssqlServices": { "$ref": "#/components/schemas/DeviceAssociatedMonitorGroup" }, "adMonitors": { "$ref": "#/components/schemas/DeviceAssociatedMonitorGroup" }, "folderMonitors": { "$ref": "#/components/schemas/DeviceAssociatedMonitorGroup" }, "serverMonitors": { "$ref": "#/components/schemas/DeviceAssociatedMonitorGroup" }, "urlMonitors": { "$ref": "#/components/schemas/DeviceAssociatedMonitorGroup" }, "faultMonitors": { "$ref": "#/components/schemas/DeviceAssociatedMonitorGroup" }, "processMonitors": { "$ref": "#/components/schemas/DeviceAssociatedMonitorGroup" }, "exchangeMonitors": { "$ref": "#/components/schemas/DeviceAssociatedMonitorGroup" }, "exchangeServices": { "$ref": "#/components/schemas/DeviceAssociatedMonitorGroup" }, "eventlogMonitors": { "$ref": "#/components/schemas/DeviceAssociatedMonitorGroup" }, "isDCMEnabled": { "type": "boolean" }, "scriptMonitors": { "$ref": "#/components/schemas/DeviceAssociatedMonitorGroup" }, "adServices": { "$ref": "#/components/schemas/DeviceAssociatedMonitorGroup" }, "mssqlMonitors": { "$ref": "#/components/schemas/DeviceAssociatedMonitorGroup" } } }, "AvailabilityDataSeries": { "description": "A single time-series dataset representing availability over a period.", "additionalProperties": true, "type": "object", "properties": { "name": { "type": "string", "description": "Name of the time period (e.g., Last 24 Hours, Last 7 Days)." }, "points": { "type": "array", "items": { "$ref": "#/components/schemas/DataPoint" }, "description": "Array of data points with timestamps and availability values." } } }, "DeviceRow": { "description": "A single device entry from the listDevices v2 response. Core fields are listed below; additional fields may be present depending on active filters (getInterfaces, getMonitors, customFields).\n", "additionalProperties": true, "type": "object", "properties": { "isSNMP": { "type": "boolean", "description": "Whether the device is monitored via SNMP." }, "ipaddress": { "type": "string", "description": "Primary IP address of the device." }, "statusStr": { "type": "string", "description": "Human-readable severity label (e.g., \"Clear\", \"Critical\")." }, "isSuppressed": { "type": "boolean", "description": "Whether alarm suppression is currently active for this device." }, "prettyTime": { "type": "string", "description": "Human-readable relative time since the last status change (e.g., \"5 hours ago\", \"2 days ago\").\n" }, "displayName": { "type": "string", "description": "Human-readable display name shown in the OpManager UI." }, "isNew": { "type": "boolean", "description": "Whether the device was recently added to OpManager." }, "type": { "type": "string", "description": "Device type string (e.g., \"Windows 2019\", \"Cisco2081\")." }, "vendorName": { "type": "string", "description": "Vendor name of the device (e.g., \"Microsoft\", \"Cisco\")." }, "deviceName": { "type": "string", "description": "Internal managed object name of the device. Used as the 'name' parameter in device-specific APIs such as getDeviceAssociatedMonitors and getGraphData.\n" }, "moid": { "type": "integer", "format": "int64", "description": "Managed Object ID \u2014 unique identifier for the device in OpManager. Use this as deviceMOIDList in getLastCollectedValues and other device-specific APIs.\n" }, "statusNum": { "type": "string", "description": "Numeric severity status code as a string. 1=Critical, 2=Attention, 3=Trouble, 4=Service Down, 5=Clear, 7=Unmanaged.\n" }, "suppressedMessage": { "type": "string", "description": "Suppression interval message. Present when isSuppressed is true." }, "addedTime": { "type": "string", "description": "Formatted timestamp of when the device was added to OpManager." }, "interfaceCount": { "type": "integer", "description": "Number of interfaces discovered on this device." }, "id": { "type": "string", "description": "String representation of the device MOID." }, "mapName": { "type": "string", "description": "Name of the map file this device belongs to (if applicable)." }, "category": { "type": "string", "description": "Device category (e.g., \"Server\", \"Switch\", \"Desktop\", \"Router\")." }, "status": { "type": "string", "description": "HTML-formatted status string with icon image tag. Example: \"Clear\"\n" } } }, "VirtualDeviceListResponse": { "type": "object", "description": "Paginated list response for virtual devices.", "properties": { "total": { "type": "integer", "description": "Total number of pages." }, "page": { "type": "integer", "description": "Current page number." }, "rows": { "type": "array", "description": "List of virtual device rows.", "items": { "$ref": "#/components/schemas/VirtualDeviceRow" } }, "records": { "type": "integer", "description": "Total number of matching records." } } } }, "parameters": { "defaultReportParams_bview": { "schema": { "description": "Filter report by business view. Use this to fetch data related to specific business view. MUST first call scheduleReportDefaultProps API to get current available business view values, then use the exact values from the API response to filter by organizational view/topology.", "type": "string" }, "in": "query", "name": "bview", "description": "", "required": false }, "NFA_Reports_Time_Params_EndTime": { "schema": { "description": "", "$ref": "#/components/schemas/DateTime_WithoutSeconds_regex" }, "in": "query", "name": "EndTime", "description": "", "required": false }, "defaultReportParams_logicalGroup": { "schema": { "description": "Filter report by device group. Always use this to filter and fetch data related to specific group. MUST first call scheduleReportDefaultProps Options API to get current available group values, then use the exact key from the API response to filter by logical device groupings. (Format of the logicalGroup identifier is 'GroupName-ID' (e.g., 'testGroup-1234')).", "$ref": "#/components/schemas/text_basic_symbols_two_byte_support_regex" }, "in": "query", "name": "logicalGroup", "description": "", "required": false }, "defaultReportParams_businessRuleID": { "schema": { "description": "ID of the previously created business rule, used to filter data within specific business hours. MUST first call scheduleReportDefaultProps API to get current available business rule, then use the exact values from the API response to filter by business rule.", "type": "integer" }, "in": "query", "name": "businessRuleID", "description": "", "required": false }, "defaultReportParams_fromTime": { "schema": { "description": "start time (Only if custom time period chosen for forecast trend report) in DD/MM/YYYY HH:MM format.", "$ref": "#/components/schemas/dateFormat_regex" }, "in": "query", "name": "fromTime", "description": "", "required": false }, "NFA_Reports_Time_Params_TimeFrame": { "schema": { "description": "", "$ref": "#/components/schemas/NFA_Report_TimeFrames_regex" }, "in": "query", "name": "TimeFrame", "description": "", "required": false }, "defaultReportParams_startTime": { "schema": { "description": "Start time of custom time period (only if custom time period is chosen) in YYYY-MM-DD format. Except for forecast trend report.", "$ref": "#/components/schemas/date_regex" }, "in": "query", "name": "startTime", "description": "", "required": false }, "defaultReportParams_time": { "schema": { "description": "Filter report by time period. Use available time period values for consistent filtering. Available values: 'onehour' (last 1 hour), 'twohours' (last 2 hours), 'fourhours' (last 4 hours), 'sixhours' (last 6 hours), 'eighthours' (last 8 hours), 'twelvehours' (last 12 hours), 'twfourhours' (last 24 hours), 'Today' (from 00:00 to current time today), 'Yesterday' (from 00:00 to 23:59 of previous day), 'Last_7_Days' (last 7 days), 'Last_30_Days' (last 30 days), 'Last_60_Days' (last 60 days), 'Last_90_Days' (last 90 days), 'thisweek' (current week), 'thismonth' (current month from 1st to today), 'This_Quarter' (current quarter), 'lastweek' (previous week), 'Last_Month' (previous complete month), 'Last_3_Months' (last 3 months), 'Last_6_Months' (last 6 months), 'Last_Quarter' (previous complete quarter), 'custom'(Custom Time Period).Additional Time Periods for Forecast Reports - 'Next_12_hours' (next 12 hours), 'Next_24_hours' (next 24 hours), 'Next_7_days' (next 7 days), 'Next_14_days' (next 14 days), 'Next_30_days' (next 30 days), 'Next_60_days' (next 60 days), 'Next_90_days' (next 90 days).", "$ref": "#/components/schemas/timePeriod_regex" }, "in": "query", "name": "time", "description": "", "required": false }, "defaultReportParams_timeWindow": { "schema": { "pattern": "^((\\d|1[0-9]|2[0-4])-(\\d|1[0-9]|2[0-4]))$", "description": "The time window to fetch the report data. '0-24' (Full 24 Hours), '8-20' (8:00 AM - 8:00 PM). MUST first call scheduleReportDefaultProps API to get current available time window, then use the exact values from the API response to filter by time window.", "type": "string" }, "in": "query", "name": "timeWindow", "description": "", "required": false }, "defaultReportParams_customerName": { "schema": { "description": "Used to filter data for a particular customer in MSP. Filtering data for all customers is not possible in MSP.In Enterprise Edition, this parameter represents the probe name. To fetch data for all probes, the value must be 'All Sites'. MUST first call getAllProbes API to get current available customer name, then use the exact values from the API response to filter by customer name.", "type": "string" }, "in": "query", "name": "customerName", "description": "", "required": false }, "defaultReportParams_viewAs": { "schema": { "description": "Format to view the resultant report data. Use 'json' format for API consumption.", "$ref": "#/components/schemas/defaultRepViewAs_regex" }, "in": "query", "name": "viewAs", "description": "", "required": true }, "NFADEparams_collOpt": { "schema": { "description": "NFA probe ID to be supplied if the device is accessed from NFA Central", "$ref": "#/components/schemas/NFA_Collector_ID_regex" }, "in": "query", "name": "collOpt", "description": "NFA probe ID to be supplied if the device is accessed from NFA Central", "required": false }, "defaultReportParams_endHour": { "schema": { "description": "End hour of custom time period (only if custom time period is chosen). Except for forecast trend report.", "type": "integer" }, "in": "query", "name": "endHour", "description": "", "required": false }, "defaultReportParams_reportID": { "schema": { "description": "Unique report identifier obtained from api/json/reports/getReportsList API. ALWAYS call getReportsList API first to get valid report IDs before using this API.", "$ref": "#/components/schemas/opmee_reportIdWithAudit_regex" }, "in": "query", "name": "reportID", "description": "", "required": false }, "defaultReportParams_excludedDays": { "schema": { "description": "The list of comma seperated day to be excluded in report data [Allowed values : Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday].", "$ref": "#/components/schemas/excludedDaysRegex_regex" }, "in": "query", "name": "excludedDays", "description": "", "required": false }, "defaultReportParams_customerId": { "schema": { "description": "Used to filter data for a particular customer in MSP. Filtering data for all customers is not possible in MSP.In Enterprise Edition, this parameter represents the probe ID. To fetch data for all probes, the value must be 0. MUST first call getAllProbes API to get current available customer id, then use the exact values from the API response to filter by customer id.", "type": "integer", "format": "int64" }, "in": "query", "name": "customerId", "description": "", "required": false }, "defaultReportParams_category": { "schema": { "description": "Filter report by device category such as 'Router', 'Switch', 'Server', 'Desktop', etc. MUST first call scheduleReportDefaultProps API to get current available category values, then use the exact values from the API response to filter by device categories.", "type": "string" }, "in": "query", "name": "category", "description": "", "required": false }, "defaultReportParams_endTime": { "schema": { "description": "End time of custom time period (only if custom time period is chosen) in YYYY-MM-DD format. Except for forecast trend report.", "$ref": "#/components/schemas/date_regex" }, "in": "query", "name": "endTime", "description": "", "required": false }, "defaultReportParams_toTime": { "schema": { "description": "end time (Only if custom time period chosen for forecast trend report) in DD/MM/YYYY HH:MM format.", "$ref": "#/components/schemas/dateFormat_regex" }, "in": "query", "name": "toTime", "description": "", "required": false }, "defaultReportParams_perfGroupId": { "schema": { "description": "Performance group ID for Trend Report (EX: 2 for Disk Utilization). MUST first call scheduleReportDefaultProps API to get current available perfGroupId, then use the exact values from the API response to filter by perfGroupId.", "type": "integer" }, "in": "query", "name": "perfGroupId", "description": "", "required": false }, "defaultReportParams_isBusinessHour": { "schema": { "description": "Boolean value that should be set to true when the report is filtered by businessRuleID.", "type": "boolean" }, "in": "query", "name": "isBusinessHour", "description": "", "required": false }, "NFADEparams_TimeZone": { "schema": { "description": "Any one standard time Zone Show Sub-Attributes", "$ref": "#/components/schemas/NFATimeZone_regex" }, "in": "query", "name": "TimeZone", "description": "", "required": false }, "defaultReportParams_cpResult": { "schema": { "pattern": "^(all|yes|no)$", "description": "Applicable only to the Capacity Planning report with possible values: All, Yes, and No. For example, in the Overutilized Devices report, selecting \u201cYes\u201d filters the results to display only overutilized devices.", "type": "string" }, "in": "query", "name": "cpResult", "description": "", "required": false }, "NFADEparams_reqFrm": { "schema": { "pattern": "CServ|CSConfUpdate", "description": "Used only for DE Setup. optional param.", "type": "string" }, "in": "query", "name": "reqFrm", "description": "", "required": false }, "NFA_Reports_Time_Params_StartTime": { "schema": { "description": "Time should be in the format YYYY-MM-DD HH:MM.", "$ref": "#/components/schemas/DateTime_WithoutSeconds_regex" }, "in": "query", "name": "StartTime", "description": "", "required": false }, "defaultReportParams_valueType": { "schema": { "description": "Applicable for only Trend Report. To get mimum or maximum or average value in Trend report [Allowed values : MINIMUM,MAXIMUM,AVERAGE].", "$ref": "#/components/schemas/valueTypeRegex_regex" }, "in": "query", "name": "valueType", "description": "", "required": false }, "defaultReportParams_startHour": { "schema": { "description": "Start hour of custom time period (only if custom time period is chosen). Except for forecast trend report.", "type": "integer" }, "in": "query", "name": "startHour", "description": "", "required": false }, "defaultReportParams_isExcludeDays": { "schema": { "description": "Boolean value that should be set to true when the report is filtered by excludedDays.", "type": "boolean" }, "in": "query", "name": "isExcludeDays", "description": "", "required": false } } } }