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 Alerts API
  version: 3.0.0
servers:
- url: /santaba/rest
tags:
- name: LogAlerts
paths:
  /logpipelines/processors/{processorId}:
    patch:
      summary: Update a LogAlerts by ID
      security:
      - LMv1: []
      x-minimum-permissions:
        Logs & Traces -> Logs: Manage
        Resources: Manage
      description: Handles the update of a specific LogAlerts by ID.
      operationId: patchLogAlerts
      responses:
        '200':
          description: LogAlerts updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestLogPipelineProcessorV3'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      parameters:
      - in: path
        name: processorId
        required: true
        schema:
          type: integer
          format: int32
      tags:
      - LogAlerts
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RestLogPipelineProcessorV3'
        required: true
    get:
      summary: Retrieve a LogAlerts by ID
      security:
      - LMv1: []
      x-minimum-permissions:
        Logs & Traces -> Logs: View
        Resources: View
      description: Handles the retrieval of a specific LogAlerts by ID.
      operationId: getLogAlertsById
      responses:
        '200':
          description: LogAlerts retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestLogPipelineProcessorV3'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      parameters:
      - in: path
        name: processorId
        required: true
        schema:
          type: integer
          format: int32
      tags:
      - LogAlerts
    delete:
      summary: Delete a LogAlerts by ID
      security:
      - LMv1: []
      x-minimum-permissions:
        Logs & Traces -> Logs: Manage
        Resources: Manage
      description: Deletes the specified LogAlerts using its unique ID.
      operationId: deleteLogAlertsById
      responses:
        '200':
          description: LogAlerts deleted successfully
          content:
            application/json:
              schema:
                type: object
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      parameters:
      - in: path
        name: processorId
        required: true
        schema:
          type: integer
          format: int32
      tags:
      - LogAlerts
    put:
      summary: Update a LogAlerts by ID
      security:
      - LMv1: []
      x-minimum-permissions:
        Logs & Traces -> Logs: Manage
        Resources: Manage
      description: Handles the update of a specific LogAlerts by ID.
      operationId: updateLogAlerts
      responses:
        '200':
          description: LogAlerts updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestLogPipelineProcessorV3'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      parameters:
      - in: path
        name: processorId
        required: true
        schema:
          type: integer
          format: int32
      tags:
      - LogAlerts
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RestLogPipelineProcessorV3'
        required: true
  /logpipelines/processors:
    post:
      summary: Add a new LogAlerts
      security:
      - LMv1: []
      x-minimum-permissions:
        Logs & Traces -> Logs: Manage
        Resources: Manage
      description: Handles the addition of a new LogAlerts.
      operationId: addLogAlerts
      responses:
        '200':
          description: LogAlerts added successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestLogPipelineProcessorV3'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
      - LogAlerts
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RestLogPipelineProcessorV3'
        required: true
    get:
      summary: Retrieve all LogAlerts
      security:
      - LMv1: []
      x-minimum-permissions:
        Logs & Traces -> Logs: View
        Resources: View
      description: Handles the retrieval of all LogAlerts.
      operationId: getLogAlerts
      responses:
        '200':
          description: LogAlerts retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PipelineProcessorPaginationResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
      - LogAlerts
  /logpipelines/processors/{processorId}/{action}:
    put:
      summary: Enable or disable a LogAlerts by ID
      security:
      - LMv1: []
      x-minimum-permissions:
        Logs & Traces -> Logs: Manage
        Resources: Manage
      description: Updates the state of a LogAlerts by ID. The action must be either 'enable' or 'disable'.
      operationId: updateDisableLogAlerts
      responses:
        '200':
          description: Log pipeline processor state disabled successfully
          content:
            application/json:
              schema:
                type: object
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      parameters:
      - in: path
        name: processorId
        required: true
        schema:
          type: integer
          format: int32
      - in: path
        name: action
        required: true
        schema:
          type: string
      tags:
      - LogAlerts
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DisableProcessorPayload'
components:
  schemas:
    PipelineProcessorPaginationResponse:
      type: object
      properties:
        total:
          format: int32
          readOnly: true
          type: integer
        searchId:
          readOnly: true
          type: string
        items:
          type: array
          items:
            $ref: '#/components/schemas/RestLogPipelineProcessorV3'
    WindowConfig:
      type: object
      properties:
        duration:
          type: string
        count:
          format: int32
          type: integer
    ClearConfig:
      type: object
      properties:
        autoClearAfter:
          type: string
        clearQuery:
          type: string
        groupingEntities:
          type: array
          items:
            type: string
        autoClearOnAck:
          type: boolean
    RestLogPipelineProcessorV3:
      type: object
      properties:
        severity:
          type: string
          enum:
          - critical
          - error
          - warning
          - 'null'
        alertQuery:
          type: string
        alertType:
          type: string
        logMetadataFields:
          type: array
          items:
            type: string
        clear:
          $ref: '#/components/schemas/ClearConfig'
        logNotes:
          type: string
        description:
          type: string
        grouping:
          $ref: '#/components/schemas/GroupingConfig'
        pipelineId:
          format: int32
          type: integer
        name:
          type: string
        disabled:
          type: boolean
        id:
          format: int32
          type: integer
        window:
          $ref: '#/components/schemas/WindowConfig'
    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
    DisableProcessorPayload:
      type: object
      properties:
        value:
          type: boolean
    GroupingConfig:
      type: object
      properties:
        alertEntities:
          type: array
          items:
            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/