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 OID API
  version: 3.0.0
servers:
- url: /santaba/rest
tags:
- name: OID
paths:
  /setting/oids/{id}:
    patch:
      summary: Update an OID
      security:
      - LMv1: []
      x-minimum-permissions:
        'Modules -> All Installed modules ': Manage
      description: Update the details of an existing OID
      operationId: patchOID
      responses:
        '200':
          description: Successfully updated the OID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestOidV3'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
          format: int32
      tags:
      - OID
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RestOidV3'
    get:
      summary: Get OID by ID
      security:
      - LMv1: []
      x-minimum-permissions:
        'Modules -> All Installed modules ': View
      description: Retrieve the OID details by its ID
      operationId: getOidById
      responses:
        '200':
          description: Successfully retrieved OID details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestOidV3'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
          format: int32
      tags:
      - OID
    delete:
      summary: Delete an OID
      security:
      - LMv1: []
      x-minimum-permissions:
        'Modules -> All Installed modules ': Manage
      description: Delete an existing OID from the system
      operationId: deleteOID
      responses:
        '200':
          description: Successfully deleted the OID
          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:
      - OID
    put:
      summary: Update an OID
      security:
      - LMv1: []
      x-minimum-permissions:
        'Modules -> All Installed modules ': Manage
      description: Update the details of an existing OID
      operationId: updateOID
      responses:
        '200':
          description: Successfully updated the OID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestOidV3'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
          format: int32
      tags:
      - OID
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RestOidV3'
  /setting/oids/importjson:
    post:
      summary: Import OID via json
      security:
      - LMv1: []
      x-minimum-permissions:
        Modules ->  All Installed modules: Manage
        Modules -> Access Groups: Manage
      description: Import a OID using json data
      operationId: importOidJson
      responses:
        '200':
          description: Successfully imported the OID via Json
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestOidV3'
        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:
      - OID
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  format: binary
  /setting/oids:
    post:
      summary: Add a new OID
      security:
      - LMv1: []
      x-minimum-permissions:
        'Modules -> All Installed modules ': Manage
      description: Create a new OID and add it to the system
      operationId: addOid
      responses:
        '200':
          description: Successfully added a new OID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestOidV3'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
      - OID
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RestOidV3'
    get:
      summary: Get OID's list
      security:
      - LMv1: []
      x-minimum-permissions:
        'Modules -> All Installed modules ': View
      description: Retrieve the list of OIDs
      operationId: getOIDList
      responses:
        '200':
          description: Successfully retrieved the list of OIDs
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OidSourcePaginationResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
      - OID
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
    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
    OidSourcePaginationResponse:
      type: object
      properties:
        total:
          format: int32
          readOnly: true
          type: integer
        searchId:
          readOnly: true
          type: string
        items:
          type: array
          items:
            $ref: '#/components/schemas/RestOidV3'
    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
    RestOidV3:
      type: object
      required:
      - oid
      properties:
        installationMetadata:
          description: The local module's IntegrationMetadata, readable for troubleshooting purposes
          readOnly: true
          $ref: '#/components/schemas/IntegrationMetadata'
        accessGroups:
          description: Access group Details in response
          type: array
          items:
            $ref: '#/components/schemas/AccessGroup'
        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: Checksum generated from the content of the module
          readOnly: true
          type: string
        id:
          format: int32
          description: Local ID of the module
          readOnly: true
          type: integer
          minimum: 0
        oid:
          description: The OID pattern to match to
          type: string
        categories:
          description: Categories to match the OID on
          type: string
        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 SNMP SysOID Map is currently in use
          readOnly: true
          type: boolean
        lineageId:
          description: The lineage ID that the LMModule belongs to
          readOnly: true
          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/