{ "openapi": "3.1.0", "info": { "version": "1.0", "title": "OpManager External APIs", "description": "This document consists of OpManager's External Apis" }, "servers": [ { "url": "https://{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.Events", "description": "APIs for listing and adding events in OpManager, the raw fault records generated across monitored resources that alarms are derived from." }, { "name": "OpManager.Devices", "description": "APIs for device monitoring & management in OpManager. Fetches the Device summary, Availability and performance data" }, { "name": "OpManager.Discovery", "description": "APIs for discovering and adding devices to OpManager for monitoring, including individual device and IPMI device discovery." }, { "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.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.NetworkPath", "description": "APIs related to NetworkPath Analysis management in OpManager." }, { "name": "OpManager.Wireless", "description": "APIs related to wireless management in OpManager." }, { "name": "OpManager.CustomFields", "description": "APIs related to custom fields in OpManager. Custom fields let you store additional user-defined information against devices and interfaces." }, { "name": "OpManager.Dashboard", "description": "APIs for retrieving OpManager dashboards and their widgets, including the raw JSON data rendered within each widget." }, { "name": "OpManager.Notifications", "description": "APIs for managing notification profiles in OpManager. Notification profiles define the actions triggered when an alarm is raised, and can be listed, associated with devices or groups, and enabled or disabled." }, { "name": "OpManager.Workflow", "description": "APIs related to Workflow management in OpManager." }, { "name": "OpManager.Availability", "description": "APIs for managing and retrieving availability information in OpManager." }, { "name": "OpManager.Monitoring", "description": "APIs for managing and retrieving monitoring information in OpManager." }, { "name": "OpManager.Settings", "description": "APIs for managing and retrieving OpManager settings." } ], "paths": { "/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": "To list alarm properties of the particular alarm", "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": "query", "name": "entity", "required": true, "description": "Entity of the alarm for which the alarm properties should be retrieved. This can be retrieved using the listAlarms API.", "schema": { "$ref": "#/components/schemas/entityText_regex" } } ], "tags": [ "OpManager.Alarms" ], "security": [ { "ApiKeyAuth": [] } ], "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": "100" }, "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\n**Note:** Advanced Reports are not supported by this API. Passing an Advanced Report ID returns error code 5050 (\"You are not authorized to perform this operation\"), which indicates the wrong endpoint rather than a permissions problem. Use getAdvancedReportData for Advanced Reports.", "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": [ { "name": "reportID", "in": "query", "required": true, "description": "Unique report identifier. This value can be retrieved from the id field in the getReportsList API response. Use the reserved value Audit to retrieve audit reports. If this parameter is omitted, the response returns a \"Data not available for the selected period\" message, which indicates a missing or invalid reportID, not a time-period problem.", "schema": { "type": "string", "pattern": "^[0-9]+$|^Audit$" } }, { "name": "viewAs", "in": "query", "required": true, "description": "Format of the report data returned. Use json for API consumption.", "schema": { "type": "string", "enum": [ "json" ] } }, { "name": "time", "in": "query", "required": false, "description": "Filters the report by a predefined time period. Applicable only to reports whose timeBased field is \"true\" in the getReportsList response. Forecast Reports additionally support: Next_12_hours, Next_24_hours, Next_7_days, Next_14_days, Next_30_days, Next_60_days, Next_90_days.", "schema": { "type": "string", "enum": [ "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", "custom", "Next_12_hours", "Next_24_hours", "Next_7_days", "Next_14_days", "Next_30_days", "Next_60_days", "Next_90_days" ] } }, { "name": "startTime", "in": "query", "required": false, "description": "Start date of the custom time period. Mandatory when time=custom for all reports except Forecast Trend Reports.", "schema": { "type": "string", "format": "date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, { "name": "endTime", "in": "query", "required": false, "description": "End date of the custom time period. Mandatory when time=custom for all reports except Forecast Trend Reports.", "schema": { "type": "string", "format": "date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, { "name": "startHour", "in": "query", "required": false, "description": "Start hour of the custom time period. Mandatory when time=custom for all reports except Forecast Trend Reports. A value of 24 returns error code OUT_OF_RANGE. To cover a full day, use startHour=0 and endHour=23.", "schema": { "type": "integer", "minimum": 0, "maximum": 23 } }, { "name": "endHour", "in": "query", "required": false, "description": "End hour of the custom time period. Mandatory when time=custom for all reports except Forecast Trend Reports. A value of 24 returns error code OUT_OF_RANGE. Note that this differs from timeWindow, which accepts 24 as its upper bound.", "schema": { "type": "integer", "minimum": 0, "maximum": 23 } }, { "name": "fromTime", "in": "query", "required": false, "description": "Start time of the custom time period for Forecast Trend Reports. Mandatory when time=custom for Forecast Trend Reports.", "schema": { "type": "string", "example": "11/06/2026 18:00" } }, { "name": "toTime", "in": "query", "required": false, "description": "End time of the custom time period for Forecast Trend Reports. Mandatory when time=custom for Forecast Trend Reports.", "schema": { "type": "string", "example": "11/06/2026 23:00" } }, { "name": "timeWindow", "in": "query", "required": false, "description": "Time window within each day for which report data is fetched. Format: startHour-endHour, where both values are within 0-24. Example: 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]))$", "example": "0-24" } }, { "name": "showType", "in": "query", "required": false, "description": "Controls the ordering or display mode used for Top-N reports. Pass this parameter explicitly whenever using top. Allowed values: 0 (all records), 1 (top N), 2 (bottom N). Default varies per report.", "schema": { "type": "integer", "enum": [ 0, 1, 2 ] } }, { "name": "top", "in": "query", "required": false, "description": "Number of records to return for Top-N reports. Ignored when showType=0. Applicable only to reports whose rangeBased field is \"true\". Always send showType=1 or showType=2 alongside this parameter, as some reports default to showType=0 and may silently return the full result set.", "schema": { "type": "integer" } }, { "name": "isExcludeDays", "in": "query", "required": false, "description": "When set to true, filters the report by excluding the configured days. Use together with excludedDays.", "schema": { "type": "boolean" } }, { "name": "excludedDays", "in": "query", "required": false, "description": "Comma-separated list of days to exclude from the report data. Values are case-sensitive and must not contain spaces after commas.", "schema": { "type": "string", "pattern": "^(?:Monday|Tuesday|Wednesday|Thursday|Friday|Saturday|Sunday)(?:,(?:Monday|Tuesday|Wednesday|Thursday|Friday|Saturday|Sunday))*$", "example": "Saturday,Sunday" } }, { "name": "category", "in": "query", "required": false, "description": "Filters the report by device category. This value can be retrieved from the getCategoryList API response, where the category corresponds to the key in the response object.", "schema": { "type": "string" } }, { "name": "logicalGroup", "in": "query", "required": false, "description": "Filters the report by device group. This value can be retrieved from the groupName field in the listAllLogicalGroups API response. Format: GroupName-ID.", "schema": { "type": "string", "example": "adg1-73509" } }, { "name": "bview", "in": "query", "required": false, "description": "Filters the report by Business View. This value can be retrieved from the name field in the getBusinessView API response.", "schema": { "type": "string" } }, { "name": "customerId", "in": "query", "required": false, "description": "For MSP Central, provide the target customer ID. For Enterprise Edition Central, provide the probe ID. Filtering across all customers is not supported. This value can be retrieved from the getAllProbes API response.", "schema": { "type": "integer" } } ], "tags": [ "OpManager.Reports" ], "security": [ { "ApiKeyAuth": [] } ], "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": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "This API is used to clear an Alarm.", "operationId": "clearAlarm", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlarmAckResponse" }, "examples": { "Example1": { "value": { "ackMessage": "Alarm has been successfully Cleared!", "AlarmProperty": { "Details": { "displayName": "sampleDeviceDisplayName", "cycleId": "4", "PRIORITY": "0", "source": "sampleDeviceName", "modTimeStr": "3 Jul 2026 04:07:07 PM IST", "alarmCode": "DEVICE-DOWN-CLEAR", "stringseverity": "Clear", "GROUPNAME": "", "id": "4", "createTimeStr": "2 Jul 2026 05:31:27 PM IST", "severity": "5", "WEBNMS": "", "eventType": "Device Down", "previousSeverity": "1", "priority": "0", "message": "Device Down: No response from device for last 5 polls", "OWNERNAME": "", "MAPNAME": "", "stage": "0", "modTime": "1783075027786", "createTime": "1782993687928", "pollid": "-1", "category": "Server", "entity": "sampleEntity_Poll", "who": "Unacknowledge", "status": "5" } } } } } } } } }, "parameters": [ { "in": "query", "name": "entity", "required": true, "description": "Entity of the alarm(s) that should be cleared. This can be retrieved using the listAlarms API. Comma-separated list of entity names to be cleared.", "schema": { "$ref": "#/components/schemas/entityText_regex" } } ], "tags": [ "OpManager.Alarms" ], "x-zenesis-sections": {}, "x-zenesis-doc": { "show": true }, "x-zenesis-envTags": [] } }, "/api/json/alarm/deleteAlarm": { "post": { "summary": "Delete Alarms", "x-zenesis-title": "Delete Alarms", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "This API is used to delete an alarm", "operationId": "deleteAlarm", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "", "properties": { "ackMessage": { "type": "string", "description": "" } } }, "examples": { "Example1": { "value": { "ackMessage": "Alarm has been successfully Deleted!" } } } } } } }, "parameters": [ { "in": "query", "name": "entity", "required": true, "description": "The entity of the alarm(s) that should be deleted. This can be retrieved using the listAlarms API. Comma-separated list of entity names to be deleted.", "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": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "This API is used to add notes to an alarm", "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": "query", "name": "entity", "required": true, "description": "The entity of the alarm(s) to which the notes should be added. This can be retrieved using the listAlarms API. Comma-separated list of entity names to which the notes should be added.", "schema": { "$ref": "#/components/schemas/entityText_regex" } }, { "in": "query", "name": "notes", "required": true, "description": "Notes description to be added.", "schema": { "$ref": "#/components/schemas/text_twoByteSupport_regex" } } ], "tags": [ "OpManager.Alarms" ], "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": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": {}, "description": "This API is used to acknowledge an alarm", "operationId": "acknowledgeAlarm", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlarmAckResponse" }, "examples": { "Example1": { "value": { "ackMessage": "Alarm has been successfully Acknowledged", "AlarmProperty": { "Details": { "displayName": "sampleDeviceDisplayName", "cycleId": "4", "PRIORITY": "0", "source": "sampleDeviceName", "modTimeStr": "2 Jul 2026 05:51:26 PM IST", "alarmCode": "DEVICE DOWN", "stringseverity": "Critical", "GROUPNAME": "", "id": "4", "createTimeStr": "2 Jul 2026 05:31:27 PM IST", "severity": "1", "WEBNMS": "", "eventType": "Device Down", "previousSeverity": "1", "priority": "0", "message": "Device Down: No response from device for last 5 polls", "OWNERNAME": "", "MAPNAME": "", "stage": "0", "modTime": "1782994886410", "createTime": "1782993687928", "pollid": "-1", "category": "Server", "entity": "sampleEntity_Poll", "who": "admin" } } } } } } } } }, "parameters": [ { "in": "query", "name": "entity", "required": true, "description": "Entity of the alarm(s) that should be acknowledged. This can be retrieved using the listAlarms API. Comma-separated list of entity names to be acknowledged.", "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": "This API is used to get notes of the alarms", "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": "query", "name": "entity", "required": true, "description": "The entity of the alarm for which the notes should be retrieved. This can be retrieved using the listAlarms API.", "schema": { "$ref": "#/components/schemas/entityText_regex" } } ], "tags": [ "OpManager.Alarms" ], "security": [ { "ApiKeyAuth": [] } ], "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": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "This API is used to unacknowledge an alarm", "operationId": "unAcknowledgeAlarm", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlarmAckResponse" }, "examples": { "Example1": { "value": { "ackMessage": "Alarm has been successfully UnAcknowledged", "AlarmProperty": { "Details": { "displayName": "sampleDeviceDisplayName", "cycleId": "4", "PRIORITY": "0", "source": "sampleDeviceName", "modTimeStr": "2 Jul 2026 05:51:26 PM IST", "alarmCode": "DEVICE DOWN", "stringseverity": "Critical", "GROUPNAME": "", "id": "4", "createTimeStr": "2 Jul 2026 05:31:27 PM IST", "severity": "1", "WEBNMS": "", "eventType": "Device Down", "previousSeverity": "1", "priority": "0", "message": "Device Down: No response from device for last 5 polls", "OWNERNAME": "", "MAPNAME": "", "stage": "0", "modTime": "1782994886410", "createTime": "1782993687928", "pollid": "-1", "category": "Server", "entity": "sampleEntity_Poll", "who": "Unacknowledge" } } } } } } } } }, "parameters": [ { "in": "query", "name": "entity", "required": true, "description": "Entity of the alarm(s) that should be unacknowledged. This can be retrieved using the listAlarms API. Comma-separated list of entity names to be acknowledged.", "schema": { "$ref": "#/components/schemas/entityText_regex" } } ], "tags": [ "OpManager.Alarms" ], "x-zenesis-sections": {}, "x-zenesis-doc": { "show": true }, "x-zenesis-envTags": [] } }, "/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. The first call with getColumnDetails=true returns metadata (row count, column headers). Subsequent calls fetch the data in batches of 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 } ] } }, "Example2": { "value": { "headers": [ "Device Name", "Availability (%)", "CPU Utilization $-$Min", "CPU Utilization $-$Max", "CPU Utilization $-$Avg", "Disk Utilization $-$Min", "Disk Utilization $-$Max", "Disk Utilization $-$Avg", "Memory Utilization $-$Min", "Memory Utilization $-$Max", "Memory Utilization $-$Avg" ], "total": 1, "groupByCount": 0, "records": 36, "deviceNameIndex": 0, "timePeriod": "Last_7_Days", "totalColumns": 5, "moduleId": "1", "groupHeader": [ { "startColumnName": "CPU Utilization $-$Min", "numberOfColumns": 3, "titleText": "CPU Utilization" }, { "startColumnName": "Disk Utilization $-$Min", "numberOfColumns": 3, "titleText": "Disk Utilization" }, { "startColumnName": "Memory Utilization $-$Min", "numberOfColumns": 3, "titleText": "Memory Utilization" } ] } } } } } } }, "parameters": [ { "name": "reportID", "in": "query", "required": true, "description": "Unique identifier of the Advanced Report. This value can be retrieved from the ReportId field in the listAllAdvancedReports API response.", "schema": { "type": "integer", "format": "int64" } }, { "name": "getColumnDetails", "in": "query", "required": false, "description": "Specifies whether to fetch only the report metadata (headers and row count) or the actual report data.", "schema": { "type": "boolean", "default": false } }, { "name": "fetchFromRowNumber", "in": "query", "required": false, "description": "Row number from which data fetching begins. Mandatory when getColumnDetails=false. Row index is 1-based and inclusive. This API can retrieve at most the first 100,000 rows of a report.", "schema": { "type": "integer", "minimum": 1, "maximum": 100000 } }, { "name": "rowsToFetch", "in": "query", "required": false, "description": "Number of rows to fetch in the current call. Mandatory when getColumnDetails=false. Values outside the allowed range return error code OUT_OF_RANGE.", "schema": { "type": "integer", "minimum": 1, "maximum": 1000 } }, { "name": "reportRequestId", "in": "query", "required": false, "description": "Identifier of a server-side report snapshot. Returned only for reports that contain performance or time-series data. When present in a response, pass it on all subsequent paginated calls for the same report to ensure optimal performance.", "schema": { "type": "integer", "format": "int64" } } ], "tags": [ "OpManager.Reports" ], "security": [ { "ApiKeyAuth": [] } ] } }, "/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": "100" }, "description": "Fetches all the Advanced Reports available on the server. Use this as the discovery API for Advanced Reports, then pass the returned ReportId to the getAdvancedReportData API to fetch the report's data.", "operationId": "listAllAdvancedReports", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "isAPMReport": { "type": "boolean", "description": "Indicates whether the report belongs to Applications Manager (APM)." }, "Description": { "type": "string", "description": "Description of the report." }, "isEdit": { "type": "boolean", "description": "Indicates whether the report can be edited." }, "isCustom": { "type": "boolean", "description": "Indicates whether the report is a custom report." }, "ReportId": { "type": "integer", "description": "Unique identifier of the report." }, "Name": { "type": "string", "description": "Display name of the report." } } } }, "examples": { "Example1": { "value": [ { "isAPMReport": false, "Description": "This report contains the summary of the discovered Devices.", "isEdit": true, "isCustom": false, "ReportId": 745, "Name": "Device Summary" }, { "isAPMReport": false, "Description": "This report contains the summary of the monitors associated with a device.", "isEdit": true, "isCustom": false, "ReportId": 746, "Name": "Device monitors summary" }, { "isAPMReport": false, "Description": "This report contains the summary of a device's credential.", "isEdit": true, "isCustom": false, "ReportId": 747, "Name": "Credential summary" }, { "isAPMReport": false, "Description": "This report contains the summary of the notification profiles associated with a device.", "isEdit": true, "isCustom": false, "ReportId": 748, "Name": "Notification profile summary" }, { "isAPMReport": false, "Description": "This report contains the summary of the custom fields of a device.", "isEdit": true, "isCustom": false, "ReportId": 749, "Name": "Device custom fields" }, { "isAPMReport": false, "Description": "This report contains the summary of the custom fields of an Interface.", "isEdit": true, "isCustom": false, "ReportId": 750, "Name": "Interface custom fields" }, { "isAPMReport": false, "Description": "This report contains the summary of performance data of the servers.", "isEdit": true, "isCustom": false, "ReportId": 751, "Name": "Server summary" } ] } } } } } }, "tags": [ "OpManager.Reports" ], "security": [ { "ApiKeyAuth": [] } ] } }, "/api/json/v2/device/getReportData": { "post": { "summary": "Graphical Reports - Get Data", "x-zenesis-title": "Graphical Reports - Get Data", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "100" }, "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. For standardized, pre-configured reports, use the getReportsData API instead.", "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": [ { "name": "deviceMOIDList", "in": "query", "required": true, "description": "Filters the performance report to specific devices. Provide a comma-separated list of device MOIDs retrieved from the moid field in the listDevices API response. An unknown or unauthorized MOID returns error code AUTHORIZATION_FAILED - verify the value before assuming a permissions problem. Numeric MOIDs only.", "schema": { "type": "string", "pattern": "^\\d+(,\\d+)*$", "example": "1111,2222,3333" } }, { "name": "monitorList", "in": "query", "required": true, "description": "Selects which performance metrics to analyze. Provide comma-separated policyName values retrieved from the fetchMonitorsList API. Values are case-sensitive and must be exact policyName strings. Available monitors vary by device and monitoring protocol. An unrecognized monitor name returns an empty object {} with HTTP 200 and no error message - if you receive {}, verify these values first.", "schema": { "type": "string", "example": "Packet_Loss,ResponseTime" } }, { "name": "view", "in": "query", "required": true, "description": "Format in which the report data is returned. graph returns time-series data points, table returns pre-aggregated min/avg/max rows per device. Use table when aggregates are needed rather than raw series.", "schema": { "type": "string", "enum": [ "graph", "table" ] } }, { "name": "graphReportType", "in": "query", "required": true, "description": "Graph report category for formatting and display options. Use Individual for device-specific graphs showing detailed performance metrics of individual monitors for particular devices.", "schema": { "type": "string", "enum": [ "Individual" ] } }, { "name": "timePeriod", "in": "query", "required": true, "description": "Filters the report by time period for the data range.", "schema": { "type": "string", "enum": [ "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", "custom" ] } }, { "name": "startDate", "in": "query", "required": false, "description": "Start date from which data is shown in the report. Applicable only when timePeriod=custom.", "schema": { "type": "string", "format": "date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, { "name": "startHour", "in": "query", "required": false, "description": "Hour of the start date from which data is shown in the report. Applicable only when timePeriod=custom.", "schema": { "type": "integer", "minimum": 0, "maximum": 23 } }, { "name": "endDate", "in": "query", "required": false, "description": "End date up to which data is shown in the report. Applicable only when timePeriod=custom.", "schema": { "type": "string", "format": "date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, { "name": "endHour", "in": "query", "required": false, "description": "Hour of the end date up to which data is shown in the report. Applicable only when timePeriod=custom.", "schema": { "type": "integer", "minimum": 0, "maximum": 23 } }, { "name": "timeWindow", "in": "query", "required": false, "description": "Time window within each day for which report data is fetched.", "schema": { "type": "string", "pattern": "^((\\d|1[0-9]|2[0-4])-(\\d|1[0-9]|2[0-4]))$" } }, { "name": "seriesType", "in": "query", "required": false, "description": "Specifies how time-series data is aggregated for each reporting interval. Defaults to AVG when omitted. Uppercase only.", "schema": { "type": "string", "enum": [ "AVG", "MAX", "MIN" ] } } ], "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-title": "Get Device Summary", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "500", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "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.", "operationId": "getDeviceSummary", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDeviceSummaryResponse" }, "examples": { "Example1": { "value": { "hardDiskSize": 149, "ramSize": 16384, "type": "Windows 2016", "ISHWMONITORED": false, "deviceName": "10.5.5.120", "moID": "277", "sysDescr": "", "sysName": "", "state": "1", "statusPollEnabled": true, "hardDiskSizeWithUnit": "149 GB", "dependency": "None", "displayCategory": "Server", "ipAddress": "10.5.5.120", "Encoding": "ISO-8859-1", "vendorName": "Microsoft", "statusNum": "3", "customLinks": [ { "URL": "https://manageengine.com", "NAME": "ManageEngineSite" } ], "parentCategory": "Server", "status": "Attention", "isSNMP": true, "deviceProtocol": "WMI", "statusStr": "Attention", "pollUsingIPorDNS": "PollUsingIP", "displayName": "OPM-Server38", "dnsName": "10.5.5.120", "availability": [ "UP,1782230446595,1782310606595,Up" ], "snmpport": "161", "pollPeriod": "60", "managed": "true", "deviceTypeID": 1156, "pollUsing": "ICMP", "responseTime": "001ms", "packetLoss": "0", "isNetwork": false, "isDevicePingable": "true", "category": "Server", "ramSizeWithUnit": "16 GB" } } } } } } }, "parameters": [ { "in": "query", "name": "name", "required": true, "description": "Internal name of the device, retrieved from the deviceName field in the listDevices API response.", "schema": { "type": "string", "maxLength": 100, "examples": [ "switch-10.5.5.1" ], "description": "" } } ], "tags": [ "OpManager.Devices" ], "x-zenesis-doc": { "show": true } } }, "/api/json/alarm/listAlarms": { "get": { "summary": "Get Alarms and Incidents Data", "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "This API is used to list all the alarms generated in OpManager.", "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": " Critical", "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": " Clear", "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": " Clear", "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": "query", "name": "deviceName", "required": false, "description": "Name of the device for which the alarms should be listed. To obtain this value, execute the listDevices API and use the deviceName value from the response.", "schema": { "type": "string", "description": "" } }, { "in": "query", "name": "severity", "required": false, "description": "Severity of the alarm. Allowed values: 1 (Critical), 2 (Trouble), 3 (Attention), 4 (Service Down), 5 (Clear)", "schema": { "$ref": "#/components/schemas/numberWithComma_regex" } }, { "in": "query", "name": "category", "required": false, "description": "Category of the device.", "schema": { "$ref": "#/components/schemas/opmee_category_regex" } }, { "in": "query", "name": "alertType", "required": false, "description": "Type of the alarms.", "schema": { "type": "string", "enum": [ "ActiveAlarms", "EventLogAlarms", "SyslogAlarms", "TrapAlarms", "NCMAlarms", "NFAAlarms", "WebAlarms", "FWAAlarms", "StorageAlarms", "APMAlarms", "Server", "Network", "Virtualization", "CorrelatedAlarms" ], "description": "" } }, { "in": "query", "name": "fromTime", "required": false, "description": "Start time for the custom time period range. It could be of the format yyyy-mm-dd or yyyy-mm-dd hh:mm:ss. If no time is specified (i.e, yyyy-mm-dd format), the default time will be set to 12 A.M(start of the day). (e.g., fromTime=2022-05-02 08:00:00)", "schema": { "$ref": "#/components/schemas/opmee_dateWithOptionalTime_regex" } }, { "in": "query", "name": "toTime", "required": false, "description": "End time for the custom time period range. It could be of the format yyyy-mm-dd or yyyy-mm-dd hh:mm:ss. If no time is specified (i.e, yyyy-mm-dd format), the default time will be set to 12 A.M(start of the day). (e.g., toTime=2022-06-02 18:30:00)", "schema": { "$ref": "#/components/schemas/opmee_dateWithOptionalTime_regex" } }, { "in": "query", "name": "probeName", "required": false, "description": "The name of the Probe. The probe name could be obtained by executing the listProbes API ,where the parameter name in the response refers to the probeName.[Applicable only for Central Server]", "schema": { "$ref": "#/components/schemas/probeNameRegex_regex" } } ], "tags": [ "OpManager.Alarms" ], "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-sections": {}, "x-zenesis-doc": { "show": true }, "x-zenesis-envTags": [], "x-zenesis-title": "Get Alarms and Incidents Data" } }, "/api/json/alarm/updateAlarmNote": { "post": { "summary": "Update Alarm Notes", "x-zenesis-title": "Update Alarm Notes", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "This API is used to update notes for an alarm", "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": "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": "ID of the note to be updated. This can be retrieved using the getAnnotation API.", "schema": { "type": "integer", "format": "int64", "description": "" } } ], "tags": [ "OpManager.Alarms" ], "x-zenesis-sections": {}, "x-zenesis-doc": { "show": true }, "x-zenesis-envTags": [] } }, "/api/json/device/ConfigureSuppressAlarm": { "post": { "summary": "Configure Suppress Alarm", "x-zenesis-title": "Configure Suppress Alarm", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "This API is used to suppress alarms for a specific device.", "operationId": "ConfigureSuppressAlarm", "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 Suppression rule has been added successfully" } } } } } } } }, "parameters": [ { "in": "query", "name": "name", "required": true, "description": "Name of the device to be suppressed. To obtain this value, execute the listDevices API and use the deviceName value from the response.", "schema": { "type": "string", "maxLength": 100, "description": "" } }, { "in": "query", "name": "suppressInterval", "required": true, "description": "The time period during which the device should be suppressed. Allowed values: 0 (never), -1 (forever), 3600000 (1 hour), 7200000 (2 hours), 28800000 (8 hours), 43200000 (12 hours), 86400000 (1 day), 604800000 (7 days), -2 (Custom Time Period - For Custom Time Period, specify the startTime and endTime parameters in the format YYYY-MM-DD HH:MM)", "schema": { "type": "string", "enum": [ "0", "-1", "3600000", "7200000", "28800000", "43200000", "86400000", "604800000", "-2" ], "description": "" } }, { "in": "query", "name": "startTime", "required": false, "description": "Alarm suppression start time in YYYY-MM-DD HH:MM format. This To be specified only for suppressInterval=-2.", "schema": { "$ref": "#/components/schemas/DateTime_WithoutSeconds_regex" } }, { "in": "query", "name": "endTime", "required": false, "description": "Alarm suppression end time in YYYY-MM-DD HH:MM format. To be specified only for suppressInterval=-2.", "schema": { "$ref": "#/components/schemas/DateTime_WithoutSeconds_regex" } } ], "tags": [ "OpManager.Alarms" ], "x-zenesis-sections": {}, "x-zenesis-doc": { "show": true }, "x-zenesis-envTags": [] } }, "/api/json/device/GetSuppressAlarmDetails": { "get": { "summary": "Get Suppress Alarm Details", "x-zenesis-title": "Get Suppress Alarm Details", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "description": "This API is used to retrieve the suppression details for a specific device.", "operationId": "GetSuppressAlarmDetails", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "", "properties": { "List": { "type": "array", "description": "", "items": { "type": "object", "description": "", "properties": { "configID": { "type": "integer", "description": "" }, "LASTUPDATEDTIME": { "type": "integer", "format": "int64", "description": "" }, "startTime": { "type": "string", "description": "" }, "endTime": { "type": "string", "description": "" }, "userName": { "type": "string", "description": "" }, "message": { "type": "string", "description": "" }, "userProfile": { "type": "string", "description": "" }, "suppressInterval": { "type": "string", "description": "" } } } } } }, "examples": { "Example1": { "value": { "List": [ { "configID": 303, "LASTUPDATEDTIME": 1784205484763, "startTime": "16 Jul 2026 06:08:04 PM IST", "endTime": "16 Jul 2026 07:08:04 PM IST", "userName": "admin", "message": "Alarms are suppressed till : 16 Jul 2026 07:08:04 PM IST", "userProfile": "\\apiclient\\fluidicv2\\img\\profile.png", "suppressInterval": "3600000" } ] } } } } } } }, "parameters": [ { "in": "query", "name": "name", "required": true, "description": "Name of the device for which suppression details are to be retrieved. To obtain this value, execute the listDevices API and use the deviceName value from the response.", "schema": { "type": "string", "maxLength": 100, "description": "" } } ], "tags": [ "OpManager.Alarms" ], "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": { "duration": "1M", "lock-period": "1M", "threshold": "100" }, "description": "Retrieves a categorized list of all available default and custom reports across areas like performance, availability and inventory. Returns report metadata and access details, not actual report data. Use this as a discovery API to identify reports and then fetch their data via the getReportsData API.\n\n**Note:** Advanced Reports are not included in this response. Use listAllAdvancedReports to enumerate Advanced Reports and getAdvancedReportData to fetch their data.", "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": [ { "name": "isFavouriteNeeded", "in": "query", "required": false, "description": "When set to true, favorite reports are listed under a separate report type labeled \"My Favorites\".", "schema": { "type": "boolean" } } ], "tags": [ "OpManager.Reports" ], "security": [ { "ApiKeyAuth": [] } ], "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": "This API is to list all the probes, and the probe's details configured in the central.(Note: This API is applicable only for central server)", "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" } ] } } } } } }, "tags": [ "OpManager.Enterprise" ], "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-sections": {}, "x-zenesis-doc": { "show": true }, "x-zenesis-envTags": [] } }, "/api/json/v2/device/listDevices": { "get": { "summary": "List all monitored devices (v2)", "x-zenesis-title": "List Devices v2", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "500", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Lists all devices monitored by OpManager.", "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": [ { "name": "page", "schema": { "$ref": "#/components/schemas/dt_page_regex", "description": "" }, "description": "Used along with the rows parameter to fetch data in batches. Example: page=1&rows=100", "in": "query", "required": false }, { "name": "rows", "schema": { "$ref": "#/components/schemas/dt_page_regex", "description": "" }, "description": "Number of rows to fetch in the current batch. Example: page=1&rows=100.\n", "in": "query", "required": false } ], "tags": [ "OpManager.Devices" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/fetchMonitorsList": { "post": { "summary": "Get Available Performance Monitors", "x-zenesis-title": "Get Available Performance Monitors", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": {}, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Retrieve the list of monitors configured for one or more devices in OpManager. By providing the device name(s), the API returns the monitors associated with those devices.", "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" } ] } } } } } }, "parameters": [ { "in": "query", "name": "deviceList", "required": true, "description": "Internal name of the device used to uniquely identify it. Multiple device names can be specified as a comma-separated list. This value can be retrieved from the deviceName field in the listDevices API response.", "schema": { "type": "string", "description": "" } } ], "tags": [ "OpManager.Devices" ], "x-zenesis-doc": { "show": true } } }, "/api/json/admin/getDowntimeSchedule": { "get": { "summary": "Get Downtime Schedule Details", "x-zenesis-title": "Get Downtime Schedule Details", "security": [ { "ApiKeyAuth": [] } ], "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.", "operationId": "getDowntimeSchedule", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "description": "Downtime schedule details.", "properties": { "scheduleName": { "type": "string", "description": "Name of the downtime schedule." }, "onceonly_to_mins_sel": { "type": "string", "pattern": "^[0-5][0-9]$", "description": "Minute value for the once-only schedule end time." }, "once_endat": { "type": "string", "format": "date", "description": "End date for the once-only schedule." }, "daily_effectfrom": { "type": "string", "format": "date", "description": "Date from which the daily schedule becomes effective." }, "daily_to_hrs_sel": { "type": "string", "pattern": "^([01][0-9]|2[0-3])$", "description": "Hour value for the daily schedule end time." }, "MS_INSTANCEID": { "type": "string", "description": "Maintenance schedule instance ID." }, "onceonly_from_hrs_sel": { "type": "string", "pattern": "^([01][0-9]|2[0-3])$", "description": "Hour value for the once-only schedule start time." }, "editable": { "type": "boolean", "description": "Whether the schedule is editable by the current user." }, "onceonly_from_mins_sel": { "type": "string", "pattern": "^[0-5][0-9]$", "description": "Minute value for the once-only schedule start time." }, "serverTimeZone": { "type": "string", "description": "Server's current timezone." }, "businessviewsCount": { "type": "string", "description": "Number of associated business views." }, "recurrence": { "type": "string", "description": "Recurrence type of the downtime schedule.", "enum": [ "OnceOnly", "Daily", "Weekly", "Monthly" ] }, "manageScheduleID": { "type": "integer", "description": "Manage schedule ID." }, "scheduleDesc": { "type": "string", "description": "Description of the downtime schedule." }, "suppressType": { "type": "string", "description": "Type of suppression.", "enum": [ "Alarm", "Monitoring" ] }, "daily_to_mins_sel": { "type": "string", "pattern": "^[0-5][0-9]$", "description": "Minute value for the daily schedule end time." }, "selectDevicesMethod": { "type": "string", "description": "Method used to select devices for the schedule." }, "selectedTimeZone": { "type": "string", "description": "Timezone selected for the downtime schedule." }, "daily_from_hrs_sel": { "type": "string", "pattern": "^([01][0-9]|2[0-3])$", "description": "Hour value for the daily schedule start time." }, "once_startat": { "type": "string", "format": "date", "description": "Start date for the once-only schedule." }, "selectedLogicalGroups": { "type": "object", "description": "Logical groups selected for the downtime schedule.", "additionalProperties": { "type": "string" } }, "unmanageScheduleID": { "type": "integer", "description": "Unmanage schedule ID." }, "daily_from_mins_sel": { "type": "string", "pattern": "^[0-5][0-9]$", "description": "Minute value for the daily schedule start time." }, "status": { "type": "string", "description": "Current status of the downtime schedule.", "enum": [ "Enabled", "Disabled" ] }, "onceonly_to_hrs_sel": { "type": "string", "pattern": "^([01][0-9]|2[0-3])$", "description": "Hour value for the once-only schedule end time." } } }, "examples": { "Example1": { "value": { "scheduleName": "Server Maintenance", "onceonly_to_mins_sel": "00", "once_endat": "2026-06-15", "daily_effectfrom": "2026-06-15", "daily_to_hrs_sel": "22", "MS_INSTANCEID": "67", "onceonly_from_hrs_sel": "21", "editable": true, "onceonly_from_mins_sel": "00", "serverTimeZone": "Asia/Calcutta", "businessviewsCount": "109", "recurrence": "OnceOnly", "manageScheduleID": 154, "scheduleDesc": "Schedule for server maintenance activities.", "suppressType": "Monitoring", "daily_to_mins_sel": "00", "selectDevicesMethod": "GROUP", "selectedTimeZone": "Asia/Calcutta", "daily_from_hrs_sel": "21", "once_startat": "2026-06-15", "selectedLogicalGroups": { "ServerGroup-127067": "ServerGroup", "NonProduction-33177": "NonProduction" }, "unmanageScheduleID": 155, "daily_from_mins_sel": "00", "status": "Enabled", "onceonly_to_hrs_sel": "22" } } } } } } }, "parameters": [ { "in": "query", "name": "scheduleName", "required": true, "description": "Name of the downtime schedule to retrieve. This value can be fetched from the 'name' param in the listDownTimeSchedules API response.", "schema": { "$ref": "#/components/schemas/ScheduleName_regex" } } ], "tags": [ "OpManager.Availability" ], "x-zenesis-doc": { "show": true } } }, "/api/json/admin/addDowntimeSchedule": { "post": { "summary": "Add Downtime Schedule", "x-zenesis-title": "Add Downtime Schedule", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "50", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Allows you to schedule downtimes for groups and devices.", "operationId": "addDowntimeSchedule", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DowntimeScheduleResult" }, "examples": { "Example1": { "value": { "result": { "message": "Downtime Scheduler has been added successfully.", "scheduleID": 7 } } } } } } }, "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 50 requests per minute. Exceeding this limit will block requests for 1 minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "parameters": [ { "in": "query", "name": "operation", "required": true, "description": "Set operation=Add by default", "schema": { "type": "string", "enum": [ "Add" ] } }, { "in": "query", "name": "scheduleName", "required": true, "description": "Name of the downtime schedule", "schema": { "$ref": "#/components/schemas/ScheduleName_regex" } }, { "in": "query", "name": "status", "required": true, "description": "Set status=Enabled by default.", "schema": { "type": "string", "enum": [ "Enabled", "Disabled" ] } }, { "in": "query", "name": "scheduleDesc", "required": false, "description": "Downtime schedule description", "schema": { "$ref": "#/components/schemas/text_basic_symbols_two_byte_support_regex" } }, { "in": "query", "name": "selectDevicesMethod", "required": true, "description": "Set selectDevicesMethod=Device to choose devices\nSet selectDevicesMethod=BV to choose Business View\nSet selectDevicesMethod=Category to choose Category\nSet selectDevicesMethod=GROUP to choose Groups\nSet selectDevicesMethod=URL to choose URLs\nSet selectDevicesMethod=CSV to choose CSVs", "schema": { "$ref": "#/components/schemas/devicesMethod_regex" } }, { "in": "query", "name": "selectedCateg", "required": false, "description": "Device category (applicable only if selectDevicesMethod is 'Category'). Can be obtained from the getCategoryList API response", "schema": { "$ref": "#/components/schemas/entityText_regex" } }, { "in": "query", "name": "selectedBV", "required": false, "description": "Internal name of the Business view (applicable only if selectDevicesMethod is 'BV'). This can be retrieved from the name field in the getBusinessView API response", "schema": { "$ref": "#/components/schemas/entityText_regex" } }, { "in": "query", "name": "selectedDevices", "required": false, "description": "Name of the device (comma-separated values). Applicable only if the selectDevicesMethod is 'Device')\nThis can be retrieved from the deviceName field in the listDevices API response", "schema": { "$ref": "#/components/schemas/entityText_regex" } }, { "in": "query", "name": "selectedURL", "required": false, "description": "URL Monitor name (applicable only if selectDevicesMethod is 'URLs'). This can be retrieved from the name field in the listURLMonitors API response.", "schema": { "$ref": "#/components/schemas/entityText_regex" } }, { "in": "query", "name": "selectedLogicalGroups", "required": false, "description": "Device Group name (comma-separated values). (applicable only if selectDevicesMethod is 'Group').\nThis can be retrieved from the groupName field in the listAllLogicalGroups API response.", "schema": { "$ref": "#/components/schemas/entityText_regex" } }, { "in": "query", "name": "mailID", "required": false, "description": "Email id to which the report should be sent", "schema": { "type": "string", "format": "email" } }, { "in": "query", "name": "suppressType", "required": false, "description": "Set suppressType=Monitoring to move the devices/groups/Business Views to the unmanaged state. Set suppressType=Alarm to suppress the alarms of the selected devices/groups/Business Views.", "schema": { "$ref": "#/components/schemas/DowntimeSuppressType_regex" } }, { "in": "query", "name": "timeZone", "required": false, "description": "Time zone of the location used to calculate the start and end time values in the request.", "schema": { "$ref": "#/components/schemas/NFATimeZone_regex" } }, { "in": "query", "name": "recurrence", "required": true, "description": "Recurrence of the downtime schedule.\n- Set recurrence=OnceOnly to run the downtime schedule a single time between a specific start and end date/time.\n- Set recurrence=Daily to run the downtime schedule every day.\n- Set recurrence=Weekly to run the downtime schedule on selected days of the week.\n- Set recurrence=Monthly to run the downtime schedule on a monthly basis (by date or by weekday pattern).", "schema": { "$ref": "#/components/schemas/DowntimeRecurrence_regex" } }, { "in": "query", "name": "once_starttime", "required": false, "description": "The date and time at which the downtime schedule should start running (applicable only if recurrence is 'OnceOnly'). Example: 2026-08-11 20:58", "schema": { "$ref": "#/components/schemas/DateTime_WithoutSeconds_regex" } }, { "in": "query", "name": "once_endtime", "required": false, "description": "The date and time at which the downtime schedule should stop running (applicable only if recurrence is 'OnceOnly'). Example: 2026-08-11 23:58", "schema": { "$ref": "#/components/schemas/DateTime_WithoutSeconds_regex" } }, { "in": "query", "name": "daily_offsetfrom", "required": false, "description": "Downtime schedule start date & time (applicable only if recurrence is 'Daily'). Example: 2026-08-11", "schema": { "$ref": "#/components/schemas/date_regex" } }, { "in": "query", "name": "from_time", "required": false, "description": "The time of day at which the downtime schedule should start running (applicable only if recurrence is 'Daily' or 'Weekly'). Allowed values: 00:00-23:59 (hours 00-23, minutes 00-59)", "schema": { "$ref": "#/components/schemas/TimeOfDay_HHMM_regex" } }, { "in": "query", "name": "to_time", "required": false, "description": "The time of day at which the downtime schedule should stop running (applicable only if recurrence is 'Daily' or 'Weekly'). Allowed values: 00:00-23:59 (hours 00-23, minutes 00-59)", "schema": { "$ref": "#/components/schemas/TimeOfDay_HHMM_regex" } }, { "in": "query", "name": "startday", "required": false, "description": "The day on which the downtime schedule should start running.\n- For recurrence='Weekly', the day of the week. Allowed values: Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday\n- For recurrence='Monthly' with monthlyType='monthlyDate', the day of the month. Allowed values: 1-31", "schema": { "oneOf": [ { "$ref": "#/components/schemas/DayOfWeek_regex" }, { "type": "integer", "minimum": 1, "maximum": 31 } ] } }, { "in": "query", "name": "endday", "required": false, "description": "The day on which the downtime schedule should stop running.\n- For recurrence='Weekly', the day of the week. Allowed values: Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday\n- For recurrence='Monthly' with monthlyType='monthlyDate', the day of the month. Allowed values: 1-31", "schema": { "oneOf": [ { "$ref": "#/components/schemas/DayOfWeek_regex" }, { "type": "integer", "minimum": 1, "maximum": 31 } ] } }, { "in": "query", "name": "monthlyType", "required": false, "description": "Determines whether startday/endday or weekOfMonth/weekday are used (applicable only if recurrence is 'Monthly')", "schema": { "type": "string", "enum": [ "monthlyDate", "monthlyDay" ] } }, { "in": "query", "name": "weekOfMonth", "required": false, "description": "The week of the month on which the downtime schedule should run (only if monthlyType='monthlyDay')", "schema": { "type": "string", "enum": [ "First", "Second", "Third", "Fourth", "Last" ] } }, { "in": "query", "name": "weekday", "required": false, "description": "The day of the week on which the downtime schedule should run (only if monthlyType='monthlyDay')", "schema": { "$ref": "#/components/schemas/DayOfWeek_regex" } }, { "in": "query", "name": "from_hrs", "required": false, "description": "The hour of the day at which the downtime schedule should start running (applicable only if recurrence is 'Monthly'). Allowed values: 00-23", "schema": { "type": "integer", "minimum": 0, "maximum": 23 } }, { "in": "query", "name": "to_hrs", "required": false, "description": "The hour of the day at which the downtime schedule should stop running (applicable only if recurrence is 'Monthly'). Allowed values: 00-23", "schema": { "type": "integer", "minimum": 0, "maximum": 23 } }, { "in": "query", "name": "from_mins", "required": false, "description": "The minute of the hour at which the downtime schedule should start running (applicable only if recurrence is 'Monthly'). Allowed values: 00-59", "schema": { "type": "integer", "minimum": 0, "maximum": 59 } }, { "in": "query", "name": "to_mins", "required": false, "description": "The minute of the hour at which the downtime schedule should stop running (applicable only if recurrence is 'Monthly'). Allowed values: 00-59", "schema": { "type": "integer", "minimum": 0, "maximum": 59 } } ], "tags": [ "OpManager.Availability" ], "x-zenesis-doc": { "show": true } } }, "/api/json/admin/updateDowntimeSchedule": { "post": { "summary": "Update Downtime Schedule", "x-zenesis-title": "Update Downtime Schedule", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "50", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Used to update downtime schedule.", "operationId": "updateDowntimeSchedule", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DowntimeScheduleResult" }, "examples": { "Example1": { "value": { "result": { "message": "Downtime Scheduler has been updated successfully." } } } } } } }, "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 50 requests per minute. Exceeding this limit will block requests for 1 minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "parameters": [ { "in": "query", "name": "MS_INSTANCEID", "required": true, "description": "Downtime schedule ID. Can be obtained from the id field in the listDownTimeSchedules API response", "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "scheduleId", "required": true, "description": "Downtime schedule ID. Can be obtained from the id field in the listDownTimeSchedules API response", "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "operation", "required": true, "description": "Set operation=Edit by default", "schema": { "type": "string", "enum": [ "Edit" ] } }, { "in": "query", "name": "scheduleName", "required": true, "description": "Name of the downtime schedule", "schema": { "$ref": "#/components/schemas/ScheduleName_regex" } }, { "in": "query", "name": "status", "required": true, "description": "Set status=Enabled by default.", "schema": { "type": "string", "enum": [ "Enabled", "Disabled" ] } }, { "in": "query", "name": "scheduleDesc", "required": true, "description": "Downtime schedule description", "schema": { "$ref": "#/components/schemas/text_basic_symbols_two_byte_support_regex" } }, { "in": "query", "name": "selectDevicesMethod", "required": true, "description": "Set selectDevicesMethod=Device to choose devices\nSet selectDevicesMethod=BV to choose Business View\nSet selectDevicesMethod=Category to choose Category\nSet selectDevicesMethod=GROUP to choose Groups\nSet selectDevicesMethod=URL to choose URLs\nSet selectDevicesMethod=CSV to choose CSVs", "schema": { "$ref": "#/components/schemas/devicesMethod_regex" } }, { "in": "query", "name": "selectedCateg", "required": false, "description": "Device category (applicable only if selectDevicesMethod is 'Category'). Can be obtained from the getCategoryList API response", "schema": { "$ref": "#/components/schemas/entityText_regex" } }, { "in": "query", "name": "selectedBV", "required": false, "description": "Internal name of the Business view (applicable only if selectDevicesMethod is 'BV'). This can be retrieved from the name field in the getBusinessView API response", "schema": { "$ref": "#/components/schemas/entityText_regex" } }, { "in": "query", "name": "selectedDevices", "required": false, "description": "Name of the device (comma-separated values). Applicable only if the selectDevicesMethod is 'Device')\nThis can be retrieved from the deviceName field in the listDevices API response", "schema": { "$ref": "#/components/schemas/entityText_regex" } }, { "in": "query", "name": "selectedURL", "required": false, "description": "URL Monitor name (applicable only if selectDevicesMethod is 'URLs'). This can be retrieved from the name field in the listURLMonitors API response.", "schema": { "$ref": "#/components/schemas/entityText_regex" } }, { "in": "query", "name": "selectedLogicalGroups", "required": false, "description": "Device Group name (comma-separated values). (applicable only if selectDevicesMethod is 'Group').\nThis can be retrieved from the groupName field in the listAllLogicalGroups API response.", "schema": { "$ref": "#/components/schemas/entityText_regex" } }, { "in": "query", "name": "mailID", "required": false, "description": "Email id to which the report should be sent", "schema": { "type": "string", "format": "email" } }, { "in": "query", "name": "suppressType", "required": false, "description": "Set suppressType=Monitoring to move the devices/groups/Business Views to the unmanaged state. Set suppressType=Alarm to suppress the alarms of the selected devices/groups/Business Views.", "schema": { "$ref": "#/components/schemas/DowntimeSuppressType_regex" } }, { "in": "query", "name": "timeZone", "required": false, "description": "Time zone of the location used to calculate the start and end time values in the request.", "schema": { "$ref": "#/components/schemas/NFATimeZone_regex" } }, { "in": "query", "name": "recurrence", "required": true, "description": "Recurrence of the downtime schedule.\n- Set recurrence=OnceOnly to run the downtime schedule a single time between a specific start and end date/time.\n- Set recurrence=Daily to run the downtime schedule every day.\n- Set recurrence=Weekly to run the downtime schedule on selected days of the week.\n- Set recurrence=Monthly to run the downtime schedule on a monthly basis (by date or by weekday pattern).", "schema": { "$ref": "#/components/schemas/DowntimeRecurrence_regex" } }, { "in": "query", "name": "once_starttime", "required": false, "description": "The date and time at which the downtime schedule should start running (applicable only if recurrence is 'OnceOnly'). Example: 2026-08-11 20:58", "schema": { "$ref": "#/components/schemas/DateTime_WithoutSeconds_regex" } }, { "in": "query", "name": "once_endtime", "required": false, "description": "The date and time at which the downtime schedule should stop running (applicable only if recurrence is 'OnceOnly'). Example: 2026-08-11 23:58", "schema": { "$ref": "#/components/schemas/DateTime_WithoutSeconds_regex" } }, { "in": "query", "name": "daily_offsetfrom", "required": false, "description": "Downtime schedule start date & time (applicable only if recurrence is 'Daily'). Example: 2026-08-11", "schema": { "$ref": "#/components/schemas/date_regex" } }, { "in": "query", "name": "from_time", "required": false, "description": "The time of day at which the downtime schedule should start running (applicable only if recurrence is 'Daily' or 'Weekly'). Allowed values: 00:00-23:59 (hours 00-23, minutes 00-59)", "schema": { "$ref": "#/components/schemas/TimeOfDay_HHMM_regex" } }, { "in": "query", "name": "to_time", "required": false, "description": "The time of day at which the downtime schedule should stop running (applicable only if recurrence is 'Daily' or 'Weekly'). Allowed values: 00:00-23:59 (hours 00-23, minutes 00-59)", "schema": { "$ref": "#/components/schemas/TimeOfDay_HHMM_regex" } }, { "in": "query", "name": "startday", "required": false, "description": "The day on which the downtime schedule should start running.\n- For recurrence='Weekly', the day of the week. Allowed values: Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday\n- For recurrence='Monthly' with monthlyType='monthlyDate', the day of the month. Allowed values: 1-31", "schema": { "oneOf": [ { "$ref": "#/components/schemas/DayOfWeek_regex" }, { "type": "integer", "minimum": 1, "maximum": 31 } ] } }, { "in": "query", "name": "endday", "required": false, "description": "The day on which the downtime schedule should stop running.\n- For recurrence='Weekly', the day of the week. Allowed values: Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday\n- For recurrence='Monthly' with monthlyType='monthlyDate', the day of the month. Allowed values: 1-31", "schema": { "oneOf": [ { "$ref": "#/components/schemas/DayOfWeek_regex" }, { "type": "integer", "minimum": 1, "maximum": 31 } ] } }, { "in": "query", "name": "monthlyType", "required": false, "description": "Determines whether startday/endday or weekOfMonth/weekday are used (applicable only if recurrence is 'Monthly')", "schema": { "type": "string", "enum": [ "monthlyDate", "monthlyDay" ] } }, { "in": "query", "name": "weekOfMonth", "required": false, "description": "The week of the month on which the downtime schedule should run (only if monthlyType='monthlyDay')", "schema": { "type": "string", "enum": [ "First", "Second", "Third", "Fourth", "Last" ] } }, { "in": "query", "name": "weekday", "required": false, "description": "The day of the week on which the downtime schedule should run (only if monthlyType='monthlyDay')", "schema": { "$ref": "#/components/schemas/DayOfWeek_regex" } }, { "in": "query", "name": "from_hrs", "required": false, "description": "The hour of the day at which the downtime schedule should start running (applicable only if recurrence is 'Monthly'). Allowed values: 00-23", "schema": { "type": "integer", "minimum": 0, "maximum": 23 } }, { "in": "query", "name": "to_hrs", "required": false, "description": "The hour of the day at which the downtime schedule should stop running (applicable only if recurrence is 'Monthly'). Allowed values: 00-23", "schema": { "type": "integer", "minimum": 0, "maximum": 23 } }, { "in": "query", "name": "from_mins", "required": false, "description": "The minute of the hour at which the downtime schedule should start running (applicable only if recurrence is 'Monthly'). Allowed values: 00-59", "schema": { "type": "integer", "minimum": 0, "maximum": 59 } }, { "in": "query", "name": "to_mins", "required": false, "description": "The minute of the hour at which the downtime schedule should stop running (applicable only if recurrence is 'Monthly'). Allowed values: 00-59", "schema": { "type": "integer", "minimum": 0, "maximum": 59 } } ], "tags": [ "OpManager.Availability" ], "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": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "100", "lock-period": "1M" }, "description": "Retrieves the list of all devices associated with the specified Business View, along with summary information for each device.", "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": { "BusinessDetailsView": { "type": "object", "description": "Contains the devices associated with the requested Business View.", "properties": { "Details": { "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 of the device. 1=Critical, 2=Trouble, 3=Attention, 4=Service Down, 5=Clear." }, "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." }, "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 (for example, the vendor or model information)." }, "status": { "type": "string", "description": "Severity status string of the device (for example, \"Critical\", \"Clear\")." } } } }, "TotalRecords": { "type": "string", "description": "Total number of devices in the Business View." } } } } }, "examples": { "Example1": { "value": { "BusinessDetailsView": { "Details": [ { "severity": "5", "CPUUtilization": 31, "MemUtilization": 81, "displayName": "xxx.xxx.xx.x", "name": "10.x.x.x", "IpAddress": "10.x.x.x", "type": "Windows 2019", "status": "Clear" }, { "severity": "5", "CPUUtilization": 0, "MemUtilization": 0, "displayName": "xxx.xxx.xx.x", "name": "10.x.x.x", "IpAddress": "10.x.x.x", "type": "Dell PowerEdge iDRAC", "status": "Clear" }, { "severity": "5", "CPUUtilization": 0, "MemUtilization": 0, "displayName": "xxx.xxx.xx.x", "name": "10.x.x.x", "IpAddress": "10.x.x.x", "type": "Linux", "status": "Clear" } ], "TotalRecords": "3" } } } } } } }, "400": { "description": "Bad request. A mandatory parameter is missing or an invalid value was supplied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The apiKey is missing or invalid." }, "403": { "description": "Forbidden. The API key does not have sufficient privileges." }, "429": { "description": "Too many requests. Rate limit is 100 requests per minute. Exceeding this limit will block requests for 1 minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "parameters": [ { "name": "bvName", "schema": { "$ref": "#/components/schemas/entityText_regex" }, "description": "Internal name of the Business View.\nIt can be obtained from the name field of the getBusinessView API response.\nIf the value returned in the name field ends with the suffix _bv, remove '_bv' before using it as the bvName parameter.\nExample: If the getBusinessView API returns \"name\": \"Production_Servers_bv\", use bvName=Production_Servers.", "in": "query", "required": true } ], "tags": [ "OpManager.BusinessViews" ], "x-zenesis-sections": {}, "x-zenesis-envTags": [], "x-zenesis-doc": { "show": true } } }, "/api/json/device/getInterfaces": { "get": { "summary": "Get Interfaces for a Device", "x-zenesis-title": "Get Interfaces for a Device", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "20", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Provides the list of available interfaces in a device.", "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" } ] } } } } } } }, "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": "name", "schema": { "type": "string", "maxLength": 100 }, "description": "Internal name of the device used to uniquely identify it. This value can be retrieved from the 'deviceName' field in the listDevices API response.", "in": "query", "required": true } ], "tags": [ "OpManager.Interfaces" ], "x-zenesis-doc": { "show": true } } }, "/api/json/businessview/getBusinessView": { "get": { "summary": "List All Business Views", "x-zenesis-title": "List All Business Views", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "200", "lock-period": "1M" }, "description": "Retrieves a list of all Business Views created in OpManager. For each Business View, the API provides information such as the display name, total number of associated devices, alarm count and status.", "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" } ] } } } } } } }, "400": { "description": "Bad request. A mandatory parameter is missing or an invalid value was supplied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The apiKey is missing or invalid." }, "403": { "description": "Forbidden. The API key does not have sufficient privileges." }, "429": { "description": "Too many requests. Rate limit is 200 requests per minute. Exceeding this limit will block requests for 1 minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "parameters": [], "tags": [ "OpManager.BusinessViews" ], "x-zenesis-sections": {}, "x-zenesis-envTags": [], "x-zenesis-doc": { "show": true } } }, "/api/json/v2/wireless/getWirelessNetworkDetails": { "get": { "summary": "Get Wireless Network Details", "x-zenesis-title": "Get Wireless Network Details", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "40", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Lists Access Points, Client Count and Network Usage for each SSID in Wireless LAN Controller", "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": "deviceName", "schema": { "type": "string", "maxLength": 100 }, "description": "Internal name of the WLC device. This param value can be obtained from the 'deviceName' key of the '/listDevices' API's JSON Response.", "in": "query", "required": true } ], "tags": [ "OpManager.Wireless" ], "x-zenesis-doc": { "show": true } } }, "/api/json/v2/pathanalysis/getPathwayGraph": { "get": { "summary": "Get Pathway Graph", "x-zenesis-title": "Get Pathway Graph", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "50", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Retrieves the packets traversed path information from source to destination for the given network path monitor. Returns raw data based on the data retention period for Detailed Statistics, configured under Database Maintenance.", "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:10.5.5.3" ] }, "networkPathDetails": { "pathName": "networkpath_10.5.5.1_10.5.5.2", "pathDestinationPort": 80, "pathStatus": 1, "pathSource": "10.5.5.1", "pathSourceDisplayName": "Office-Router", "pathDestination": "10.5.5.2", "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_10.5.5.2", "pathDestinationPort": 80, "pathStatus": 1, "pathSource": "10.5.5.1", "pathSourceDisplayName": "Office-Router", "pathDestination": "10.5.5.2", "moID": 100001, "pathDisplayName": "Office to DataCenter" }, "ERROR": "NO_DATA_FOUND" } } } } } } }, "parameters": [ { "name": "moID", "schema": { "type": "integer" }, "description": "Internal ID of the network path analysis monitor. This value can be obtained from the moID key from the listNetworkPaths API response.", "in": "query", "required": true }, { "name": "period", "schema": { "type": "string", "enum": [ "Today", "Last 24 hours", "Yesterday", "customDate" ] }, "description": "Filters the data by the specified time period.", "in": "query", "required": true }, { "name": "date", "schema": { "type": "string", "format": "date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "description": "Applicable when period=customDate", "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": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "100", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Provides information on the members available in the given group.", "operationId": "listLogicalGroupMembers", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "description": "Array of logical group members " } }, "examples": { "Example1": { "value": [ { "groupType": "Device", "statusStr": "Critical", "displayname": "TestServer", "name": "testserver.example.com", "ipAddress": "10.X.X.X", "type": "Windows Server", "moid": "34950", "statusNum": "1" }, { "groupType": "Device", "statusStr": "Critical", "displayname": "TestServer2", "name": "testserver2.example.com", "ipAddress": "10.X.X.X", "type": "Windows Server", "moid": "34951", "statusNum": "1" } ] } } } } } }, "parameters": [ { "name": "groupName", "schema": { "type": "string" }, "description": "Name of the logical group. This can be retrieved from the groupName field in the listAllLogicalGroups API response.", "in": "query", "required": true } ], "tags": [ "OpManager.Groups" ], "x-zenesis-doc": { "show": true } } }, "/api/json/admin/listDownTimeSchedules": { "get": { "summary": "List Downtime Schedules", "x-zenesis-title": "List Downtime Schedules", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "100", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Provides the list of downtime schedules created in OpManager.", "operationId": "listDownTimeSchedules", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "description": "Details of a downtime schedule.", "properties": { "suppressType": { "type": "string", "description": "Type of suppression (Alarm or Monitoring)" }, "editable": { "type": "boolean", "description": "Indicates if the schedule is editable" }, "name": { "type": "string", "description": "Name of the downtime schedule" }, "id": { "type": "string", "description": "ID of the downtime schedule" }, "type": { "type": "string", "description": "Type of downtime schedule" }, "nextscheduledtime": { "type": "string", "description": "Next scheduled time for the downtime" }, "statusNum": { "type": "string", "description": "Status number of the downtime schedule" }, "status": { "type": "string", "description": "Status of the downtime schedule" } } } }, "examples": { "Example1": { "summary": "List of downtime schedules", "value": [ { "suppressType": "Monitoring", "editable": true, "name": "Weekend Maintenance", "id": "123", "type": "Once", "nextscheduledtime": "Finished", "statusNum": "1", "status": "Enabled" }, { "suppressType": "Monitoring", "editable": true, "name": "Monthly Patch Updates", "id": "124", "type": "Once", "nextscheduledtime": "Finished", "statusNum": "1", "status": "Enabled" } ] } } } } } }, "parameters": [ { "name": "callAction", "description": "Set callAction=settings by default", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "settings" ] } } ], "tags": [ "OpManager.Availability" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/getInterfaceSummary": { "get": { "summary": "Get Interface Summary", "x-zenesis-title": "Get Interface Summary", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "50", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Retrieves comprehensive summary information (such as ifAlias, Rx/Tx traffic, etc.) for a specific network interface.", "operationId": "getInterfaceSummary", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InterfaceSummaryResponse" }, "examples": { "Example1": { "value": { "recBandwidth": "1000", "instance": "2", "Util": "7", "avgOutPackets": "6.932 M", "outTraffic": "68.544 M", "moID": "5565", "isIPAvailable": false, "intfDisplayName": "GigabitEthernet0-2-TRUNK03", "txUtil": "6.85", "rstime": "1 Gbps", "statusPollEnabled": "true", "ifAdminStatus": "1", "isAgentMonitoring": false, "ifSpeedIn": "1000", "rxUtil": "6.03", "ifName": "GigabitEthernet0-2", "stringStatus": "Up", "Discards": "2", "Errors": "0", "pollInterval": "900", "operState": "Up", "intfmanaged": "true", "name": "10.5.5.120", "typeId": "6", "desc": "TRUNK03", "status": "5", "trafficCounter": "64 bit", "displayName": "PaloAlto Firewall Device", "availability": { "Down": 0, "Dependent Unavailable": 0, "Not Monitored": 0, "On Hold": 0, "Parent Down": 0, "On Maintenance": 0, "Up": 100 }, "inSpeedDisplayValue": "1 Gbps", "typeIdDescr": "Ethernet (6)", "isSubInterface": "false", "managed": "true", "ifPhysAddr": "24 0b 0a 01 81 e2", "adminState": "Up", "transBandwidth": "1000", "outSpeedDisplayValue": "1 Gbps", "availabilityTimeLine": [ "UP,1782316838641,1782335198641,Up" ], "rxPackets": "1.586 K", "txPackets": "1.235 K", "pollingStatus": "0", "ifSpeedOut": "1000", "inTraffic": "60.32 M", "intfMoName": "IF-10.5.5.110-5565", "ifOperStatus": "1", "category": "Firewall", "avgInPackets": "4.753 M" } } } } } }, "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": "interfaceName", "schema": { "type": "string", "maxLength": 100 }, "description": "Internal name of the interface. This value can be obtained from the 'interfaceName' field in the listInterfaces API response.", "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": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "100", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Lists all the groups available in OpManager. Also provides basic group information such as members count and group health.", "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": [ { "total": 141, "page": 1, "rows": [ { "groupType": "Interface", "isSuppressed": false, "memberAvailability": "100", "groupID": "132995", "count": "4", "description": "No Description", "statusImg": "/images/devices/status5.gif", "availability": "100", "statusLabel": "Clear", "groupDisplayName": "ServerGroup", "groupName": "ServerGroup-132995", "suppressedMessage": "", "displayGroupType": "Interface", "status": "5" }, { "groupType": "Device", "isSuppressed": false, "memberAvailability": "0", "groupID": "132002", "count": "1", "description": "No Description", "statusImg": "/images/devices/status5.gif", "availability": "100", "statusLabel": "Clear", "groupDisplayName": "Agent", "groupName": "Agent-132002", "suppressedMessage": "", "displayGroupType": "Device", "status": "5" } ], "records": 282 } ] } } } } } }, "parameters": [ { "name": "isGroupPage", "schema": { "type": "boolean" }, "description": "If set to false (default), returns all groups. If set to true, returns paginated results and requires the page and rows parameters.", "in": "query", "required": false }, { "name": "page", "schema": { "type": "integer", "format": "int64" }, "description": "Page number for pagination.", "in": "query", "required": false }, { "name": "rows", "schema": { "type": "integer", "format": "int64" }, "description": "Number of records to return per page.", "in": "query", "required": false }, { "name": "sortByColumn", "schema": { "type": "string", "enum": [ "groupDisplayName", "description", "groupType", "displayGroupType", "status", "count", "DISPLAYNAME", "availability", "isSuppressed", "memberAvailability" ] }, "description": "Column name to sort the result by.", "in": "query", "required": false }, { "name": "sortByType", "schema": { "type": "string", "enum": [ "asc", "desc" ], "description": "" }, "description": "Sort by ascending or descending.", "in": "query", "required": false } ], "tags": [ "OpManager.Groups" ], "x-zenesis-doc": { "show": true } } }, "/api/json/v2/pathanalysis/listNetworkPaths": { "get": { "summary": "List Network Paths", "x-zenesis-title": "List Network Paths", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "60", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Retrieves the list of network path monitors configured in OpManager.", "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_10.5.5.2", "source": "10.5.5.1", "destinationHost": "10.5.5.2", "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_10.5.5.2", "source": "10.5.5.1", "destinationHost": "10.5.5.2", "moID": "100002", "status": "5", "sourceManaged": "true" } ] } } } } } }, "parameters": [], "tags": [ "OpManager.NetworkPath" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/getDeviceNotes": { "get": { "summary": "Get Custom Fields for device", "x-zenesis-title": "Get Custom Fields for device", "security": [ { "ApiKeyAuth": [] } ], "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 type and field length.", "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-XP", "DATATYPE": "Text", "ISMONAVAIL": false, "ISEDITABLE": true, "DESCRIPTION": "Serial number of the device", "FIELDNAME": "Serial Number", "ALIASNAME": "UDF2", "FIELDLENGTH": 50 } ] } } } } } } }, "parameters": [ { "name": "name", "schema": { "type": "string", "maxLength": 100 }, "description": "Name of the device, retrieved from the deviceName field in the listDevices API response.", "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": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "40", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Lists all Access Points in the WLC Device.", "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": "deviceName", "schema": { "type": "string", "maxLength": 100 }, "description": "Internal name of the WLC device. This param value can be obtained from the 'deviceName' key of the '/listDevices' API's JSON Response.", "in": "query", "required": true } ], "tags": [ "OpManager.Wireless" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/getInterfaceNotes": { "get": { "summary": "Get Custom Fields for Interface", "x-zenesis-title": "Get Custom Fields for Interface", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "50", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Retrieves custom field values of an interface along with field metadata including data types and field properties.", "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 LeaseLine Link1", "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": "interfaceName", "schema": { "type": "string", "maxLength": 100 }, "description": "Internal name of the interface. This value can be obtained from the 'interfaceName' field in the listInterfaces API response.", "in": "query", "required": true } ], "tags": [ "OpManager.Interfaces" ], "x-zenesis-doc": { "show": true } } }, "/api/json/admin/getLogicalGroupInfo": { "get": { "summary": "Get Logical Group Information", "x-zenesis-title": "Get Logical Group Information", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "50", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Provides details such as members count, group status, etc of the given group.", "operationId": "getLogicalGroupInfo", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "properties": { "GroupDetails": { "type": "object", "description": "Group summary information" }, "DashBoardDetails": { "type": "object", "description": "Dashboard details for the logical group" } } }, "examples": { "Example1": { "value": { "GroupDetails": { "groupType": "Device", "groupID": "52983", "count": "2", "description": "No Description", "statusImg": "/images/devices/status1.gif", "statusLabel": "Critical", "deviceDevice_Count": "2", "groupDisplayName": "ServerGroup", "groupName": "ServerGroup-52983", "alertCount": 5, "statusChangeCount": 2, "displayGroupType": "Device", "status": "1" }, "DashBoardDetails": { "Distribution": { "data": { "chartData": [ { "seriesname": "99.99 - 100", "data": [ [ 1759818600000, 100 ], [ 1759822200000, 100 ], [ 1759825800000, 100 ] ], "yaxiscolumnorder": [ 0 ] }, { "seriesname": "99 - 99.99", "data": [ [ 1759818600000, 0 ], [ 1759822200000, 0 ], [ 1759825800000, 0 ] ], "yaxiscolumnorder": [ 0 ] }, { "seriesname": "90 - 99", "data": [ [ 1759818600000, 0 ], [ 1759822200000, 0 ], [ 1759825800000, 0 ] ], "yaxiscolumnorder": [ 0 ] }, { "seriesname": "50 - 90", "data": [ [ 1759818600000, 0 ], [ 1759822200000, 0 ], [ 1759825800000, 0 ] ], "yaxiscolumnorder": [ 0 ] }, { "seriesname": "10 - 50", "data": [ [ 1759818600000, 0 ], [ 1759822200000, 0 ], [ 1759825800000, 0 ] ], "yaxiscolumnorder": [ 0 ] }, { "seriesname": "0 - 10", "data": [ [ 1759818600000, 0 ], [ 1759822200000, 0 ], [ 1759825800000, 0 ] ], "yaxiscolumnorder": [ 0 ] }, { "seriesname": "Not Monitored", "data": [ [ 1759818600000, 0 ], [ 1759822200000, 0 ], [ 1759825800000, 0 ] ], "yaxiscolumnorder": [ 0 ] } ], "xyTitles": [ "Time", "Distribution (%)" ] }, "displayName": "Availability Distribution" } } } } } } } } }, "parameters": [ { "name": "groupName", "description": "Name of the logical group. This can be retrieved from the groupName field in the listAllLogicalGroups API response.", "in": "query", "schema": { "type": "string" }, "required": true }, { "name": "period", "schema": { "type": "integer" }, "description": "Value must be set to 3.", "in": "query", "required": true } ], "tags": [ "OpManager.Groups" ], "x-zenesis-doc": { "show": true } } }, "/api/json/admin/listAdditionalFields": { "get": { "summary": "List the Custom Fields by Object Type", "x-zenesis-title": "List the Custom Fields by Object Type", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "500", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Retrieves a list of custom fields configured for the specified Device or Interface. Returns custom field definitions including field names, aliases, data types, and properties.", "operationId": "listAdditionalFields", "responses": { "200": { "description": "Successful response containing the list of custom fields.", "content": { "application/json": { "schema": { "type": "array", "description": "List of custom fields configured for the specified object type.", "items": { "type": "object", "description": "Definition of a single custom field.", "properties": { "name": { "type": "string", "description": "Name of the custom field." }, "description": { "type": "string", "description": "Description of the custom field." }, "checked": { "type": "boolean", "description": "Indicates whether the custom field is enabled for the specified object type." }, "id": { "type": "integer", "description": "Unique identifier of the custom field." }, "type": { "type": "string", "description": "Data type of the custom field. For example, Text." }, "delete": { "type": "boolean", "description": "Indicates whether the custom field can be deleted." } } } }, "examples": { "Example1": { "value": [ { "name": "SerialNumber", "description": "Serial Number of the device", "checked": true, "id": 1, "type": "Text", "delete": false }, { "name": "Model", "description": "Model of the device", "checked": false, "id": 2, "type": "Text", "delete": false }, { "name": "Comments", "description": "Comments about the device", "checked": true, "id": 4, "type": "Text", "delete": false }, { "name": "Building", "description": "Building where the device is present", "checked": true, "id": 5, "type": "Text", "delete": false }, { "name": "Department", "description": "Department for which the device services", "checked": true, "id": 6, "type": "Text", "delete": false }, { "name": "Floor", "description": "Floor where the device is located", "checked": true, "id": 7, "type": "Text", "delete": false }, { "name": "Contact Name", "description": "Contact person for the device", "checked": true, "id": 13, "type": "Text", "delete": false }, { "name": "Cabinet", "description": "Cabinet where the device is located", "checked": true, "id": 15, "type": "Text", "delete": false } ] } } } } }, "400": { "description": "Bad request. A mandatory parameter is missing or an invalid value was supplied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The apiKey is missing or invalid." }, "403": { "description": "Forbidden. The API key does not have sufficient privileges." }, "429": { "description": "Too many requests. Rate limit is 500 requests per minute. Exceeding this limit will block requests for 1 minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "parameters": [ { "name": "type", "schema": { "$ref": "#/components/schemas/CustomFieldType_regex" }, "description": "Type of object to retrieve custom fields for. Use type=Device for device fields or type=Interface for interface fields. Allowed values: Device, Interface", "in": "query", "required": true } ], "tags": [ "OpManager.CustomFields" ], "x-zenesis-doc": { "show": true } } }, "/api/json/discovery/getDownDevices": { "get": { "summary": "Get Down Devices", "x-zenesis-title": "Get Down Devices", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": {}, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Returns the list of devices that are currently down.", "operationId": "getDownDevices", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "description": "Details of a down device." } }, "examples": { "Example1": { "value": { "getDownDevices": { "Details": [ { "name": "router-01", "category": "Router", "type": "Cisco ISR 9300", "displayName": "Router-01" }, { "name": "switch-02", "category": "Switch", "type": "Cisco Catalyst 9300", "displayName": "Switch-02" } ] } } } } } } } }, "parameters": [], "tags": [ "OpManager.Availability" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/getAvailabilityGraphData": { "get": { "summary": "Get Availability Graph Data", "x-zenesis-title": "Get Availability Graph Data", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "50", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Fetches the Availability graph data for monitored entities such as device, interface, URL, etc. It returns uptime and availability data.", "operationId": "getAvailabilityGraphData", "responses": { "200": { "description": "Availability graph data retrieved successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AvailabilityGraphDataResponse" }, "examples": { "Example1": { "value": { "uptimeData": { "Today": 100, "This week": 100, "Last week": 100, "Last 30 days": 100, "Last month": 97, "This month": 100, "Last 24 hours": 100, "Yesterday": 100, "Last 7 days": 100, "Last 12 hours": 100 }, "graphData": [ { "seriesname": "Up", "data": [ [ "Last 12 hours", 100 ], [ "Today", 100 ], [ "Last 24 hours", 100 ], [ "Yesterday", 100 ], [ "This week", 100 ], [ "Last 7 days", 100 ], [ "Last week", 100 ], [ "This month", 100 ], [ "Last 30 days", 100 ], [ "Last month", 96.64 ] ] }, { "seriesname": "On Maintenance", "data": [ [ "Last 12 hours", 0 ], [ "Today", 0 ], [ "Last 24 hours", 0 ], [ "Yesterday", 0 ], [ "This week", 0 ], [ "Last 7 days", 0 ], [ "Last week", 0 ], [ "This month", 0 ], [ "Last 30 days", 0 ], [ "Last month", 0 ] ] }, { "seriesname": "Dependent Unavailable", "data": [ [ "Last 12 hours", 0 ], [ "Today", 0 ], [ "Last 24 hours", 0 ], [ "Yesterday", 0 ], [ "This week", 0 ], [ "Last 7 days", 0 ], [ "Last week", 0 ], [ "This month", 0 ], [ "Last 30 days", 0 ], [ "Last month", 0 ] ] }, { "seriesname": "On Hold", "data": [ [ "Last 12 hours", 0 ], [ "Today", 0 ], [ "Last 24 hours", 0 ], [ "Yesterday", 0 ], [ "This week", 0 ], [ "Last 7 days", 0 ], [ "Last week", 0 ], [ "This month", 0 ], [ "Last 30 days", 0 ], [ "Last month", 0 ] ] }, { "seriesname": "Down", "data": [ [ "Last 12 hours", 0 ], [ "Today", 0 ], [ "Last 24 hours", 0 ], [ "Yesterday", 0 ], [ "This week", 0 ], [ "Last 7 days", 0 ], [ "Last week", 0 ], [ "This month", 0 ], [ "Last 30 days", 0 ], [ "Last month", 0 ] ] }, { "seriesname": "Not Monitored", "data": [ [ "Last 12 hours", 0 ], [ "Today", 0 ], [ "Last 24 hours", 0 ], [ "Yesterday", 0 ], [ "This week", 0 ], [ "Last 7 days", 0 ], [ "Last week", 0 ], [ "This month", 0 ], [ "Last 30 days", 0 ], [ "Last month", 3.36 ] ] } ] } } } } } }, "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. Exceeding this limit will block requests for 1 minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "parameters": [ { "in": "query", "name": "name", "required": true, "description": "Internal name of the entity.\n- For devices, this value can be retrieved from the **deviceName** field in the listDevices API response.\n- For Interface, this value can be retrieved from the **interfaceName** field in the listInterfaces API response.\n- For URLs, this value can be retrieved from the **name** field in the listURLMonitors API response.\n\nMandatory for device, Interface and URL entities. Not applicable when elementID is used (Process, Windows Service and Service monitors).", "schema": { "type": "string", "maxLength": 100 } }, { "in": "query", "name": "elementID", "required": false, "description": "Internal ID of the entity.\n\nThe elementID value can be retrieved from the **id** column in the getDeviceAssociatedMonitors API.\n\nMandatory when fetching availability data for Process, Windows Service or Service monitors.", "schema": { "$ref": "#/components/schemas/onlyNumber_regex" } }, { "in": "query", "name": "isFluidic", "required": true, "description": "Set value as **true** by default.", "schema": { "type": "boolean" } }, { "in": "query", "name": "instance", "required": false, "description": "Specifies the monitor type for which the availability graph is to be fetched.\n- **Interface** - To fetch availability graph of interface.\n- **URL** - To fetch availability graph of URL monitor.\n- **service** - To fetch availability graph of service monitor.\n- **winService** - To fetch availability graph of Windows Service monitor.\n- **process** - To fetch availability graph of process monitor.\n\nNot required when fetching the availability graph of a device.", "schema": { "type": "string", "enum": [ "Interface", "URL", "service", "winService", "process" ] } } ], "tags": [ "OpManager.Availability" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/setManaged": { "post": { "summary": "Set Managed", "x-zenesis-title": "Set Managed", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "100", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Manage or Unmanage the devices,interfaces or URL monitors that are currently added in OpManager.", "operationId": "setManaged", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "properties": { "message": { "type": "string", "description": "Human-readable status message indicating whether the entity is being managed or unmanaged." } } } } }, "examples": { "Example1": { "value": { "result": { "message": "Device \"xxx.xxx.xx.x\" is being managed." } } } } } } }, "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. Exceeding this limit will block requests for 5 minutes.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "parameters": [ { "in": "query", "name": "manage", "required": true, "description": "Enables monitoring of devices or interfaces or URLs if manage=true, disables monitoring if manage=false", "schema": { "type": "boolean" } }, { "in": "query", "name": "name", "required": true, "description": "Internal name of the device or interface or URL.\n\n**For devices**, this value can be retrieved from the deviceName field in the listDevices API response.\n**For interfaces**, this value can be retrieved from the interfaceName field in the listInterfaces API response.\n**For URLs**, this value can be retrieved from the name field in the listURLMonitors API response.\n\nBy default, the entity will be assumed as device if isUrl=False, or isInterface=False.", "schema": { "type": "string", "maxLength": 100 } }, { "in": "query", "name": "isUrl", "required": false, "description": "Set as true to manage or unmanage an URL monitor.", "schema": { "type": "boolean" } }, { "in": "query", "name": "isInterface", "required": false, "description": "Set as true to manage or unmanage an Interface monitor.", "schema": { "type": "boolean" } } ], "tags": [ "OpManager.Availability" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/getCategoryList": { "get": { "summary": "Get Device Categories", "x-zenesis-title": "Get Device Categories", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "200" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Retrieves the list of device categories available in OpManager.", "operationId": "getCategoryList", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCategoryListResponse" }, "examples": { "Example1": { "value": { "Wireless": "Wireless", "Server": "Server", "UCS": "UCS", "WirelessLANController": "Wireless LAN Controller", "DomainController": "DomainController", "Printer": "Printer", "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", "IPMI": "IPMI", "MerakiSwitch": "Meraki Switch", "MerakiSensor": "MerakiSensor", "SDWAN": "SDWAN", "FCSwitch": "FCSwitch", "LoadBalancer": "Load Balancer", "Router": "Router", "RAID": "RAID", "Firewall": "Firewall", "Storage": "Storage", "Desktop": "Desktop", "Switch": "Switch", "MerakiController": "Meraki Controller", "MerakiSecurity": "Meraki Security", "WANAccelerator": "WAN Accelerator" } } } } } }, "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" } } } } }, "tags": [ "OpManager.Settings" ], "x-zenesis-doc": { "show": true } } }, "/api/json/admin/getURLSummary": { "get": { "summary": "Get URL Monitor Summary", "x-zenesis-title": "Get URL Monitor Summary", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": {}, "description": "Provides a summarized view of URL monitor performance by consolidating availability status, response time, and overall health metrics associated with the device.", "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": "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 — \"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 — \"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.\n" } } }, "examples": { "Example1": { "value": { "viewData": "NODATA", "snapDetails": { "snapList": [ { "indexCount": 0, "ondemandWidget": false, "refresh": false, "type": "URLSummary", "sizex": 10, "expand": false, "apiurl": "/client/api/json/admin/getURLSummary", "rowNum": 1, "parameter": "urlName", "isEnabled": true, "colNum": 1, "name": "opm.url.summary", "header": false, "id": 235, "snapid": 235, "expandtime": false, "parameters": [], "sizey": 12, "timeSelection": false, "desc": "dashboard.name.nwconfig" }, { "indexCount": 1, "ondemandWidget": false, "refresh": false, "type": "Grid", "sizex": 10, "expand": false, "apiurl": "/client/api/json/alarm/listAlarms", "rowNum": 8, "parameter": "urlName", "isEnabled": true, "colNum": 1, "name": "opm.url.alarms", "header": true, "id": 236, "snapid": 236, "snapshotData": { "sortCol": "modTime", "sortOrder": "desc", "colModelList": [ { "classes": "cursorPointer", "name": "message", "index": "message" }, { "classes": "cursorPointer", "name": "who", "index": "who" }, { "formatter": "severityColorIcon", "classes": "cursorPointer", "name": "statusStr", "index": "statusStr" }, { "sorttype": "convertTimeToLongFormatter", "classes": "cursorPointer", "name": "modTime", "index": "modTime" }, { "hidden": true, "name": "statusNum", "index": "statusNum" }, { "hidden": true, "name": "entity", "index": "entity" }, { "hidden": true, "name": "alarmId", "index": "alarmId" }, { "hidden": true, "name": "modTimeLong", "index": "modTimeLong" } ], "colNamesList": [ "webclient.fault.event.text", "webclient.fault.alarm.operator", "webclient.fault.details.properties.severity", "webclient.fault.details.properties.modttime", "", "webclient.api.ui.event.entity", "webclient.api.ui.event.alarmid", "" ], "onselectfunction": "url_alarmsList" }, "expandtime": false, "parameters": [], "sizey": 14, "timeSelection": false, "desc": "webclient.devices.details.alarm" }, { "indexCount": 2, "ondemandWidget": false, "refresh": false, "type": "Graph", "sizex": 10, "expand": false, "apiurl": "/client/api/json/device/getGraphData", "rowNum": 22, "parameter": "name", "isEnabled": true, "colNum": 1, "name": "opm.url.response", "header": true, "id": 237, "snapid": 237, "expandtime": false, "parameters": [ { "param": "index", "paramData": [], "value": "urlresponseTime" }, { "param": "instance", "paramData": [], "value": "urlresponseTime" }, { "paramType": "urlresponseTime", "param": "withMMA", "paramData": [], "value": "true" }, { "param": "policyName", "paramData": [], "value": "urlresponseTime" }, { "paramType": "opmtime", "param": "period", "paramData": [], "value": "Today" } ], "sizey": 14, "timeSelection": true, "desc": "webclient.home.server.responsetime.column.time" } ], "snapshotID": "18", "snapshotDesc": "snapshot.desc.url", "snapshotName": "OPMURL", "tabs": { "tabs": [ { "tabid": 55, "name": "webclient.snapshot.testlinks.summary", "order": 1 }, { "tabid": 56, "name": "webclient.devices.details.alarm", "order": 2 }, { "tabid": 57, "name": "webclient.home.server.responsetime.column.time", "order": 3 } ], "tabWidgets": { "55": [ { "ROW": 1, "ASSOCIATIONID": 235 } ], "56": [ { "ROW": 8, "ASSOCIATIONID": 236 } ], "57": [ { "ROW": 22, "ASSOCIATIONID": 237 } ] } }, "timeSelectionNeeded": true, "yScale": 25, "maxColumns": 10 }, "details": { "alreadyExist": "false", "urlName": "ManageEngine", "displayName": "ManageEngine", "matchContent": "", "probeID": "0", "tester": "usertest", "isContainer": "false", "type": "URL", "moID": "119432", "timeout": "25", "responseCode": "", "suppressedMessage": "", "failureThreshold": "2", "errorContent": "", "managed": "true", "smartUrl": "https://www.manageengine.com", "siteID": "0", "state": "1", "statusPollEnabled": "false", "groupMembers": "", "DISPLAYNAME": "-", "lastPolled": "Mon,Oct 13 16:55:13 IST 2025", "method": "G", "isSuppressed": false, "stringstatus": "Clear", "responseTime": "103", "profile": "", "statusChangeTime": "1760294951262", "profileIDs": "", "AvailabilityImagePath": { "Down": 0.487, "Dependent Unavailable": 0, "Not Monitored": 0, "On Hold": 0, "Parent Down": 0, "On Maintenance": 0, "Up": 99.513 }, "userAgent": "", "queryString": "", "userName": "", "acceptCookie": "1", "url": "https://www.manageengine.com", "groupNames": "", "pollInterval": "5", "childrenKeys": "", "parentKey": "NULL", "nextPoll": "Mon,Oct 13 17:00:13 IST 2025", "name": "ManageEngine_URL", "isGroup": "false", "failureCount": "0", "statusUpdateTime": "1760294951262", "status": "5" } } } } } } } }, "parameters": [ { "name": "urlName", "schema": { "type": "string", "pattern": "^[\\w\\s\\-\\.\\(\\)]+$", "maxLength": 100 }, "description": "Name of the URL monitor. The 'urlName' value can be obtained from the 'name' key in the JSON response of the listURLMonitors API response.", "in": "query", "required": true }, { "name": "snapType", "schema": { "type": "string", "enum": [ "MonitoringURL" ] }, "description": "Used to identify the source of the request. The only allowed value is 'MonitoringURL'.", "in": "query", "required": true }, { "name": "deviceName", "schema": { "type": "string", "description": "", "maxLength": 100 }, "description": "Internal name of the device used to uniquely identify it. Can be used when the URL monitor is associated with a device.", "in": "query", "required": false } ], "tags": [ "OpManager.Devices" ] } }, "/api/json/device/getDeviceAssociatedMonitors": { "get": { "summary": "Get Device Associated Monitors", "x-zenesis-title": "Get Device Associated Monitors", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "500", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "The API returns a complete list of monitors associated with the device, including performance monitors, application monitors, Windows services, and scripts, along with their last polled values and status.\nNote: If you're looking for performance monitor details alone, we recommend using the getLastCollectedValues API, which is more efficient and returns the last collected values of the monitors along with other properties.", "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": [ { "in": "query", "name": "name", "required": true, "description": "Internal name of the device used to uniquely identify it.\nThe 'name' value can be obtained from the 'deviceName' key in the JSON response of the listDevices API.", "schema": { "type": "string", "maxLength": 100 } } ], "tags": [ "OpManager.Monitoring" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/getLastCollectedValues": { "get": { "summary": "Get Last Collected Values", "x-zenesis-title": "Get Last Collected Values", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "300", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Retrieves the last collected monitor values for all devices in a specified device group or a list of device MOIDs. For each device, the response includes the most recently polled data from all active monitors - such as performance monitors (CPU, memory, disk, interface traffic), script monitors, and other polling-based monitors, along with associated metadata including monitor policy name, OID, threshold settings, polling status, and graph display details.\nNote:\n- While deviceMOIDList, groupName are each marked as not mandatory, at least one of the two must be provided in the request.\n- If both deviceMOIDList and groupName are specified, the API retrieves the last collected values for all monitors associated with the devices in the specified device groups, and the deviceMOIDList parameter is ignored.\n- It is recommended to pass up to 500 elements in the deviceMOIDList param.", "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": [ { "in": "query", "name": "deviceMOIDList", "required": false, "description": "Internal id of the device used to uniquely identify it.\nMultiple moid can be specified as comma-separated list. The 'moid' value can be obtained from the 'moid' key in the JSON response of the listDevices API.", "schema": { "$ref": "#/components/schemas/numberWithComma_regex" } }, { "in": "query", "name": "groupName", "required": false, "description": "Internal name used to identify a device group.\nThe 'groupName' value can be obtained from the 'groupName' key in the JSON response of the listAllLogicalGroups API.", "schema": { "type": "string" } }, { "in": "query", "name": "eeProbeID", "required": false, "description": "Internal id of the probe used to uniquely identify it.\nThe 'eeProbeID' value can be obtained from the 'probeID' key in the JSON response of the listProbes API.\nThis parameter is mandatory to get the data from OpManager Central.", "schema": { "type": "integer", "format": "int64" } } ], "tags": [ "OpManager.Monitoring" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/getVMWareVMs": { "get": { "summary": "List VMware VMs", "x-zenesis-title": "List VMware VMs", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": {}, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Retrieves detailed information about VMware VMs monitored by OpManager for the specified entity type details at multiple levels, including vCenter, Host, Datastore and VxRail, to provide flexible storage visibility throughout the VMware environment.", "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": "name", "schema": { "type": "string", "maxLength": 100 }, "description": "Internal name of the monitored VMware entity used to uniquely identify it. The 'name' value can be obtained from the 'deviceName' key in the JSON response of the listVirtualDevices API response. Pass the 'virtualDeviceType' parameter as 'VCENTER' or 'VHOST', 'VxRail', 'VDATASTORE' in the listVirtualDevices API to retrieve the corresponding virtual devices.", "in": "query", "required": true }, { "name": "type", "schema": { "type": "string", "enum": [ "VCENTER", "HOST", "DATASTORE", "VXRAIL" ] }, "description": "Specifies the VMware entity level for which VM details should be retrieved. If not specified, VM details are retrieved based on the provided name.", "in": "query", "required": false } ], "tags": [ "OpManager.Devices" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/listVirtualDevices": { "get": { "summary": "List Virtual Devices", "x-zenesis-title": "List Virtual Devices", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": {}, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Retrieves the list of virtual devices along with inventory details monitored by OpManager based on the specified virtual device type.", "operationId": "listVirtualDevices", "responses": { "200": { "description": "Successful paginated response containing the virtual entities list.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VirtualDeviceListResponse" }, "examples": { "listVirtualDevices": { "summary": "List of Virtual Entities and its details.", "value": [ { "DISPLAYNAME": "opm-server89", "VM_ID": 1234, "statusStr": "Critical", "VM_POWERSTATE": "On", "MAX_CPU_MHZ": 14366, "IPADDRESS": "10.1.1.9", "OS_NAME": "Microsoft Windows Server 2019 (64-bit)", "deviceName": "opm-server89", "statusNum": 1, "MEMORY_MB": 16384, "STATUS": " Critical", "HOSTNAME": "opm-server89", "MOID": 1004, "id": 1004, "state": 1 }, { "DISPLAYNAME": "opm-server90", "VM_ID": 5678, "statusStr": "Critical", "VM_POWERSTATE": "On", "MAX_CPU_MHZ": 4788, "IPADDRESS": "10.1.1.10", "OS_NAME": "Ubuntu Linux (64-bit)", "deviceName": "opm-server90", "statusNum": 1, "MEMORY_MB": 8192, "STATUS": " Critical", "HOSTNAME": "opm-server90", "MOID": 1005, "id": 1005, "state": 1 } ] } } } } } }, "parameters": [ { "name": "virtualDeviceType", "schema": { "$ref": "#/components/schemas/virtualTypes_regex" }, "description": "Type of virtual device to be listed.", "in": "query", "required": true } ], "tags": [ "OpManager.Devices" ], "x-zenesis-doc": { "show": true } } }, "/api/json/admin/listPerformanceMonitors": { "get": { "summary": "List Performance Monitors", "x-zenesis-title": "List Performance Monitors", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "500", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "This API returns a list of all performance monitors that can be monitored within the product, including properties such as displayName, protocol, identifier, graphName, associatedDeviceCount, isCustomGraph, and additional details.", "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": "isCustomMonitor", "schema": { "type": "boolean" }, "description": "When set to true, filters the list to return only custom performance monitors.", "in": "query", "required": false }, { "name": "isCustFieldMonitor", "schema": { "type": "boolean" }, "description": "When set to true, filters the list to return only custom field-based monitors.", "in": "query", "required": false } ], "tags": [ "OpManager.Devices" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/getNutanixVMs": { "get": { "summary": "Get Nutanix VMs", "x-zenesis-title": "Get Nutanix VMs", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": {}, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Retrieves detailed information about virtual machines within the Nutanix environment. Based on the specified entity type, this API can return virtual machine details either at the cluster level or the host level.", "operationId": "getNutanixVMs", "responses": { "200": { "description": "Successful response containing the list of Nutanix VMs.", "content": { "application/json": { "schema": { "type": "array", "description": "List of Nutanix VM details under Cluster ", "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": "name", "schema": { "type": "string", "maxLength": 100 }, "description": "Internal name of the managed Nutanix entity used to uniquely identify it. This value can be retrieved from the deviceName field in the listVirtualDevices API response. Pass virtualDeviceType as Nutanix-Cluster or Nutanix-Host in the listVirtualDevices API to retrieve the corresponding virtual devices.", "in": "query", "required": true }, { "name": "type", "schema": { "type": "string", "enum": [ "Nutanix-Cluster", "Nutanix-Host" ] }, "description": "Specifies the Nutanix entity type for which VM details should be retrieved.", "in": "query", "required": true } ], "tags": [ "OpManager.Devices" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/getDeviceInfo": { "get": { "summary": "Get Device Metric Info", "x-zenesis-title": "Get Device Metric Info", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "60", "lock-period": "1M" }, "description": "Identifies and lists inventory attributes like HDD, RAM, Model, MACAddress, ServiceTag, Manufacturer, SerialNumber, OperatingSystem, and SoftwareVersion.", "operationId": "getDeviceInfo", "responses": { "200": { "description": "Successful response containing device metric/inventory data.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceMetricsInfo" }, "examples": { "Example1": { "value": { "OperatingSystem": "Windows", "MACAddress": "00:00:00:11:11:11", "SoftwareVersion": "10.0.1", "SerialNumber": "RKRRRR", "ServiceTag": "ADRRB126", "Model": "ProLiant BL460c", "Manufacturer": "HP", "HDD": "512", "RAM": "16384" } } } } } }, "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": "deviceName", "schema": { "type": "string", "maxLength": 100 }, "description": "Internal name of the device used to uniquely identify it. This value can be retrieved from the deviceName field in the listDevices API response.", "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. This value can be retrieved from the ipaddress field in the listDevices API response.", "in": "query", "required": false }, { "name": "dnsName", "schema": { "type": "string", "maxLength": 100 }, "description": "DNS name of the device. This value can be retrieved from the dnsName field in the getDeviceSummary API response.", "in": "query", "required": false } ], "tags": [ "OpManager.Devices" ] } }, "/api/json/device/getGraphData": { "get": { "summary": "Get Graph Data", "x-zenesis-title": "Get Graph Data", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "500", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Retrieves graph data for device performance metrics", "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": "name", "schema": { "type": "string", "maxLength": 100 }, "description": "Internal name of the device used to uniquely identify it. The 'name' value can be obtained from the 'deviceName' key in the JSON response of the listDevices API.", "in": "query", "required": true }, { "name": "policyName", "schema": { "type": "string", "maxLength": 250 }, "description": "Internal name of the monitor used to uniquely identify it. The 'policyName' value can be obtained from the 'policyName' key in the JSON response of the getDeviceAssociatedMonitors API.", "in": "query", "required": true }, { "name": "index", "schema": { "type": "string", "maxLength": 250 }, "description": "Additional parameter of the performance monitor used to uniquely identify it. The 'graphName' value can be obtained from the 'name' key in the JSON response of the getDeviceAssociatedMonitors API.", "in": "query", "required": true }, { "name": "period", "schema": { "type": "string" }, "description": "Specifies the time range for which monitor data should be retrieved.", "in": "query", "required": false }, { "name": "instance", "schema": { "type": "string", "enum": [ "urlResponseTime", "responseTime", "packetLoss" ] }, "description": "Internal name used to identify availability instance of a monitor.", "in": "query", "required": false }, { "name": "parentObj", "schema": { "type": "string", "maxLength": 100 }, "description": "Specifies the parent object associated with the monitor. Applicable only for monitor types that require a parent entity reference, such as Meraki Uplink.", "in": "query", "required": false }, { "name": "withMMA", "schema": { "type": "boolean" }, "description": "Set this parameter to true to include historical data along with min, max, and average values in the response.", "in": "query", "required": false }, { "name": "isHardwareGraph", "schema": { "type": "boolean" }, "description": "Boolean flag indicating whether the requested graph is based on hardware sensor metrics.", "in": "query", "required": false }, { "name": "parameterName", "schema": { "type": "string", "maxLength": 50 }, "description": "Name of the hardware sensor parameter to retrieve data for. This parameter is applicable only when isHardwareGraph is true.", "in": "query", "required": false }, { "name": "startDate", "schema": { "type": "string" }, "description": "When the graph needs to be retrieved for a custom period, this parameter is required. It specifies the start of the custom time range. Format: dd/MM/yyyy HH:mm.", "in": "query", "required": false }, { "name": "endDate", "schema": { "type": "string" }, "description": "When the graph needs to be retrieved for a custom period, this parameter is required. It specifies the end of the custom time range. Format: dd/MM/yyyy HH:mm.", "in": "query", "required": false }, { "name": "graphFilterType", "schema": { "type": "string", "enum": [ "min", "max", "avg" ] }, "description": "Specifies the aggregation type used for fetching historical graph data.", "in": "query", "required": false }, { "name": "instanceName", "schema": { "type": "string", "maxLength": 100 }, "description": "When the monitor is an MSSQL Application Monitor, pass this parameter with the MSSQL instance name. MSSQL Instance name can be fetched from the end device or can be viewed from MSSQL Tab in device snapshot page of MSSQL device in OpManager.", "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", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "500", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "This API is used to get the data shown within widget in raw JSON format.", "operationId": "getWidgetData", "responses": { "200": { "description": "Successful response containing the raw data of the requested widgets.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WidgetDataResponse" }, "examples": { "Example1": { "value": { "623": { "WidgetName": "Devices by Availability", "WidgetData": [ { "displayName": "SampleDevice", "availability": "99.5%" } ], "Name": "widget.name.topnavail" } } } } } } }, "400": { "description": "Bad request. A mandatory parameter is missing or an invalid value was supplied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The apiKey is missing or invalid." }, "403": { "description": "Forbidden. The API key does not have sufficient privileges." }, "429": { "description": "Too many requests. Rate limit is 500 requests per minute. Exceeding this limit will block further requests from that user for 1 minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "parameters": [ { "name": "widgetID", "schema": { "$ref": "#/components/schemas/numberWithComma_regex" }, "description": "The widget ID for which the data is to be fetched. This value can be obtained from the 'widgetID' key in the getWidgetsList API response.", "in": "query", "required": true } ], "tags": [ "OpManager.Dashboard" ], "x-zenesis-doc": { "show": true } } }, "/api/json/dashboard/getWidgetsList": { "get": { "summary": "List Widgets in a Dashboard", "x-zenesis-title": "List Widgets in a Dashboard", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "30", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "This API is used to list all widgets in a specific dashboard.", "operationId": "getWidgetsList", "responses": { "200": { "description": "Successful response containing the dashboard properties and its widget list.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WidgetsListResponse" }, "examples": { "Example1": { "value": { "isDashboardOwner": false, "dashDesc": "Top 10 Reports", "noOfCols": "12", "colWidths": [ { "colWidth": "50", "colID": "1" }, { "colWidth": "50", "colID": "2" } ], "configureWidget": true, "isWidgetActionsAllowed": true, "editDashboard": false, "widgetList": [ { "widgetID": "248", "name": "Interfaces exceeding N Mbps Traffic", "x": "6", "width": "6", "y": "40", "id": "473", "type": "Grid", "widgetUniqueName": "widget.name.overntraf", "desc": "Over N Traffic", "height": "22" }, { "widgetID": "246", "name": "Top 10 Interface Traffic", "x": "0", "width": "6", "y": "0", "id": "469", "type": "Grid", "widgetUniqueName": "widget.name.topntraf", "desc": "Top N Interface Traffic", "height": "22" }, { "widgetID": "245", "name": "Top 10 Bandwidth Utilization", "x": "6", "width": "6", "y": "0", "id": "470", "type": "Grid", "widgetUniqueName": "widget.name.topnbw", "desc": "Top N Bandwidth Utilization", "height": "20" } ], "dashName": "Network Top 10", "dashboardID": "3", "isDashPropsAvailable": true, "isDefaultDashboard": true, "viewType": "default" } } } } } }, "400": { "description": "Bad request. A mandatory parameter is missing or an invalid value was supplied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The apiKey is missing or invalid." }, "403": { "description": "Forbidden. The API key does not have sufficient privileges." }, "429": { "description": "Too many requests. Rate limit is 30 requests per minute. Exceeding this limit will block requests from that user for 1 minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "parameters": [ { "name": "dashboardName", "schema": { "$ref": "#/components/schemas/entityText_regex" }, "description": "Name of the dashboard from which widgets list should be retrieved. The dashboard name can be obtained from the browser URL when navigating to the required dashboard in the UI", "in": "query", "required": true } ], "tags": [ "OpManager.Dashboard" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/listSubnets": { "get": { "summary": "List Subnets", "x-zenesis-title": "List Subnets", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "300", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Lists all the Subnets added in OpManager", "operationId": "listSubnets", "responses": { "200": { "description": "Successful response containing the list of subnets added in OpManager.", "content": { "application/json": { "schema": { "type": "object", "description": "Map of subnet address to its details.", "additionalProperties": { "$ref": "#/components/schemas/SubnetDetail" } }, "examples": { "Example1": { "value": { "1.1.1.0": { "data": [ { "Status": "7", "Label": "Unknown", "Count": "1" } ], "displayName": "1.1.1.0", "subnetDisplayName": "" }, "10.5.5.0": { "data": [ { "Status": "1", "Label": "Critical", "Count": "1" }, { "Status": "2", "Label": "Trouble", "Count": "1" }, { "Status": "5", "Label": "Clear", "Count": "1" } ], "displayName": "10.5.5.0", "subnetDisplayName": "" } } } } } } } }, "parameters": [], "tags": [ "OpManager.Devices" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/setDeviceInfo": { "post": { "summary": "Set Device Metric Info", "x-zenesis-title": "Set Device Metric Info", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "60", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Allows administrators to configure and update device attributes such as HDD, RAM, Model, Manufacturer, OperatingSystem, and SoftwareVersion.", "operationId": "setDeviceInfo", "responses": { "200": { "description": "Device attributes updated successfully.", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "properties": { "message": { "type": "string", "description": "Human-readable status message of the update operation." } } } } }, "examples": { "Example1": { "value": { "result": { "message": "Values updated successfully" } } } } } } } }, "parameters": [ { "name": "deviceName", "schema": { "type": "string", "maxLength": 100 }, "description": "Internal name of the device used to uniquely identify it. This value can be retrieved from the deviceName field in the listDevices API response.", "in": "query", "required": false }, { "name": "ipAddress", "schema": { "type": "string", "maxLength": 100 }, "description": "IP address of the device. This value can be retrieved from the ipaddress field in the listDevices API response.", "in": "query", "required": false }, { "name": "dnsName", "schema": { "type": "string", "maxLength": 100 }, "description": "DNS name of the device. This value can be retrieved from the dnsName field in the getDeviceSummary API response.", "in": "query", "required": false }, { "name": "values", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceInfoMetricUpdate" } }, "description": "Device attributes to be updated. Include only the attributes that need to be updated. Supported attributes: HDD, RAM, Model, Manufacturer, OperatingSystem, SoftwareVersion. Example: [{\"metricName\":\"SoftwareVersion\",\"metricValue\":\"10.0.26101\"},{\"metricName\":\"Model\",\"metricValue\":\"VMware8,1\"}]", "in": "query", "required": true } ], "tags": [ "OpManager.Devices" ], "x-zenesis-doc": { "show": true } } }, "/api/json/discovery/getInfrastructureDetailsView": { "get": { "summary": "Get Infrastructure Details View", "x-zenesis-title": "Get Infrastructure Details View", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "100", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Provides device details such as device name, status, the associated performance monitor values etc, based on the given category.", "operationId": "getInfrastructureDetailsView", "responses": { "200": { "description": "Successful response containing the infrastructure details of the given category.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InfrastructureDetailsViewResponse" }, "examples": { "Example1": { "value": { "InfrastructureDetailsView": { "Details": [ { "severity": "5", "intfCount": "95", "displayName": "10.5.5.1", "name": "10.5.5.1", "IpAddress": "10.5.5.1", "type": "Windows 2019", "status": "Clear", "monitors": { "DiskUtilization": 95, "CPUUtilization": 22, "MemoryUtilization": 84 } } ], "TotalRecords": "1" } } } } } } } }, "parameters": [ { "name": "categoryName", "schema": { "type": "string", "maxLength": 100 }, "description": "The device category can be retrieved from the getCategoryList API response.", "in": "query", "required": true } ], "tags": [ "OpManager.Devices" ], "x-zenesis-doc": { "show": true } } }, "/api/json/v2/device/getDeviceCompleteDetails": { "get": { "summary": "Get Device Complete Details", "x-zenesis-title": "Get Device Complete Details", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "500", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Lists the basic details and availability of the device", "operationId": "getDeviceCompleteDetails", "responses": { "200": { "description": "Successful response containing the complete details of the device.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceCompleteDetails" }, "examples": { "Example1": { "value": { "credentialAssociated": "false", "nfadetails": { "NFAStatus": "Not Added" }, "statusStr": "Clear", "responseTime": "001ms", "dnsName": "10.5.5.1", "timeZone": "Asia/Calcutta", "availability": [ "UP,1782844226426,1782912206426,Up" ], "type": "Windows 2019", "vendorName": "Microsoft", "statusNum": "5", "isStorage": false, "packetLoss": "0", "opmdetails": { "Type": "Windows 2019", "Category": "Server", "displayCategory": "Servers", "PollInterval": "5", "IPAddress": "10.5.5.1", "DNSName": "10.5.5.1", "Monitoring": "ICMP", "UpLinkDependency": "None" }, "state": "1", "availdata": { "Down": 0, "Dependent Unavailable": 0, "Not Monitored": 0, "On Hold": 0, "Parent Down": 0, "On Maintenance": 0, "Up": 100 } } } } } } } }, "parameters": [ { "name": "name", "schema": { "type": "string", "maxLength": 100 }, "description": "Name of the device - Managed Entity name as seen in the URL of device snapshot page OR 'deviceName' property value in the listDevices API response.", "in": "query", "required": true } ], "tags": [ "OpManager.Devices" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/getVMWareHosts": { "get": { "summary": "Get VMWare Hosts", "x-zenesis-title": "Get VMWare Hosts", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "500", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Retrieves detailed information about VMware ESXi hosts along with inventory details monitored by OpManager for the specified type scope at either the vCenter level or the VxRail level.", "operationId": "getVMWareHosts", "responses": { "200": { "description": "Successful response containing the list of VMware hosts.", "content": { "application/json": { "schema": { "type": "array", "description": "List of VMware host objects.", "items": { "$ref": "#/components/schemas/VMwareHostDetail" } }, "examples": { "Example1": { "value": [ { "DISPLAYNAME": "ESXHost-2", "STATUS_STR": "Critical", "NUM_PNIC": 2, "OS": "ESXServer", "OS_TYPE": "vmnix-x86", "SYSUPTIME": "Apr 22, 2023 21:52 PM", "CONNECTION_STATUS": "connected", "NAME": "ESXHost-2", "VHOST_ID": 23703, "STATUS": "1", "CPU_SPEED_MHZ": 2195, "MEM_CAPACITY_MB": 130698, "POWER_STATE": "On" }, { "DISPLAYNAME": "ESXHost-1", "STATUS_STR": "Clear", "NUM_PNIC": 2, "OS": "ESXServer", "OS_TYPE": "vmnix-x86", "SYSUPTIME": "Apr 23, 2023 01:53 AM", "CONNECTION_STATUS": "connected", "NAME": "ESXHost-1", "VHOST_ID": 22505, "STATUS": "5", "CPU_SPEED_MHZ": 2195, "MEM_CAPACITY_MB": 130698, "POWER_STATE": "On" } ] } } } } } }, "parameters": [ { "name": "name", "schema": { "type": "string", "maxLength": 100 }, "description": "Internal name of the device used to uniquely identify it. The 'name' value can be obtained from the 'deviceName' key in the JSON response of the listVirtualDevices API response. Pass the 'virtualDeviceType' parameter as 'VCENTER' or 'VxRail' in the listVirtualDevices API to retrieve the corresponding virtual devices.", "in": "query", "required": true }, { "name": "type", "schema": { "type": "string", "enum": [ "VCENTER", "VXRAIL" ] }, "description": "Virtual entity type used to retrieve VMware host details.", "in": "query", "required": true } ], "tags": [ "OpManager.Devices" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/getDataCenterDetails": { "get": { "summary": "Get Data Center Details", "x-zenesis-title": "Get Data Center Details", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "500", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Fetches all datacenters associated with a specific vCenter and provides visibility into the vCenter inventory structure.", "operationId": "getDataCenterDetails", "responses": { "200": { "description": "Successful response containing the list of datacenters under the vCenter.", "content": { "application/json": { "schema": { "type": "array", "description": "List of datacenter objects.", "items": { "$ref": "#/components/schemas/VMwareDataCenterDetail" } }, "examples": { "Example1": { "value": [ { "NO_OF_DATASTORES": 5, "STATUS_STR": "Unknown", "STATUS": "7", "NO_OF_NETWORKS": 3, "ENTITY_NAME": "Datacenter" }, { "NO_OF_DATASTORES": 0, "STATUS_STR": "Unknown", "STATUS": "7", "NO_OF_NETWORKS": 0, "ENTITY_NAME": "Datacenter 2" } ] } } } } } }, "parameters": [ { "name": "moID", "schema": { "type": "integer", "format": "int64" }, "description": "Internal ID of the VMware vCenter used to uniquely identify it. The 'moID' value can be obtained from the 'MOID' key in the JSON response of the listVirtualDevices API response. Pass the 'virtualDeviceType' parameter as 'VCENTER' in the listVirtualDevices API to retrieve the corresponding virtual devices.", "in": "query", "required": true } ], "tags": [ "OpManager.Devices" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/getClusterDetails": { "get": { "summary": "Get Cluster Details", "x-zenesis-title": "Get Cluster Details", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "500", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Fetches all clusters associated with a specific vCenter and provides visibility into the vCenter inventory structure at cluster level.", "operationId": "getClusterDetails", "responses": { "200": { "description": "Successful response containing the list of clusters under the vCenter.", "content": { "application/json": { "schema": { "type": "array", "description": "List of cluster objects.", "items": { "$ref": "#/components/schemas/VMwareClusterDetail" } }, "examples": { "Example1": { "value": [ { "NO_OF_DATASTORES": 5, "STATUS_STR": "Clear", "STATUS": "5", "NO_OF_NETWORKS": 2, "EFFECTIVE_CPU": 76780, "NO_OF_HOSTS": 2, "TOTAL_CPU_GHZ": 86, "DRS_ENABLED": false, "DAS_ENABLED": true, "EFFECTIVE_MEMORY": 208229, "ENTITY_NAME": "VSANLab", "TOTAL_MEMORY_GB": 255 } ] } } } } } }, "parameters": [ { "name": "moID", "schema": { "type": "integer", "format": "int64" }, "description": "Internal ID of the VMware vCenter used to uniquely identify it. The 'moID' value can be obtained from the 'MOID' key in the JSON response of the listVirtualDevices API response. Pass the 'virtualDeviceType' parameter as 'VCENTER' in the listVirtualDevices API to retrieve the corresponding virtual devices.", "in": "query", "required": true } ], "tags": [ "OpManager.Devices" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/getVMWareDataStores": { "get": { "summary": "Get VMWare DataStores", "x-zenesis-title": "Get VMWare DataStores", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "500", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Retrieves detailed information about VMware datastores based on the selected entity type.\n\nThis API supports fetching datastore details at multiple levels, including vCenter, Host, Virtual Machine, and VxRail, providing flexible storage visibility across the VMware environment.", "operationId": "getVMWareDataStores", "responses": { "200": { "description": "Successful response containing the list of VMware datastores.", "content": { "application/json": { "schema": { "type": "array", "description": "List of VMware datastore objects.", "items": { "$ref": "#/components/schemas/VMwareDataStoreDetail" } }, "examples": { "Example1": { "value": [ { "HostCount": 1, "DATASTORENAME": "VMDatastorage (1)", "Datastore_ID": 23719, "FILESYSTEM_TYPE": "VMFS", "CAPACITY_MB": 3224, "DATASTORE_URL": "ds:///vmfs/volumes/442ec0fc-67dad2ec-386f-b496913ce490/", "MOID": 48373, "FREESPACE_MB": 615, "deviceName": "device1_com_datastore-1923", "IS_ACCESSIBLE": "5" }, { "HostCount": 2, "DATASTORENAME": "VSANDatastore", "Datastore_ID": 32101, "FILESYSTEM_TYPE": "vsan", "CAPACITY_MB": 1862, "DATASTORE_URL": "ds:///vmfs/volumes/vsan:56f4a7b4df993895-66fa8c0ed80efd32/", "MOID": 61801, "FREESPACE_MB": 1840, "deviceName": "device3_datastore-2718", "IS_ACCESSIBLE": "5" } ] } } } } } }, "parameters": [ { "name": "name", "schema": { "type": "string", "maxLength": 100 }, "description": "Internal name of the monitored VMware entity used to uniquely identify it. The 'name' value can be obtained from the 'deviceName' key in the JSON response of the listVirtualDevices API response. Pass the 'virtualDeviceType' parameter as 'VCENTER' or 'VHOST', 'VxRail', 'VM' in the listVirtualDevices API to retrieve the corresponding virtual devices.", "in": "query", "required": true }, { "name": "type", "schema": { "type": "string", "enum": [ "VCENTER", "HOST", "VM", "VXRAIL" ] }, "description": "Specifies the VMware entity level for which datastore associated details should be retrieved. If not specified, datastore details are retrieved based on the provided name.", "in": "query", "required": false } ], "tags": [ "OpManager.Devices" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/getNutanixVDisks": { "get": { "summary": "Get Nutanix VDisks", "x-zenesis-title": "Get Nutanix VDisks", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "500", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Retrieves information about virtual disks associated to the specific VM in a Nutanix cluster", "operationId": "getNutanixVDisks", "responses": { "200": { "description": "Successful response containing the list of Nutanix virtual disks.", "content": { "application/json": { "schema": { "type": "array", "description": "List of Nutanix virtual disk objects.", "items": { "$ref": "#/components/schemas/NutanixVDiskDetail" } }, "examples": { "Example1": { "value": [ { "CAPACITY": "150", "NFSFILEPATH": "/General/.acropolis/vmdisk/343e6469-b11d-e321-b30a-1598371a20f8", "VDISK_ID": 1, "DISKADDRESS": "scsi.0", "UUID": "343e6469-b11d-e321-b30a-1598371a20f8" } ] } } } } } }, "parameters": [ { "name": "name", "schema": { "type": "string", "maxLength": 100 }, "description": "Internal name of the managed Nutanix VM used to uniquely identify it. This value can be retrieved from the name field in the getNutanixVMs API response.", "in": "query", "required": true } ], "tags": [ "OpManager.Devices" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/getNutanixDetails": { "get": { "summary": "Get Nutanix Details", "x-zenesis-title": "Get Nutanix Details", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "500", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Retrieves detailed information about Nutanix infrastructure components based on the specified entity types such as virtual machines, hosts, or clusters.", "operationId": "getNutanixDetails", "responses": { "200": { "description": "Successful response containing the Nutanix entity details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NutanixEntityDetail" }, "examples": { "Example1": { "value": { "DISPLAYNAME": "NutanixVM2", "clusterMoName": "Nutanix-Cluster-1", "hostName": "Nutanix-Host-1", "VCPUCOUNT": 2, "VM_ID": 21, "statusStr": "Clear", "TOOLSMOUNTED": false, "TOOLSVERSION": "1.2.0.3", "VM_POWERSTATE": "Powered On", "DISKCAPACITY": "150", "IPADDRESS": "10.5.5.1", "uuid": "3af940cd-b453-485d-89ab-2cab95aba188", "deviceName": "Nutanix-VM-1", "MEMORYCAPACITY": "6", "statusNum": 5, "ISCONTROLLERVM": "False", "NOOFNETWORKADAPTERS": 1, "clusterName": "Nutanix-Cluster-1", "hostMoName": "Nutanix-Host-1", "MOID": 307, "MEMRESERVEDCAPACITY": "6", "ENTITYNAME": "Nutanix-VM-2" } } } } } } }, "parameters": [ { "name": "deviceName", "schema": { "type": "string", "maxLength": 100 }, "description": "Internal name of the managed entity used to uniquely identify it. This value can be retrieved from the deviceName field in the listVirtualDevices API response.", "in": "query", "required": true }, { "name": "entityType", "schema": { "type": "string", "enum": [ "Nutanix-Cluster", "Nutanix-Host", "Nutanix-VM" ] }, "description": "Virtual entity type used to retrieve Nutanix device details.", "in": "query", "required": true } ], "tags": [ "OpManager.Devices" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/addVxRailTovCenter": { "post": { "summary": "Add VxRail to vCenter", "x-zenesis-title": "Add VxRail to vCenter", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "500", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "This API is used to monitor a VxRail system and associate it with a specific vCenter instance, thereby enabling centralized management.", "operationId": "addVxRailTovCenter", "responses": { "200": { "description": "VxRail device successfully submitted for discovery under the vCenter.", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "properties": { "message": { "type": "string", "description": "Human-readable status message of the operation." } } } } }, "examples": { "Example1": { "value": { "result": { "message": "VxRail inventory discovery in progress." } } } } } } } }, "parameters": [ { "name": "deviceName", "schema": { "type": "string", "maxLength": 100 }, "description": "Internal name of the vCenter device to which the VxRail device should be added. This value can be retrieved from the deviceName field in the listVirtualDevices API response. Pass virtualDeviceType as VCENTER in the listVirtualDevices API to retrieve the vCenter devices.", "in": "query", "required": true }, { "name": "vxrailDeviceName", "schema": { "type": "string", "maxLength": 100 }, "description": "IP address or DNS name of the VxRail device to be added to the vCenter.", "in": "query", "required": true }, { "name": "vxrailCredentialName", "schema": { "type": "string" }, "description": "Credential profile to be used for discovering the VxRail device. Multiple credentials can be entered as comma-separated values.", "in": "query", "required": true } ], "tags": [ "OpManager.Devices" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/EditPerformanceMonitor": { "post": { "summary": "Edit Performance Monitor", "x-zenesis-title": "Edit Performance Monitor", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "500", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Updating the Performance monitor", "operationId": "EditPerformanceMonitor", "responses": { "200": { "description": "Performance monitor updated successfully.", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "properties": { "message": { "type": "string", "description": "Human-readable status message of the update operation." } } } } }, "examples": { "Example1": { "value": { "result": { "message": "Successfully modified the graph" } } } } } } } }, "parameters": [ { "name": "name", "schema": { "type": "string", "maxLength": 100 }, "description": "Internal name of the device used to uniquely identify it. The 'name' value can be obtained from the 'deviceName' key in the JSON response of the listDevices API.", "in": "query", "required": true }, { "name": "policyName", "schema": { "type": "string" }, "description": "Internal name of the monitor used to uniquely identify it. The 'policyName' value can be obtained from the 'policyName' key in the JSON response of the getPerformanceMonitorDetails API.", "in": "query", "required": true }, { "name": "graphName", "schema": { "type": "string" }, "description": "Additional parameter of the performance monitor used to uniquely identify it. The 'graphName' value can be obtained from the 'name' key in the JSON response of the getDeviceAssociatedMonitors API.", "in": "query", "required": false }, { "name": "pollId", "schema": { "type": "integer", "format": "int64" }, "description": "Internal id of the monitor used to uniquely identify it. The 'pollId' value can be obtained from the 'Id' key in the JSON response of the getPerformanceMonitorDetails API.", "in": "query", "required": true }, { "name": "checkNumeric", "schema": { "type": "boolean" }, "description": "Indicates whether the monitor returns a numeric value or a string value. The 'checkNumeric' value can be obtained from the 'checkNumeric' key in the JSON response of the getPerformanceMonitorDetails API.", "in": "query", "required": true }, { "name": "displayName", "schema": { "type": "string" }, "description": "DisplayName of the performance monitor. The 'displayName' value can be obtained from the 'DISPLAYNAME' key in the JSON response of the getPerformanceMonitorDetails API.", "in": "query", "required": true }, { "name": "thresholdName", "schema": { "type": "string" }, "description": "Internal name of the threshold used to uniquely identify it.", "in": "query", "required": true }, { "name": "type", "schema": { "type": "string" }, "description": "Internal type of the monitor used to uniquely identify it. The 'type' value can be obtained from the 'graphType' key in the JSON response of the getPerformanceMonitorDetails API.", "in": "query", "required": true }, { "name": "timeAvg", "schema": { "type": "string", "enum": [ "" ] }, "description": "timeAvg of the monitor.", "in": "query", "required": true }, { "name": "vendor", "schema": { "type": "string", "enum": [ "" ] }, "description": "Vendor of the monitor.", "in": "query", "required": true }, { "name": "sendClear", "schema": { "type": "boolean", "enum": [ true ] }, "description": "SendClear of the monitor.", "in": "query", "required": false }, { "name": "oid", "schema": { "type": "string" }, "description": "Internal OID of the monitor used for data collection. The 'oid' value can be obtained from the 'oid' key in the JSON response of the getPerformanceMonitorDetails API.", "in": "query", "required": true }, { "name": "interval", "schema": { "type": "integer" }, "description": "Specifies the interval of the monitor to be updated, in minutes. The 'interval' value can be obtained from the 'interval' key in the JSON response of the getPerformanceMonitorDetails API.", "in": "query", "required": true }, { "name": "yaxisText", "schema": { "type": "string" }, "description": "Unit of a performance monitor. The 'yaxisText' value can be obtained from the 'YAXISTEXT' key in the JSON response of the getPerformanceMonitorDetails API.", "in": "query", "required": true }, { "name": "failureThreshold", "schema": { "type": "integer" }, "description": "Specifies the number of consecutive times the threshold must be violated before an alert is generated. The 'failureThreshold' value can be obtained from the 'FAILURETHRESHOLD' key in the JSON response of the getPerformanceMonitorDetails API.", "in": "query", "required": true }, { "name": "oidType", "schema": { "type": "string", "enum": [ "" ] }, "description": "Internal type of the oid uniquely used to identify it.", "in": "query", "required": false }, { "name": "firstTime", "schema": { "type": "boolean", "enum": [ false ] }, "description": "Used to identify whether the monitor is being modified for the first time.", "in": "query", "required": false }, { "name": "thresholdEnabled", "schema": { "type": "boolean" }, "description": "The 'thresholdEnabled' value can be obtained from the 'THRESHOLDENABLED' key in the JSON response of the getPerformanceMonitorDetails API.", "in": "query", "required": false }, { "name": "perfDataStoreType", "schema": { "type": "integer" }, "description": "Data should be stored or not", "in": "query", "required": false }, { "name": "instanceName", "schema": { "type": "string" }, "description": "When the monitor is an MSSQL Application Monitor, pass this parameter with the MSSQL instance name. MSSQL Instance name can be fetched from the end device or can be viewed from MSSQL Tab in device snapshot page of MSSQL device in OpManager.", "in": "query", "required": false }, { "name": "isGraphNeeded", "schema": { "type": "boolean" }, "description": "Specifies whether data storage is enabled for the monitor. The 'isGraphNeeded' value can be obtained from the 'sSave' key in the JSON response of the getPerformanceMonitorDetails API.", "in": "query", "required": true }, { "name": "isAdaptiveThresholdsEnabled", "schema": { "type": "boolean" }, "description": "Specifies whether the adaptive threshold is enabled.", "in": "query", "required": false }, { "name": "deviationType", "schema": { "type": "integer", "enum": [ 1, 2 ] }, "description": "Specifies the deviation type of the adaptive threshold: 1 for percentage and 2 for value.", "in": "query", "required": false }, { "name": "warningThresholdType", "schema": { "type": "string", "enum": [ "min", "max", "equal", "notEqual" ] }, "description": "Threshold type of the warning severity of the Integer monitor", "in": "query", "required": false }, { "name": "warningThresholdTextualType", "schema": { "type": "string", "enum": [ "Contains", "Equals", "Not Contains", "Not Equals", "Regex" ] }, "description": "Threshold type of the warning severity of the String monitor", "in": "query", "required": false }, { "name": "warningThresholdTextValue", "schema": { "type": "string" }, "description": "Threshold Value of the warning severity of the String monitor", "in": "query", "required": false }, { "name": "warningMessage", "schema": { "type": "string" }, "description": "Threshold Value of the warning severity of the int monitor", "in": "query", "required": false }, { "name": "troubleThresholdType", "schema": { "type": "string", "enum": [ "min", "max", "equal", "notEqual" ] }, "description": "Threshold Value of the warning severity of the integer monitor", "in": "query", "required": false }, { "name": "troubleThresholdTextualType", "schema": { "type": "string", "enum": [ "Contains", "Equals", "Not Contains", "Not Equals", "Regex" ] }, "description": "Threshold Type of the warning severity of the String monitor", "in": "query", "required": false }, { "name": "troubleThresholdTextValue", "schema": { "type": "string", "enum": [ "Contains", "Equals", "Not Contains", "Not Equals", "Regex" ] }, "description": "Threshold Type of the trouble severity of the String monitor", "in": "query", "required": false }, { "name": "troubleMessage", "schema": { "type": "string" }, "description": "Threshold Message of the trouble severity of the int monitor", "in": "query", "required": false }, { "name": "criticalThresholdType", "schema": { "type": "string", "enum": [ "min", "max", "equal", "notEqual" ] }, "description": "Threshold Value of the critical severity of the integer monitor", "in": "query", "required": false }, { "name": "criticalThresholdTextualType", "schema": { "type": "string", "enum": [ "Contains", "Equals", "Not Contains", "Not Equals", "Regex" ] }, "description": "Threshold condition of the critical severity of the String monitor", "in": "query", "required": false }, { "name": "criticalThresholdTextValue", "schema": { "type": "string" }, "description": "Threshold Value of the critical severity of the String monitor", "in": "query", "required": false }, { "name": "criticalMessage", "schema": { "type": "string" }, "description": "Threshold Message of the Critical severity of the int monitor", "in": "query", "required": false }, { "name": "upperlimitThresholdType", "schema": { "type": "string", "enum": [ "max", "min" ] }, "description": "Threshold Type of the Upper limit of the Adaptive threshold", "in": "query", "required": false }, { "name": "upperlimitThresholdTextualType", "schema": { "type": "string", "enum": [ "max", "equal", "min", "notEqual", "Contains", "Equals", "Not Contains", "Not Equals", "Regex" ] }, "description": "Threshold Type of the Upper limit of the Adaptive threshold", "in": "query", "required": false }, { "name": "upperlimitThresholdTextValue", "schema": { "type": "number", "format": "double" }, "description": "Threshold Value of the Upper limit of the Adaptive threshold", "in": "query", "required": false }, { "name": "upperlimitMessage", "schema": { "type": "string" }, "description": "Threshold Message of the Upper limit of the Adaptive threshold", "in": "query", "required": false }, { "name": "upperlimitSeverity", "schema": { "type": "integer", "minimum": 1, "maximum": 7 }, "description": "Threshold Severity of the Upper limit of the Adaptive threshold", "in": "query", "required": false }, { "name": "lowerlimitThresholdType", "schema": { "type": "string", "enum": [ "max", "min" ] }, "description": "Threshold Type of the lower limit of the Adaptive threshold", "in": "query", "required": false }, { "name": "lowerlimitThresholdTextualType", "schema": { "type": "string", "enum": [ "max", "equal", "min", "notEqual", "Contains", "Equals", "Not Contains", "Not Equals", "Regex" ] }, "description": "Threshold Type of the lower limit of the Adaptive threshold", "in": "query", "required": false }, { "name": "lowerlimitThresholdTextValue", "schema": { "type": "number", "format": "double" }, "description": "Threshold Value of the lower limit of the Adaptive threshold", "in": "query", "required": false }, { "name": "clearThresholdType", "schema": { "type": "string", "enum": [ "min", "max", "equal", "notEqual" ] }, "description": "To clear alert the Threshold Type", "in": "query", "required": false }, { "name": "rearmTextualType", "schema": { "type": "string", "enum": [ "Contains", "Equals", "Not Contains", "Not Equals", "Regex" ] }, "description": "To clear alert the Threshold Type of String", "in": "query", "required": false }, { "name": "rearmTextValue", "schema": { "type": "string" }, "description": "Rearm text value", "in": "query", "required": false }, { "name": "clrMessage", "schema": { "type": "string" }, "description": "Clear message of the monitor", "in": "query", "required": false }, { "name": "adStoreFilePath", "schema": { "type": "string" }, "description": "AD Store file path", "in": "query", "required": false }, { "name": "xchgStoreLocation", "schema": { "type": "string" }, "description": "Exchange Store Location", "in": "query", "required": false }, { "name": "minInterval", "schema": { "type": "integer", "enum": [ 0 ] }, "description": "Minimum interval", "in": "query", "required": false }, { "name": "isMultipleThreshold", "schema": { "type": "boolean" }, "description": "Is multiple threshold", "in": "query", "required": false }, { "name": "downSeverity", "schema": { "type": "integer", "enum": [ 1, 2, 3, 4, 6 ] }, "description": "Down Severity", "in": "query", "required": false }, { "name": "downConsecutiveTime", "schema": { "type": "integer", "enum": [ 1, 2, 3, 4, 6 ] }, "description": "Consecutive time of the service monitor", "in": "query", "required": false }, { "name": "warningThresholdValue", "schema": { "type": "number", "format": "double" }, "description": "Threshold value of the warning severity of the monitor", "in": "query", "required": false }, { "name": "troubleThresholdValue", "schema": { "type": "number", "format": "double" }, "description": "Threshold value of the trouble severity of the monitor", "in": "query", "required": false }, { "name": "criticalThresholdValue", "schema": { "type": "number", "format": "double" }, "description": "Threshold value of the critical severity of the monitor", "in": "query", "required": false }, { "name": "lowerlimitThresholdValue", "schema": { "type": "number", "format": "double" }, "description": "Lower limit of the Threshold value of the adaptive threshold", "in": "query", "required": false }, { "name": "upperlimitThresholdValue", "schema": { "type": "number", "format": "double" }, "description": "Upper limit of the Threshold value of the adaptive threshold", "in": "query", "required": false }, { "name": "rearmValue", "schema": { "type": "number", "format": "double" }, "description": "Rearm of the Threshold value of the monitor", "in": "query", "required": false } ], "tags": [ "OpManager.Devices" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/getAssociatedMonitors": { "get": { "summary": "Get Associated Monitors", "x-zenesis-title": "Get Associated Monitors", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "500", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "The API returns a complete list of monitors associated with the device, including performance monitors, application monitors, Windows services, and scripts, along with their last polled values and status.", "operationId": "getAssociatedMonitors", "responses": { "200": { "description": "Successful response containing the monitors associated with the device.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssociatedMonitorsResponse" }, "examples": { "Example1": { "value": { "performanceMonitors": { "total": 1, "down": 0, "monitors": [ { "DISPLAYNAME": "CPU Utilization", "checkNumeric": "true", "graphType": "multiple", "policyName": "WMI-CPUUtilization", "THRESHOLDENABLED": "true", "thresholdStatus": "Violated", "groupName": "WMI", "name": "WMI-CPUUtilization", "interval": "8", "Id": "22905", "Protocol": "WMI" } ] }, "serverMonitors": { "total": 1, "down": 1, "monitors": [ { "portNo": "25", "failureThreshold": 1, "name": "SMTP", "status": "images/servicestatus7.gif" } ] }, "ntServiceMonitors": { "total": 1, "down": 1, "monitors": [ { "name": "Print Spooler", "serviceName": "Spooler", "moid": "89263", "status": "/images/devices/status7.gif" } ] }, "urlMonitors": { "total": 0, "down": 0, "monitors": [] }, "processMonitors": { "total": 1, "down": 1, "monitors": [ { "statusStr": "Unknown", "trimName": "csrss.exe", "statusNum": "7", "name": "csrss.exe", "id": "81371" } ] }, "fileMonitors": { "total": 0, "down": 0, "monitors": [] }, "eventlogMonitors": { "period": "300", "total": 1, "isActive": "true", "down": 0, "monitors": [ { "ruleName": "Eventlog Service stopped", "id": "29" } ] }, "folderMonitors": { "total": 0, "down": 0, "monitors": [] }, "scriptMonitors": { "total": 1, "down": 1, "monitors": [ { "displayName": "Certificate Expiry Monitor", "pollid": "24728", "thresholdSeverity": "Violated", "interval": "15", "OID": "33611" } ] } } } } } } } }, "parameters": [ { "name": "name", "schema": { "type": "string", "maxLength": 100 }, "description": "Internal name of the device used to uniquely identify it. This value can be retrieved from the deviceName field in the listDevices API response.", "in": "query", "required": true } ], "tags": [ "OpManager.Devices" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/getDeviceAssociatedProcessMonitors": { "get": { "summary": "Get Device Associated Process Monitors", "x-zenesis-title": "Get Device Associated Process Monitors", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "500", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "The API provides a complete list of Process Monitors associated with the device, including details such as process path, arguments, and status.", "operationId": "getDeviceAssociatedProcessMonitors", "responses": { "200": { "description": "Successful response containing the process monitors associated with the device.", "content": { "application/json": { "schema": { "type": "array", "description": "List of process monitor objects.", "items": { "$ref": "#/components/schemas/DeviceProcessMonitorDetail" } }, "examples": { "Example1": { "value": [ { "path": "/usr/sbin/writesrv", "processName": "writesrv", "displayName": "writesrv", "cmdLineArgs": "", "status": "Clear" } ] } } } } } }, "parameters": [ { "name": "name", "schema": { "type": "string", "maxLength": 100 }, "description": "Internal name of the device used to uniquely identify it. This value can be retrieved from the deviceName field in the listDevices API response.", "in": "query", "required": true } ], "tags": [ "OpManager.Devices" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/getDeviceAssociatedServiceMonitors": { "get": { "summary": "Get Device Associated Service Monitors", "x-zenesis-title": "Get Device Associated Service Monitors", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "500", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "The API provides a complete list of Service monitors linked to the device, including details such as name, port, and status.", "operationId": "getDeviceAssociatedServiceMonitors", "responses": { "200": { "description": "Successful response containing the service monitors associated with the device.", "content": { "application/json": { "schema": { "type": "array", "description": "List of service monitor objects.", "items": { "$ref": "#/components/schemas/DeviceServiceMonitorDetail" } }, "examples": { "Example1": { "value": [ { "name": "DNS", "portNo": "80", "status": "Clear" } ] } } } } }, "401": { "description": "Unauthorized." }, "403": { "description": "Forbidden." }, "429": { "description": "Too many requests. Rate limit is 500 requests per minute." } }, "parameters": [ { "name": "name", "schema": { "type": "string", "maxLength": 100 }, "description": "Internal name of the device used to uniquely identify it. This value can be retrieved from the deviceName field in the listDevices API response.", "in": "query", "required": true } ], "tags": [ "OpManager.Devices" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/getDeviceAssociatedWindowsServiceMonitors": { "get": { "summary": "Get Device Associated Windows Service Monitors", "x-zenesis-title": "Get Device Associated Windows Service Monitors", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "500", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Fetches the list of Windows service monitors associated to a device", "operationId": "getDeviceAssociatedWindowsServiceMonitors", "responses": { "200": { "description": "Successful response containing the Windows service monitors associated with the device.", "content": { "application/json": { "schema": { "type": "array", "description": "List of Windows service monitor objects.", "items": { "$ref": "#/components/schemas/DeviceWindowsServiceMonitorDetail" } }, "examples": { "Example1": { "value": [ { "displayName": "Print Spooler", "serviceName": "Spooler", "serviceID": "1", "status": "Clear" }, { "displayName": "RPC", "serviceName": "RpcSs", "serviceID": "14", "status": "Clear" } ] } } } } }, "401": { "description": "Unauthorized." }, "403": { "description": "Forbidden." }, "429": { "description": "Too many requests. Rate limit is 500 requests per minute." } }, "parameters": [ { "name": "name", "schema": { "type": "string", "maxLength": 100 }, "description": "Internal name of the device used to uniquely identify it. The 'name' value can be obtained from the 'deviceName' key in the JSON response of the listDevices API.", "in": "query", "required": true } ], "tags": [ "OpManager.Devices" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/getGraphNames": { "get": { "summary": "Get Graph Names", "x-zenesis-title": "Get Graph Names", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "500", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "The API will return a complete set of performance monitors associated with the device, including properties such as displayName, pollId, policyName, name, protocol, OID, and graphType.\n\nNote: If you're looking for performance monitor details alone, we recommend using the getLastCollectedValues API, which is more efficient and returns the last collected values of the monitors along with other properties.", "operationId": "getGraphNames", "responses": { "200": { "description": "Successful response containing the performance monitors associated with the device.", "content": { "application/json": { "schema": { "type": "array", "description": "List of performance monitor objects.", "items": { "$ref": "#/components/schemas/DeviceGraphNameDetail" } }, "examples": { "Example1": { "value": [ { "protocol": "WMI", "graphType": "multiple", "policyName": "WMI-MemoryUtilization", "displayName": "Memory Utilization", "pollId": "28650", "name": "WMI-MemoryUtilization", "oid": "Memory Utilization" }, { "protocol": "WMI", "graphType": "multiplenode", "policyName": "WMI-PartitionDetails", "displayName": "Partition Details of the Device(%)-C:", "pollId": "28653", "name": "C:", "oid": "Partition Details of the Device" } ] } } } } }, "401": { "description": "Unauthorized." }, "403": { "description": "Forbidden." }, "429": { "description": "Too many requests. Rate limit is 500 requests per minute." } }, "parameters": [ { "name": "name", "schema": { "type": "string", "maxLength": 100 }, "description": "Internal name of the device used to uniquely identify it. This value can be retrieved from the deviceName field in the listDevices API response.", "in": "query", "required": true } ], "tags": [ "OpManager.Devices" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/getNutanixDisks": { "get": { "summary": "Get Nutanix Disks", "x-zenesis-title": "Get Nutanix Disks", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "500", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Retrieves detailed information about disks within the Nutanix environment. Based on the specified entity type, this API returns disk-level details at either the cluster level or the host level.", "operationId": "getNutanixDisks", "responses": { "200": { "description": "Successful response containing the list of Nutanix disks.", "content": { "application/json": { "schema": { "type": "array", "description": "List of Nutanix disk objects.", "items": { "$ref": "#/components/schemas/NutanixDiskDetail" } }, "examples": { "Example1": { "value": [ { "CAPACITY": "3330.52", "STATUS": "NORMAL", "DISK_ID": 36, "SERIALNUMBER": "local123", "USAGE": "741.21", "TIER": "SSD", "MOUNTPATH": "/home/nutanix/data/stargate-storage/disks/local123" }, { "CAPACITY": "3119.15", "STATUS": "NORMAL", "DISK_ID": 40, "SERIALNUMBER": "local126", "USAGE": "721.46", "TIER": "SSD", "BOOTDISK": true, "MOUNTED": true, "VENDOR": "Not Available", "MODEL": "SAMSUNG -00005", "MOUNTPATH": "/home/nutanix/data/stargate-storage/disks/local126" } ] } } } } }, "401": { "description": "Unauthorized." }, "403": { "description": "Forbidden." }, "429": { "description": "Too many requests. Rate limit is 500 requests per minute." } }, "parameters": [ { "name": "name", "schema": { "type": "string", "maxLength": 100 }, "description": "Internal name of the managed Nutanix entity used to uniquely identify it. This value can be retrieved from the deviceName field in the listVirtualDevices API response. Pass virtualDeviceType as Nutanix-Cluster or Nutanix-Host in the listVirtualDevices API to retrieve the corresponding virtual devices.", "in": "query", "required": true }, { "name": "type", "schema": { "type": "string", "enum": [ "Nutanix-Cluster", "Nutanix-Host" ] }, "description": "Specifies the Nutanix entity type for which disk details should be retrieved.", "in": "query", "required": true } ], "tags": [ "OpManager.Devices" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/getNutanixHosts": { "get": { "summary": "Get Nutanix Hosts", "x-zenesis-title": "Get Nutanix Hosts", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "500", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Retrieves detailed information about all hosts within a specified Nutanix cluster. This API provides visibility into host-level resources, health, and operational status", "operationId": "getNutanixHosts", "responses": { "200": { "description": "Successful response containing the list of Nutanix hosts.", "content": { "application/json": { "schema": { "type": "array", "description": "List of Nutanix host objects.", "items": { "$ref": "#/components/schemas/NutanixHostDetail" } }, "examples": { "Example1": { "value": [ { "DISPLAYNAME": "NutanixHost1", "statusStr": "Critical", "DISKCAPACITY": "19560.36", "IPADDRESS": "10.255.1.255", "HYPERVISORDETAIL": "Nutanix 20170830.265", "CPUMODEL": "Intel(R) Xeon(R) Gold 6138 CPU @ 2.00GHz", "MEMORYCAPACITY": "503.49", "statusNum": 1, "NAME": "nutanixHost1.mydomain.com", "BOOTTIME": "2019-05-27 20:48:24.153", "SELECTIONSTATE": 1, "NUMCPUCORES": 40, "HOST_ID": 21, "state": 2, "TYPE": "kKvm" } ] } } } } }, "401": { "description": "Unauthorized." }, "403": { "description": "Forbidden." }, "429": { "description": "Too many requests. Rate limit is 500 requests per minute." } }, "parameters": [ { "name": "name", "schema": { "type": "string", "maxLength": 100 }, "description": "Internal name of the device used to uniquely identify it. This value can be retrieved from the deviceName field in the listDevices API response.", "in": "query", "required": true } ], "tags": [ "OpManager.Devices" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/getNutanixOrphanedVMs": { "get": { "summary": "Get Nutanix Orphaned VMs", "x-zenesis-title": "Get Nutanix Orphaned VMs", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "500", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Retrieves detailed information about orphaned virtual machines within the Nutanix environment. Orphaned VMs are virtual machines that exist in storage but are no longer properly associated with an active host or cluster.", "operationId": "getNutanixOrphanedVMs", "responses": { "200": { "description": "Successful response containing the list of orphaned Nutanix VMs.", "content": { "application/json": { "schema": { "type": "array", "description": "List of orphaned Nutanix virtual machine objects.", "items": { "$ref": "#/components/schemas/NutanixOrphanedVMDetail" } }, "examples": { "Example1": { "value": [ { "NUMNETWORKADAPTERS": 1, "DISPLAYNAME": "opm-Nutanix44VM233", "VCPUCOUNT": 2, "VM_ID": 22, "statusStr": "Critical", "OS": "Windows 2012 R2", "DISKCAPACITY": "150", "IPADDRESS": "99.99.99.99", "MEMORYCAPACITY": "6", "statusNum": 1, "NAME": "99.99.99.99", "ISCONTROLLERVM": false, "SELECTIONSTATE": -5 } ] } } } } }, "401": { "description": "Unauthorized." }, "403": { "description": "Forbidden." }, "429": { "description": "Too many requests. Rate limit is 500 requests per minute." } }, "parameters": [ { "name": "name", "schema": { "type": "string", "maxLength": 100 }, "description": "Internal name of the managed Nutanix entity used to uniquely identify it. This value can be retrieved from the deviceName field in the listVirtualDevices API response. Pass virtualDeviceType as Nutanix-Cluster or Nutanix-Host in the listVirtualDevices API to retrieve the corresponding virtual devices.", "in": "query", "required": true }, { "name": "type", "schema": { "type": "string", "enum": [ "Nutanix-Cluster", "Nutanix-Host" ] }, "description": "Specifies the Nutanix entity type for which disk details should be retrieved.", "in": "query", "required": true } ], "tags": [ "OpManager.Devices" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/getNutanixStorageContainers": { "get": { "summary": "Get Nutanix Storage Containers", "x-zenesis-title": "Get Nutanix Storage Containers", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "500", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Retrieves detailed information about all storage containers configured within a specified Nutanix cluster. This API provides visibility into container-level storage resources used for hosting virtual machine data.", "operationId": "getNutanixStorageContainers", "responses": { "200": { "description": "Successful response containing the list of Nutanix storage containers.", "content": { "application/json": { "schema": { "type": "array", "description": "List of Nutanix storage container objects.", "items": { "$ref": "#/components/schemas/NutanixStorageContainerDetail" } }, "examples": { "Example1": { "value": [ { "CAPACITY": "77150.47", "CACHEDUPLICATION": "POST_PROCESS", "RF": 2, "ERASUREENCODING": "on", "USAGE": "334.77", "COMPRESSION": true, "SC_ID": 5, "NAME": "default-container" }, { "CAPACITY": "76889.46", "CACHEDUPLICATION": "OFF", "RF": 2, "ERASUREENCODING": "off", "USAGE": "73.75", "COMPRESSION": true, "SC_ID": 6, "NAME": "NutanixMgmtShare" } ] } } } } }, "401": { "description": "Unauthorized." }, "403": { "description": "Forbidden." }, "429": { "description": "Too many requests. Rate limit is 500 requests per minute." } }, "parameters": [ { "name": "name", "schema": { "type": "string", "maxLength": 100 }, "description": "Internal name of the managed Nutanix Cluster used to uniquely identify it. The 'name' value can be obtained from the 'deviceName' key in the JSON response of the listVirtualDevices API response. Pass the 'virtualDeviceType' parameter as 'Nutanix-Cluster' in the listVirtualDevices API to retrieve the corresponding virtual devices.", "in": "query", "required": true } ], "tags": [ "OpManager.Devices" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/getNutanixStoragePools": { "get": { "summary": "Get Nutanix Storage Pools", "x-zenesis-title": "Get Nutanix Storage Pools", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "500", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Retrieves detailed information about all storage pools available within a Nutanix cluster. Storage pools represent the combined physical storage resources that are used to create and manage storage containers and virtual machine workloads.", "operationId": "getNutanixStoragePools", "responses": { "200": { "description": "Successful response containing the list of Nutanix storage pools.", "content": { "application/json": { "schema": { "type": "array", "description": "List of Nutanix storage pool objects.", "items": { "$ref": "#/components/schemas/NutanixStoragePoolDetail" } }, "examples": { "Example1": { "value": [ { "CAPACITY": "1.15", "DISKS": 1, "SP_ID": 11, "NAME": "Test StoragePool" } ] } } } } }, "401": { "description": "Unauthorized." }, "403": { "description": "Forbidden." }, "429": { "description": "Too many requests. Rate limit is 500 requests per minute." } }, "parameters": [ { "name": "name", "schema": { "type": "string", "maxLength": 100 }, "description": "Internal name of the managed Nutanix Cluster used to uniquely identify it. The 'name' value can be obtained from the 'deviceName' key in the JSON response of the listVirtualDevices API response. Pass the 'virtualDeviceType' parameter as 'Nutanix-Cluster' in the listVirtualDevices API to retrieve the corresponding virtual devices.", "in": "query", "required": true } ], "tags": [ "OpManager.Devices" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/getNutanixVGroups": { "get": { "summary": "Get Nutanix Volume Groups", "x-zenesis-title": "Get Nutanix Volume Groups", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "500", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Retrieves detailed information about all volume groups configured within a Nutanix cluster. Volume groups are used to present storage volumes directly to virtual machines or hosts.", "operationId": "getNutanixVGroups", "responses": { "200": { "description": "Successful response containing the list of Nutanix volume groups.", "content": { "application/json": { "schema": { "type": "array", "description": "List of Nutanix volume group objects.", "items": { "$ref": "#/components/schemas/NutanixVolumeGroupDetail" } }, "examples": { "Example1": { "value": [ { "CAPACITY": "800", "VG_ID": 18, "DISKS": 1, "NAME": "opm-vg1" }, { "CAPACITY": "1529", "VG_ID": 20, "DISKS": 4, "NAME": "opm-vg2" } ] } } } } }, "401": { "description": "Unauthorized." }, "403": { "description": "Forbidden." }, "429": { "description": "Too many requests. Rate limit is 500 requests per minute." } }, "parameters": [ { "name": "name", "schema": { "type": "string", "maxLength": 100 }, "description": "Internal name of the managed Nutanix Cluster used to uniquely identify it. The 'name' value can be obtained from the 'deviceName' key in the JSON response of the listVirtualDevices API response. Pass the 'virtualDeviceType' parameter as 'Nutanix-Cluster' in the listVirtualDevices API to retrieve the corresponding virtual devices.", "in": "query", "required": true } ], "tags": [ "OpManager.Devices" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/listApplicationServices": { "get": { "summary": "List Application Services", "x-zenesis-title": "List Application Services", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "20", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "The API returns a list of all available Application Service monitors (from AD, or MSSQL, or Exchange) that can be monitored within the product.", "operationId": "listApplicationServices", "responses": { "200": { "description": "Successful response containing the list of application services.", "content": { "application/json": { "schema": { "type": "array", "description": "List of application service objects.", "items": { "$ref": "#/components/schemas/ApplicationServiceDetail" } }, "examples": { "Example1": { "value": [ { "serviceDesc": "The service synchronizes the time between domain controllers, which prevents time skews from occurring.", "serviceDisplayName": "Windows Time service", "autoAdd": true, "serviceid": 59, "serviceName": "W32Time" }, { "serviceDesc": "This service resolves and caches (Domain Name Server) DNS names.", "serviceDisplayName": "DNS Client Service", "autoAdd": true, "serviceid": 60, "serviceName": "Dnscache" } ] } } } } }, "401": { "description": "Unauthorized." }, "403": { "description": "Forbidden." }, "429": { "description": "Too many requests. Rate limit is 20 requests per minute." } }, "parameters": [ { "name": "app", "schema": { "type": "string", "enum": [ "AD", "Exchange", "MSSQL" ] }, "description": "The type of application for which service details are to be retrieved.", "in": "query", "required": true }, { "name": "version", "schema": { "type": "integer", "enum": [ 2003, 2007, 2010, 2013, 2016, 2019 ] }, "description": "This parameter is required when the app type is 'Exchange' and is used to retrieve the respective services for the specified Exchange version..", "in": "query", "required": false } ], "tags": [ "OpManager.Devices" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/mapEntity": { "post": { "summary": "Map Entity", "x-zenesis-title": "Map Entity", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "500", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Starts monitoring a VMware & Nutanix VM for real time health and performance updates.", "operationId": "mapEntity", "responses": { "200": { "description": "Successful response indicating that monitoring has started for the virtual machine.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VirtualEntityMappingResponse" }, "examples": { "Example1": { "value": { "result": "true", "status": "Started monitoring the VM New Virtual Machine with ipAddress test-2k16.corporation.com" } } } } } }, "400": { "description": "Bad request. A mandatory parameter is missing or invalid." }, "401": { "description": "Unauthorized." }, "403": { "description": "Forbidden." }, "429": { "description": "Too many requests. Rate limit is 500 requests per minute." } }, "parameters": [ { "name": "entityID", "schema": { "type": "integer", "format": "int64" }, "description": "Internal VM ID of the VM. This value can be retrieved from the VM_ID field in the getVMWareVMs API response for VMware VMs, or the getNutanixVMs API response for Nutanix VMs.", "in": "query", "required": true }, { "name": "virtualType", "schema": { "type": "string", "enum": [ "VMware-VM", "Nutanix-VM" ] }, "description": "VMware or Nutanix VM virtualType to start monitoring it.", "in": "query", "required": true }, { "name": "ipAddress", "schema": { "type": "string", "maxLength": 255 }, "description": "IP address or DNS name of the VM.", "in": "query", "required": true } ], "tags": [ "OpManager.Devices" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/unmapEntity": { "post": { "summary": "Unmap Entity", "x-zenesis-title": "Unmap Entity", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "500", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Stops monitoring a VMware & Nutanix VM for real time health and performance updates.", "operationId": "unmapEntity", "responses": { "200": { "description": "Successful response indicating that monitoring has stopped for the virtual machine.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VirtualEntityMappingResponse" }, "examples": { "Example1": { "value": { "result": "true", "status": "Stopped monitoring server as Virtual Server" } } } } } }, "400": { "description": "Bad request. A mandatory parameter is missing or invalid." }, "401": { "description": "Unauthorized." }, "403": { "description": "Forbidden." }, "429": { "description": "Too many requests. Rate limit is 500 requests per minute." } }, "parameters": [ { "name": "entityID", "schema": { "type": "integer", "format": "int64" }, "description": "Internal VM ID of the VM. This value can be retrieved from the VM_ID field in the getVMWareVMs API response for VMware VMs, or the getNutanixVMs API response for Nutanix VMs.", "in": "query", "required": true }, { "name": "virtualType", "schema": { "type": "string", "enum": [ "VMware-VM", "Nutanix-VM" ] }, "description": "VMware or Nutanix VM virtualType to stop monitoring it.", "in": "query", "required": true } ], "tags": [ "OpManager.Devices" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/suppressVSANDiskAlarm": { "post": { "summary": "Suppress VSAN Disk Alarm", "x-zenesis-title": "Suppress VSAN Disk Alarm", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "500", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "To enable or disable alarm notifications for specific VSAN disk issues. This allows administrators to temporarily suppress alerts during maintenance activities or troubleshoot without generating unnecessary alarm noise.", "operationId": "suppressVSANDiskAlarm", "responses": { "200": { "description": "Successful response indicating that the alarm suppression state was updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VSANDiskAlarmSuppressionResponse" }, "examples": { "Example1": { "value": { "result": { "message": "Alert suppression has been enabled successfully for vSAN Disk VsanDisk0" } } } } } } }, "400": { "description": "Bad request. A mandatory parameter is missing or invalid." }, "401": { "description": "Unauthorized." }, "403": { "description": "Forbidden." }, "429": { "description": "Too many requests. Rate limit is 500 requests per minute." } }, "parameters": [ { "name": "diskID", "schema": { "type": "integer", "format": "int64" }, "description": "Internal id of the VSAN disk used to uniquely identify it.", "in": "query", "required": true }, { "name": "enable", "schema": { "type": "boolean" }, "description": "Specifies whether to enable or disable alarm notifications.", "in": "query", "required": true } ], "tags": [ "OpManager.Devices" ], "x-zenesis-doc": { "show": true } } }, "/api/json/discovery/addDevice": { "post": { "summary": "Add Device", "x-zenesis-title": "Add Device", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "10", "lock-period": "NO_TIME_LIMIT" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Adds an individual device to OpManager for monitoring.", "operationId": "addDevice", "responses": { "200": { "description": "Device successfully added to OpManager for monitoring.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddDeviceResponse" }, "examples": { "Example1": { "value": { "device": { "deviceIp": "10.10.10.1", "message": "Device added successfully.", "deviceName": "10.10.10.1", "moid": 3125 } } } } } } } }, "parameters": [ { "name": "deviceName", "schema": { "type": "string", "maxLength": 100 }, "description": "Name or IP address of the device to be added.", "in": "query", "required": true }, { "name": "credentialName", "schema": { "type": "string", "maxLength": 100 }, "description": "Credential profile to use for discovery (SNMP, WMI, etc). Multiple credentials can be entered as comma seperated values.", "in": "query", "required": false }, { "name": "availabilityNode", "schema": { "type": "boolean" }, "description": "Set availabilityNode=true to add a Lite Device.", "in": "query", "required": false }, { "name": "addDeviceToNCM", "schema": { "type": "boolean" }, "description": "Set addDeviceToNCM=true to add the device to Network Configuration Manager", "in": "query", "required": false }, { "name": "addDeviceToIPAM", "schema": { "type": "boolean" }, "description": "Set addDeviceToIPAM=true to add the device to IP Address Manager", "in": "query", "required": false } ], "tags": [ "OpManager.Discovery" ], "x-zenesis-doc": { "show": true } } }, "/api/json/discovery/addIPMIDevice": { "post": { "summary": "Add IPMI Device", "x-zenesis-title": "Add IPMI Device", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "10", "lock-period": "NO_TIME_LIMIT" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Allows you to add individual IPMI devices to OpManager for monitoring.", "operationId": "addIPMIDevice", "responses": { "200": { "description": "IPMI device successfully added to OpManager for monitoring.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddIPMIDeviceResponse" }, "examples": { "Example1": { "value": { "result": { "deviceIp": "10.10.10.1", "message": "Device added successfully", "deviceName": "10.10.10.1", "moid": 3125 } } } } } } } }, "parameters": [ { "name": "deviceName", "schema": { "type": "string", "maxLength": 100 }, "description": "Name of the device to be added.", "in": "query", "required": true }, { "name": "credentialName", "schema": { "type": "string", "maxLength": 100 }, "description": "Credential profile to use for discovery via SNMP or IPMI.", "in": "query", "required": true }, { "name": "vendor", "schema": { "type": "string", "enum": [ "Dell", "HP", "IBM", "Supermicro", "Huawei", "H3C", "Lenovo" ] }, "description": "Vendor of the device to be discovered.", "in": "query", "required": true } ], "tags": [ "OpManager.Discovery" ], "x-zenesis-doc": { "show": true } } }, "/api/json/events/listEvents": { "get": { "summary": "List Events", "x-zenesis-title": "List Events", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "50" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "This API is used to list all the events generated in OpManager.", "operationId": "listEvents", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListEventsResponse" }, "examples": { "Example1": { "value": [ { "severity": "Attention", "prettyTime": "9 minutes ago", "statusStr": "Attention", "source": "sampleDeviceName", "statusNum": "3", "modTimeLong": "1783075083168", "displayname": "sampleDeviceDisplayName", "text": "Device not responding: Probably down or busy", "time": "3 Jul 2026 04:08:03 PM IST", "id": "23", "category": "Server", "imgsrc": "/images/devices/status3.gif", "entity": "SampleEntity_Poll" } ] } } } } } }, "parameters": [ { "name": "deviceName", "schema": { "type": "string" }, "description": "Name of the device for which the events should be listed. This can be retrieved using the listDevices API.", "in": "query", "required": false }, { "name": "entity", "schema": { "type": "string" }, "description": "Entity of the event for which the events should be listed.", "in": "query", "required": false }, { "name": "period", "schema": { "type": "string", "enum": [ "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" ] }, "description": "Time period for which events should be listed.", "in": "query", "required": false }, { "name": "severity", "schema": { "type": "string", "enum": [ "Attention", "Trouble", "Critical", "Info" ] }, "description": "Severity of the alarm", "in": "query", "required": false }, { "name": "category", "schema": { "type": "string" }, "description": "Device category of the alarm", "in": "query", "required": false } ], "tags": [ "OpManager.Events" ], "x-zenesis-doc": { "show": true } } }, "/api/json/events/addEvent": { "post": { "summary": "Add Event", "x-zenesis-title": "Add Event", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "lock-period": "1M", "threshold": "500" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "This API is used to add a new event in OpManager.", "operationId": "addEvent", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddEventResponse" }, "examples": { "Example1": { "value": { "result": { "message": "Event has been successfully generated." } } } } } } } }, "parameters": [ { "name": "source", "schema": { "type": "string" }, "description": "Name of the device for which the events should be added. This can be retrieved using the listDevices API.", "in": "query", "required": true }, { "name": "severity", "schema": { "type": "integer", "enum": [ 1, 2, 3, 4 ] }, "description": "Severity of the event", "in": "query", "required": true }, { "name": "message", "schema": { "type": "string" }, "description": "Message for the event", "in": "query", "required": true }, { "name": "alarmCode", "schema": { "type": "string" }, "description": "AlarmCode for the event", "in": "query", "required": true }, { "name": "entity", "schema": { "type": "string" }, "description": "Entity for the event", "in": "query", "required": true }, { "name": "eventType", "schema": { "type": "string" }, "description": "Type of event", "in": "query", "required": true }, { "name": "eventTime", "schema": { "type": "integer", "format": "int64" }, "description": "Time of the event in milliseconds", "in": "query", "required": false } ], "tags": [ "OpManager.Events" ], "x-zenesis-doc": { "show": true } } }, "/api/json/admin/getLogicalGroupAlerts": { "get": { "summary": "Get Logical Group Alerts", "x-zenesis-title": "Get Logical Group Alerts", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "50", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Retrieves the alarms generated from the members of the given group.", "operationId": "getLogicalGroupAlerts", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetLogicalGroupAlertsResponse" }, "examples": { "Example1": { "value": [ { "severity": "Attention", "groupType": "device", "severityString": "/images/devices/status3.gif", "modTime": "8 Oct 2025 11:50:59 AM IST", "displayName": "xxx.xxx.xx.x", "name": "xxx.xxx.xx.x", "alarmId": 2101, "message": "Device not responding: Probably down or busy", "type": "device", "entity": 2101, "status": 3 }, { "severity": "Attention", "groupType": "device", "severityString": "/images/devices/status3.gif", "modTime": "8 Oct 2025 11:50:59 AM IST", "displayName": "ServersProduction", "name": "ServersProduction-3128", "alarmId": 2102, "message": "Severity of the group is changed from Clear to Attention", "type": "device", "entity": 2102, "status": 3 } ] } } } } } }, "parameters": [ { "name": "groupName", "schema": { "type": "string" }, "description": "Internal name of the logical group. This can be retrieved from the groupName field in the listAllLogicalGroups API response.", "in": "query", "required": true } ], "tags": [ "OpManager.Groups" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/addToGroup": { "post": { "summary": "Add To Group", "x-zenesis-title": "Add To Group", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "50", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Add one or more devices or interfaces to an existing Group.", "operationId": "addToGroup", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddToGroupResponse" }, "examples": { "Example1": { "value": { "result": { "message": "The Device(s) have been associated to the group successfully." } } } } } } } }, "parameters": [ { "name": "groupName", "schema": { "type": "string" }, "description": "Internal name of the logical group. This can be retrieved from the groupName field in the listAllLogicalGroups API response.", "in": "query", "required": true }, { "name": "groupType", "schema": { "type": "string", "enum": [ "device", "interface" ] }, "description": "Type of group", "in": "query", "required": true }, { "name": "selectedMembers", "schema": { "type": "string" }, "description": "For Devices: The 'moid' value can be obtained from the 'moid' field of the listDevices API's response. For Interfaces: The 'id' value can be obtained from the 'id' field of the listInterfaces API response.", "in": "query", "required": true } ], "tags": [ "OpManager.Groups" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/listInterfaces": { "get": { "summary": "List Interfaces", "x-zenesis-title": "List Interfaces", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "500", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Lists all the interfaces monitored in OpManager", "operationId": "listInterfaces", "parameters": [ { "name": "rows", "schema": { "type": "integer", "format": "int64" }, "description": "Number of rows to fetch in the current batch.", "in": "query", "required": true }, { "name": "page", "schema": { "type": "integer", "format": "int64" }, "description": "Used along with the rows parameter to fetch data in batches.", "in": "query", "required": false } ], "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListInterfacesResponse" }, "examples": { "Example1": { "value": { "total": "2", "records": "2", "page": "1", "rows": [ { "interfaceDisplayName": "HP ProCurve Switch software loopback interface-lo4", "statusStr": "Clear", "stateNum": 1, "displayName": "OPM-CoreRouter", "ipAddress": "", "outSpeed": "0 bps", "inSpeed": "0 bps", "type": "Software Loopback", "deviceName": "xxx.xxx.xx.x", "interfaceStatus": 5, "outTraffic": "67.398 M (0.0%)", "statusNum": 5, "inTraffic": "110.774 M (0.0%)", "adminStatus": "Up", "operStatus": "Up", "id": "26732", "interfaceName": "IF-xxx.xxx.xx.x-26732" }, { "interfaceDisplayName": "sit0-sit0", "statusStr": "Trouble", "stateNum": 1, "displayName": "OPM-SWITCH", "ipAddress": "", "outSpeed": "0 bps", "inSpeed": "0 bps", "type": "Tunnel", "deviceName": "xxx.xxx.xx.x", "interfaceStatus": 2, "outTraffic": "69.481 M (0.0%)", "statusNum": 2, "inTraffic": "90.512 M (0.0%)", "adminStatus": "Up", "operStatus": "Up", "id": "4006", "interfaceName": "IF-xxx.xxx.xx.x-4006" } ] } } } } } } }, "tags": [ "OpManager.Interfaces" ], "x-zenesis-doc": { "show": true } } }, "/api/json/v2/device/getIntfAtAGlanceReportDetails": { "get": { "summary": "Get Interface At A Glance Report Details", "x-zenesis-title": "Get Interface At A Glance Report Details", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "100", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Provides a consolidated availability and performance monitoring health report data for the given interface.", "operationId": "getIntfAtAGlanceReportDetails", "parameters": [ { "name": "InterfaceName", "schema": { "type": "string" }, "description": "Internal name of the interface. This value can be obtained from the 'interfaceName' field in the listInterfaces API response.", "in": "query", "required": true }, { "name": "period", "schema": { "type": "string", "enum": [ "onehour", "twohours", "fourhours", "sixhours", "eighthours", "twelvehours", "twfourhours", "Today", "Yesterday", "thisweek", "lastweek", "Last_7_Days", "Last_30_Days", "Last_60_Days", "Last_90_Days", "thismonth", "Last_Month", "Last_3_Months", "Last_6_Months", "Last_Quarter", "This_Quarter", "custom" ], "default": "Today" }, "description": "Time period for which the report is to be generated. For 'custom' time period, supply 'startDate' and 'endDate'.", "in": "query", "required": true }, { "name": "startDate", "schema": { "type": "string", "pattern": "^\\d{2}/\\d{2}/\\d{4} \\d{2}:\\d{2}$" }, "description": "From Date. This parameter is applicable only if 'custom' time is opted in period param value. Example: 13/08/2026 03:00", "in": "query", "required": false }, { "name": "endDate", "schema": { "type": "string", "pattern": "^\\d{2}/\\d{2}/\\d{4} \\d{2}:\\d{2}$" }, "description": "To Date. This param is applicable only if 'custom' time is opted in period param value. Example: 13/08/2026 03:00", "in": "query", "required": false } ], "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetIntfAtAGlanceReportDetailsResponse" }, "examples": { "Example1": { "value": { "intfDisplayName": "WAN Miniport -IPv6--Npcap Packet Driver -NPCAP--0000-Local Area Connection* 8-Npcap Packet Driver -NPCAP--0000", "InterfaceCategory": "LAN", "Details": { "Parent Name": "opm-core-switch1", "IfDescr": "WAN Miniport (IPv6)-Npcap Packet Driver (NPCAP)-0000", "IfAlias": "Local Area Connection* 8-Npcap Packet Driver (NPCAP)-0000", "IfIndex": "26", "Receive Bandwidth": "0 bps", "IfName": "ethernet_8", "Transmit Bandwidth": "0 bps", "Circuit ID": "-" }, "repType": 7, "graphData": { "Availability": [ [ "Up", "90" ], [ "On Maintenance", "10" ], [ "Dependent Unavailable", "0" ], [ "On Hold", "0" ], [ "Down", "0" ], [ "Not Monitored", "0" ], [ "Parent Down", "0" ] ], "inTraffic": [ { "seriesname": "inTraffic", "data": [ [ 1785263761113, 0, "0 " ], [ 1785264361283, 0, "0 " ], [ 1785264961074, 0, "0 " ] ], "xyTitles": [ "Time", "bps" ], "yaxiscolumnorder": [ 0 ], "suffix": "" } ], "outTraffic": [ { "seriesname": "outTraffic", "data": [ [ 1785263761113, 0, "0 " ], [ 1785264361283, 0, "0 " ], [ 1785264961074, 0, "0 " ] ], "xyTitles": [ "Time", "bps" ], "yaxiscolumnorder": [ 0 ], "suffix": "" } ], "Errors": [ { "seriesname": "inErrors", "data": [ [ 1785263761113, 0, "0 " ] ], "xyTitles": [ "Time", "Errors/sec" ], "yaxiscolumnorder": [ 0 ], "suffix": "" }, { "seriesname": "outErrors", "data": [ [ 1785263761113, 0, "0 " ] ], "xyTitles": [ "Time", "Errors/sec" ], "yaxiscolumnorder": [ 0 ], "suffix": "" } ], "Discards": [ { "seriesname": "inDiscards", "data": [ [ 1785263761113, 0, "0 " ] ], "xyTitles": [ "Time", "Discards/sec" ], "yaxiscolumnorder": [ 0 ], "suffix": "" }, { "seriesname": "outDiscards", "data": [ [ 1785263761113, 0, "0 " ] ], "xyTitles": [ "Time", "Discards/sec" ], "yaxiscolumnorder": [ 0 ], "suffix": "" } ] } } } } } } } }, "tags": [ "OpManager.Interfaces" ], "x-zenesis-doc": { "show": true } } }, "/api/json/v2/device/getIntfBWOutageReportDetails": { "get": { "summary": "Get Interface Bandwidth Outage Report Details", "x-zenesis-title": "Get Interface Bandwidth Outage Report Details", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "100", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Provides data for consolidated Bandwidth report (Rx/Tx Traffic) for the given interface.", "operationId": "getIntfBWOutageReportDetails", "parameters": [ { "name": "interfaceName", "schema": { "type": "string" }, "description": "Internal name of the interface. This value can be obtained from the 'interfaceName' field in the listInterfaces API response.", "in": "query", "required": true }, { "name": "period", "schema": { "type": "string", "enum": [ "onehour", "twohours", "fourhours", "sixhours", "eighthours", "twelvehours", "twfourhours", "Today", "Yesterday", "thisweek", "lastweek", "Last_7_Days", "Last_30_Days", "Last_60_Days", "Last_90_Days", "thismonth", "Last_Month", "Last_3_Months", "Last_6_Months", "Last_Quarter", "This_Quarter", "custom" ], "default": "Today" }, "description": "Time period for which the report is to be generated. For 'custom' time period, supply 'startDate' and 'endDate'.", "in": "query", "required": true }, { "name": "startDate", "schema": { "type": "string", "pattern": "^\\d{2}/\\d{2}/\\d{4} \\d{2}:\\d{2}$" }, "description": "From Date. This parameter is applicable only if 'custom' time is opted in period param value. Example: 13/08/2026 03:00", "in": "query", "required": false }, { "name": "endDate", "schema": { "type": "string", "pattern": "^\\d{2}/\\d{2}/\\d{4} \\d{2}:\\d{2}$" }, "description": "To Date. This param is applicable only if 'custom' time is opted in period param value. Example: 13/08/2026 03:00", "in": "query", "required": false } ], "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetIntfBWOutageReportDetailsResponse" }, "examples": { "Example1": { "value": { "InSpeed": "0 bps", "IfDesc": "Switch loopback interface", "repType": 9, "consolidatedValues": [ { "minCollectionTime": "1760677410060", "currVal": "1.309 K ( 0.0 % )", "seriesName": "InTraffic", "exactMaxVal": 14.45119, "maxCollectionTime": "1760679211506", "95thpercVal": "1.0659", "legendType": "intfGraph", "95thpercentileValue": "14.451 K ( 0.0 % )", "exactMinVal": 0.75889, "maxVal": "14.451 K ( 0.0 % )", "minVal": "758.89 ( 0.0 % )", "95thpercRawVal": "1065.9", "avgVal": "3.742 K ( 0.0 % )", "95thperc": "1.065 K ( 0.0 % )" }, { "minCollectionTime": "1760677410060", "currVal": "1.202 K ( 0.0 % )", "seriesName": "OutTraffic", "exactMaxVal": 13.241100000000001, "maxCollectionTime": "1760679211506", "95thpercVal": "0.9796275000000001", "legendType": "intfGraph", "95thpercentileValue": "13.241 K ( 0.0 % )", "exactMinVal": 0.69837, "maxVal": "13.241 K ( 0.0 % )", "minVal": "698.37 ( 0.0 % )", "95thpercRawVal": "979.6275", "avgVal": "3.431 K ( 0.0 % )", "95thperc": "979.627 ( 0.0 % )" } ], "seriesNames": [ "InTraffic", "OutTraffic", "Total", "InTraffic-95th", "OutTraffic-95th", "Total-95th" ], "bwChartData": [ { "seriesname": "InTraffic", "isRaw": true, "data": [ [ 1760677410060, 0.75889, "758.89 " ], [ 1760678311494, 1.30847, "1.308 K" ], [ 1760679211506, 14.45119, "14.451 K" ] ], "xyTitles": [ "Time", "Bits per Second" ] }, { "seriesname": "OutTraffic", "isRaw": true, "data": [ [ 1760677410060, 0.69837, "698.37 " ], [ 1760678311494, 1.20186, "1.201 K" ], [ 1760679211506, 13.241100000000001, "13.241 K" ] ], "xyTitles": [ "Time", "Bits per Second" ] } ], "InterfaceDisplayName": "Switch loopback interface-lo0", "IfAlias": "lo0", "suffix": "K", "availData": { "Down": 0, "Dependent Unavailable": 0, "Not Monitored": 0, "On Hold": 0, "Parent Down": 0, "On Maintenance": 0, "Up": 100 }, "deviceName": "IF-xxx.xxx.xx.x-13767", "interfaceDetails": { "Parent Name": "xxx.xxx.xx.x", "IfDescr": "Switch loopback interface", "IfIndex": "4875", "IfAlias": "lo0", "IfName": "lo0", "Circuit ID": "-" }, "OutSpeed": "0 bps", "name": "xxx.xxx.xx.x", "CircuitID": "-", "IfIndex": "4875", "InterfaceName": "IF-xxx.xxx.xx.x-13767", "IfName": "lo0" } } } } } } }, "tags": [ "OpManager.Interfaces" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/getInterfaceGraphs": { "get": { "summary": "Get Interface Graphs", "x-zenesis-title": "Get Interface Graphs", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "100", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Retrieves the collected data such as traffic, errors & discards, etc., for the given interface.", "operationId": "getInterfaceGraphs", "parameters": [ { "name": "interfaceName", "schema": { "type": "string" }, "description": "Internal name of the interface. This value can be obtained from the 'interfaceName' field in the listInterfaces API response.", "in": "query", "required": true }, { "name": "graphName", "schema": { "type": "string", "enum": [ "traffic", "packets", "errors", "totalPackets", "utilization", "rxutilization", "txutilization", "errorRate", "discardRate" ] }, "description": "Name of the interface graph", "in": "query", "required": true }, { "name": "period", "schema": { "type": "string", "enum": [ "onehour", "twohours", "fourhours", "sixhours", "eighthours", "twelvehours", "twfourhours", "Today", "Yesterday", "thisweek", "lastweek", "Last_7_Days", "Last_30_Days", "Last_60_Days", "Last_90_Days", "thismonth", "Last_Month", "Last_3_Months", "Last_6_Months", "Last_Quarter", "This_Quarter", "custom" ], "default": "Today" }, "description": "Time period for which the interface graph is to be generated.", "in": "query", "required": false }, { "name": "startDate", "schema": { "type": "string", "pattern": "^\\d{2}/\\d{2}/\\d{4} \\d{2}:\\d{2}$" }, "description": "From Date. This parameter is applicable only if 'custom' time is opted in period param value", "in": "query", "required": false }, { "name": "endDate", "schema": { "type": "string", "pattern": "^\\d{2}/\\d{2}/\\d{4} \\d{2}:\\d{2}$" }, "description": "To Date. This parameter is applicable only if 'custom' time is opted in period param value", "in": "query", "required": false }, { "name": "graphFilterType", "schema": { "type": "string", "enum": [ "min", "max", "avg" ] }, "description": "Specifies the aggregation type for the graph data (min, max, avg)", "in": "query", "required": false } ], "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetInterfaceGraphsResponse" }, "examples": { "Example1": { "value": { "interfaceDetails": { "Parent Name": "xxx.xxx.xx.x", "IfDescr": "B4", "IfIndex": "28", "IfAlias": "-", "IfName": "B4", "Circuit ID": "-" }, "displayName": "Traffic", "consolidatedValues": { "Rx Traffic": { "minCollectionTime": "1786988763000", "currVal": "118.6 M ( 11.86 % )", "seriesName": "Rx Traffic", "exactMaxVal": 118.600415, "maxCollectionTime": "1787035563000", "95thpercVal": "84.23557846428572", "95thpercentileValue": "115.856 M ( 11.59 % )", "exactMinVal": 58.58383, "maxVal": "118.6 M ( 11.86 % )", "minVal": "58.583 M ( 5.86 % )", "95thpercRawVal": "8.423557846428572E7", "avgVal": "86.435 M ( 8.64 % )", "95thperc": "84.235 M ( 8.42 % )" }, "Tx Traffic": { "minCollectionTime": "1787017563000", "currVal": "72.276 M ( 7.23 % )", "seriesName": "Tx Traffic", "exactMaxVal": 112.458731, "maxCollectionTime": "1786988763000", "95thpercVal": "81.58324892857144", "95thpercentileValue": "111.543 M ( 11.15 % )", "exactMinVal": 53.419168, "maxVal": "112.458 M ( 11.25 % )", "minVal": "53.419 M ( 5.34 % )", "95thpercRawVal": "8.158324892857143E7", "avgVal": "83.611 M ( 8.36 % )", "95thperc": "81.583 M ( 8.16 % )" } }, "seriesNames": [ "Rx Traffic", "Tx Traffic" ], "xyTitles": [ "Time", "Bits per Second" ], "showGraphFilters": false, "graphData": [ { "seriesname": "Rx Traffic", "data": [ [ 1786983367000, 109.812851, "109.812 M" ], [ 1786985163000, 102.623929, "102.623 M" ], [ 1787035563000, 118.600415, "118.6 M" ] ] }, { "seriesname": "Tx Traffic", "data": [ [ 1786983367000, 87.492656, "87.492 M" ], [ 1786985163000, 61.382223, "61.382 M" ], [ 1787035563000, 72.276606, "72.276 M" ] ] } ], "suffix": "M" } } } } } } }, "tags": [ "OpManager.Interfaces" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/getPerformanceMonitors": { "get": { "summary": "Get Performance Monitors", "x-zenesis-title": "Get Performance Monitors", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "500", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Lists all the available performance monitors for a particular device (based on the device's category and type)", "operationId": "getPerformanceMonitors", "responses": { "200": { "description": "Successful response containing available performance monitors grouped by category.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PerformanceMonitorsResponse" }, "examples": { "Example1": { "value": { "General Monitors": [ { "DISPLAYNAME": "SysUpTime", "Description": "The time (in hundredths of a second) since the network management portion of the system was last re-initialized", "showAddPartitionOption": "false", "isNumeric": "true", "GRAPHID": 1166, "name": "SysUpTime", "isSelected": "false", "interval": "900", "oid": "(.1.3.6.1.2.1.1.3.0/360000)", "Protocol": "SNMP", "thresholdEnabled": "false", "STANDARDNAME": "General Monitors" } ], "HOST-RESOURCES Monitors": [ { "DISPLAYNAME": "CPU Utilization", "Description": "Monitors the CPU Utilization based on HOSTRESOURCE MIB", "showAddPartitionOption": "false", "isNumeric": "true", "GRAPHID": 35, "name": "Win-CPUUtilization", "isSelected": "false", "interval": "900", "oid": ".1.3.6.1.2.1.25.3.3.1.2", "Protocol": "SNMP", "thresholdEnabled": "false", "STANDARDNAME": "HOST-RESOURCES Monitors" } ], "Custom Monitor": [] } } } } } }, "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": [ { "in": "query", "name": "deviceName", "required": true, "description": "Internal name of the device used to uniquely identify it.\nThis value can be retrieved from the deviceName field in the listDevices API response.", "schema": { "type": "string" } }, { "in": "query", "name": "category", "required": true, "description": "Category of the device like Server, Desktop etc.\nThe 'category' value can be obtained from the 'category' key in the JSON response of the listDevices API.", "schema": { "type": "string", "example": "Server" } }, { "in": "query", "name": "type", "required": true, "description": "Type of the device like Windows 2025.\nThe 'type' value can be obtained from the 'type' key in the JSON response of the listDevices API.\nEncode the value using URL encoding before passing it in the API request.", "schema": { "type": "string", "example": "Windows 2025" } } ], "tags": [ "OpManager.Monitoring" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/getPerformanceMonitorDetails": { "get": { "summary": "Get Performance Monitor Details", "x-zenesis-title": "Get Performance Monitor Details", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "500", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Fetches detailed information about performance monitors for a specific device\nNote: While pollId, graphName are each marked as not mandatory, at least one of the two must be provided in the request.", "operationId": "getPerformanceMonitorDetails", "responses": { "200": { "description": "Successful response containing performance monitor details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PerformanceMonitorDetailsResponse" }, "examples": { "Example1": { "value": { "statsList": [ { "minimumValue": "84", "averageValue": "85", "instance": "PhysicalMemUtilization", "percentile": "85", "lastPolledValue": "86", "maximumValue": "86" } ], "monitors": { "YAXISTEXT": "Percentage", "checkNumeric": "true", "Description": "Monitors the Memory Utilization using WMI", "Instance": "", "THRESHOLDENABLED": "true", "GRAPHID": "204", "oid": "Memory Utilization", "type": "multiple", "PREVIOUSSEVERITY": "5", "defaultMessage_AT": "$MONITOR is $CURRENTVALUE $UNITS,Expected value for this monitor is $EXPECTEDVALUE $UNITS, current adaptive threshold is $THRESHOLDVALUE $UNITS", "defaultMessage": "$MONITOR is $CURRENTVALUE%, threshold value for this monitor is $THRESHOLDVALUE%", "id": "125", "Protocol": "WMI", "FAILURETHRESHOLD": "1", "DISPLAYNAME": "Memory Utilization", "thresholdSet": [ { "severity": "2", "clrMessage": "$MONITOR is now back to normal, current value is $CURRENTVALUE $UNITS", "troubleThresholdType": "max", "troubleThresholdName": "1668514350868814042", "troubleMessage": "$MONITOR is $CURRENTVALUE $UNITS,Expected value for this monitor is $EXPECTEDVALUE $UNITS, current adaptive threshold is $THRESHOLDVALUE $UNITS", "oidType": "", "rearmValue": "0", "troubleThresholdValue": "15" } ], "graphType": "multiple", "policyName": "WMI-MemoryUtilization", "agentName": "localhost", "isMultiple": "true", "sSave": "true", "defaultClrMessage": "$MONITOR is now back to normal, current value is $CURRENTVALUE%", "DisplayColumn": "", "name": "WMI-MemoryUtilization", "numericType": "1", "interval": "15", "Id": "125", "isAtEnabled": true } } } } } } }, "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": [ { "in": "query", "name": "name", "required": true, "description": "Internal name of the device used to uniquely identify it.\nThe 'name' value can be obtained from the 'deviceName' key in the JSON response of the listDevices API.", "schema": { "type": "string" } }, { "in": "query", "name": "policyName", "required": true, "description": "Internal name of the monitor used to uniquely identify it.\nThe 'policyName' value can be obtained from the 'policyName' key in the JSON response of the getDeviceAssociatedMonitors API.", "schema": { "type": "string" } }, { "in": "query", "name": "graphName", "required": false, "description": "Additional parameter of the performance monitor used to uniquely identify it.\nThe 'graphName' value can be obtained from the 'name' key in the JSON response of the getDeviceAssociatedMonitors API.\nIf the monitor is an instance-based monitor (e.g., a partition-based monitor), pass the instance name using this parameter. This parameter works along with policyName.", "schema": { "type": "string", "example": "D:" } }, { "in": "query", "name": "pollId", "required": false, "description": "Internal id of the monitor used to uniquely identify it.\nThe 'pollId' value can be obtained from the 'pollId' key in the JSON response of the getDeviceAssociatedMonitors API.", "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "checkNumeric", "required": true, "description": "Indicates whether the monitor returns a numeric value or a string value.\nThe 'checkNumeric' value can be obtained from the 'checkNumeric' key in the JSON response of the getDeviceAssociatedMonitors API.", "schema": { "type": "boolean" } }, { "in": "query", "name": "instanceName", "required": false, "description": "When the monitor is an MSSQL Application Monitor, pass this parameter with the MSSQL instance name.\nMSSQL Instance name can be fetched from the end device or can be viewed from MSSQL Tab in device snapshot page of MSSQL device in OpManager.", "schema": { "type": "string" } }, { "in": "query", "name": "instance", "required": false, "description": "Internal name used to identify availability instance of a monitor.", "schema": { "type": "string", "enum": [ "Url", "Device", "Packet_Loss" ] } }, { "in": "query", "name": "type", "required": false, "description": "Internal name used to identify the type of the monitor.", "schema": { "type": "string", "enum": [ "hardwareMonitors" ] } }, { "in": "query", "name": "sensorId", "required": false, "description": "Internal id of the hardware sensor used to uniquely identify it.\nThis parameter is mandatory when the type parameter is specified.", "schema": { "type": "string" } } ], "tags": [ "OpManager.Monitoring" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/addPerformanceMonitors": { "post": { "summary": "Add Performance Monitors", "x-zenesis-title": "Add Performance Monitors", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "500", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Adds a new performance monitor (or multiple performance monitors) to the device", "operationId": "addPerformanceMonitors", "responses": { "200": { "description": "Successful response confirming the monitor was added.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MonitorResultMessageResponse" }, "examples": { "Example1": { "value": { "result": { "message": "Monitor added successfully" } } } } } } }, "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": [ { "in": "query", "name": "name", "required": true, "description": "Internal name of the device used to uniquely identify it.\nThe 'name' value can be obtained from the 'deviceName' key in the JSON response of the listDevices API.", "schema": { "type": "string" } }, { "in": "query", "name": "selectedMonitors", "required": true, "description": "Internal Id of the performance monitor that needs to be associated with the device.\nMultiple IDs can be specified as comma-separated list.\nThe monitor IDs for selected monitors can be obtained from 'GRAPHID' key in the JSON response of the getPerformanceMonitors API.", "schema": { "type": "string" } }, { "in": "query", "name": "processExistingPartitionMonitors", "required": false, "description": "Indicates whether newly discovered partitions for existing partition-based monitors should be automatically added for monitoring.\nThis is applicable only when a partition-based monitor is already associated with the device and new partitions need to be added for monitoring.", "schema": { "type": "boolean" } } ], "tags": [ "OpManager.Monitoring" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/deletePerformanceMonitors": { "post": { "summary": "Delete Performance Monitors", "x-zenesis-title": "Delete Performance Monitors", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "500", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Deletes performance monitor(s) from the device", "operationId": "deletePerformanceMonitors", "responses": { "200": { "description": "Successful response confirming the monitor(s) will be deleted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MonitorResultMessageResponse" }, "examples": { "Example1": { "value": { "result": { "message": "The monitor(s) will be deleted. Please check after sometime." } } } } } } }, "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": [ { "in": "query", "name": "name", "required": true, "description": "Internal name of the device used to uniquely identify it.\nThe 'name' value can be obtained from the 'deviceName' key in the JSON response of the listDevices API.", "schema": { "type": "string" } }, { "in": "query", "name": "pollId", "required": true, "description": "Internal id of the monitor used to uniquely identify it.\nMultiple poll IDs can be specified as comma-separated list. The 'pollId' value can be obtained from the 'pollId' key in the JSON response of the getDeviceAssociatedMonitors API.", "schema": { "$ref": "#/components/schemas/numberWithComma_regex" } } ], "tags": [ "OpManager.Monitoring" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/TestMonitor": { "post": { "summary": "Test Monitor", "x-zenesis-title": "Test Monitor", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "100", "lock-period": "30S" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "This API directly accesses the device to collect the required data and returns the results.\nNote: If you're looking for last collected values of performance monitors, we recommend using the getLastCollectedValues API, which is more efficient and returns the last collected values of the monitors along with other properties.\nNote: While pollId, graphName are each marked as not mandatory, at least one of the two must be provided in the request.", "operationId": "TestMonitor", "responses": { "200": { "description": "Successful response containing the data collected from the device.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestMonitorResponse" }, "examples": { "Example1": { "value": { "protocol": "SNMP", "checkNumeric": "true", "reasons": [], "monitorname": "Win-MemoryUtilization", "data": [ 89 ], "displayName": "Memory Utilization", "isMultiple": "false", "oid": ".1.3.6.1.2.1.25.5.1.1.2", "units": "Percentage", "deviceName": "localhost" } } } } } }, "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 100 requests per minute. Exceeding this limit will block requests for 30 seconds." } }, "parameters": [ { "in": "query", "name": "name", "required": true, "description": "Internal name of the device used to uniquely identify it.\nThe 'name' value can be obtained from the 'deviceName' key in the JSON response of the listDevices API.", "schema": { "type": "string" } }, { "in": "query", "name": "policyName", "required": true, "description": "Internal name of the monitor used to uniquely identify it.\nThe 'policyName' value can be obtained from the 'policyName' key in the JSON response of the getDeviceAssociatedMonitors API.", "schema": { "type": "string" } }, { "in": "query", "name": "graphName", "required": false, "description": "Additional parameter of the performance monitor used to uniquely identify it.\nThe 'graphName' value can be obtained from the 'name' key in the JSON response of the getDeviceAssociatedMonitors API.\nIf the monitor is an instance-based monitor (e.g., a partition-based monitor), pass the instance name using this parameter.\nThis parameter works along with policyName.", "schema": { "type": "string", "example": "D:" } }, { "in": "query", "name": "pollId", "required": false, "description": "Internal id of the monitor used to uniquely identify it.\nThe 'pollId' value can be obtained from the 'pollId' key in the JSON response of the getDeviceAssociatedMonitors API.", "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "instanceName", "required": false, "description": "When the monitor is an MSSQL Application Monitor, pass this parameter with the MSSQL instance name.\nMSSQL Instance name can be fetched from the end device or can be viewed from MSSQL Tab in device snapshot page of MSSQL device in OpManager.", "schema": { "type": "string" } } ], "tags": [ "OpManager.Monitoring" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/getAssociatedProcessMonitors": { "get": { "summary": "Get Associated Process Monitors", "x-zenesis-title": "Get Associated Process Monitors", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "500", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Retrieves the list of process monitor templates, the process monitors currently associated with the specified device, and the active processes currently running on the monitored machine.", "operationId": "getAssociatedProcessMonitors", "responses": { "200": { "description": "Successful response containing process monitor templates, associated monitors, and active processes.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssociatedProcessMonitorsResponse" }, "examples": { "Example1": { "value": { "protocol": "WMI", "Templates": [ { "protocol": "CLI", "associatedDeviceCount": "0", "templateName": "httpd", "displayName": "httpd", "description": "Process Template for httpd", "templateId": "2" }, { "protocol": "WMI", "associatedDeviceCount": "2", "templateName": "sqlservr.exe", "displayName": "MSSQL", "description": "Process Template for MSSQL", "templateId": "1" } ], "AssignedMonitors": [ { "path": "C:\\Program Files\\Microsoft SQL Server\\MSSQL\\Binn\\sqlservr.exe", "statusStr": "Clear", "cmdLineArgs": "", "statusIcon": "/webclient/devices/images/servicestatus5.gif", "name": "MSSQL", "state": "1", "id": "611", "proName": "sqlservr.exe", "trimName": "MSSQL", "status": "5", "statusNum": "5" } ], "ActiveProcesses": { "7244": { "path": "C:\\Windows\\System32\\msdtc.exe", "trimArgs": "", "trimPath": "C:\\Windows\\System32\\msdtc.exe", "cmdLineArgs": "", "name": "msdtc.exe", "trimName": "msdtc.exe" }, "3680": { "path": "C:\\Windows\\system32\\SearchIndexer.exe", "trimArgs": "/Embedding", "trimPath": "C:\\Windows\\system32\\SearchIndexer.exe", "cmdLineArgs": "/Embedding", "name": "SearchIndexer.exe", "trimName": "SearchIndexer.exe" } }, "deviceName": "localhost" } } } } } }, "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": [ { "in": "query", "name": "deviceName", "required": true, "description": "Internal name of the device used to uniquely identify it.\nThe 'deviceName' value can be obtained from the 'deviceName' key in the JSON response of the listDevices API.", "schema": { "type": "string" } } ], "tags": [ "OpManager.Monitoring" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/associateProcessMonitor": { "post": { "summary": "Associate Process Monitor", "x-zenesis-title": "Associate Process Monitor", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "500", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Associates process monitor(s) to a device", "operationId": "associateProcessMonitor", "responses": { "200": { "description": "Successful response confirming the process monitor(s) were associated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MonitorResultMessageResponse" }, "examples": { "Example1": { "value": { "result": { "message": "Process monitor(s) associated successfully." } } } } } } }, "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": [ { "in": "query", "name": "deviceName", "required": true, "description": "Internal name of the device used to uniquely identify it.\nThe 'deviceName' value can be obtained from the 'deviceName' key in the JSON response of the listDevices API.", "schema": { "type": "string" } }, { "in": "query", "name": "protocol", "required": true, "description": "Monitoring protocol associated with the device.\nThe 'protocol' value can be obtained from the 'protocol' key in the JSON response of the getAssociatedProcessMonitors API.", "schema": { "type": "string", "enum": [ "WMI", "CLI", "SNMP" ] } }, { "in": "query", "name": "processId", "required": true, "description": "ID of the process to be associated. Multiple process IDs can be specified as comma-separated list.\nThe processIds can be taken from the 'ActiveProcesses' key in the JSON response of the getAssociatedProcessMonitors API.\nThe process IDs can also be obtained from the process details in the task manager of the monitored machine.", "schema": { "$ref": "#/components/schemas/numberWithComma_regex" } } ], "tags": [ "OpManager.Monitoring" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/getAssociatedServiceMonitors": { "get": { "summary": "Get Associated Service Monitors", "x-zenesis-title": "Get Associated Service Monitors", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "500", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Retrieves the list of service monitors currently associated with the specified device, along with the remaining service monitors that are available for association.", "operationId": "getAssociatedServiceMonitors", "responses": { "200": { "description": "Successful response containing associated and available service monitors.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssociatedServiceMonitorsResponse" }, "examples": { "Example1": { "value": { "remainingServices": [ "DNS(53)", "Echo(7)", "FTP(21)" ], "selectedServices": [ "SMTP(25)", "Telnet(23)" ] } } } } } }, "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": [ { "in": "query", "name": "name", "required": true, "description": "Internal name of the device used to uniquely identify it.\nThe 'name' value can be obtained from the 'deviceName' key in the JSON response of the listDevices API.", "schema": { "type": "string" } } ], "tags": [ "OpManager.Monitoring" ], "x-zenesis-doc": { "show": true } } }, "/api/json/admin/associateServiceMonitor": { "post": { "summary": "Associate Service Monitor", "x-zenesis-title": "Associate Service Monitor", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "500", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Associates service monitor(s) to a device", "operationId": "associateServiceMonitor", "responses": { "200": { "description": "Successful response confirming the service monitor was associated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MonitorResultMessageResponse" }, "examples": { "Example1": { "value": { "result": { "message": "Service Monitor associated successfully" } } } } } } }, "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": [ { "in": "query", "name": "deviceName", "required": true, "description": "Internal name of the device used to uniquely identify it.\nMultiple device names can be specified as comma-separated list. The 'deviceName' value can be obtained from the 'deviceName' key in the JSON response of the listDevices API.", "schema": { "type": "string" } }, { "in": "query", "name": "serviceName", "required": true, "description": "Name of the service monitors to be associated.\nMultiple service monitor names can be specified as comma-separated list.\nThe 'serviceName' value can be obtained from the 'remainingServices' key in the JSON response of the getAssociatedServiceMonitors API.", "schema": { "type": "string" } } ], "tags": [ "OpManager.Monitoring" ], "x-zenesis-doc": { "show": true } } }, "/api/json/admin/listURLMonitors": { "get": { "summary": "List URL Monitors", "x-zenesis-title": "List URL Monitors", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "500", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Lists URL monitors, representing globally defined URL monitors.", "operationId": "listURLMonitors", "responses": { "200": { "description": "Successful response containing globally defined URL monitors.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/URLMonitorsResponse" }, "examples": { "Example1": { "value": { "List": [ { "availPercentage": 0, "urlName": "ManageEngine", "statusStr": "Service Down", "name": "ManageEngine_URL", "RESPONSETIME": "No Response", "url": "https://www.manageengine.com", "moID": 961, "statusNum": 4 }, { "availPercentage": 0, "urlName": "HTTP Url", "statusStr": "Service Down", "name": "HTTP Url_URL", "RESPONSETIME": "No Response", "url": "http://localhost:8060", "moID": 996, "statusNum": 4 } ], "Details": { "00-10%": [ { "Status": 4, "Label": "Service Down", "Count": 6 } ] }, "DialCounter": [ { "title": "Service Down", "value": 6, "status": 4 } ] } } } } } }, "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": [], "tags": [ "OpManager.Monitoring" ], "x-zenesis-doc": { "show": true } } }, "/api/json/device/listAllDevicesSpecificURLs": { "get": { "summary": "List All Devices Specific URLs", "x-zenesis-title": "List All Devices Specific URLs", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "500", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Identifies and lists URL monitors associated with individual devices, scoped to individual devices rather than applied globally.", "operationId": "listAllDevicesSpecificURLs", "responses": { "200": { "description": "Successful response containing device specific URL monitors.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceSpecificURLsResponse" }, "examples": { "Example1": { "value": { "List": [ { "parentName": "localhost", "urlName": "URL_1", "stringstatus": "Clear", "parentDispName": "localhost", "name": "URL_1_URL", "url": "https://manageengine.com", "status": "5", "statusNum": "5" }, { "parentName": "localhost", "urlName": "URL_2", "stringstatus": "Clear", "parentDispName": "localhost", "name": "URL_2_URL", "url": "https://manageengine.com", "status": "5", "statusNum": "5" } ] } } } } } }, "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": [], "tags": [ "OpManager.Monitoring" ], "x-zenesis-doc": { "show": true } } }, "/api/json/admin/listScriptMonitors": { "get": { "summary": "List Script Monitors", "x-zenesis-title": "List Script Monitors", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "40", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Retrieves the list of all script templates created in OpManager.", "operationId": "listScriptMonitors", "responses": { "200": { "description": "Successful response containing script templates created in OpManager.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScriptMonitorListItem" } }, "examples": { "Example1": { "value": [ { "graphName": "Cache Memory", "scriptID": "102", "executeFrom": "1", "graphDesc": "Perl Script to get cache memory of a linux system", "graphID": "1207" }, { "graphName": "File Size", "scriptID": "103", "executeFrom": "1", "graphDesc": "Shell script to get memory size of a file in linux system", "graphID": "1208" }, { "graphName": "Instance Count", "scriptID": "101", "executeFrom": "0", "graphDesc": "VBScript to get number of instances running for a given process", "graphID": "1206" }, { "graphName": "Thread Count", "scriptID": "104", "executeFrom": "0", "graphDesc": "Powershell script to get thread count of a process", "graphID": "1209" } ] } } } } }, "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 40 requests per minute." } }, "parameters": [], "tags": [ "OpManager.Monitoring" ], "x-zenesis-doc": { "show": true } } }, "/api/json/v2/pathanalysis/getAvailabilityGraph": { "get": { "summary": "Get Availability Graph", "x-zenesis-title": "Get Availability Graph", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "50", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Retrieves the availability data for the given network path monitor. Returns raw data based on the data retention period for Detailed Statistics, configured under Database Maintenance.", "operationId": "getAvailabilityGraph", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkPathAvailabilityResponse" }, "examples": { "Example1": { "value": { "availability": [ "DownTime,1785264214000,1785264851913,Down", "DownTime,1785268964000,1785270148555,Down", "DownTime,1785275859000,1785276477561,Down", "DownTime,1785285460000,1785286076764,Down", "DownTime,1785288822000,1785289463897,Down", "DownTime,1785291223000,1785292496658,Down", "DownTime,1785294557000,1785295123583,Down", "DownTime,1785296349000,1785296938340,Down", "UP,1785263400000,1785264214000,Up", "UP,1785296938340,1785300967871,Up", "UP,1785264851913,1785268964000,Up", "UP,1785270148555,1785275859000,Up", "UP,1785276477561,1785285460000,Up", "UP,1785286076764,1785288822000,Up", "UP,1785289463897,1785291223000,Up", "UP,1785292496658,1785294557000,Up", "UP,1785295123583,1785296349000,Up" ] } } } } } } }, "parameters": [ { "name": "moID", "schema": { "type": "integer", "format": "int64" }, "description": "Internal ID of the network path analysis monitor. This value can be obtained from the moID key from the listNetworkPaths API response.", "in": "query", "required": true }, { "name": "period", "schema": { "type": "string", "enum": [ "Today", "Last 24 hours", "Yesterday", "customDate" ] }, "description": "Filters the data by the specified time period.", "in": "query", "required": true }, { "name": "date", "schema": { "type": "string", "format": "date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "description": "Applicable when period=customDate", "in": "query", "required": false } ], "tags": [ "OpManager.NetworkPath" ], "x-zenesis-doc": { "show": true } } }, "/api/json/v2/pathanalysis/getLatencyPacketLossGraph": { "get": { "summary": "Get Latency Packet Loss Graph", "x-zenesis-title": "Get Latency Packet Loss Graph", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "100", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Retrieves a graph showing latency and packet loss metrics for a network path monitor. Returns raw data based on the data retention period for Detailed Statistics, configured under Database Maintenance.", "operationId": "getLatencyPacketLossGraph", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LatencyPacketLossGraphResponse" }, "examples": { "PacketLoss": { "value": { "data": { "chartData": [ { "seriesname": "Clear", "data": [ [ 1786369011695, 22.5 ], [ 1786372592739, 22.5 ], [ 1786376192545, 20 ], [ 1786379792563, 21.25 ], [ 1786383392410, 18.75 ], [ 1786386997991, 18.75 ], [ 1786390595142, 18.75 ], [ 1786394194963, 18.75 ], [ 1786397794503, 18.75 ], [ 1786401394587, 18.75 ], [ 1786404994608, 18.75 ], [ 1786408594457, 18.75 ], [ 1786412194662, 18.75 ], [ 1786415794648, 18.75 ], [ 1786419394765, 18.75 ], [ 1786422994678, 18.75 ], [ 1786426594771, 18.75 ], [ 1786430194585, 18.75 ], [ 1786433794547, 18.75 ], [ 1786437394667, 18.75 ], [ 1786440995244, 22.5 ], [ 1786444594766, 21.25 ] ] }, { "seriesname": "Attention", "data": [] }, { "seriesname": "Trouble", "data": [] }, { "seriesname": "Critical", "data": [] } ], "xyTitles": [ "Time", "Packet Loss" ] }, "displayName": "Packet Loss" } }, "Latency": { "value": { "data": { "chartData": [ { "seriesname": "Clear", "data": [ [ 1786369011695, 8 ], [ 1786372592739, 3 ], [ 1786376192545, 3.4 ], [ 1786379792563, 3.6 ], [ 1786383392410, 3.8 ], [ 1786386997991, 14 ], [ 1786390595142, 3.6 ], [ 1786394194963, 3.8 ], [ 1786397794503, 3.8 ], [ 1786401394587, 3 ], [ 1786404994608, 4.2 ], [ 1786408594457, 3.4 ], [ 1786412194662, 4 ], [ 1786415794648, 3.4 ], [ 1786419394765, 3.6 ], [ 1786422994678, 3.2 ], [ 1786426594771, 3.6 ], [ 1786430194585, 3.2 ], [ 1786433794547, 3.4 ], [ 1786437394667, 3.2 ], [ 1786440995244, 3.6 ], [ 1786444594766, 3.2 ] ] }, { "seriesname": "Attention", "data": [] }, { "seriesname": "Trouble", "data": [] }, { "seriesname": "Critical", "data": [] } ], "xyTitles": [ "Time", "Latency" ] }, "displayName": "Latency" } } } } } } }, "parameters": [ { "name": "moID", "schema": { "type": "integer" }, "description": "Internal ID of the network path analysis monitor. This value can be obtained from the moID key from the listNetworkPaths API response.", "in": "query", "required": true }, { "name": "instance", "schema": { "type": "string", "enum": [ "packetLoss", "latency" ] }, "description": "Set instance=packetLoss to get the packetloss data. Set instance=latency to get the latency data.", "in": "query", "required": true }, { "name": "period", "schema": { "type": "string", "enum": [ "Today", "Last 24 hours", "Yesterday", "customDate" ] }, "description": "Filters the data by the specified time period.", "in": "query", "required": true }, { "name": "date", "schema": { "type": "string", "format": "date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "description": "Applicable when period=customDate", "in": "query", "required": false } ], "tags": [ "OpManager.NetworkPath" ], "x-zenesis-doc": { "show": true } } }, "/api/json/admin/listNotificationProfiles": { "get": { "summary": "List Notification Profiles", "x-zenesis-title": "List Notification Profiles", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "50", "lock-period": "5M" }, "description": "This API is used to list all the Notification Profiles.", "operationId": "listNotificationProfiles", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationProfileListResponse" }, "examples": { "Example1": { "value": [ { "profileName": "CriticalAlerts_To_Admin", "actionDisplayName": "Run System Command", "associationTypeDisplayName": "Manual", "profileLabel": "Run System Command", "criteriaId": "301", "profileId": "301", "associationType": "MANUAL", "isGlobal": true, "status": "true", "actionName": "Run System Command" }, { "profileName": "Default Notification Profile", "actionDisplayName": "Send Email", "associationTypeDisplayName": "Manual", "profileLabel": "Send Email", "criteriaId": "1", "profileId": "1", "associationType": "MANUAL", "isGlobal": true, "status": "true", "actionName": "Send Email" } ] } } } } }, "429": { "description": "Rate limit exceeded. This API allows 50 requests per minute; exceeding this limit will block requests for 5 minutes." } }, "parameters": [ { "in": "query", "name": "isGlobal", "required": false, "description": "Boolean flag indicating whether to fetch only global profiles or the device specific profiles", "schema": { "type": "boolean" } }, { "in": "query", "name": "profileFilter", "required": false, "description": "To filter global notification profiles, based on action types", "schema": { "type": "string", "enum": [ "All", "Send Email", "Send SMS", "Send Modem SMS", "Run System Command", "Run Program", "Log a Ticket", "Web Alarm", "Send SysLog", "Send Trap", "Chat", "SDPOnDemand", "Webhook", "CITemplate", "Ansible", "CITInternal", "Splunk", "SIEM" ] } } ], "tags": [ "OpManager.Notifications" ], "x-zenesis-sections": {}, "x-zenesis-doc": { "show": true }, "x-zenesis-envTags": [] } }, "/api/json/admin/associateNotificationProfiles": { "post": { "summary": "Associate Notification Profiles", "x-zenesis-title": "Associate Notification Profiles", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "50", "lock-period": "5M" }, "description": "This API is used to associate notification profiles to a device or a device group or an interface group.", "operationId": "associateNotificationProfiles", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssociateNotificationProfilesResponse" }, "examples": { "Example1": { "value": { "result": { "message": "Notification Profile has been associated successfully" } } } } } } }, "429": { "description": "Rate limit exceeded. This API allows 50 requests per minute; exceeding this limit will block requests for 5 minutes." } }, "parameters": [ { "in": "query", "name": "deviceName", "required": false, "description": "Name of the device to which the notification profiles should be associated. The 'deviceName' value can be obtained from the 'deviceName' key in the JSON response of the listDevices API. Note: While deviceName, and groupName are each marked as not mandatory, at least one of the two must be provided in the request.", "schema": { "type": "string" } }, { "in": "query", "name": "groupName", "required": false, "description": "Name of the device/interface group to which the notification profiles should be associated. The 'groupName' value can be obtained from the 'groupName' key in the JSON response of the listAllLogicalGroups API. Note: While deviceName, and groupName are each marked as not mandatory, at least one of the two must be provided in the request.", "schema": { "type": "string" } }, { "in": "query", "name": "profiles", "required": true, "description": "IDs of the profiles for association. The 'profiles' value can be obtained from the 'profileId' key in the JSON response of the listNotificationProfiles API. Note: Refer the 'associationType' key from the same API response and select profileId of MANUAL or BY_DEVICE_GROUP or BY_INTERFACE_GROUP association type to associate device or device group or interface group respectively.", "schema": { "type": "string", "pattern": "^\\d+(,\\d+)*$", "example": "501,502,504" } } ], "tags": [ "OpManager.Notifications" ], "x-zenesis-sections": {}, "x-zenesis-doc": { "show": true }, "x-zenesis-envTags": [] } }, "/api/json/admin/updateNotificationProfileStatus": { "post": { "summary": "Update Notification Profile Status", "x-zenesis-title": "Update Notification Profile Status", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "50", "lock-period": "5M" }, "description": "This API is used to enable/disable notification profiles. This API will be available from OpManager version 127189.", "operationId": "updateNotificationProfileStatus", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateNotificationProfileStatusResponse" }, "examples": { "Enabled": { "value": { "message": "Notification Profile(s) enabled successfully" } }, "Disabled": { "value": { "message": "Notification Profile(s) disabled successfully" } } } } } }, "429": { "description": "Rate limit exceeded. This API allows 50 requests per minute; exceeding this limit will block requests for 5 minutes." } }, "parameters": [ { "in": "query", "name": "profileName", "required": true, "description": "Name of the notification profile to be enabled or disabled. The 'profileName' value can be obtained from the 'profileName' key in the JSON response of the listNotificationProfiles API.", "schema": { "type": "string" } }, { "in": "query", "name": "profileId", "required": true, "description": "ID of the notification profile to be enabled or disabled. The 'profiles' value can be obtained from the 'profileId' key in the JSON response of the listNotificationProfiles API.", "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "status", "required": true, "description": "Specifies whether the profile has to be enabled or disabled.", "schema": { "type": "string", "enum": [ "enable", "disable" ] } } ], "tags": [ "OpManager.Notifications" ], "x-zenesis-sections": {}, "x-zenesis-doc": { "show": true }, "x-zenesis-envTags": [] } }, "/api/json/device/getNotificationProfiles": { "get": { "summary": "Get Notification Profiles", "x-zenesis-title": "Get Notification Profiles", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "50", "lock-period": "5M" }, "description": "This API is used to list notification profiles specific to the device.", "operationId": "getNotificationProfiles", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceNotificationProfileListResponse" }, "examples": { "Example1": { "value": [ { "profileName": "Default Notification Profile", "actionDisplayName": "Send Email", "profileLabel": "Send Email", "criteriaId": "301", "profileId": "601", "isGlobal": true, "actionName": "Send Email", "status": "true" } ] } } } } }, "429": { "description": "Rate limit exceeded. This API allows 50 requests per minute; exceeding this limit will block requests for 5 minutes." } }, "parameters": [ { "in": "query", "name": "name", "required": false, "description": "Name of the device for which the associated notification profiles should be listed. The 'name' value can be obtained from the 'deviceName' key in the JSON response of the listDevices API. Note: While name, and groupName are each marked as not mandatory, at least one of the two must be provided in the request.", "schema": { "type": "string" } }, { "in": "query", "name": "groupName", "required": false, "description": "Name of the device/interface group for which the associated notification profiles should be listed. The 'groupName' value can be obtained from the 'groupName' key in the JSON response of the listAllLogicalGroups API. Note: While name, and groupName are each marked as not mandatory, at least one of the two must be provided in the request.", "schema": { "type": "string" } } ], "tags": [ "OpManager.Notifications" ], "x-zenesis-sections": {}, "x-zenesis-doc": { "show": true }, "x-zenesis-envTags": [] } }, "/api/json/v2/wireless/getSSIDClientList": { "get": { "summary": "Get SSID Client List", "x-zenesis-title": "Get SSID Client List", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "50", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Lists all the SSID and its associated client count for the given WLC device.", "operationId": "getSSIDClientList", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SSIDClientListResponse" }, "examples": { "Example1": { "value": { "clientData": [ { "displayName": "XYZ-Corp", "ClientCount": "790" }, { "displayName": "XYZ-Guest", "ClientCount": "72" }, { "displayName": "XYZ-Handhelds", "ClientCount": "58" }, { "displayName": "XYZ-BMS", "ClientCount": "26" }, { "displayName": "XYZ-Reps", "ClientCount": "13" }, { "displayName": "XYZ-mobile", "ClientCount": "9" }, { "displayName": "XYZ-ConfTV", "ClientCount": "9" }, { "displayName": "XYZ-IOT", "ClientCount": "8" }, { "displayName": "XYZ-Reception", "ClientCount": "6" }, { "displayName": "XYZ-Pitstops", "ClientCount": "2" }, { "displayName": "Guest-Test", "ClientCount": "0" }, { "displayName": "IPV6-Test", "ClientCount": "0" }, { "displayName": "XYZ-Schools", "ClientCount": "0" }, { "displayName": "XYZ-Audit", "ClientCount": "0" }, { "displayName": "XYZ-Test", "ClientCount": "0" } ], "clientCount": 993 } } } } } } }, "parameters": [ { "name": "deviceName", "schema": { "type": "string", "maxLength": 100 }, "description": "Internal name of the WLC device. This param value can be obtained from the 'deviceName' key of the '/listDevices' API's JSON Response.", "in": "query", "required": true } ], "tags": [ "OpManager.Wireless" ], "x-zenesis-doc": { "show": true } } }, "/api/json/v2/wireless/getClientDetails": { "get": { "summary": "Get Client Details", "x-zenesis-title": "Get Client Details", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "40", "lock-period": "1M" }, "x-zenesis-sections": {}, "x-zenesis-envTags": [], "description": "Fetches the client devices connected to the given SSID of WLC device.", "operationId": "getClientDetails", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WirelessClientDetail" } }, "examples": { "Example1": { "value": [ { "ClientCount": "0", "TotalBytes": "0 Bps", "APMOName": "ap-10.5.5.1-148.140.15.210.7.100", "apName": "PLL-MDX313-F13-MFLOORNEARMEETINGROOM", "advanceMonitoringEnabled": "true" }, { "ClientCount": "0", "TotalBytes": "0 Bps", "APMOName": "ap-10.5.5.2-148.180.15.192.78.100", "apName": "7thFL-7LF06-E/V", "advanceMonitoringEnabled": "true" } ] } } } } } }, "parameters": [ { "name": "deviceName", "schema": { "type": "string", "maxLength": 100 }, "description": "Internal name of the WLC device. This param value can be obtained from the 'deviceName' key of the '/listDevices' API's JSON Response.", "in": "query", "required": true }, { "name": "ssidName", "schema": { "type": "string", "maxLength": 200 }, "description": "Name of the SSID for which client details are needed. The param value can be obtained from the 'SSIDName' key of the '/getWirelessNetworkDetails' API response.", "in": "query", "required": true } ], "tags": [ "OpManager.Wireless" ], "x-zenesis-doc": { "show": true } } }, "/api/json/workflow/getWorkflowList": { "get": { "summary": "Get Workflow List", "x-zenesis-title": "Get Workflow List", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "20", "lock-period": "1M" }, "description": "Lists all the Workflows added in OpManager. (Note: This API is not applicable for central server)", "operationId": "getWorkflowList", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowListEntry" } }, "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 }, { "reportID": 90, "name": "URL Down Check", "description": "Description not given for this Workflow", "triggerdesc": "Schedule or Alarm Trigger is not configured for this Workflow", "workflowType": 1, "triggerType": 3, "rbID": 2 } ] } } } } } }, "parameters": [], "tags": [ "OpManager.Workflow" ], "x-zenesis-sections": {}, "x-zenesis-doc": { "show": true }, "x-zenesis-envTags": [] } }, "/api/json/workflow/getWorkFlows": { "get": { "summary": "Get Work Flows", "x-zenesis-title": "Get Work Flows", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "5", "lock-period": "1M" }, "description": "Lists the workflows associated with a specific device. (Note: This API is not applicable for central server)", "operationId": "getWorkFlows", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceWorkflowListResponse" }, "examples": { "Example1": { "value": { "workflows": [ { "reportID": 10000000091, "wfID": 10000000002, "wfName": "Instant Device Check", "wfDesc": "This Workflow updates the alarm notes with results of PING and NSLOOKUP when triggered from a device down alarm", "triggerType": 1, "triggerDesc": "Alarm trigger configured for this workflow" }, { "reportID": 10000000091, "wfID": 10000000302, "wfName": "alarm", "wfDesc": "Description not given for this Workflow", "triggerType": 1, "triggerDesc": "Alarm trigger configured for this workflow" } ] } } } } } } }, "parameters": [ { "in": "query", "name": "name", "required": true, "description": "Name of the device, retrieved from the deviceName field in the listDevices API response.", "schema": { "type": "string" } } ], "tags": [ "OpManager.Workflow" ], "x-zenesis-sections": {}, "x-zenesis-doc": { "show": true }, "x-zenesis-envTags": [] } }, "/api/json/workflow/triggerWorkflow": { "post": { "summary": "Trigger Workflow", "x-zenesis-title": "Trigger Workflow", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "5", "lock-period": "1M" }, "description": "Allows user to execute an workflow for a specific device. (Note: This API is not applicable for central server)", "operationId": "triggerWorkflow", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowTriggerResponse" }, "examples": { "Example1": { "value": { "message": "Workflow has been triggered successfully." } } } } } } }, "parameters": [ { "in": "query", "name": "workflowName", "required": true, "description": "Name of the workflow to be executed, retrieved from the name field in the getWorkflowList API response.", "schema": { "$ref": "#/components/schemas/alphanumeric_basic_regex" } }, { "in": "query", "name": "deviceName", "required": true, "description": "Name of the device, retrieved from the deviceName field in the listDevices API response.", "schema": { "type": "string" } } ], "tags": [ "OpManager.Workflow" ], "x-zenesis-sections": {}, "x-zenesis-doc": { "show": true }, "x-zenesis-envTags": [] } }, "/api/json/workflow/triggerWorkflowToAlarm": { "post": { "summary": "Trigger Workflow To Alarm", "x-zenesis-title": "Trigger Workflow To Alarm", "security": [ { "ApiKeyAuth": [] } ], "x-zenesis-security": { "duration": "1M", "threshold": "5", "lock-period": "1M" }, "description": "Allows user to execute an workflow for a specific alarm. (Note: This API is not applicable for central server).", "operationId": "triggerWorkflowToAlarm", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowAlarmTriggerResult" } }, "examples": { "Example1": { "value": [ { "result": { "message": "Workflow has been triggered successfully." } } ] } } } } } }, "parameters": [ { "in": "query", "name": "wfID", "required": true, "description": "ID of the workflow to be executed, retrieved from the 'rbID' field in the getWorkflowList API response.", "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "alarmId", "required": true, "description": "ID of the alarm, retrieved from the alarmId field in the listAlarms API response.", "schema": { "$ref": "#/components/schemas/numberWithComma_regex" } } ], "tags": [ "OpManager.Workflow" ], "x-zenesis-sections": {}, "x-zenesis-doc": { "show": true }, "x-zenesis-envTags": [] } } }, "components": { "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "in": "header", "name": "apikey", "description": "API Key to access your OpManager server." } }, "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" }, "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.\n Supported List includes,\n For VMware: VHOST|VDATASTORE|VM|VCENTER|VxRail \n For HyperV: HyperV-Host|HyperV-VM|HyperV-Disk \n For Citrix Xen: Xen-Host|Xen-VM|Xen-SR|Xen-Pool \n For Nutanix: Nutanix-Cluster|Nutanix-Host|Nutanix-VM \n For Proxmox: Proxmox-Node|Proxmox-VM|Proxmox-Container|Proxmox-Cluster \n" }, "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" } } }, "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" }, "AlarmAckResponse": { "type": "object", "description": "", "properties": { "ackMessage": { "type": "string", "description": "" }, "AlarmProperty": { "type": "object", "description": "", "properties": { "Details": { "type": "object", "description": "", "properties": { "displayName": { "type": "string", "description": "" }, "cycleId": { "type": "string", "description": "" }, "PRIORITY": { "type": "string", "description": "" }, "source": { "type": "string", "description": "" }, "modTimeStr": { "type": "string", "description": "" }, "alarmCode": { "type": "string", "description": "" }, "stringseverity": { "type": "string", "description": "" }, "GROUPNAME": { "type": "string", "description": "" }, "id": { "type": "string", "description": "" }, "createTimeStr": { "type": "string", "description": "" }, "severity": { "type": "string", "description": "" }, "WEBNMS": { "type": "string", "description": "" }, "eventType": { "type": "string", "description": "" }, "previousSeverity": { "type": "string", "description": "" }, "priority": { "type": "string", "description": "" }, "message": { "type": "string", "description": "" }, "OWNERNAME": { "type": "string", "description": "" }, "MAPNAME": { "type": "string", "description": "" }, "stage": { "type": "string", "description": "" }, "modTime": { "type": "string", "description": "" }, "createTime": { "type": "string", "description": "" }, "pollid": { "type": "string", "description": "" }, "category": { "type": "string", "description": "" }, "entity": { "type": "string", "description": "" }, "who": { "type": "string", "description": "" }, "status": { "type": "string", "description": "" } } } } } } }, "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" } ] } }, "graphData": { "type": "array", "items": { "$ref": "#/components/schemas/AvailabilityDataSeries" }, "description": "Array of availability time-series data for graphing. Each series represents an availability state such as Up, On Maintenance, Dependent Unavailable, On Hold, Down or Not Monitored." } } }, "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" } } }, "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.\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 availability series. Each series represents one availability state and carries its percentage value for every reported time period.", "additionalProperties": true, "type": "object", "properties": { "seriesname": { "type": "string", "description": "Availability state represented by this series - Up, On Maintenance, Dependent Unavailable, On Hold, Down or Not Monitored." }, "data": { "type": "array", "description": "Array of [period label, availability percentage] pairs, where the label is a time period such as \"Today\" or \"Last 7 days\".", "items": { "type": "array", "minItems": 2, "maxItems": 2, "items": { "oneOf": [ { "type": "string" }, { "type": "number" } ] } } } } }, "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 — 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." } } }, "DowntimeRecurrence_regex": { "type": "string", "enum": [ "OnceOnly", "Daily", "Weekly", "Monthly" ], "description": "Recurrence pattern of the downtime schedule." }, "DowntimeSuppressType_regex": { "type": "string", "enum": [ "Alarm", "Monitoring" ], "description": "Suppression mode applied by the downtime schedule." }, "DayOfWeek_regex": { "type": "string", "enum": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ], "description": "Day of the week." }, "TimeOfDay_HHMM_regex": { "type": "string", "pattern": "^([01][0-9]|2[0-3]):([0-5][0-9])$", "description": "Time of day in HH:MM format (hours 00-23, minutes 00-59)." }, "DowntimeScheduleResult": { "type": "object", "description": "Result of a downtime schedule operation.", "properties": { "result": { "type": "object", "properties": { "message": { "type": "string", "description": "Human-readable status message." }, "scheduleID": { "type": "integer", "description": "Internal ID of the created downtime schedule." } } } } }, "CustomFieldType_regex": { "type": "string", "description": "Type of object for which custom fields are configured.", "pattern": "^(Device|Interface)$", "enum": [ "Device", "Interface" ] }, "DashboardWidget": { "type": "object", "description": "A single widget placed on the dashboard.", "properties": { "widgetID": { "type": "string", "description": "Unique identifier of the widget. This value can be passed to the getWidgetData API to fetch the data rendered within the widget." }, "name": { "type": "string", "description": "Display name of the widget." }, "id": { "type": "string", "description": "Association ID that uniquely identifies this widget's placement on the dashboard." }, "type": { "type": "string", "description": "Rendering type of the widget. For example, Grid." }, "widgetUniqueName": { "type": "string", "description": "Internal unique name (i18n key) of the widget. For example, widget.name.topntraf." }, "desc": { "type": "string", "description": "Description of the widget." }, "x": { "type": "string", "description": "Horizontal position of the widget within the dashboard layout grid." }, "y": { "type": "string", "description": "Vertical position of the widget within the dashboard layout grid." }, "width": { "type": "string", "description": "Width of the widget within the dashboard layout grid." }, "height": { "type": "string", "description": "Height of the widget within the dashboard layout grid." } } }, "DashboardColumnWidth": { "type": "object", "description": "Width configuration of a single dashboard column.", "properties": { "colID": { "type": "string", "description": "Identifier of the dashboard column." }, "colWidth": { "type": "string", "description": "Width of the dashboard column, in percentage." } } }, "WidgetsListResponse": { "type": "object", "description": "Dashboard properties along with the list of widgets it contains.", "properties": { "dashboardID": { "type": "string", "description": "Unique identifier of the dashboard." }, "dashName": { "type": "string", "description": "Display name of the dashboard." }, "dashDesc": { "type": "string", "description": "Description of the dashboard." }, "viewType": { "type": "string", "description": "View type of the dashboard. For example, default." }, "noOfCols": { "type": "string", "description": "Number of columns in the dashboard layout." }, "colWidths": { "type": "array", "description": "Width configuration for each dashboard column.", "items": { "$ref": "#/components/schemas/DashboardColumnWidth" } }, "widgetList": { "type": "array", "description": "List of widgets present in the dashboard.", "items": { "$ref": "#/components/schemas/DashboardWidget" } }, "isDashboardOwner": { "type": "boolean", "description": "Indicates whether the requesting user is the owner of the dashboard." }, "isDefaultDashboard": { "type": "boolean", "description": "Indicates whether this dashboard is the default dashboard." }, "isDashPropsAvailable": { "type": "boolean", "description": "Indicates whether dashboard properties are available for this dashboard." }, "isWidgetActionsAllowed": { "type": "boolean", "description": "Indicates whether widget-level actions are permitted for the requesting user." }, "configureWidget": { "type": "boolean", "description": "Indicates whether the requesting user can configure widgets in this dashboard." }, "editDashboard": { "type": "boolean", "description": "Indicates whether the requesting user can edit this dashboard." } } }, "WidgetDataResponse": { "type": "object", "description": "Map of widget data keyed by widget ID. Each key is the widget ID that was requested and each value holds the data rendered within that widget.", "additionalProperties": { "type": "object", "description": "Data for a single widget.", "properties": { "WidgetName": { "type": "string", "description": "Display name of the widget." }, "Name": { "type": "string", "description": "Internal unique name (i18n key) of the widget. For example, widget.name.topnavail." }, "WidgetData": { "type": "array", "description": "Raw data rendered within the widget. The properties of each entry vary depending on the widget.", "items": { "type": "object", "description": "A single record of widget data. The set of properties depends on the widget type.", "additionalProperties": true } } } } }, "SubnetStatusCount": { "type": "object", "description": "Severity-wise device count within the subnet.", "properties": { "Status": { "type": "string", "description": "Numeric severity code of the devices counted in this entry." }, "Label": { "type": "string", "description": "Severity label corresponding to the status code." }, "Count": { "type": "string", "description": "Number of devices in this severity." } } }, "SubnetDetail": { "type": "object", "description": "Details of a subnet added in OpManager.", "properties": { "data": { "type": "array", "description": "Severity-wise device counts for the subnet.", "items": { "$ref": "#/components/schemas/SubnetStatusCount" } }, "displayName": { "type": "string", "description": "Display name of the subnet." }, "subnetDisplayName": { "type": "string", "description": "User-configured display name of the subnet." } } }, "DeviceInfoMetricUpdate": { "type": "object", "description": "Device attribute to be updated.", "properties": { "metricName": { "type": "string", "description": "Name of the device attribute to be updated.", "enum": [ "HDD", "RAM", "Model", "Manufacturer", "OperatingSystem", "SoftwareVersion" ] }, "metricValue": { "type": "string", "description": "New value to be set for the device attribute." } } }, "InfrastructureDeviceDetail": { "type": "object", "description": "Device details under the requested category.", "properties": { "severity": { "type": "string", "description": "Numeric severity code of the device." }, "intfCount": { "type": "string", "description": "Number of interfaces associated with the device." }, "displayName": { "type": "string", "description": "Display name of the device." }, "name": { "type": "string", "description": "Internal name of the device." }, "IpAddress": { "type": "string", "description": "IP address of the device." }, "type": { "type": "string", "description": "Device type." }, "status": { "type": "string", "description": "Current status of the device." }, "monitors": { "type": "object", "description": "Associated performance monitor values of the device.", "additionalProperties": { "type": "number" } } } }, "InfrastructureDetailsViewResponse": { "type": "object", "description": "Infrastructure details of the devices under the requested category.", "properties": { "InfrastructureDetailsView": { "type": "object", "properties": { "Details": { "type": "array", "description": "List of devices under the requested category.", "items": { "$ref": "#/components/schemas/InfrastructureDeviceDetail" } }, "TotalRecords": { "type": "string", "description": "Total number of device records returned." } } } } }, "DeviceCompleteDetails": { "type": "object", "description": "Basic details and availability of the device.", "properties": { "credentialAssociated": { "type": "string", "description": "Indicates whether a credential is associated with the device." }, "showCredentialNotAssociatedMsg": { "type": "string", "description": "Indicates whether the credential-not-associated message should be shown." }, "statusStr": { "type": "string", "description": "Current status of the device as a string." }, "statusNum": { "type": "string", "description": "Numeric status code of the device." }, "state": { "type": "string", "description": "Internal state code of the device." }, "type": { "type": "string", "description": "Device type." }, "vendorName": { "type": "string", "description": "Vendor of the device." }, "dnsName": { "type": "string", "description": "DNS name of the device." }, "responseTime": { "type": "string", "description": "Last measured response time of the device." }, "packetLoss": { "type": "string", "description": "Last measured packet loss of the device." }, "timeZone": { "type": "string", "description": "Time zone configured for the device." }, "format": { "type": "string", "description": "Date format used in the response." }, "isStorage": { "type": "boolean", "description": "Indicates whether the device is a storage device." }, "availability": { "type": "array", "description": "Availability entries of the device for the reported period.", "items": { "type": "string" } }, "todayTimeAvail": { "type": "object", "description": "Availability time window for the current day.", "properties": { "todayStartTime": { "type": "string", "description": "Start time of the current day's availability window." }, "endTimeVal": { "type": "string", "description": "End time of the current day's availability window." } } }, "availdata": { "type": "object", "description": "Percentage distribution of the device availability states.", "additionalProperties": { "type": "number" } }, "opmdetails": { "type": "object", "description": "Basic OpManager details of the device.", "additionalProperties": true }, "nfadetails": { "type": "object", "description": "NetFlow Analyzer details of the device.", "additionalProperties": true }, "ncmdetails": { "type": "object", "description": "Network Configuration Manager details of the device.", "additionalProperties": true }, "oputilsDetails": { "type": "object", "description": "OpUtils details of the device.", "additionalProperties": true }, "configBackup": { "type": "object", "description": "Configuration backup details of the device.", "additionalProperties": true } } }, "VMwareHostDetail": { "type": "object", "description": "Details of a VMware ESXi host monitored by OpManager.", "properties": { "DISPLAYNAME": { "type": "string", "description": "Display name of the VMware host." }, "NAME": { "type": "string", "description": "Internal name of the VMware host." }, "VHOST_ID": { "type": "integer", "description": "Internal ID of the VMware host." }, "STATUS": { "type": "string", "description": "Numeric status code of the VMware host." }, "STATUS_STR": { "type": "string", "description": "Status of the VMware host as a string." }, "OS": { "type": "string", "description": "Operating system running on the VMware host." }, "OS_TYPE": { "type": "string", "description": "Operating system type of the VMware host." }, "NUM_PNIC": { "type": "integer", "description": "Number of physical network interface cards on the host." }, "CPU_SPEED_MHZ": { "type": "integer", "description": "CPU speed of the host in MHz." }, "MEM_CAPACITY_MB": { "type": "integer", "description": "Memory capacity of the host in MB." }, "POWER_STATE": { "type": "string", "description": "Power state of the VMware host." }, "CONNECTION_STATUS": { "type": "string", "description": "Connection status of the VMware host." }, "SYSUPTIME": { "type": "string", "description": "System up time of the VMware host." } } }, "VMwareDataCenterDetail": { "type": "object", "description": "Details of a datacenter associated with a vCenter.", "properties": { "ENTITY_NAME": { "type": "string", "description": "Name of the datacenter." }, "STATUS": { "type": "string", "description": "Numeric status code of the datacenter." }, "STATUS_STR": { "type": "string", "description": "Status of the datacenter as a string." }, "NO_OF_DATASTORES": { "type": "integer", "description": "Number of datastores under the datacenter." }, "NO_OF_NETWORKS": { "type": "integer", "description": "Number of networks under the datacenter." } } }, "VMwareClusterDetail": { "type": "object", "description": "Details of a cluster associated with a vCenter.", "properties": { "ENTITY_NAME": { "type": "string", "description": "Name of the cluster." }, "STATUS": { "type": "string", "description": "Numeric status code of the cluster." }, "STATUS_STR": { "type": "string", "description": "Status of the cluster as a string." }, "NO_OF_HOSTS": { "type": "integer", "description": "Number of hosts under the cluster." }, "NO_OF_DATASTORES": { "type": "integer", "description": "Number of datastores under the cluster." }, "NO_OF_NETWORKS": { "type": "integer", "description": "Number of networks under the cluster." }, "TOTAL_CPU_GHZ": { "type": "integer", "description": "Total CPU capacity of the cluster in GHz." }, "EFFECTIVE_CPU": { "type": "integer", "description": "Effective CPU capacity available in the cluster." }, "TOTAL_MEMORY_GB": { "type": "integer", "description": "Total memory capacity of the cluster in GB." }, "EFFECTIVE_MEMORY": { "type": "integer", "description": "Effective memory capacity available in the cluster." }, "DRS_ENABLED": { "type": "boolean", "description": "Indicates whether DRS is enabled for the cluster." }, "DAS_ENABLED": { "type": "boolean", "description": "Indicates whether HA (DAS) is enabled for the cluster." } } }, "VMwareDataStoreDetail": { "type": "object", "description": "Details of a VMware datastore monitored by OpManager.", "properties": { "DATASTORENAME": { "type": "string", "description": "Name of the VMware datastore." }, "Datastore_ID": { "type": "integer", "description": "Internal ID of the VMware datastore." }, "deviceName": { "type": "string", "description": "Internal name of the datastore entity." }, "FILESYSTEM_TYPE": { "type": "string", "description": "File system type of the datastore." }, "CAPACITY_MB": { "type": "integer", "description": "Total capacity of the datastore in MB." }, "FREESPACE_MB": { "type": "integer", "description": "Free space available in the datastore in MB." }, "DATASTORE_URL": { "type": "string", "description": "URL of the datastore." }, "HostCount": { "type": "integer", "description": "Number of hosts using the datastore." }, "MOID": { "type": "integer", "description": "Managed object ID of the datastore." }, "IS_ACCESSIBLE": { "type": "string", "description": "Accessibility status of the datastore." } } }, "NutanixVDiskDetail": { "type": "object", "description": "Details of a virtual disk associated with a Nutanix VM.", "properties": { "VDISK_ID": { "type": "integer", "description": "Internal ID of the Nutanix virtual disk." }, "UUID": { "type": "string", "description": "UUID of the Nutanix virtual disk." }, "CAPACITY": { "type": "string", "description": "Capacity of the virtual disk." }, "DISKADDRESS": { "type": "string", "description": "Disk address of the virtual disk." }, "NFSFILEPATH": { "type": "string", "description": "NFS file path of the virtual disk." } } }, "NutanixEntityDetail": { "type": "object", "description": "Details of the Nutanix entity corresponding to the requested entity type.", "properties": { "ENTITYNAME": { "type": "string", "description": "Name of the Nutanix entity." }, "DISPLAYNAME": { "type": "string", "description": "Display name of the Nutanix entity." }, "deviceName": { "type": "string", "description": "Internal name of the Nutanix entity." }, "MOID": { "type": "integer", "description": "Managed object ID of the Nutanix entity." }, "statusStr": { "type": "string", "description": "Status of the Nutanix entity as a string." }, "statusNum": { "type": "integer", "description": "Numeric status code of the Nutanix entity." }, "STATUS": { "type": "string", "description": "Status of the Nutanix entity." }, "IPADDRESS": { "type": "string", "description": "IP address of the Nutanix entity." }, "uuid": { "type": "string", "description": "UUID of the Nutanix entity." }, "clusterName": { "type": "string", "description": "Name of the Nutanix cluster." }, "clusterMoName": { "type": "string", "description": "Internal name of the Nutanix cluster." }, "hostName": { "type": "string", "description": "Name of the Nutanix host." }, "hostMoName": { "type": "string", "description": "Internal name of the Nutanix host." }, "VM_ID": { "type": "integer", "description": "Internal ID of the Nutanix VM." }, "VCPUCOUNT": { "type": "integer", "description": "Number of virtual CPUs assigned to the VM." }, "MEMORYCAPACITY": { "type": "string", "description": "Memory capacity of the entity." }, "MEMRESERVEDCAPACITY": { "type": "string", "description": "Reserved memory capacity of the entity." }, "DISKCAPACITY": { "type": "string", "description": "Disk capacity of the entity." }, "VM_POWERSTATE": { "type": "string", "description": "Power state of the Nutanix VM." }, "NOOFNETWORKADAPTERS": { "type": "integer", "description": "Number of network adapters on the entity." }, "ISCONTROLLERVM": { "type": "string", "description": "Indicates whether the VM is a controller VM." }, "TOOLSMOUNTED": { "type": "boolean", "description": "Indicates whether Nutanix guest tools are mounted." }, "TOOLSVERSION": { "type": "string", "description": "Version of the Nutanix guest tools." } }, "additionalProperties": true }, "AssociatedMonitorsResponse": { "type": "object", "description": "Monitors associated with the device along with their last polled values and status.", "properties": { "performanceMonitors": { "type": "object", "description": "Performance monitors associated with the device.", "properties": { "total": { "type": "integer", "description": "Total number of monitors in this group." }, "down": { "type": "integer", "description": "Number of monitors currently down in this group." }, "monitors": { "type": "array", "description": "List of monitors in this group.", "items": { "type": "object", "additionalProperties": true } } } }, "serverMonitors": { "type": "object", "description": "Service monitors associated with the device.", "properties": { "total": { "type": "integer", "description": "Total number of monitors in this group." }, "down": { "type": "integer", "description": "Number of monitors currently down in this group." }, "monitors": { "type": "array", "description": "List of monitors in this group.", "items": { "type": "object", "additionalProperties": true } } } }, "ntServiceMonitors": { "type": "object", "description": "Windows service monitors associated with the device.", "properties": { "total": { "type": "integer", "description": "Total number of monitors in this group." }, "down": { "type": "integer", "description": "Number of monitors currently down in this group." }, "monitors": { "type": "array", "description": "List of monitors in this group.", "items": { "type": "object", "additionalProperties": true } } } }, "urlMonitors": { "type": "object", "description": "URL monitors associated with the device.", "properties": { "total": { "type": "integer", "description": "Total number of monitors in this group." }, "down": { "type": "integer", "description": "Number of monitors currently down in this group." }, "monitors": { "type": "array", "description": "List of monitors in this group.", "items": { "type": "object", "additionalProperties": true } } } }, "processMonitors": { "type": "object", "description": "Process monitors associated with the device.", "properties": { "total": { "type": "integer", "description": "Total number of monitors in this group." }, "down": { "type": "integer", "description": "Number of monitors currently down in this group." }, "monitors": { "type": "array", "description": "List of monitors in this group.", "items": { "type": "object", "additionalProperties": true } } } }, "fileMonitors": { "type": "object", "description": "File monitors associated with the device.", "properties": { "total": { "type": "integer", "description": "Total number of monitors in this group." }, "down": { "type": "integer", "description": "Number of monitors currently down in this group." }, "monitors": { "type": "array", "description": "List of monitors in this group.", "items": { "type": "object", "additionalProperties": true } } } }, "folderMonitors": { "type": "object", "description": "Folder monitors associated with the device.", "properties": { "total": { "type": "integer", "description": "Total number of monitors in this group." }, "down": { "type": "integer", "description": "Number of monitors currently down in this group." }, "monitors": { "type": "array", "description": "List of monitors in this group.", "items": { "type": "object", "additionalProperties": true } } } }, "eventlogMonitors": { "type": "object", "description": "Event log monitors associated with the device.", "properties": { "total": { "type": "integer", "description": "Total number of monitors in this group." }, "down": { "type": "integer", "description": "Number of monitors currently down in this group." }, "period": { "type": "string", "description": "Polling period configured for the event log monitors." }, "isActive": { "type": "string", "description": "Indicates whether event log monitoring is active." }, "monitors": { "type": "array", "description": "List of monitors in this group.", "items": { "type": "object", "additionalProperties": true } } } }, "scriptMonitors": { "type": "object", "description": "Script monitors associated with the device.", "properties": { "total": { "type": "integer", "description": "Total number of monitors in this group." }, "down": { "type": "integer", "description": "Number of monitors currently down in this group." }, "monitors": { "type": "array", "description": "List of monitors in this group.", "items": { "type": "object", "additionalProperties": true } } } } } }, "DeviceProcessMonitorDetail": { "type": "object", "description": "Details of a process monitor associated with the device.", "properties": { "processName": { "type": "string", "description": "Name of the monitored process." }, "displayName": { "type": "string", "description": "Display name of the process monitor." }, "path": { "type": "string", "description": "Path of the monitored process." }, "cmdLineArgs": { "type": "string", "description": "Command line arguments of the monitored process." }, "status": { "type": "string", "description": "Current status of the process monitor." } } }, "DeviceServiceMonitorDetail": { "type": "object", "description": "Service monitor associated with a device.", "properties": { "name": { "type": "string", "description": "Name of the service monitor." }, "portNo": { "type": "string", "description": "Port number on which the service is monitored." }, "status": { "type": "string", "description": "Current status of the service monitor." } } }, "DeviceWindowsServiceMonitorDetail": { "type": "object", "description": "Windows service monitor associated with a device.", "properties": { "displayName": { "type": "string", "description": "Display name of the Windows service monitor." }, "serviceName": { "type": "string", "description": "Internal Windows service name." }, "serviceID": { "type": "string", "description": "Internal identifier of the Windows service monitor." }, "status": { "type": "string", "description": "Current status of the Windows service monitor." } } }, "DeviceGraphNameDetail": { "type": "object", "description": "Performance monitor associated with a device.", "properties": { "protocol": { "type": "string", "description": "Protocol used by the performance monitor for data collection." }, "graphType": { "type": "string", "description": "Type of the performance monitor." }, "policyName": { "type": "string", "description": "Internal name of the performance monitor used to uniquely identify it." }, "displayName": { "type": "string", "description": "Display name of the performance monitor." }, "pollId": { "type": "string", "description": "Internal id of the performance monitor." }, "name": { "type": "string", "description": "Name of the performance monitor instance." }, "oid": { "type": "string", "description": "Internal OID of the performance monitor used for data collection." } } }, "NutanixDiskDetail": { "type": "object", "description": "Disk details within the Nutanix environment.", "properties": { "DISK_ID": { "type": "integer", "description": "Internal identifier of the Nutanix disk." }, "SERIALNUMBER": { "type": "string", "description": "Serial number of the disk." }, "CAPACITY": { "type": "string", "description": "Total capacity of the disk." }, "USAGE": { "type": "string", "description": "Used space of the disk." }, "TIER": { "type": "string", "description": "Storage tier to which the disk belongs." }, "STATUS": { "type": "string", "description": "Current status of the disk." }, "MOUNTPATH": { "type": "string", "description": "Mount path of the disk." }, "MOUNTED": { "type": "boolean", "description": "Indicates whether the disk is mounted." }, "BOOTDISK": { "type": "boolean", "description": "Indicates whether the disk is a boot disk." }, "VENDOR": { "type": "string", "description": "Vendor of the disk." }, "MODEL": { "type": "string", "description": "Model of the disk." } } }, "NutanixHostDetail": { "type": "object", "description": "Host details within a Nutanix cluster.", "properties": { "HOST_ID": { "type": "integer", "description": "Internal identifier of the Nutanix host." }, "NAME": { "type": "string", "description": "Name of the Nutanix host." }, "DISPLAYNAME": { "type": "string", "description": "Display name of the Nutanix host." }, "IPADDRESS": { "type": "string", "description": "IP address of the Nutanix host." }, "HYPERVISORDETAIL": { "type": "string", "description": "Hypervisor details of the Nutanix host." }, "CPUMODEL": { "type": "string", "description": "CPU model of the Nutanix host." }, "NUMCPUCORES": { "type": "integer", "description": "Number of CPU cores available in the Nutanix host." }, "MEMORYCAPACITY": { "type": "string", "description": "Memory capacity of the Nutanix host." }, "DISKCAPACITY": { "type": "string", "description": "Disk capacity of the Nutanix host." }, "BOOTTIME": { "type": "string", "description": "Boot time of the Nutanix host." }, "TYPE": { "type": "string", "description": "Type of the Nutanix host." }, "statusStr": { "type": "string", "description": "Current status of the Nutanix host as a string." }, "statusNum": { "type": "integer", "description": "Numeric status code of the Nutanix host." }, "state": { "type": "integer", "description": "Internal state of the Nutanix host." }, "SELECTIONSTATE": { "type": "integer", "description": "Selection state of the Nutanix host." } } }, "NutanixOrphanedVMDetail": { "type": "object", "description": "Orphaned virtual machine details within the Nutanix environment.", "properties": { "VM_ID": { "type": "integer", "description": "Internal identifier of the Nutanix virtual machine." }, "NAME": { "type": "string", "description": "Name of the Nutanix virtual machine." }, "DISPLAYNAME": { "type": "string", "description": "Display name of the Nutanix virtual machine." }, "IPADDRESS": { "type": "string", "description": "IP address of the Nutanix virtual machine." }, "OS": { "type": "string", "description": "Operating system of the Nutanix virtual machine." }, "VCPUCOUNT": { "type": "integer", "description": "Number of virtual CPUs assigned to the virtual machine." }, "MEMORYCAPACITY": { "type": "string", "description": "Memory capacity of the virtual machine." }, "DISKCAPACITY": { "type": "string", "description": "Disk capacity of the virtual machine." }, "NUMNETWORKADAPTERS": { "type": "integer", "description": "Number of network adapters attached to the virtual machine." }, "ISCONTROLLERVM": { "type": "boolean", "description": "Indicates whether the virtual machine is a controller virtual machine." }, "statusStr": { "type": "string", "description": "Current status of the virtual machine as a string." }, "statusNum": { "type": "integer", "description": "Numeric status code of the virtual machine." }, "SELECTIONSTATE": { "type": "integer", "description": "Selection state of the virtual machine." } } }, "NutanixStorageContainerDetail": { "type": "object", "description": "Storage container details within a Nutanix cluster.", "properties": { "SC_ID": { "type": "integer", "description": "Internal identifier of the Nutanix storage container." }, "NAME": { "type": "string", "description": "Name of the storage container." }, "CAPACITY": { "type": "string", "description": "Total capacity of the storage container." }, "USAGE": { "type": "string", "description": "Used space of the storage container." }, "RF": { "type": "integer", "description": "Replication factor configured for the storage container." }, "COMPRESSION": { "type": "boolean", "description": "Indicates whether compression is enabled for the storage container." }, "CACHEDUPLICATION": { "type": "string", "description": "Cache deduplication setting of the storage container." }, "ERASUREENCODING": { "type": "string", "description": "Erasure coding setting of the storage container." } } }, "NutanixStoragePoolDetail": { "type": "object", "description": "Storage pool details within a Nutanix cluster.", "properties": { "SP_ID": { "type": "integer", "description": "Internal identifier of the Nutanix storage pool." }, "NAME": { "type": "string", "description": "Name of the storage pool." }, "CAPACITY": { "type": "string", "description": "Total capacity of the storage pool." }, "DISKS": { "type": "integer", "description": "Number of disks that are part of the storage pool." } } }, "NutanixVolumeGroupDetail": { "type": "object", "description": "Volume group details within a Nutanix cluster.", "properties": { "VG_ID": { "type": "integer", "description": "Internal identifier of the Nutanix volume group." }, "NAME": { "type": "string", "description": "Name of the volume group." }, "CAPACITY": { "type": "string", "description": "Total capacity of the volume group." }, "DISKS": { "type": "integer", "description": "Number of disks that are part of the volume group." } } }, "ApplicationServiceDetail": { "type": "object", "description": "Application service monitor that can be monitored within the product.", "properties": { "serviceid": { "type": "integer", "description": "Internal identifier of the application service." }, "serviceName": { "type": "string", "description": "Internal name of the application service." }, "serviceDisplayName": { "type": "string", "description": "Display name of the application service." }, "serviceDesc": { "type": "string", "description": "Description of the application service." }, "autoAdd": { "type": "boolean", "description": "Indicates whether the service is added automatically for monitoring." } } }, "VirtualEntityMappingResponse": { "type": "object", "description": "Response returned when a virtual machine is mapped or unmapped for monitoring.", "properties": { "result": { "type": "string", "description": "Result of the operation." }, "status": { "type": "string", "description": "Status message describing the outcome of the operation." } } }, "VSANDiskAlarmSuppressionResponse": { "type": "object", "description": "Response returned when alarm notifications for a VSAN disk are enabled or disabled.", "properties": { "result": { "type": "object", "properties": { "message": { "type": "string", "description": "Message describing the outcome of the alarm suppression request." } } } } }, "AddDeviceResponse": { "type": "object", "properties": { "device": { "type": "object", "properties": { "deviceIp": { "type": "string", "description": "IP address of the newly added device." }, "message": { "type": "string", "description": "Human-readable status message of the operation." }, "deviceName": { "type": "string", "description": "Internal name that uniquely identifies the newly added device." }, "moid": { "type": "integer", "format": "int64", "description": "Unique managed object identifier assigned to the newly added device." } } } } }, "AddIPMIDeviceResponse": { "type": "object", "properties": { "result": { "type": "object", "properties": { "deviceIp": { "type": "string", "description": "IP address of the newly added IPMI device." }, "message": { "type": "string", "description": "Human-readable status message of the operation." }, "deviceName": { "type": "string", "description": "Internal name that uniquely identifies the newly added IPMI device." }, "moid": { "type": "integer", "format": "int64", "description": "Unique managed object identifier assigned to the newly added IPMI device." } } } } }, "ListEventsResponse": { "type": "array", "description": "", "items": { "type": "object", "description": "", "properties": { "severity": { "type": "string", "description": "" }, "prettyTime": { "type": "string", "description": "" }, "statusStr": { "type": "string", "description": "" }, "source": { "type": "string", "description": "" }, "statusNum": { "type": "string", "description": "" }, "modTimeLong": { "type": "string", "description": "" }, "displayname": { "type": "string", "description": "" }, "text": { "type": "string", "description": "" }, "time": { "type": "string", "description": "" }, "id": { "type": "string", "description": "" }, "category": { "type": "string", "description": "" }, "imgsrc": { "type": "string", "description": "" }, "entity": { "type": "string", "description": "" } } } }, "AddEventResponse": { "type": "object", "description": "", "properties": { "result": { "type": "object", "description": "", "properties": { "message": { "type": "string", "description": "" } } } } }, "GetLogicalGroupAlertsResponse": { "type": "array", "description": "", "items": { "type": "object", "description": "", "properties": { "severity": { "type": "string", "description": "" }, "groupType": { "type": "string", "description": "" }, "severityString": { "type": "string", "description": "" }, "modTime": { "type": "string", "description": "" }, "displayName": { "type": "string", "description": "" }, "name": { "type": "string", "description": "" }, "alarmId": { "type": "integer", "format": "int64", "description": "" }, "message": { "type": "string", "description": "" }, "type": { "type": "string", "description": "" }, "entity": { "type": "integer", "format": "int64", "description": "" }, "status": { "type": "integer", "description": "" } } } }, "AddToGroupResponse": { "type": "object", "description": "", "properties": { "result": { "type": "object", "description": "", "properties": { "message": { "type": "string", "description": "" } } } } }, "ListInterfacesResponse": { "type": "object", "description": "Response wrapper for the listInterfaces API.", "properties": { "total": { "type": "string", "description": "Total number of pages available." }, "records": { "type": "string", "description": "Total number of interface records available." }, "page": { "type": "string", "description": "Current page number." }, "rows": { "type": "array", "description": "List of monitored interfaces.", "items": { "$ref": "#/components/schemas/ListInterfacesRow" } } } }, "ListInterfacesRow": { "type": "object", "description": "A single interface entry from the listInterfaces response.", "additionalProperties": true, "properties": { "id": { "type": "string", "description": "Unique identifier of the interface." }, "interfaceName": { "type": "string", "description": "Internal name of the interface." }, "interfaceDisplayName": { "type": "string", "description": "Display name of the interface." }, "displayName": { "type": "string", "description": "Display name of the parent device." }, "deviceName": { "type": "string", "description": "Internal name of the parent device." }, "ipAddress": { "type": "string", "description": "IP address of the interface." }, "type": { "type": "string", "description": "Type of the interface." }, "statusStr": { "type": "string", "description": "Current status of the interface as a string." }, "statusNum": { "type": "integer", "description": "Current status of the interface as a number." }, "stateNum": { "type": "integer", "description": "Current state of the interface as a number." }, "interfaceStatus": { "type": "integer", "description": "Status code of the interface." }, "adminStatus": { "type": "string", "description": "Administrative status of the interface." }, "operStatus": { "type": "string", "description": "Operational status of the interface." }, "inSpeed": { "type": "string", "description": "Receive speed of the interface." }, "outSpeed": { "type": "string", "description": "Transmit speed of the interface." }, "inTraffic": { "type": "string", "description": "Receive traffic of the interface." }, "outTraffic": { "type": "string", "description": "Transmit traffic of the interface." } } }, "GetIntfAtAGlanceReportDetailsResponse": { "type": "object", "description": "Response wrapper for the getIntfAtAGlanceReportDetails API.", "additionalProperties": true, "properties": { "intfDisplayName": { "type": "string", "description": "Display name of the interface." }, "InterfaceCategory": { "type": "string", "description": "Category of the interface." }, "repType": { "type": "integer", "description": "Report type identifier." }, "Details": { "type": "object", "description": "Identification details of the interface.", "additionalProperties": true, "properties": { "Parent Name": { "type": "string", "description": "Name of the parent device." }, "IfDescr": { "type": "string", "description": "Interface description." }, "IfAlias": { "type": "string", "description": "Interface alias." }, "IfIndex": { "type": "string", "description": "Interface index." }, "IfName": { "type": "string", "description": "Interface name." }, "Circuit ID": { "type": "string", "description": "Circuit ID of the interface." }, "Receive Bandwidth": { "type": "string", "description": "Receive bandwidth of the interface." }, "Transmit Bandwidth": { "type": "string", "description": "Transmit bandwidth of the interface." } } }, "graphData": { "type": "object", "description": "Graph data keyed by metric name. The Availability entry holds state and percentage pairs; all other entries hold a list of data series.", "additionalProperties": true, "properties": { "Availability": { "type": "array", "description": "Availability state and percentage pairs.", "items": { "type": "array", "items": { "type": "string" } } }, "inTraffic": { "type": "array", "description": "Receive traffic series.", "items": { "type": "object", "description": "A single graph data series.", "additionalProperties": true, "properties": { "seriesname": { "type": "string", "description": "Name of the data series." }, "data": { "type": "array", "description": "Data points for the series. Each entry is a tuple of collection time in milliseconds, the numeric value, and the formatted display value.", "items": { "type": "array", "items": {} } }, "xyTitles": { "type": "array", "description": "Titles for the X and Y axes.", "items": { "type": "string" } }, "yaxiscolumnorder": { "type": "array", "description": "Column order for the Y axis.", "items": { "type": "integer" } }, "suffix": { "type": "string", "description": "Unit suffix applied to the series values." } } } }, "outTraffic": { "type": "array", "description": "Transmit traffic series.", "items": { "type": "object", "description": "A single graph data series.", "additionalProperties": true, "properties": { "seriesname": { "type": "string", "description": "Name of the data series." }, "data": { "type": "array", "description": "Data points for the series. Each entry is a tuple of collection time in milliseconds, the numeric value, and the formatted display value.", "items": { "type": "array", "items": {} } }, "xyTitles": { "type": "array", "description": "Titles for the X and Y axes.", "items": { "type": "string" } }, "yaxiscolumnorder": { "type": "array", "description": "Column order for the Y axis.", "items": { "type": "integer" } }, "suffix": { "type": "string", "description": "Unit suffix applied to the series values." } } } }, "inBytes": { "type": "array", "description": "Receive bytes series.", "items": { "type": "object", "description": "A single graph data series.", "additionalProperties": true, "properties": { "seriesname": { "type": "string", "description": "Name of the data series." }, "data": { "type": "array", "description": "Data points for the series. Each entry is a tuple of collection time in milliseconds, the numeric value, and the formatted display value.", "items": { "type": "array", "items": {} } }, "xyTitles": { "type": "array", "description": "Titles for the X and Y axes.", "items": { "type": "string" } }, "yaxiscolumnorder": { "type": "array", "description": "Column order for the Y axis.", "items": { "type": "integer" } }, "suffix": { "type": "string", "description": "Unit suffix applied to the series values." } } } }, "outBytes": { "type": "array", "description": "Transmit bytes series.", "items": { "type": "object", "description": "A single graph data series.", "additionalProperties": true, "properties": { "seriesname": { "type": "string", "description": "Name of the data series." }, "data": { "type": "array", "description": "Data points for the series. Each entry is a tuple of collection time in milliseconds, the numeric value, and the formatted display value.", "items": { "type": "array", "items": {} } }, "xyTitles": { "type": "array", "description": "Titles for the X and Y axes.", "items": { "type": "string" } }, "yaxiscolumnorder": { "type": "array", "description": "Column order for the Y axis.", "items": { "type": "integer" } }, "suffix": { "type": "string", "description": "Unit suffix applied to the series values." } } } }, "inUtilization": { "type": "array", "description": "Receive utilization series.", "items": { "type": "object", "description": "A single graph data series.", "additionalProperties": true, "properties": { "seriesname": { "type": "string", "description": "Name of the data series." }, "data": { "type": "array", "description": "Data points for the series. Each entry is a tuple of collection time in milliseconds, the numeric value, and the formatted display value.", "items": { "type": "array", "items": {} } }, "xyTitles": { "type": "array", "description": "Titles for the X and Y axes.", "items": { "type": "string" } }, "yaxiscolumnorder": { "type": "array", "description": "Column order for the Y axis.", "items": { "type": "integer" } }, "suffix": { "type": "string", "description": "Unit suffix applied to the series values." } } } }, "outUtilization": { "type": "array", "description": "Transmit utilization series.", "items": { "type": "object", "description": "A single graph data series.", "additionalProperties": true, "properties": { "seriesname": { "type": "string", "description": "Name of the data series." }, "data": { "type": "array", "description": "Data points for the series. Each entry is a tuple of collection time in milliseconds, the numeric value, and the formatted display value.", "items": { "type": "array", "items": {} } }, "xyTitles": { "type": "array", "description": "Titles for the X and Y axes.", "items": { "type": "string" } }, "yaxiscolumnorder": { "type": "array", "description": "Column order for the Y axis.", "items": { "type": "integer" } }, "suffix": { "type": "string", "description": "Unit suffix applied to the series values." } } } }, "totalUtilization": { "type": "array", "description": "Total utilization series.", "items": { "type": "object", "description": "A single graph data series.", "additionalProperties": true, "properties": { "seriesname": { "type": "string", "description": "Name of the data series." }, "data": { "type": "array", "description": "Data points for the series. Each entry is a tuple of collection time in milliseconds, the numeric value, and the formatted display value.", "items": { "type": "array", "items": {} } }, "xyTitles": { "type": "array", "description": "Titles for the X and Y axes.", "items": { "type": "string" } }, "yaxiscolumnorder": { "type": "array", "description": "Column order for the Y axis.", "items": { "type": "integer" } }, "suffix": { "type": "string", "description": "Unit suffix applied to the series values." } } } }, "inFrames": { "type": "array", "description": "Receive frames series.", "items": { "type": "object", "description": "A single graph data series.", "additionalProperties": true, "properties": { "seriesname": { "type": "string", "description": "Name of the data series." }, "data": { "type": "array", "description": "Data points for the series. Each entry is a tuple of collection time in milliseconds, the numeric value, and the formatted display value.", "items": { "type": "array", "items": {} } }, "xyTitles": { "type": "array", "description": "Titles for the X and Y axes.", "items": { "type": "string" } }, "yaxiscolumnorder": { "type": "array", "description": "Column order for the Y axis.", "items": { "type": "integer" } }, "suffix": { "type": "string", "description": "Unit suffix applied to the series values." } } } }, "outFrames": { "type": "array", "description": "Transmit frames series.", "items": { "type": "object", "description": "A single graph data series.", "additionalProperties": true, "properties": { "seriesname": { "type": "string", "description": "Name of the data series." }, "data": { "type": "array", "description": "Data points for the series. Each entry is a tuple of collection time in milliseconds, the numeric value, and the formatted display value.", "items": { "type": "array", "items": {} } }, "xyTitles": { "type": "array", "description": "Titles for the X and Y axes.", "items": { "type": "string" } }, "yaxiscolumnorder": { "type": "array", "description": "Column order for the Y axis.", "items": { "type": "integer" } }, "suffix": { "type": "string", "description": "Unit suffix applied to the series values." } } } }, "Errors": { "type": "array", "description": "Receive and transmit errors series.", "items": { "type": "object", "description": "A single graph data series.", "additionalProperties": true, "properties": { "seriesname": { "type": "string", "description": "Name of the data series." }, "data": { "type": "array", "description": "Data points for the series. Each entry is a tuple of collection time in milliseconds, the numeric value, and the formatted display value.", "items": { "type": "array", "items": {} } }, "xyTitles": { "type": "array", "description": "Titles for the X and Y axes.", "items": { "type": "string" } }, "yaxiscolumnorder": { "type": "array", "description": "Column order for the Y axis.", "items": { "type": "integer" } }, "suffix": { "type": "string", "description": "Unit suffix applied to the series values." } } } }, "Discards": { "type": "array", "description": "Receive and transmit discards series.", "items": { "type": "object", "description": "A single graph data series.", "additionalProperties": true, "properties": { "seriesname": { "type": "string", "description": "Name of the data series." }, "data": { "type": "array", "description": "Data points for the series. Each entry is a tuple of collection time in milliseconds, the numeric value, and the formatted display value.", "items": { "type": "array", "items": {} } }, "xyTitles": { "type": "array", "description": "Titles for the X and Y axes.", "items": { "type": "string" } }, "yaxiscolumnorder": { "type": "array", "description": "Column order for the Y axis.", "items": { "type": "integer" } }, "suffix": { "type": "string", "description": "Unit suffix applied to the series values." } } } }, "Unicast": { "type": "array", "description": "Unicast and broadcast series.", "items": { "type": "object", "description": "A single graph data series.", "additionalProperties": true, "properties": { "seriesname": { "type": "string", "description": "Name of the data series." }, "data": { "type": "array", "description": "Data points for the series. Each entry is a tuple of collection time in milliseconds, the numeric value, and the formatted display value.", "items": { "type": "array", "items": {} } }, "xyTitles": { "type": "array", "description": "Titles for the X and Y axes.", "items": { "type": "string" } }, "yaxiscolumnorder": { "type": "array", "description": "Column order for the Y axis.", "items": { "type": "integer" } }, "suffix": { "type": "string", "description": "Unit suffix applied to the series values." } } } } } } } }, "GetIntfBWOutageReportDetailsResponse": { "type": "object", "description": "Response wrapper for the getIntfBWOutageReportDetails API.", "additionalProperties": true, "properties": { "InterfaceName": { "type": "string", "description": "Internal name of the interface." }, "InterfaceDisplayName": { "type": "string", "description": "Display name of the interface." }, "IfName": { "type": "string", "description": "Interface name." }, "IfDesc": { "type": "string", "description": "Interface description." }, "IfAlias": { "type": "string", "description": "Interface alias." }, "IfIndex": { "type": "string", "description": "Interface index." }, "CircuitID": { "type": "string", "description": "Circuit ID of the interface." }, "InSpeed": { "type": "string", "description": "Receive speed of the interface." }, "OutSpeed": { "type": "string", "description": "Transmit speed of the interface." }, "name": { "type": "string", "description": "Name of the parent device." }, "deviceName": { "type": "string", "description": "Internal name of the device." }, "repType": { "type": "integer", "description": "Report type identifier." }, "suffix": { "type": "string", "description": "Unit suffix applied to the chart values." }, "seriesNames": { "type": "array", "description": "Names of the series present in the chart data.", "items": { "type": "string" } }, "consolidatedValues": { "type": "array", "description": "Consolidated values for each traffic series.", "items": { "type": "object", "description": "Consolidated min/max/avg and 95th percentile values for a series.", "additionalProperties": true, "properties": { "seriesName": { "type": "string", "description": "Name of the data series." }, "currVal": { "type": "string", "description": "Current value of the series." }, "minVal": { "type": "string", "description": "Minimum value of the series." }, "maxVal": { "type": "string", "description": "Maximum value of the series." }, "avgVal": { "type": "string", "description": "Average value of the series." }, "exactMinVal": { "type": "number", "description": "Exact minimum value of the series." }, "exactMaxVal": { "type": "number", "description": "Exact maximum value of the series." }, "minCollectionTime": { "type": "string", "description": "Collection time of the minimum value in milliseconds." }, "maxCollectionTime": { "type": "string", "description": "Collection time of the maximum value in milliseconds." }, "95thperc": { "type": "string", "description": "95th percentile value of the series." }, "95thpercVal": { "type": "string", "description": "Raw 95th percentile value of the series." }, "95thpercRawVal": { "type": "string", "description": "Unformatted 95th percentile value of the series." }, "95thpercentileValue": { "type": "string", "description": "Formatted 95th percentile value of the series." }, "legendType": { "type": "string", "description": "Legend type of the series." } } } }, "bwChartData": { "type": "array", "description": "Bandwidth chart data series.", "items": { "allOf": [ { "type": "object", "description": "A single graph data series.", "additionalProperties": true, "properties": { "seriesname": { "type": "string", "description": "Name of the data series." }, "data": { "type": "array", "description": "Data points for the series. Each entry is a tuple of collection time in milliseconds, the numeric value, and the formatted display value.", "items": { "type": "array", "items": {} } }, "xyTitles": { "type": "array", "description": "Titles for the X and Y axes.", "items": { "type": "string" } }, "yaxiscolumnorder": { "type": "array", "description": "Column order for the Y axis.", "items": { "type": "integer" } }, "suffix": { "type": "string", "description": "Unit suffix applied to the series values." } } }, { "type": "object", "properties": { "isRaw": { "type": "boolean", "description": "Indicates whether the series holds raw collected data." } } } ] } }, "availData": { "type": "object", "description": "Availability distribution as a percentage per state.", "additionalProperties": true, "properties": { "Up": { "type": "number", "description": "Percentage of time the interface was up." }, "Down": { "type": "number", "description": "Percentage of time the interface was down." }, "Dependent Unavailable": { "type": "number", "description": "Percentage of time the interface was dependent unavailable." }, "Not Monitored": { "type": "number", "description": "Percentage of time the interface was not monitored." }, "On Hold": { "type": "number", "description": "Percentage of time the interface was on hold." }, "On Maintenance": { "type": "number", "description": "Percentage of time the interface was on maintenance." }, "Parent Down": { "type": "number", "description": "Percentage of time the parent device was down." } } }, "interfaceDetails": { "type": "object", "description": "Identification details of the interface.", "additionalProperties": true, "properties": { "Parent Name": { "type": "string", "description": "Name of the parent device." }, "IfDescr": { "type": "string", "description": "Interface description." }, "IfAlias": { "type": "string", "description": "Interface alias." }, "IfIndex": { "type": "string", "description": "Interface index." }, "IfName": { "type": "string", "description": "Interface name." }, "Circuit ID": { "type": "string", "description": "Circuit ID of the interface." }, "Receive Bandwidth": { "type": "string", "description": "Receive bandwidth of the interface." }, "Transmit Bandwidth": { "type": "string", "description": "Transmit bandwidth of the interface." } } } } }, "GetInterfaceGraphsResponse": { "type": "object", "description": "Response wrapper for the getInterfaceGraphs API.", "additionalProperties": true, "properties": { "displayName": { "type": "string", "description": "Display name of the graph." }, "interfaceDetails": { "type": "object", "description": "Identification details of the interface.", "additionalProperties": true, "properties": { "Parent Name": { "type": "string", "description": "Name of the parent device." }, "IfDescr": { "type": "string", "description": "Interface description." }, "IfAlias": { "type": "string", "description": "Interface alias." }, "IfIndex": { "type": "string", "description": "Interface index." }, "IfName": { "type": "string", "description": "Interface name." }, "Circuit ID": { "type": "string", "description": "Circuit ID of the interface." }, "Receive Bandwidth": { "type": "string", "description": "Receive bandwidth of the interface." }, "Transmit Bandwidth": { "type": "string", "description": "Transmit bandwidth of the interface." } } }, "consolidatedValues": { "type": "object", "description": "Consolidated values keyed by series name.", "additionalProperties": { "type": "object", "description": "Consolidated min/max/avg and 95th percentile values for a series.", "additionalProperties": true, "properties": { "seriesName": { "type": "string", "description": "Name of the data series." }, "currVal": { "type": "string", "description": "Current value of the series." }, "minVal": { "type": "string", "description": "Minimum value of the series." }, "maxVal": { "type": "string", "description": "Maximum value of the series." }, "avgVal": { "type": "string", "description": "Average value of the series." }, "exactMinVal": { "type": "number", "description": "Exact minimum value of the series." }, "exactMaxVal": { "type": "number", "description": "Exact maximum value of the series." }, "minCollectionTime": { "type": "string", "description": "Collection time of the minimum value in milliseconds." }, "maxCollectionTime": { "type": "string", "description": "Collection time of the maximum value in milliseconds." }, "95thperc": { "type": "string", "description": "95th percentile value of the series." }, "95thpercVal": { "type": "string", "description": "Raw 95th percentile value of the series." }, "95thpercRawVal": { "type": "string", "description": "Unformatted 95th percentile value of the series." }, "95thpercentileValue": { "type": "string", "description": "Formatted 95th percentile value of the series." }, "legendType": { "type": "string", "description": "Legend type of the series." } } } }, "seriesNames": { "type": "array", "description": "Names of the series present in the graph data.", "items": { "type": "string" } }, "xyTitles": { "type": "array", "description": "Titles for the X and Y axes.", "items": { "type": "string" } }, "showGraphFilters": { "type": "boolean", "description": "Indicates whether graph filters are applicable." }, "graphData": { "type": "array", "description": "Graph data series.", "items": { "type": "object", "description": "A single graph data series.", "additionalProperties": true, "properties": { "seriesname": { "type": "string", "description": "Name of the data series." }, "data": { "type": "array", "description": "Data points for the series. Each entry is a tuple of collection time in milliseconds, the numeric value, and the formatted display value.", "items": { "type": "array", "items": {} } }, "xyTitles": { "type": "array", "description": "Titles for the X and Y axes.", "items": { "type": "string" } }, "yaxiscolumnorder": { "type": "array", "description": "Column order for the Y axis.", "items": { "type": "integer" } }, "suffix": { "type": "string", "description": "Unit suffix applied to the series values." } } } }, "suffix": { "type": "string", "description": "Unit suffix applied to the graph values." } } }, "PerformanceMonitorCatalogItem": { "type": "object", "description": "Definition of an available performance monitor.", "properties": { "DISPLAYNAME": { "type": "string", "description": "Display name of the performance monitor." }, "Description": { "type": "string", "description": "Description of what the monitor measures." }, "showAddPartitionOption": { "type": "string", "description": "Indicates whether the monitor supports adding partitions." }, "isNumeric": { "type": "string", "description": "Indicates whether the monitor collects a numeric value." }, "GRAPHID": { "type": "integer", "description": "Internal id of the performance monitor." }, "name": { "type": "string", "description": "Internal name of the performance monitor." }, "isSelected": { "type": "string", "description": "Indicates whether the monitor is already associated with the device." }, "interval": { "type": "string", "description": "Polling interval of the monitor in seconds." }, "oid": { "type": "string", "description": "OID or counter expression used to collect the monitor value." }, "Protocol": { "type": "string", "description": "Protocol used to collect the monitor value." }, "thresholdEnabled": { "type": "string", "description": "Indicates whether threshold is enabled for the monitor." }, "STANDARDNAME": { "type": "string", "description": "Name of the standard monitor group the monitor belongs to." }, "isCustomGraph": { "type": "string", "description": "Indicates whether the monitor is a custom graph." } } }, "PerformanceMonitorsResponse": { "type": "object", "description": "Available performance monitors grouped by monitor category name.", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/PerformanceMonitorCatalogItem" } } }, "MonitorThresholdSetItem": { "type": "object", "description": "Threshold configuration entry of a performance monitor.", "additionalProperties": true }, "PerformanceMonitorStatsItem": { "type": "object", "description": "Statistical summary of a monitor instance.", "properties": { "minimumValue": { "type": "string", "description": "Minimum collected value." }, "averageValue": { "type": "string", "description": "Average collected value." }, "instance": { "type": "string", "description": "Name of the monitor instance." }, "percentile": { "type": "string", "description": "Percentile value of the collected data." }, "lastPolledValue": { "type": "string", "description": "Value collected in the last poll." }, "maximumValue": { "type": "string", "description": "Maximum collected value." } } }, "PerformanceMonitorDetailsResponse": { "type": "object", "description": "Detailed information about a performance monitor of a device.", "properties": { "statsList": { "type": "array", "description": "Statistical summary of the monitor.", "items": { "$ref": "#/components/schemas/PerformanceMonitorStatsItem" } }, "monitors": { "type": "object", "description": "Properties and threshold configuration of the monitor.", "properties": { "YAXISTEXT": { "type": "string", "description": "Unit displayed on the Y axis of the monitor graph." }, "checkNumeric": { "type": "string", "description": "Indicates whether the monitor returns a numeric value." }, "Description": { "type": "string", "description": "Description of the monitor." }, "Instance": { "type": "string", "description": "Name of the monitor instance." }, "THRESHOLDENABLED": { "type": "string", "description": "Indicates whether threshold is enabled for the monitor." }, "GRAPHID": { "type": "string", "description": "Internal id of the performance monitor." }, "oid": { "type": "string", "description": "OID or counter used to collect the monitor value." }, "type": { "type": "string", "description": "Type of the monitor." }, "PREVIOUSSEVERITY": { "type": "string", "description": "Severity recorded in the previous poll." }, "defaultMessage_AT": { "type": "string", "description": "Default adaptive threshold alarm message." }, "defaultMessage": { "type": "string", "description": "Default threshold alarm message." }, "id": { "type": "string", "description": "Internal id of the monitor." }, "Protocol": { "type": "string", "description": "Protocol used to collect the monitor value." }, "FAILURETHRESHOLD": { "type": "string", "description": "Number of consecutive failures before an alarm is raised." }, "DISPLAYNAME": { "type": "string", "description": "Display name of the monitor." }, "thresholdSet": { "type": "array", "description": "Threshold configuration of the monitor.", "items": { "$ref": "#/components/schemas/MonitorThresholdSetItem" } }, "graphType": { "type": "string", "description": "Graph type of the monitor." }, "policyName": { "type": "string", "description": "Internal name of the monitor." }, "agentName": { "type": "string", "description": "Name of the agent collecting the monitor value." }, "isMultiple": { "type": "string", "description": "Indicates whether the monitor collects multiple values." }, "sSave": { "type": "string", "description": "Indicates whether the collected data is saved." }, "defaultClrMessage": { "type": "string", "description": "Default clear message of the monitor." }, "DisplayColumn": { "type": "string", "description": "Display column of the monitor." }, "name": { "type": "string", "description": "Internal name of the monitor." }, "numericType": { "type": "string", "description": "Numeric type of the monitor." }, "interval": { "type": "string", "description": "Polling interval of the monitor in seconds." }, "Id": { "type": "string", "description": "Internal id of the monitor." }, "isAtEnabled": { "type": "boolean", "description": "Indicates whether adaptive threshold is enabled." } } } } }, "TestMonitorResponse": { "type": "object", "description": "Data collected directly from the device for the specified monitor.", "properties": { "protocol": { "type": "string", "description": "Protocol used to collect the data." }, "checkNumeric": { "type": "string", "description": "Indicates whether the monitor returns a numeric value." }, "reasons": { "type": "array", "description": "Reasons for the failure, if the collection failed.", "items": { "type": "string" } }, "monitorname": { "type": "string", "description": "Internal name of the monitor." }, "data": { "type": "array", "description": "Values collected from the device.", "items": {} }, "displayName": { "type": "string", "description": "Display name of the monitor." }, "isMultiple": { "type": "string", "description": "Indicates whether the monitor collects multiple values." }, "oid": { "type": "string", "description": "OID or counter used to collect the monitor value." }, "units": { "type": "string", "description": "Unit of the collected value." }, "deviceName": { "type": "string", "description": "Internal name of the device." } } }, "ProcessMonitorTemplate": { "type": "object", "description": "Process monitor template available in OpManager.", "properties": { "protocol": { "type": "string", "description": "Protocol associated with the process template." }, "associatedDeviceCount": { "type": "string", "description": "Number of devices associated with the template." }, "templateName": { "type": "string", "description": "Internal name of the process template." }, "displayName": { "type": "string", "description": "Display name of the process template." }, "description": { "type": "string", "description": "Description of the process template." }, "templateId": { "type": "string", "description": "Internal id of the process template." } } }, "ProcessMonitorAssignedItem": { "type": "object", "description": "Process monitor associated with the device.", "properties": { "path": { "type": "string", "description": "Executable path of the monitored process." }, "statusStr": { "type": "string", "description": "Status of the process monitor as a string." }, "cmdLineArgs": { "type": "string", "description": "Command line arguments of the monitored process." }, "statusIcon": { "type": "string", "description": "Path of the status icon of the process monitor." }, "name": { "type": "string", "description": "Display name of the process monitor." }, "state": { "type": "string", "description": "State of the process monitor." }, "id": { "type": "string", "description": "Internal id of the process monitor." }, "proName": { "type": "string", "description": "Name of the monitored process." }, "trimName": { "type": "string", "description": "Trimmed display name of the process monitor." }, "status": { "type": "string", "description": "Status of the process monitor." }, "statusNum": { "type": "string", "description": "Numeric status of the process monitor." } } }, "ProcessMonitorActiveProcess": { "type": "object", "description": "Process currently running on the monitored machine.", "properties": { "path": { "type": "string", "description": "Executable path of the process." }, "trimArgs": { "type": "string", "description": "Trimmed command line arguments of the process." }, "trimPath": { "type": "string", "description": "Trimmed executable path of the process." }, "cmdLineArgs": { "type": "string", "description": "Command line arguments of the process." }, "name": { "type": "string", "description": "Name of the process." }, "trimName": { "type": "string", "description": "Trimmed name of the process." } } }, "AssociatedProcessMonitorsResponse": { "type": "object", "description": "Process monitor templates, associated process monitors, and active processes of the device.", "properties": { "protocol": { "type": "string", "description": "Monitoring protocol associated with the device." }, "Templates": { "type": "array", "description": "Process monitor templates available in OpManager.", "items": { "$ref": "#/components/schemas/ProcessMonitorTemplate" } }, "AssignedMonitors": { "type": "array", "description": "Process monitors associated with the device.", "items": { "$ref": "#/components/schemas/ProcessMonitorAssignedItem" } }, "ActiveProcesses": { "type": "object", "description": "Processes currently running on the monitored machine, keyed by process id.", "additionalProperties": { "$ref": "#/components/schemas/ProcessMonitorActiveProcess" } }, "deviceName": { "type": "string", "description": "Internal name of the device." } } }, "AssociatedServiceMonitorsResponse": { "type": "object", "description": "Service monitors associated with the device and those available for association.", "properties": { "remainingServices": { "type": "array", "description": "Service monitors available for association with the device.", "items": { "type": "string" } }, "selectedServices": { "type": "array", "description": "Service monitors currently associated with the device.", "items": { "type": "string" } } } }, "URLMonitorListItem": { "type": "object", "description": "Globally defined URL monitor.", "properties": { "availPercentage": { "type": "number", "description": "Availability percentage of the URL monitor." }, "urlName": { "type": "string", "description": "Display name of the URL monitor." }, "statusStr": { "type": "string", "description": "Status of the URL monitor as a string." }, "name": { "type": "string", "description": "Internal name of the URL monitor." }, "RESPONSETIME": { "type": "string", "description": "Response time of the URL monitor." }, "url": { "type": "string", "description": "URL being monitored." }, "moID": { "type": "integer", "description": "Internal id of the URL monitor." }, "statusNum": { "type": "integer", "description": "Numeric status of the URL monitor." } } }, "URLMonitorsResponse": { "type": "object", "description": "Globally defined URL monitors along with availability distribution details.", "properties": { "List": { "type": "array", "description": "URL monitors configured in OpManager.", "items": { "$ref": "#/components/schemas/URLMonitorListItem" } }, "Details": { "type": "object", "description": "Count of URL monitors grouped by availability percentage range.", "additionalProperties": true }, "DialCounter": { "type": "array", "description": "Count of URL monitors grouped by status.", "items": { "type": "object", "additionalProperties": true } } } }, "DeviceSpecificURLListItem": { "type": "object", "description": "URL monitor associated with an individual device.", "properties": { "parentName": { "type": "string", "description": "Internal name of the device the URL monitor is associated with." }, "urlName": { "type": "string", "description": "Display name of the URL monitor." }, "stringstatus": { "type": "string", "description": "Status of the URL monitor as a string." }, "parentDispName": { "type": "string", "description": "Display name of the device the URL monitor is associated with." }, "name": { "type": "string", "description": "Internal name of the URL monitor." }, "url": { "type": "string", "description": "URL being monitored." }, "status": { "type": "string", "description": "Status of the URL monitor." }, "statusNum": { "type": "string", "description": "Numeric status of the URL monitor." } } }, "DeviceSpecificURLsResponse": { "type": "object", "description": "URL monitors associated with individual devices.", "properties": { "List": { "type": "array", "description": "Device specific URL monitors.", "items": { "$ref": "#/components/schemas/DeviceSpecificURLListItem" } } } }, "ScriptMonitorListItem": { "type": "object", "description": "Script template created in OpManager.", "properties": { "graphName": { "type": "string", "description": "Name of the script monitor." }, "scriptID": { "type": "string", "description": "Internal id of the script." }, "executeFrom": { "type": "string", "description": "Indicates the machine from which the script is executed." }, "graphDesc": { "type": "string", "description": "Description of the script monitor." }, "graphID": { "type": "string", "description": "Internal id of the script monitor graph." } } }, "MonitorResultMessageResponse": { "type": "object", "description": "Result of the requested monitor operation.", "properties": { "result": { "type": "object", "properties": { "message": { "type": "string", "description": "Message describing the result of the operation." } } } } }, "NetworkPathAvailabilityResponse": { "type": "object", "description": "Availability data for the network path monitor. The start and end time are displayed in milliseconds, for both UP and Down states.", "properties": { "availability": { "type": "array", "description": "Availability entries. Each entry is a comma-separated string of state label, start time in milliseconds, end time in milliseconds and state.", "items": { "type": "string" } } } }, "LatencyPacketLossGraphResponse": { "type": "object", "description": "Latency or packet loss graph data for the network path monitor. The data collection time is displayed in milliseconds.", "properties": { "data": { "type": "object", "properties": { "chartData": { "type": "array", "description": "Graph data series grouped by severity.", "items": { "type": "object", "description": "A single graph data series.", "properties": { "seriesname": { "type": "string", "description": "Name of the data series." }, "data": { "type": "array", "description": "Data points for the series. Each entry is a tuple of the data collection time in milliseconds and the numeric value.", "items": { "type": "array", "items": {} } } } } }, "xyTitles": { "type": "array", "description": "Titles for the X and Y axes.", "items": { "type": "string" } } } }, "displayName": { "type": "string", "description": "Display name of the graph." } } }, "NotificationProfileListResponse": { "type": "array", "description": "List of all the Notification Profiles.", "items": { "$ref": "#/components/schemas/NotificationProfileListItem" } }, "NotificationProfileListItem": { "type": "object", "description": "A notification profile.", "properties": { "profileName": { "type": "string", "description": "Name of the notification profile." }, "actionDisplayName": { "type": "string", "description": "Display name of the action performed by the notification profile." }, "associationTypeDisplayName": { "type": "string", "description": "Display name of the association type of the notification profile." }, "profileLabel": { "type": "string", "description": "Label of the notification profile." }, "criteriaId": { "type": "string", "description": "ID of the criteria associated with the notification profile." }, "profileId": { "type": "string", "description": "ID of the notification profile." }, "associationType": { "type": "string", "description": "Association type of the notification profile." }, "isGlobal": { "type": "boolean", "description": "Indicates whether the notification profile is a global profile." }, "status": { "type": "string", "description": "Indicates whether the notification profile is enabled." }, "actionName": { "type": "string", "description": "Name of the action performed by the notification profile." } } }, "DeviceNotificationProfileListResponse": { "type": "array", "description": "List of notification profiles specific to the device.", "items": { "$ref": "#/components/schemas/DeviceNotificationProfileListItem" } }, "DeviceNotificationProfileListItem": { "type": "object", "description": "A notification profile associated with the device or group.", "properties": { "profileName": { "type": "string", "description": "Name of the notification profile." }, "actionDisplayName": { "type": "string", "description": "Display name of the action performed by the notification profile." }, "profileLabel": { "type": "string", "description": "Label of the notification profile." }, "criteriaId": { "type": "string", "description": "ID of the criteria associated with the notification profile." }, "profileId": { "type": "string", "description": "ID of the notification profile." }, "isGlobal": { "type": "boolean", "description": "Indicates whether the notification profile is a global profile." }, "status": { "type": "string", "description": "Indicates whether the notification profile is enabled." }, "actionName": { "type": "string", "description": "Name of the action performed by the notification profile." } } }, "AssociateNotificationProfilesResponse": { "type": "object", "description": "Result of the notification profile association.", "properties": { "result": { "type": "object", "description": "Result of the notification profile association.", "properties": { "message": { "type": "string", "description": "Status message of the notification profile association." } } } } }, "UpdateNotificationProfileStatusResponse": { "type": "object", "description": "Result of the notification profile status update.", "properties": { "message": { "type": "string", "description": "Status message of the notification profile status update." } } }, "SSIDClientEntry": { "type": "object", "properties": { "displayName": { "type": "string", "description": "Name of the SSID." }, "ClientCount": { "type": "string", "description": "Number of clients associated with this SSID." } } }, "SSIDClientListResponse": { "type": "object", "properties": { "clientData": { "type": "array", "items": { "$ref": "#/components/schemas/SSIDClientEntry" }, "description": "List of SSIDs with their associated client count." }, "clientCount": { "type": "integer", "description": "Total number of clients across all SSIDs of the WLC device." } } }, "WirelessClientDetail": { "type": "object", "properties": { "ClientCount": { "type": "string", "description": "Number of client devices connected through this access point." }, "TotalBytes": { "type": "string", "description": "Network usage formatted as a speed string with \"Bps\" suffix." }, "APMOName": { "type": "string", "description": "Internal managed object name of the access point." }, "apName": { "type": "string", "description": "Name of the access point." }, "advanceMonitoringEnabled": { "type": "string", "description": "Whether advance monitoring is enabled for this AP (\"true\" or \"false\")." } } }, "WorkflowListEntry": { "type": "object", "description": "", "properties": { "reportID": { "type": "integer", "description": "" }, "name": { "type": "string", "description": "" }, "description": { "type": "string", "description": "" }, "triggerdesc": { "type": "string", "description": "" }, "workflowType": { "type": "integer", "description": "" }, "triggerType": { "type": "integer", "description": "" }, "rbID": { "type": "integer", "description": "" } } }, "DeviceWorkflowEntry": { "type": "object", "description": "", "properties": { "reportID": { "type": "integer", "description": "" }, "wfID": { "type": "integer", "description": "" }, "wfName": { "type": "string", "description": "" }, "wfDesc": { "type": "string", "description": "" }, "triggerType": { "type": "integer", "description": "" }, "triggerDesc": { "type": "string", "description": "" } } }, "DeviceWorkflowListResponse": { "type": "object", "description": "", "properties": { "workflows": { "type": "array", "description": "", "items": { "$ref": "#/components/schemas/DeviceWorkflowEntry" } } } }, "WorkflowTriggerResponse": { "type": "object", "description": "", "properties": { "message": { "type": "string", "description": "" } } }, "WorkflowAlarmTriggerResult": { "type": "object", "description": "", "properties": { "result": { "type": "object", "description": "", "properties": { "message": { "type": "string", "description": "" } } } } } }, "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 “Yes” 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 } } } }