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 Log Query Groups API version: 3.0.0 servers: - url: /santaba/rest tags: - name: LogQueryGroups paths: /log/logquerygroups/{id}/logqueries: get: summary: Get log queries by group ID security: - LMv1: [] x-minimum-permissions: Logs -> Log query group: View description: Fetch log queries belonging to a log query group operationId: getLogQueriesByGroupId responses: '200': description: Successful operation 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: - LogQueryGroups /log/logquerygroups/import: post: summary: Import log query groups and queries (best-effort) security: - LMv1: [] x-minimum-permissions: Logs -> Log query group: Manage description: Validates the payload, then persists every query that passes validation and returns per-item status with reasons for any unimported entries. HTTP 200 when all imported, 207 on partial success, 500 on fatal error. operationId: importLogQueryGroups responses: '200': description: All queries imported successfully content: application/json: schema: type: array items: $ref: '#/components/schemas/RestLogQueryGroupImportResult' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: Fatal error during validation/import content: application/json: schema: $ref: '#/components/schemas/ErrorResponseV2' '207': description: 'Partial success: some queries imported' content: application/json: schema: type: array items: $ref: '#/components/schemas/RestLogQueryGroupImportResult' parameters: - in: query name: groupType schema: type: string tags: - LogQueryGroups requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/RestLogQueryGroupValidationRequestItemV4' /log/logquerygroups: post: summary: Create a new log query group security: - LMv1: [] x-minimum-permissions: Logs -> Log query group: Manage description: Add a log query group operationId: addLogQueryGroup responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/LogQueryGroup' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' tags: - LogQueryGroups requestBody: content: application/json: schema: $ref: '#/components/schemas/LogQueryGroup' required: true get: summary: Get log query group list security: - LMv1: [] x-minimum-permissions: Logs -> Log query group: View description: Get all log query groups operationId: getLogQueryGroupList responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/LogQueryGroupPaginationResponse' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' tags: - LogQueryGroups /log/logquerygroups/grouptype/{groupType}: get: summary: Get log query groups by groupType security: - LMv1: [] x-minimum-permissions: Logs -> Log query group: Manage description: Returns log query groups filtered by the provided groupType. If allGroups=true, returns all groups (subject to permissions); otherwise returns groups for the current user. operationId: getLogQueryGroupListByGroupType responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/LogQueryGroupPaginationResponse' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' parameters: - in: path name: groupType required: true schema: type: string - in: query name: allGroups schema: type: boolean tags: - LogQueryGroups /log/logquerygroups/{id}: patch: summary: Update log query group security: - LMv1: [] x-minimum-permissions: Logs -> Log query group: Manage description: Modify an existing log query group operationId: patchLogQueryGroup responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/LogQueryGroup' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' parameters: - in: path name: id required: true schema: type: integer format: int32 tags: - LogQueryGroups requestBody: content: application/json: schema: $ref: '#/components/schemas/LogQueryGroup' required: true get: summary: Get log query group by ID security: - LMv1: [] x-minimum-permissions: Logs -> Log query group: Manage description: Fetch a log query group by ID operationId: getLogQueryGroupById responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/LogQueryGroup' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' parameters: - in: path name: id required: true schema: type: integer format: int32 tags: - LogQueryGroups delete: summary: Delete log query group security: - LMv1: [] x-minimum-permissions: Logs -> Log query group: Manage description: Delete log query group by ID operationId: deleteLogQueryGroup responses: '200': description: Successful operation 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: string tags: - LogQueryGroups put: summary: Update log query group security: - LMv1: [] x-minimum-permissions: Logs -> Log query group: Manage description: Modify an existing log query group operationId: updateLogQueryGroup responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/LogQueryGroup' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' parameters: - in: path name: id required: true schema: type: integer format: int32 tags: - LogQueryGroups requestBody: content: application/json: schema: $ref: '#/components/schemas/LogQueryGroup' required: true /log/logquerygroups/{id}/move: post: summary: Move log queries to another group security: - LMv1: [] x-minimum-permissions: Logs -> Log query group: Manage description: Move one or more log queries into a different log query group operationId: moveLogQueries responses: '200': description: Successful operation 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: - LogQueryGroups requestBody: content: application/json: schema: type: array items: type: string required: true components: schemas: RestResponseMetaBlock: type: object properties: filteredCount: format: int64 type: integer isTotalCountExhaustive: type: boolean fromPagingResponseInfo: $ref: '#/components/schemas/RestResponseMetaBlock' fromSortInfo: $ref: '#/components/schemas/RestResponseMetaBlock' perPageCount: format: int32 type: integer sort: type: string totalCount: format: int64 type: integer pageOffsetCount: format: int32 type: integer AggregateColumn: type: object properties: columnSize: format: int32 type: integer column: type: string View_Config: type: object properties: aggregateConfig: description: aggregate chart configuration readOnly: false $ref: '#/components/schemas/AggregateConfig' fieldPanel: description: field panel configuration type: array items: $ref: '#/components/schemas/FieldPanelItem' LogQueryGroupPaginationResponse: type: object properties: total: format: int32 readOnly: true type: integer searchId: readOnly: true type: string items: type: array items: $ref: '#/components/schemas/LogQueryGroup' RestLogQueryImportResult: description: Import result for one log query. type: object properties: duration: description: Saved query time range. type: string example: 5min partitions: description: Optional log partitions selected for the query. type: array items: description: Optional log partitions selected for the query. type: string example: '["partition1"]' example: - partition1 reason: description: Validation or import status reason for the query. type: string example: Existing query query: description: Log query expression. type: string example: error isValid: type: boolean label: description: Saved query label. type: string example: AWS error logs viewConfig: description: Optional saved view configuration for the query. readOnly: false $ref: '#/components/schemas/View_Config' Log_Query: description: List of log queries in this group readOnly: true type: object required: - id - version properties: partitions: description: partitions associated with the query type: array items: description: partitions associated with the query type: string trackable: type: boolean identifier: $ref: '#/components/schemas/ObjectIdentifier' startMs: format: int64 description: start time epoch in ms for log filter type: integer endMs: format: int64 description: end time epoch in ms for log filter type: integer query: description: query for log filter type: string groupId: format: int32 description: group id type: integer intoRestResponse: $ref: '#/components/schemas/RestResponse' label: description: label for log filter type: string viewConfig: $ref: '#/components/schemas/ViewConfig' favourite: type: boolean version: description: query grammar version type: string duration: description: time range type: string adminName: description: username associated with the log query readOnly: true type: string groupName: description: log query group name type: string relatedIntoRestResponse: $ref: '#/components/schemas/RestResponse' 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: description: uuid of record type: string isAggregate: description: is aggregate query or not type: boolean RestResponse: type: object properties: diagnostics: $ref: '#/components/schemas/ArrayNode' suppressedWarnings: $ref: '#/components/schemas/ArrayNode' preserveInsertionOrder: type: boolean data: $ref: '#/components/schemas/ObjectNode' suppressedErrors: $ref: '#/components/schemas/ArrayNode' successes: $ref: '#/components/schemas/ArrayNode' meta: $ref: '#/components/schemas/RestResponseMetaBlock' warnings: $ref: '#/components/schemas/ArrayNode' errors: $ref: '#/components/schemas/ArrayNode' RestLogQueryValidationRequestItemV4: type: object properties: duration: type: string partitions: type: array items: type: string query: type: string label: type: string viewConfig: $ref: '#/components/schemas/View_Config' version: type: string RestLogQueryGroupValidationRequestItemV4: type: object properties: logQuery: type: array items: $ref: '#/components/schemas/RestLogQueryValidationRequestItemV4' name: type: string description: type: string ObjectNode: type: object FieldPanelItem: type: object properties: field: type: string columnSize: format: int32 type: integer isVisible: type: boolean ObjectIdentifier: type: object properties: 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 RestLogQueryGroupImportResult: description: Import result for one log query group. type: object properties: reason: description: Validation or import status reason for the group. type: string example: existing logQuery: description: Per-query import results for this group. type: array items: $ref: '#/components/schemas/RestLogQueryImportResult' isValid: type: boolean name: description: Name of the target log query group. type: string example: Ungrouped description: description: Description of the target log query group. type: string example: Ungrouped folder LogQueryGroup: type: object required: - name properties: groupType: type: string enum: - PRIVATE - SHARED - PUBLIC userPermission: description: Effective user permission for this group type: string logQuery: description: List of log queries in this group readOnly: true type: array items: $ref: '#/components/schemas/Log_Query' name: description: The name of the log query group type: string description: description: Description of the log query group type: string id: format: int32 description: The ID of the log query group readOnly: true type: integer ownerId: format: int32 description: Owner of the log query group type: integer parentId: format: int32 description: Parent group ID if nested type: integer ErrorResponseV2: type: object properties: errorMessage: type: string errorCode: format: int32 type: integer errorDetail: type: object 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 AggregateConfig: type: object properties: chartMetadata: type: string data: type: string columns: type: array items: $ref: '#/components/schemas/AggregateColumn' donut: type: string chartType: type: string sortBy: type: string label: type: string ViewConfig: description: log query group fields view type: object properties: aggregateConfig: $ref: '#/components/schemas/AggregateConfig' fieldPanel: type: array items: $ref: '#/components/schemas/FieldPanelItem' ArrayNode: type: object securitySchemes: LMv1: in: header name: Authorization type: apiKey externalDocs: description: LogicMonitor Support Docs url: https://www.logicmonitor.com/support/rest-api-developers-guide/