openapi: 3.2.0 info: license: name: Apache 2.0 url: http://www.apache.org/licenses/LICENSE-2.0.html description: LogicMonitor is a SaaS-based performance monitoring platform that provides full visibility into complex, hybrid infrastructures, offering granular performance monitoring and actionable data and insights. title: LogicMonitor REST Diagnostic Sources API version: 3.0.0 servers: - url: /santaba/rest tags: - name: DiagnosticSources paths: /setting/diagnosticsources/executemanually: post: summary: Trigger a diagnostic module for host security: - LMv1: [] x-minimum-permissions: Host -> Diagnostic Source: NA description: Trigger a diagnostic module for host. Set includeOutput=true to wait for completion and return script output. operationId: executeDiagnosticsManually responses: '200': description: Trigger a diagnostic module for host content: application/json: schema: $ref: '#/components/schemas/DiagnosticsSourceExecution' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' tags: - DiagnosticSources requestBody: content: application/json: schema: $ref: '#/components/schemas/DiagnosticsSourceExecution' /setting/diagnosticsources: post: summary: Add diagnostics source security: - LMv1: [] x-minimum-permissions: Modules -> All Installed Module: Manage Modules -> Access Group: Manage description: Adds a new diagnostics source operationId: addDiagnosticSource responses: '200': description: Successfully added new diagnostics source content: application/json: schema: $ref: '#/components/schemas/DiagnosticsSource' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' tags: - DiagnosticSources requestBody: content: application/json: schema: $ref: '#/components/schemas/DiagnosticsSource' get: summary: Get diagnostics sources list security: - LMv1: [] x-minimum-permissions: Modules -> All Installed Module: View Modules -> Access Group: View description: Retrieves a list of diagnostics sources operationId: getDiagnosticSourcesList responses: '200': description: Successfully retrieved diagnostics sources list content: application/json: schema: $ref: '#/components/schemas/DiagnosticsourcePaginationResponse' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' tags: - DiagnosticSources /setting/diagnosticsources/{id}: patch: summary: Update a diagnostics source security: - LMv1: [] x-minimum-permissions: Modules -> All Installed Module: Manage Modules -> Access Group: Manage description: Updates a diagnostics source by its ID operationId: patchDiagnosticSourceById responses: '200': description: Successfully updated diagnostics source content: application/json: schema: $ref: '#/components/schemas/DiagnosticsSource' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' parameters: - in: path name: id required: true schema: type: integer format: int32 - in: query name: reason schema: type: string tags: - DiagnosticSources requestBody: content: application/json: schema: $ref: '#/components/schemas/DiagnosticsSource' get: summary: Get diagnostics sources by ID security: - LMv1: [] x-minimum-permissions: Modules -> All Installed Module: View Modules -> Access Group: View description: Retrieves a diagnostics source by its ID operationId: getDiagnosticSourcesById responses: '200': description: Successfully retrieved diagnostics source by ID content: application/json: schema: $ref: '#/components/schemas/DiagnosticsSource' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' parameters: - in: path name: id required: true schema: type: integer format: int32 - in: query name: format schema: type: string tags: - DiagnosticSources delete: summary: Delete a diagnostic source module security: - LMv1: [] x-minimum-permissions: Modules -> All Installed Module: Manage Modules -> Access Group: Manage description: Deletes a diagnostic source module by its ID operationId: deleteDiagnosticSourceById responses: '200': description: Successfully deleted diagnostic source module content: application/json: schema: type: object default: description: Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' parameters: - in: path name: id required: true schema: type: integer format: int32 tags: - DiagnosticSources put: summary: Update a diagnostics source security: - LMv1: [] x-minimum-permissions: Modules -> All Installed Module: Manage Modules -> Access Group: Manage description: Updates a diagnostics source by its ID operationId: updateDiagnosticSourceById responses: '200': description: Successfully updated diagnostics source content: application/json: schema: $ref: '#/components/schemas/DiagnosticsSource' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' parameters: - in: path name: id required: true schema: type: integer format: int32 - in: query name: reason schema: type: string tags: - DiagnosticSources requestBody: content: application/json: schema: $ref: '#/components/schemas/DiagnosticsSource' /setting/diagnosticsources/importjson: post: summary: Import DiagnosticSource via json security: - LMv1: [] x-minimum-permissions: Modules -> Default Access Group: Manage Modules -> All Installed modules: Manage description: Import a DiagnosticSource using json data operationId: importDiagnosticSourceJson responses: '200': description: Successfully imported the DiagnosticSource via Json content: application/json: schema: $ref: '#/components/schemas/RestDiagnosticSourceV4' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' parameters: - in: query name: handleConflict schema: type: string - in: query name: fieldsToPreserve style: form explode: true schema: type: array items: type: string tags: - DiagnosticSources requestBody: content: multipart/form-data: schema: type: object properties: file: type: string description: LogicModule JSON file format: binary required: - file components: schemas: AccessGroup: description: Module's access groups type: object required: - name properties: createdBy: description: User who created access group readOnly: true type: string name: description: The name of the access group type: string example: LinuxGroup tenantId: description: Tenancy details type: string description: description: Description about access group type: string id: format: int32 description: The id of the access group readOnly: true type: integer updatedOn: format: int64 description: Time when access group updated readOnly: true type: integer createdOn: format: int64 description: Time when access group created readOnly: true type: integer DiagnosticsSourceExecution: description: Represents a diagnostic execution for a host in the LogicMonitor system. type: object required: - diagnosticId - executionStatus - hostDiagnosticSourceId - hostId - triggerType properties: output: description: Script output when includeOutput is true and execution has completed readOnly: true type: string executionId: description: 'execution Id ' readOnly: true type: string diagnosticId: format: int32 description: The diagnostic module id type: integer example: 12345 executionStatus: description: The diagnostic module id readOnly: true type: string example: '60' hostId: format: int32 description: The host id type: integer example: 12345 alertId: description: The alert id type: string example: alert12345 triggerType: description: type of trigger readOnly: true type: string example: scheduled hostDiagnosticSourceId: format: int32 description: The diagnostic module id type: integer example: 12345 includeOutput: description: When true, the API waits for execution to finish and returns script output in the response type: boolean example: false AutoDiscoveryMethod: description: Method used to do auto discovery instance type: object required: - name properties: name: description: "The auto discovery method name. \nThe values can be ad_cim|ad_cloudwatch|ad_collector|ad_dummy|ad_ec2|ad_esx|ad_http|ad_ipmi|ad_jdbc|ad_jmx|ad_netapp|ad_pdh|ad_port|ad_script|ad_snmp|ad_wmi|ad_xen|ad_azurerediscache|ad_awsserviceregion|ad_awsec2reservedinstance|ad_awsecsservice|ad_awsec2scheduledevents|ad_azureserviceregion|ad_azuresubscription|ad_azurebackupjob|ad_azuresdk|ad_azurewebjob|ad_awsbillingreport|ad_awselasticache|ad_awsredshift|ad_azurebilling|ad_awslbtargetgroups|ad_gcpappengine|ad_gcpbilling|ad_awsvpntunnel|ad_gcpvpntunnel|ad_awsglobalwebacl|ad_gcplbbackendservice|ad_gcppubsubsubscription|ad_gcppubsubsnapshot|ad_gcpcloudrouternatgateway|ad_azurereplicationjob|ad_azureexpressroutecircuitpeering|ad_awsapigatewaystage|ad_azureautomationaccountcertificate|ad_azurevngconnection|ad_azurewebappinstance|ad_azureappserviceenvironmentmultirolepool|ad_openmetrics|ad_awsmediaconnectoutput|ad_awsmediaconnectsource|ad_awswebaclwafv2|ad_saaso365sharepointsite|ad_awscognitoidentityproviders|ad_saaszoomplanusage|ad_saasstatus|ad_azuresynapse|ad_saasairbrake|ad_syntheticsselenium|ad_azurevirtualdesktopsessionhosts|ad_saaso365subscribedsku|ad_azuredimension|ad_azurecostmanagementdimensions|ad_saaso365servicehealth|ad_saaso365mailbox|ad_azurenetappvolumes|ad_azureloganalyticsworkspaces|ad_saaszoomstatus|ad_saassalesforcelicense|ad_saaszoomroom|ad_saaswebexlicenseusage|ad_azureloganalyticsreplicationjob|ad_paasjsonpath|ad_awsrabbitmqqueue|ad_awssagemakerendpointvariant|ad_awsroute53resolveripaddress|ad_saasopenaiusagecost|ad_saasopenaiusagecompletion|ad_saasopenaiusageimage|ad_awsamprulegroups|ad_awsampanomalydetectors" type: string discriminator: propertyName: name IntegrationMetadata: description: The local module's IntegrationMetadata, readable for troubleshooting purposes readOnly: true type: object properties: targetLastPublishedId: description: Specifies the target last published Id readOnly: true type: string targetLastPublishedChecksum: description: The metadata checksum for the target last published LMModule content readOnly: true type: string targetLastPublishedVersion: description: Specifies the target last published version readOnly: true type: string originChecksum: description: The metadata checksum for the LMModule content readOnly: true type: string originAuthorNamespace: description: Specifies the origin Author companies namespace readOnly: true type: string originLocator: description: Specifies the origin version locator readOnly: true type: string isChangedFromOrigin: description: Specifies if the Applies To function is changed from origin or not readOnly: true type: boolean auditedRegistryId: description: Specifies the audited registry Id readOnly: true type: string targetLineageId: description: Specifies the target lineage Id readOnly: true type: string logicModuleType: description: 'The values can be DataSources | EventSources | PropertySources | ConfigSources | LogSources | TopologySources | Jobmonitors | AppliesTo Functions | SNMP SysOID Maps The type of LogicModule' readOnly: true type: string enum: - DATASOURCE - EVENTSOURCE - CONFIGSOURCE - PROPERTYSOURCE - DIAGNOSTICSOURCE - REMEDIATIONSOURCE - TOPOLOGYSOURCE - JOBMONITOR - APPLIESTO_FUNCTION - SNMP_SYSOID_MAP - LOGSOURCE isChangedFromTargetLastPublished: description: Specifies if the Applies To function is changed from target last published or not readOnly: true type: boolean originLineageId: description: The origin lineage Id of the LMmodule readOnly: true type: string originAuthorCompanyUUID: description: Specifies the origin Author companies unique Id readOnly: true type: string localModuleId: format: int32 description: The LocalModule Id readOnly: true type: integer originRegistryId: description: The Registry ID of the Exchange Integration this module is based from readOnly: true type: string originVersion: description: Specifies the origin version readOnly: true type: string auditedVersion: description: Specifies the audited registry version readOnly: true type: string originName: description: Specifies the origin module name readOnly: true type: string DataSource: type: object required: - collectInterval - collectMethod - collectorAttribute - name properties: eriDiscoveryConfig: description: Enable ERI Discovery or not readOnly: false $ref: '#/components/schemas/ScriptERIDiscoveryAttributeV3' accessGroups: description: Module's access groups type: array items: $ref: '#/components/schemas/AccessGroup' displayName: description: The data source display name type: string description: description: The description for the LMModule type: string appliesTo: description: The Applies To for the LMModule type: string lineageId: description: The lineageId the LMModule belongs to readOnly: true type: string collectMethod: description: The method to collect data. The values can be snmp|ping|exs|webpage|wmi|cim|datadump|dns|ipmi|jdbb|script|udp|tcp|xen type: string originRegistryId: description: The Registry ID of the Exchange Integration this module is based from, including this field will set this as the module's import base and mark the ID's version as audited type: string checksum: description: The metadata checksum for the LMModule content readOnly: true type: string dataPoints: description: The data point list type: array items: $ref: '#/components/schemas/DataPoint' id: format: int32 description: The ID of the LMModule readOnly: true type: integer accessGroupIds: uniqueItems: true description: The Access Groups Id's type: array items: format: int32 description: The Access Groups Id's type: integer example: 1, 2, 3 group: description: The group the LMModule is in type: string collectorAttribute: description: "Data collector's attributes to collector data. e.g. a ping data source has a ping collector attribute. \n PingCollectorAttributeV1 has two fields. the ip to ping, the data size send to ping" readOnly: false $ref: '#/components/schemas/CollectorAttribute' autoDiscoveryConfig: description: Auto discovery configuration readOnly: false $ref: '#/components/schemas/AutoDiscoveryConfiguration' adParameters: $ref: '#/components/schemas/DataSource' payloadVersion: format: int32 description: The DataSource payload version for custom metrics readOnly: true type: integer useWildValueAsUUID: description: 'Use wild-value as unique identifier in case of multi instance datasource: true|false' readOnly: true type: boolean enableAutoDiscovery: description: 'Enable Auto Discovery or not when this data source has multi instance: false|true' type: boolean technology: description: The Technical Notes for the LMModule type: string version: format: int64 description: The data source version readOnly: true type: integer tags: description: The Tags for the LMModule type: string auditVersion: format: int64 description: The data source audit version readOnly: true type: integer hasMultiInstances: description: 'If the DataSource has multi instance: true|false' readOnly: true type: boolean installationMetadata: description: The local module's IntegrationMetadata, readable for troubleshooting purposes readOnly: true $ref: '#/components/schemas/IntegrationMetadata' eriDiscoveryInterval: format: int32 description: The DataSource data collect interval type: integer enableEriDiscovery: description: 'Enable ERI Discovery or not: false|true' type: boolean collectInterval: format: int32 description: The DataSource data collect interval type: integer name: description: The data source name type: string isInUse: description: Whether the LM module is currently in use readOnly: true type: boolean LogicModuleAssociationCounts: type: object properties: inUse: type: boolean CollectorAttribute: type: object required: - name properties: name: description: The data collector's name type: string discriminator: propertyName: name AutoDiscoveryConfiguration: description: Auto discovery configuration type: object required: - method properties: persistentInstance: description: Persist discovered instance type: boolean scheduleInterval: format: int32 description: Auto discovery schedule interval in minutes. 0 means host or data source changed. The values can be 0|15|60|1440 type: integer deleteInactiveInstance: description: Delete inactive instance type: boolean method: $ref: '#/components/schemas/AutoDiscoveryMethod' instanceAutoGroupMethod: description: Auto group method. The values can be none|netscaler|netscalerservicegroup|regex|esx|ilp type: string instanceAutoGroupMethodParams: description: Auto group method's parameters type: string filters: type: array items: $ref: '#/components/schemas/AutoDiscoveryFilter' disableInstance: description: Disable discovered instance type: boolean showDeletedInstanceDays: format: int32 description: show deleted instance days type: integer DiagnosticsSource: type: object properties: accessGroups: description: Access group Details in response type: array items: $ref: '#/components/schemas/AccessGroup' groovyScript: description: groovy script type: string dataType: format: int32 description: "The data type of diagnostics source, default is 0. The values can be\n\n0: diagnostics source\n\n1: raw ERI\n\n " readOnly: true type: integer description: description: The description for the LMModule type: string appliesTo: description: The Applies To for the LMModule type: string technology: description: The Technical Notes for the LMModule type: string source: description: The diagnostics source readOnly: true type: string lineageId: description: The lineageId the LMModule belongs to readOnly: true type: string tags: description: The Tags for the LMModule type: string installationMetadata: description: The local module's IntegrationMetadata, readable for troubleshooting purposes readOnly: true $ref: '#/components/schemas/IntegrationMetadata' originRegistryId: description: The Registry ID of the Exchange Integration this module is based from, including this field will set this as the module's import base and mark the ID's version as audited type: string scriptType: description: 'script type: groovy | powershell' type: string checksum: description: The metadata checksum for the LMModule content readOnly: true type: string name: description: The diagnostics source name readOnly: true type: string id: format: int32 description: The ID of the LMModule readOnly: true type: integer accessGroupIds: uniqueItems: true description: The Access Groups Id's type: array items: format: int32 description: The Access Groups Id's type: integer example: 1, 2, 3 isInUse: description: Whether the LM module is currently in use readOnly: true type: boolean installationStatuses: description: The diagnostics Installation status readOnly: true type: array items: description: The diagnostics Installation status readOnly: true type: string enum: - NEW - UPGRADED - AUDITED - OUTDATED - INSTALLED - CUSTOMIZED - CONFLICT - PARTIALLY_INSTALLED - IS_INSTALLED - IS_CUSTOMIZED - CAN_INSTALL - CAN_UPGRADE - CAN_SKIP - CAN_DOWNGRADE group: description: The group the LMModule is in type: string RestChangelogV4: type: object properties: comments: type: string updatedAtMS: format: int64 type: integer model: type: string enum: - accessLogs - accessGroups - adminNotifications - aggregateSavings - alerts - visualizationAggregateEntry - visualizationAggregateValue - alertDependencyRules - alertRoutings - alertRules - actionRules - alertTuningConfigAncestry - alertTuningConfigs - alertTuningConfigsHistory - alertTuningConfigSlots - alertTuningGraphs - alertsTuningSeries - asnMappings - billingConfigurations - cloudAccounts - cloudResourceProperty - clusterAlertRoutings - clusterAlertTuningConfigs - collectors - collectorEvents - collectorGroups - collectorStatus - collectorUpgradeHistory - collectorUpgradeInfo - configSources - configSourceInstance - configSourceInstanceAlert - collectorLogs - config - configAlert - correlationGraphs - dashboards - datapoints - dataQueries - dataSources - dataSourceInstances - dataSourceInstanceAlertSettings - dataSourceInstanceGroups - datasets - dnsMappings - escalationChains - actionChains - eventSources - integrations - integrationAuditLogs - logSources - exchangeAccessGroups - exchangeActiveDiscoveryFilters - exchangeAppliesToFunctions - exchangeChangelogs - exchangeConfigSources - exchangeConfigSourceConfigChecks - exchangeDataSources - exchangeDataSourceDataPoints - exchangeDataSourceDataPointDisplayStatusNames - exchangeDataSourceGraphs - exchangeDataSourceGraphSeries - exchangeDataSourceGraphVirtualSeries - exchangeDataSourceOverviewGraphs - exchangeDataSourceOverviewGraphSeries - exchangeDataSourceOverviewGraphVirtualSeries - exchangeDiagnosticSources - exchangeEventSources - exchangeEventSourceFilters - exchangeEventSourceLogFiles - exchangeJobMonitors - exchangeLogSources - exchangeLogSourceFilters - exchangeSnmpTrapLogSourceFilters - exchangeLogSourceLogFields - exchangeLogSourceResourceMappings - exchangeLogSourceSensitiveDataMaskingRules - exchangeLogSourceCollectorMappings - exchangeLogicModules - exchangeLogicModulePackages - exchangeLogicModulePermissions - exchangePackagedLogicModules - exchangePropertySources - exchangeRemediationSources - exchangeSNMPSysOIDMaps - exchangeTopologySources - externalResourceIdentifiers - failedDataSourceInfo - filterFieldList - graphs - graphMeta - healthMetrics - hierarchy - hostclusterAlertDefs - auditLogSummaryContext - hostDiagnosticSourceDetails - diagnosticExecutionContext - remediationExecutionContext - latestDiagnosticExecutionResultContext - diagnosticExecutionSearchContext - remediationSourceExecutionSearchContext - diagnosticSourceAssociatedDevices - hostRemediationSourceDetails - hostActionToolDetails - actionToolExecutionContext - actionToolExecutionSearchContext - remediationSourceAssociatedDevices - latestRemediationExecutionResultContext - hostGroups - internalAlertSettings - jobMonitors - jobMonitorExecutions - lmSupportAccessHasConnection - lmSupportAccessState - lmotelCollectors - lmotelCollectorVersions - lmCollectorVersions - logalerts - logicModuleGroups - logpipelinesources - logpipelineprocessors - matchedEvents - metaGroupings - metricsCorrelation - monitoredResources - netscanGroups - netscans - netflow - netflowAlertRule - allLevels - nocWidgets - normalizedProperties - netscanPolicies - netscanExecutions - opsNotes - opsNoteResourceScopes - opsNoteServiceScopes - opsNoteResourceGroupScopes - opsNoteServiceGroupScopes - opsNoteGroupAllScopes - opsNoteTags - orgTreeNodes - portMappings - productIds - properties - propertySources - rawData - recentlyDeletedItems - recipientGroups - cloudConfigIssues - cloudConfigIntegrations - cloudConfigAccounts - cloudHealthEvents - cloudHealthEventDetails - cloudHealthEventAdditionalInfo - cloudRecommendations - cloudRecommendationAdditionalData - recommendationTypes - relationships - reports - reportHistories - reportGroups - resources - resourceDashboards - resourceDataSources - resourceDatapoints - resourceEventSources - resourceConfigSources - ConfigSourcesGoldStandard - ConfigSourceConfiguration - resourceDashboardTemplates - resourceGroups - resourceGroupDataSourceConfigs - resourceGroupEventSourceConfigs - resourceGroupInfoSourceConfigs - resourceJobMonitors - resourceLogPipelineResources - resourceLogSources - sdts - services - serviceCheckpoints - serviceGroups - sharedQueries - siteMonitors - slaWidgets - spanCount - securityRecommendations - subscriptions - topology - topologyMaps - topologyMaps-1 - topologyMaps-2 - topologyMapsHistogram - topologyMapsGraphs - subEntities - subEntitiesDetails - topologySavedMapsGroupType - topologySavedMapsGroup - topologyManualMapping - topologyManualInterfaceList - traffic - treeNodes - unmonitoredResources - userdata - users - userSettings - websiteCheckpoints - websiteGroups - websites - ServicePreview - BizServiceDatapoint - ServiceTemplateView - ServiceMemberPreview - RestServiceTemplate - ServiceTemplateServiceStats - synthetics - usage - tracesDevicesNamesIds - tracesGraphIds - tracesServices - tracesDeviceDatasources - tracesDeviceDatasourceInstances - tracesNamespaceGraphDetails - tracesResourceNamesIds - tracesTopologyEdgeData - members - apiTokens - roleGroups - roles - userGroups - sharingTokens - scimTokens - syntheticsDSInstanceRawData - syntheticsDSInstanceStepData - syntheticsDSInstanceAlerts - usageDimensions - vizResourceInfo - lmqlResult - lmqlParsed - partitions - cloudRecommendationStatus - recommendationStatusUpdateRequest - websiteDevice - mibUpload - logQueryGroups - logQueryGroupChangelog - logQuery - trackingLogQueries - billingBudgets - trackedQuery - trackedQueryGroups - trackedQueryGroupChangelog - adminName - droppedInstances - dashboardFilterGroups - dashboardFilters - dashboardFilterMappings id: type: string addressIP: type: string username: type: string StatusDisplayName: description: The status display name list type: object required: - metricValue - operator - statusDisplayName properties: statusDisplayName: description: The status display name for the metric value type: string metricValue: description: The metric value that the alert must be greater than, less than, or equal to for this status display to be considered type: string id: format: int32 description: The datapoint id readOnly: true type: integer datapointId: format: int32 description: The datappoint id readOnly: true type: integer operator: description: The operator to use for the status display type: string RestDiagnosticSourceV4: type: object properties: source: type: string enum: - REGISTRY - LOCAL replacementLineageName: type: string type: type: string enum: - DATASOURCE - EVENTSOURCE - CONFIGSOURCE - PROPERTYSOURCE - DIAGNOSTICSOURCE - REMEDIATIONSOURCE - TOPOLOGYSOURCE - JOBMONITOR - APPLIESTO_FUNCTION - SNMP_SYSOID_MAP - LOGSOURCE lineageId: type: string originVersion: type: string isTargetLastPublishedPrivate: type: boolean model: type: string enum: - accessLogs - accessGroups - adminNotifications - aggregateSavings - alerts - visualizationAggregateEntry - visualizationAggregateValue - alertDependencyRules - alertRoutings - alertRules - actionRules - alertTuningConfigAncestry - alertTuningConfigs - alertTuningConfigsHistory - alertTuningConfigSlots - alertTuningGraphs - alertsTuningSeries - asnMappings - billingConfigurations - cloudAccounts - cloudResourceProperty - clusterAlertRoutings - clusterAlertTuningConfigs - collectors - collectorEvents - collectorGroups - collectorStatus - collectorUpgradeHistory - collectorUpgradeInfo - configSources - configSourceInstance - configSourceInstanceAlert - collectorLogs - config - configAlert - correlationGraphs - dashboards - datapoints - dataQueries - dataSources - dataSourceInstances - dataSourceInstanceAlertSettings - dataSourceInstanceGroups - datasets - dnsMappings - escalationChains - actionChains - eventSources - integrations - integrationAuditLogs - logSources - exchangeAccessGroups - exchangeActiveDiscoveryFilters - exchangeAppliesToFunctions - exchangeChangelogs - exchangeConfigSources - exchangeConfigSourceConfigChecks - exchangeDataSources - exchangeDataSourceDataPoints - exchangeDataSourceDataPointDisplayStatusNames - exchangeDataSourceGraphs - exchangeDataSourceGraphSeries - exchangeDataSourceGraphVirtualSeries - exchangeDataSourceOverviewGraphs - exchangeDataSourceOverviewGraphSeries - exchangeDataSourceOverviewGraphVirtualSeries - exchangeDiagnosticSources - exchangeEventSources - exchangeEventSourceFilters - exchangeEventSourceLogFiles - exchangeJobMonitors - exchangeLogSources - exchangeLogSourceFilters - exchangeSnmpTrapLogSourceFilters - exchangeLogSourceLogFields - exchangeLogSourceResourceMappings - exchangeLogSourceSensitiveDataMaskingRules - exchangeLogSourceCollectorMappings - exchangeLogicModules - exchangeLogicModulePackages - exchangeLogicModulePermissions - exchangePackagedLogicModules - exchangePropertySources - exchangeRemediationSources - exchangeSNMPSysOIDMaps - exchangeTopologySources - externalResourceIdentifiers - failedDataSourceInfo - filterFieldList - graphs - graphMeta - healthMetrics - hierarchy - hostclusterAlertDefs - auditLogSummaryContext - hostDiagnosticSourceDetails - diagnosticExecutionContext - remediationExecutionContext - latestDiagnosticExecutionResultContext - diagnosticExecutionSearchContext - remediationSourceExecutionSearchContext - diagnosticSourceAssociatedDevices - hostRemediationSourceDetails - hostActionToolDetails - actionToolExecutionContext - actionToolExecutionSearchContext - remediationSourceAssociatedDevices - latestRemediationExecutionResultContext - hostGroups - internalAlertSettings - jobMonitors - jobMonitorExecutions - lmSupportAccessHasConnection - lmSupportAccessState - lmotelCollectors - lmotelCollectorVersions - lmCollectorVersions - logalerts - logicModuleGroups - logpipelinesources - logpipelineprocessors - matchedEvents - metaGroupings - metricsCorrelation - monitoredResources - netscanGroups - netscans - netflow - netflowAlertRule - allLevels - nocWidgets - normalizedProperties - netscanPolicies - netscanExecutions - opsNotes - opsNoteResourceScopes - opsNoteServiceScopes - opsNoteResourceGroupScopes - opsNoteServiceGroupScopes - opsNoteGroupAllScopes - opsNoteTags - orgTreeNodes - portMappings - productIds - properties - propertySources - rawData - recentlyDeletedItems - recipientGroups - cloudConfigIssues - cloudConfigIntegrations - cloudConfigAccounts - cloudHealthEvents - cloudHealthEventDetails - cloudHealthEventAdditionalInfo - cloudRecommendations - cloudRecommendationAdditionalData - recommendationTypes - relationships - reports - reportHistories - reportGroups - resources - resourceDashboards - resourceDataSources - resourceDatapoints - resourceEventSources - resourceConfigSources - ConfigSourcesGoldStandard - ConfigSourceConfiguration - resourceDashboardTemplates - resourceGroups - resourceGroupDataSourceConfigs - resourceGroupEventSourceConfigs - resourceGroupInfoSourceConfigs - resourceJobMonitors - resourceLogPipelineResources - resourceLogSources - sdts - services - serviceCheckpoints - serviceGroups - sharedQueries - siteMonitors - slaWidgets - spanCount - securityRecommendations - subscriptions - topology - topologyMaps - topologyMaps-1 - topologyMaps-2 - topologyMapsHistogram - topologyMapsGraphs - subEntities - subEntitiesDetails - topologySavedMapsGroupType - topologySavedMapsGroup - topologyManualMapping - topologyManualInterfaceList - traffic - treeNodes - unmonitoredResources - userdata - users - userSettings - websiteCheckpoints - websiteGroups - websites - ServicePreview - BizServiceDatapoint - ServiceTemplateView - ServiceMemberPreview - RestServiceTemplate - ServiceTemplateServiceStats - synthetics - usage - tracesDevicesNamesIds - tracesGraphIds - tracesServices - tracesDeviceDatasources - tracesDeviceDatasourceInstances - tracesNamespaceGraphDetails - tracesResourceNamesIds - tracesTopologyEdgeData - members - apiTokens - roleGroups - roles - userGroups - sharingTokens - scimTokens - syntheticsDSInstanceRawData - syntheticsDSInstanceStepData - syntheticsDSInstanceAlerts - usageDimensions - vizResourceInfo - lmqlResult - lmqlParsed - partitions - cloudRecommendationStatus - recommendationStatusUpdateRequest - websiteDevice - mibUpload - logQueryGroups - logQueryGroupChangelog - logQuery - trackingLogQueries - billingBudgets - trackedQuery - trackedQueryGroups - trackedQueryGroupChangelog - adminName - droppedInstances - dashboardFilterGroups - dashboardFilters - dashboardFilterMappings id: type: string group: type: string filterExchangeAccessGroupsIds: uniqueItems: true type: array items: format: int32 type: integer appliesToScript: type: string authorUsername: type: string upgradeableRegistryId: type: string version: type: string script: $ref: '#/components/schemas/RestScriptV4' tags: type: array items: type: string installedLocalId: type: string targetLineageId: type: string name: type: string authorCompanyUUID: type: string originStatus: type: string enum: - CORE - LM_ENDORSED - COMMUNITY - BETA - DEPRECATED - SECURITY_REVIEW locator: type: string status: type: string enum: - CORE - LM_ENDORSED - COMMUNITY - BETA - DEPRECATED - SECURITY_REVIEW targetLastPublishedLocator: type: string commitMessage: type: string originPublishedAtMS: format: int64 type: integer targetLastPublishedVersion: type: string exchangeAccessGroupsIds: type: array items: $ref: '#/components/schemas/ModelAndId' description: type: string originRegistryIdByInstalledLocalIdMap: additionalProperties: type: string type: object isPrivate: type: boolean localModulesIds: type: array items: $ref: '#/components/schemas/ModelAndId' targetLastPublishedStatus: type: string enum: - CORE - LM_ENDORSED - COMMUNITY - BETA - DEPRECATED - SECURITY_REVIEW isChangedFromTargetLastPublished: type: boolean exchangeChangelogsIds: type: array items: $ref: '#/components/schemas/ModelAndId' isLatest: type: boolean installedOriginRegistryId: type: string originRegistryId: type: string replacementLineageId: type: string checksum: type: string installationStatuses: type: array items: type: string enum: - NEW - UPGRADED - AUDITED - OUTDATED - INSTALLED - CUSTOMIZED - CONFLICT - PARTIALLY_INSTALLED - IS_INSTALLED - IS_CUSTOMIZED - CAN_INSTALL - CAN_UPGRADE - CAN_SKIP - CAN_DOWNGRADE associatedCounts: $ref: '#/components/schemas/LogicModuleAssociationCounts' createdAtMS: format: int64 type: integer originAuthorNamespace: type: string technicalNotes: type: string originLocator: type: string exchangeChangelogs: type: array items: $ref: '#/components/schemas/RestChangelogV4' originLineageId: type: string isLatestAvailable: type: boolean updatedAtMS: format: int64 type: integer authorPortalName: type: string targetLastPublishedAtMS: format: int64 type: integer isInUse: type: boolean originName: type: string RestScriptV4: type: object properties: powershellScript: type: string linuxScriptFilename: type: string windowsUploadScriptContent: readOnly: true type: string linuxUploadScriptContent: readOnly: true type: string groovyScript: type: string windowsScriptFilename: type: string linuxArguments: type: string windowsArguments: type: string windowsUploadScriptBinaryContentChecksum: readOnly: true type: string type: type: string enum: - INVALID - GROOVY - POWERSHELL - UPLOADED_FILE - PROPERTY linuxUploadScriptBinaryContentChecksum: readOnly: true type: string ScriptERIDiscoveryAttributeV3: description: Enable ERI Discovery or not type: object required: - name properties: winScript: description: The Windows script type: string groovyScript: description: The Groovy script type: string name: description: ERI detection name type: string type: description: The script type type: string linuxCmdline: description: The Linux script command line type: string linuxScript: description: The Linux script file type: string winCmdline: description: The Windows script command line type: string AutoDiscoveryFilter: type: object required: - attribute - operation properties: comment: description: The filter comment type: string attribute: description: Attribute to filter type: string operation: description: 'The filter''s operation. The values can be : Equal|NotEqual|GreaterThan|GreaterEqual|LessThan|LessEqual|Contain|NotContain|NotExist|RegexMatch|RegexNotMatch' type: string value: description: The operation value type: string DiagnosticsourcePaginationResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/DataSource' ErrorResponse: type: object properties: errorMessage: description: The error message readOnly: true type: string errorCode: format: int32 description: The error code readOnly: true type: integer errorDetail: description: The error detail readOnly: true type: object ModelAndId: description: SDT target readOnly: true type: object properties: displayName: type: string name: type: string namespace: type: string model: type: string id: type: string DataPoint: description: The data point list type: object required: - name properties: alertForNoData: format: int32 description: The triggered alert level if we cannot collect data for this datapoint. The values can be 0-4 (0:unused alert, 1:alert ok, 2:warn alert, 2:error alert, 4:critical alert) type: integer postProcessorMethod: description: The post processor method for the data value. Currently support complex expression and groovy. type: string postProcessorParam: description: The post processor parameter, e.g. dataPoint1*2 type: string maxDigits: format: int32 description: The max digits of the data value type: integer rawDataFieldName: description: The name of the raw data field name used to fetch value, e.g. avgrtt, output type: string description: description: The datapoint description type: string alertClearTransitionInterval: format: int32 description: The count that the alert must exist for this many poll cycles before the alert will be cleared type: integer userParam3: description: 'The third user parameter will be used to fetch the datapoint value. ' type: string userParam2: description: The second user parameter will be used to fetch the datapoint value. e.g. jmx attribute name type: string type: format: int32 description: The data metric type. The values can be 0-7 (0:unknown, 1:counter, 2:gauge, 3:derive, 5:status, 6:compute, 7:counter32, 8:counter64) type: integer dataSourceId: format: int32 description: The datasource id readOnly: true type: integer minValue: description: The minimum value of the datapoint value range type: string alertBody: description: The customized alert message body define. Empty string mean we will use the define in default template type: string originId: description: Portable id for origin tracking type: string userParam1: description: The first user parameter will be used to fetch the datapoint value. e.g. snmp oid type: string alertSubject: description: The customized alert message subject define. Empty string mean we will use the define in default template type: string id: format: int32 description: The datapoint id readOnly: true type: integer alertTransitionInterval: format: int32 description: The count that the alert must exist for this many poll cycles before it will be triggered type: integer enableAnomalyAlertSuppression: description: 'Expression of anomaly detection setting, split by comma 0 means off, 1 means on, -1 means invalid 1,0,1 = warn : ON error: OFF critical: ON Empty value on this parameter means : 0,0,0' type: string maxValue: description: The max value of the datapoint value range type: string dataType: format: int32 description: The data value type. The values can be 1-8 (1:boolean, 2:byte, 3:short, 4:int, 5:long, 6:float, 7:double, 8:ulong) type: integer criticalAdAdvSetting: description: Enable anomaly detection advance setting for CRITICAL severity type: string alertExprNote: description: alert expression note type: string adAdvSettingEnabled: description: The AD advance setting enable flag type: boolean errorAdAdvSetting: description: Enable anomaly detection advance setting for ERROR severity type: string warnAdAdvSetting: description: Enable anomaly detection advance setting for WARN severity type: string name: description: The datapoint name type: string statusDisplayNames: description: The status display name list type: array items: $ref: '#/components/schemas/StatusDisplayName' alertExpr: description: "The alert threshold define for the datapoint. e.g. '> 60 80 90' mean it will: \ntrigger warn alert if value > 60\ntrigger error alert if value > 80\ntrigger critical alert if value > 90" type: string securitySchemes: LMv1: in: header name: Authorization type: apiKey externalDocs: description: LogicMonitor Support Docs url: https://www.logicmonitor.com/support/rest-api-developers-guide/