openapi: 3.2.0
info:
  title: Logicmonitor Event Sources API
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  version: '1.0'
  description: 'Operations tagged EventSources across 2 of this provider''s published API definitions: logicmonitor-rest-api-v2-swagger.json, logicmonitor-rest-api-v3-swagger.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /santaba/rest
tags:
- name: Event Sources
paths:
  /setting/eventsources:
    get:
      summary: get eventSource list
      security:
      - LMv1: []
      description: ''
      operationId: getEventSourceList
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventSourcePaginationResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      parameters:
      - in: query
        name: format
        required: false
        schema:
          type: string
          default: json
      - in: query
        name: fields
        required: false
        schema:
          type: string
      - in: query
        name: size
        required: false
        schema:
          type: integer
          format: int32
          default: 50.0
      - in: query
        name: offset
        required: false
        schema:
          type: integer
          format: int32
          default: 0.0
      - in: query
        name: filter
        required: false
        schema:
          type: string
      tags:
      - Event Sources
    post:
      summary: Add event source
      security:
      - LMv1: []
      x-minimum-permissions:
        Modules -> All Installed modules: Manage
        Modules -> Access Groups: Manage
      description: Adds a new event source
      operationId: addEventSource
      responses:
        '200':
          description: Successfully added new event source
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventSource_2'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
      - Event Sources
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EventSource_2'
    servers:
    - url: /santaba/rest
  /setting/eventsources/importxml:
    post:
      summary: import eventsource via xml
      security:
      - LMv1: []
      description: ''
      operationId: importEventSource
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: object
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
      - Event Sources
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  format: binary
              required:
              - file
    servers:
    - url: /santaba/rest
  /setting/eventsources/importjson:
    post:
      summary: Import EventSource via json
      security:
      - LMv1: []
      x-minimum-permissions:
        Modules -> Default Access Group: Manage
        Modules ->  All Installed modules: Manage
      description: Import a EventSource using json data
      operationId: importEventSourceJson
      responses:
        '200':
          description: Successfully imported the EventSource via Json
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventSource_2'
        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:
      - Event Sources
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  format: binary
    servers:
    - url: /santaba/rest
  /setting/eventsources/{id}:
    patch:
      summary: Update event source by ID
      security:
      - LMv1: []
      x-minimum-permissions:
        Modules -> All Installed modules: Manage
        Modules -> Access Groups: Manage
      description: Updates the event source with the provided ID
      operationId: patchEventSourceById
      responses:
        '200':
          description: Successfully updated event source by ID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventSource_2'
        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:
      - Event Sources
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EventSource_2'
    get:
      summary: Get event source by ID
      security:
      - LMv1: []
      x-minimum-permissions:
        Modules -> All Installed modules: View
        Modules -> Access Groups: View
      description: Retrieves an event source by its ID
      operationId: getEventSourceById
      responses:
        '200':
          description: Successfully retrieved event source by ID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventSource_2'
        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:
      - Event Sources
    delete:
      summary: Delete event source by ID
      security:
      - LMv1: []
      x-minimum-permissions:
        Modules -> All Installed modules: Manage
        Modules -> Access Groups: Manage
      description: Deletes an event source by its ID
      operationId: deleteEventSourceById
      responses:
        '200':
          description: Successfully deleted event source by ID
          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:
      - Event Sources
    put:
      summary: Update event source by ID
      security:
      - LMv1: []
      x-minimum-permissions:
        Modules -> All Installed modules: Manage
        Modules -> Access Groups: Manage
      description: Updates the event source with the provided ID
      operationId: updateEventSourceById
      responses:
        '200':
          description: Successfully updated event source by ID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventSource_2'
        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:
      - Event Sources
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EventSource_2'
    servers:
    - url: /santaba/rest
components:
  schemas:
    EventSource:
      type: object
      required:
      - alertEffectiveIval
      - id
      - name
      properties:
        suppressDuplicatesES:
          description: Whether or not duplicate alerts should be suppressed at eventsource level
          type: boolean
        alertSubjectTemplate:
          description: The alert message subject for the EventSource
          type: string
        alertLevel:
          description: 'The default alert level: warn | error |critical'
          type: string
        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
        filters:
          description: The filters for the EventSource
          type: array
          items:
            $ref: '#/components/schemas/RestEventSourceFilter'
        version:
          format: int64
          description: The epoch time of the last update to the EventSource
          readOnly: true
          type: integer
        collector:
          description: 'The EventSource type: logfile | snmptrap | syslog | wineventlog | scriptevent'
          type: string
        tags:
          description: The Tags for the LMModule
          type: string
        alertBodyTemplate:
          description: The alert message body for the EventSource
          type: string
        name:
          description: The name of the EventSource
          type: string
        clearAfterAck:
          description: Whether or not the alert should clear after acknowledgement
          type: boolean
        id:
          format: int32
          description: The ID of the LMModule
          readOnly: true
          type: integer
        alertEffectiveIval:
          format: int32
          description: The time in minutes after which the alert should clear
          type: integer
        group:
          description: The group the LMModule is in
          type: string
      discriminator:
        propertyName: collector
    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
    RestEventSourceFilter:
      type: object
      properties:
        name:
          type: string
        comment:
          type: string
        id:
          format: int32
          type: integer
        value:
          type: string
        operator:
          type: string
    EventSourcePaginationResponse:
      type: object
      properties:
        total:
          format: int32
          readOnly: true
          type: integer
        searchId:
          readOnly: true
          type: string
        items:
          type: array
          items:
            $ref: '#/components/schemas/EventSource'
    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
    EventSourceFilter:
      type: object
      properties:
        eventSourceId:
          format: int32
          type: integer
        op:
          type: string
        originId:
          type: string
        name:
          type: string
        comment:
          type: string
        id:
          format: int32
          type: integer
        value:
          type: string
    RestEventSourceFilter_2:
      description: The filters for the EventSource
      type: object
      required:
      - comment
      - name
      - operator
      - value
      properties:
        name:
          description: The filter name
          type: string
        comment:
          description: The filter comment
          type: string
        id:
          format: int32
          description: The filter id
          readOnly: true
          type: integer
        value:
          description: The filter value
          type: string
        operator:
          description: The filter operator
          type: string
    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
    EventSource_2:
      type: object
      required:
      - alertEffectiveIval
      - name
      properties:
        accessGroups:
          description: Module's access groups
          type: array
          items:
            $ref: '#/components/schemas/AccessGroup'
        eventSource:
          $ref: '#/components/schemas/EventSource_2'
        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
        collector:
          description: The EventSource collector type. The values can be wineventlog | syslog | snmptrap | echo | logfile | scriptevent | awsrss | azurerss | azureadvisor | gcpatom | awsrdspievent | azureresourcehealthevent | azureemergingissue | azureloganalyticsworkspacesevent | awstrustedadvisor | awshealth | awsorganizationalhealth | ipmievent
          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
        alertBodyTemplate:
          description: The alert message body for the EventSource
          type: string
        checksum:
          description: The metadata checksum for the LMModule content
          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
        group:
          description: The group the LMModule is in
          type: string
        suppressDuplicatesES:
          description: Whether or not duplicate alerts have to be suppressed
          type: boolean
        alertSubjectTemplate:
          description: The alert message subject for the EventSource
          type: string
        eventSourceFilters:
          type: array
          items:
            $ref: '#/components/schemas/EventSourceFilter'
        alertLevel:
          description: The default alert level. The values can be warn | error | critical | doMapping
          type: string
        technology:
          description: The Technical Notes for the LMModule
          type: string
        filters:
          description: The filters for the EventSource
          type: array
          items:
            $ref: '#/components/schemas/RestEventSourceFilter_2'
        version:
          format: int64
          description: The epoch time of the last update to the EventSource
          readOnly: true
          type: integer
        tags:
          description: The Tags for the LMModule
          type: string
        auditVersion:
          format: int64
          description: The auditVersion of the EventSource
          readOnly: true
          type: integer
        installationMetadata:
          description: The local module's IntegrationMetadata, readable for troubleshooting purposes
          readOnly: true
          $ref: '#/components/schemas/IntegrationMetadata'
        name:
          description: The name of the EventSource
          type: string
        clearAfterAck:
          description: Whether or not the alert should clear after acknowledgement
          type: boolean
        isInUse:
          description: Whether the LM module is currently in use
          readOnly: true
          type: boolean
        alertEffectiveIval:
          format: int32
          description: The time in minutes after which the alert should clear
          type: integer
      discriminator:
        propertyName: collector
  securitySchemes:
    LMv1:
      in: header
      name: Authorization
      type: apiKey
externalDocs:
  description: LogicMonitor Support Docs
  url: https://www.logicmonitor.com/support/rest-api-developers-guide/
x-refined-from:
- logicmonitor-rest-api-v2-swagger.json
- logicmonitor-rest-api-v3-swagger.json