LogicMonitor Collectors API

openapi: 3.2.0
info:
  title: Logicmonitor Collectors API
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  version: '1.0'
  description: 'Operations tagged Collectors 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: Collectors
paths:
  /setting/collector/collectors:
    post:
      summary: add collector
      security:
      - LMv1: []
      description: ''
      operationId: addCollector
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Collector'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
      - Collectors
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Collector'
        required: true
    get:
      summary: get collector list
      security:
      - LMv1: []
      description: ''
      operationId: getCollectorList
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollectorPaginationResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      parameters:
      - 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:
      - Collectors
    servers:
    - url: /santaba/rest
  /setting/collector/collectors/{id}:
    patch:
      summary: update collector
      security:
      - LMv1: []
      description: ''
      operationId: patchCollectorById
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Collector'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
          format: int32
          pattern: \d+
      - in: query
        name: forceUpdateFailedOverDevices
        required: false
        schema:
          type: boolean
          default: false
      tags:
      - Collectors
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Collector'
        required: true
    get:
      summary: get collector
      security:
      - LMv1: []
      description: ''
      operationId: getCollectorById
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Collector'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
          format: int32
          pattern: \d+
      - in: query
        name: fields
        required: false
        schema:
          type: string
      tags:
      - Collectors
    delete:
      summary: delete collector
      security:
      - LMv1: []
      description: ''
      operationId: deleteCollectorById
      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
          pattern: \d+
      tags:
      - Collectors
    put:
      summary: update collector
      security:
      - LMv1: []
      description: ''
      operationId: updateCollectorById
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Collector'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
          format: int32
          pattern: \d+
      - in: query
        name: forceUpdateFailedOverDevices
        required: false
        schema:
          type: boolean
          default: false
      tags:
      - Collectors
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Collector'
        required: true
    servers:
    - url: /santaba/rest
  /setting/collector/collectors/{collectorId}/installers/{osAndArch}:
    get:
      summary: get collector installer
      security:
      - LMv1: []
      description: ''
      operationId: getCollectorInstaller
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: string
                format: binary
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      parameters:
      - in: path
        name: collectorId
        required: true
        schema:
          type: integer
          format: int32
          pattern: \d+
      - in: path
        name: osAndArch
        required: true
        schema:
          type: string
          pattern: .+
      - in: query
        name: collectorVersion
        description: The version of the installer you'd like to download. This defaults to the latest GD Collector, unless useEA is true
        required: false
        schema:
          type: integer
          format: int32
      - in: query
        name: token
        required: false
        schema:
          type: string
      - in: query
        name: monitorOthers
        required: false
        schema:
          type: boolean
          default: true
      - in: query
        name: collectorSize
        description: The size of the Collector you'd like to install. Options are nano, small (requires 2GB memory), medium (requires 4GB memory), large (requires 8GB memory), extra large (requires 16GB memory), double extra large (requires 32GB memory). Requires collector version 22.180 or higher. Defaults to small
        required: false
        schema:
          type: string
          default: medium
      - in: query
        name: useEA
        description: If true, the latest EA Collector version will be used. Defaults to false
        required: false
        schema:
          type: boolean
          default: false
      tags:
      - Collectors
    servers:
    - url: /santaba/rest
  /setting/collector/collectors/{id}/ackdown:
    post:
      summary: ack collector down alert
      security:
      - LMv1: []
      description: ''
      operationId: ackCollectorDownAlertById
      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
          pattern: \d+
      tags:
      - Collectors
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AckCollectorDown'
        required: true
    servers:
    - url: /santaba/rest
  /setting/collector/collectors/upgradeHistory:
    get:
      summary: get collector upgrade history list
      security:
      - LMv1: []
      x-minimum-permissions:
        Settings -> Collectors: View
      operationId: getCollectorUpgradeHistory
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollectorUpgradeHistoryPaginationResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
      - Collectors
    servers:
    - url: /santaba/rest
  /setting/collector/sizing:
    post:
      summary: Calculate collector sizing recommendations
      security:
      - LMv1: []
      x-minimum-permissions:
        Settings -> Collectors: Manage
      description: 'Analyzes workload requirements (devices, logs, NetFlow) and recommends optimal collector size and count for each workload type. Supports three independent collector pools: polling collectors for device monitoring, logs collectors for log ingestion, and NetFlow collectors for flow data processing.'
      operationId: calculateSizing
      responses:
        '200':
          description: Successful sizing calculation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestCollectorSizingResponseV3'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      parameters:
      - in: query
        name: fields
        description: Optional comma-separated list of fields to include in response
        schema:
          type: string
      tags:
      - Collectors
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RestCollectorSizingRequestV3'
        description: Sizing request with workload specifications
        required: true
    servers:
    - url: /santaba/rest
  /setting/collector/collectors/{id}/downloadToken:
    get:
      summary: get collector download token
      security:
      - LMv1: []
      x-minimum-permissions:
        Settings -> Collectors: Manage
      description: get collector download token – a short-lived token used to authorize downloading the collector installer
      operationId: getCollectorDownloadTokenById
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestCollectorDownloadTokenV3'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      parameters:
      - in: path
        name: id
        description: The collector ID
        required: true
        schema:
          type: integer
          format: int32
      tags:
      - Collectors
    servers:
    - url: /santaba/rest
  /setting/collector/collectors/{collectorId}/services/getStatusCheck:
    get:
      summary: get collector status check
      security:
      - LMv1: []
      x-minimum-permissions:
        Settings -> Collectors: Manage
      operationId: getCollectorStatusCheck
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestCollectorStatusV3'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      parameters:
      - in: path
        name: collectorId
        description: The collector ID
        required: true
        schema:
          type: integer
          format: int32
      tags:
      - Collectors
    servers:
    - url: /santaba/rest
  /setting/collector/collectors/{collectorId}/events:
    get:
      summary: get collector events
      security:
      - LMv1: []
      x-minimum-permissions:
        Settings -> Collectors: View
      operationId: getCollectorEvents
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestCollectorEventV3'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      parameters:
      - in: path
        name: collectorId
        required: true
        schema:
          type: integer
          format: int32
      tags:
      - Collectors
    servers:
    - url: /santaba/rest
  /setting/collector/collectors/{id}/agentloglevels/{component}:
    get:
      summary: get collector agent log level by component
      security:
      - LMv1: []
      x-minimum-permissions:
        Settings -> Collectors: View
      operationId: getCollectorAgentLogLevelByComponent
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestAgentLogLevelV3'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
          format: int32
      - in: path
        name: component
        required: true
        schema:
          type: string
      tags:
      - Collectors
    servers:
    - url: /santaba/rest
  /setting/collector/collectors/{collectorId}/services/triggerStatusCheck:
    post:
      summary: trigger collector status check
      security:
      - LMv1: []
      x-minimum-permissions:
        Settings -> Collectors: Manage
      operationId: triggerCollectorStatusCheck
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: string
                example: Collector 31 status check triggered
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      parameters:
      - in: path
        name: collectorId
        description: The collector ID
        required: true
        schema:
          type: integer
          format: int32
      tags:
      - Collectors
    servers:
    - url: /santaba/rest
  /setting/collector/collectors/{id}/agentloglevels:
    get:
      summary: get collector agent log levels
      security:
      - LMv1: []
      x-minimum-permissions:
        Settings -> Collectors: View
      operationId: getCollectorAgentLogLevels
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestAgentLogLevelV3'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
          format: int32
      tags:
      - Collectors
    put:
      summary: batch update collector agent log levels
      security:
      - LMv1: []
      x-minimum-permissions:
        Settings -> Collectors: Manage
      description: batch update collector agent log levels for multiple components
      operationId: batchUpdateCollectorAgentLogLevels
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RestAgentLogLevelV3'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
          format: int32
      tags:
      - Collectors
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/RestAgentLogLevelV3'
    servers:
    - url: /santaba/rest
  /setting/collector/collectors/{collectorId}/logs:
    get:
      summary: get collector log files
      security:
      - LMv1: []
      x-minimum-permissions:
        Settings -> Collectors: View
      description: get collector log files, list or zip archive
      operationId: getCollectorLogFiles
      responses:
        '200':
          description: Successful operation. When format=json, returns a paginated list of log files. When format=zip, returns a binary zip archive of all collector log files.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollectorLogFilePaginationResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      parameters:
      - in: path
        name: collectorId
        description: The collector ID
        required: true
        schema:
          type: integer
          format: int32
      - in: query
        name: format
        description: Response format – Use 'json' (default) to list log files, or 'zip' to download all log files as a zip archive
        schema:
          type: string
      tags:
      - Collectors
    servers:
    - url: /santaba/rest
  /setting/collector/collectors/{collectorId}/services/restart:
    post:
      summary: restart collector
      security:
      - LMv1: []
      x-minimum-permissions:
        Settings -> Collectors: Manage
      operationId: restartCollectorById
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                description: The async job ID for the restart operation
                type: integer
                example: 10
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      parameters:
      - in: path
        name: collectorId
        description: The collector ID
        required: true
        schema:
          type: integer
          format: int32
      tags:
      - Collectors
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RestRestartCollectorV3'
        description: Optional configuration overrides to apply before restarting. All fields default to empty string if omitted.
    servers:
    - url: /santaba/rest
  /setting/collector/collectors/{collectorId}/logs/{fileName}:
    get:
      summary: get collector log file
      security:
      - LMv1: []
      x-minimum-permissions:
        Settings -> Collectors: View
      operationId: getCollectorLogFileByName
      responses:
        '200':
          description: Successful operation. When format=json, returns metadata for the specified log file. When format=zip, downloads the file as a binary attachment.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestCollectorLogFileV3'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      parameters:
      - in: path
        name: collectorId
        description: The collector ID
        required: true
        schema:
          type: integer
          format: int32
      - in: path
        name: fileName
        description: The name of the log file to retrieve (e.g. 30.wrapper.log.zip)
        required: true
        schema:
          type: string
      - in: query
        name: format
        description: Response format – Use 'json' (default) to get file metadata, or 'zip' to download the file as a binary attachment
        schema:
          type: string
      tags:
      - Collectors
    servers:
    - url: /santaba/rest
components:
  schemas:
    CollectorBase:
      type: object
      properties:
        userChangeOn:
          format: int64
          description: The last time the Collector was updated, in epoch format
          readOnly: true
          type: integer
        confVersion:
          description: The version of the agent.conf configuration file
          readOnly: true
          type: string
        updatedOnLocal:
          description: The time that the Collector was last updated, in local time format
          readOnly: true
          type: string
        hostname:
          description: The hostname of the device the Collector is installed on
          readOnly: true
          type: string
        numberOfInstances:
          format: int32
          type: integer
        id:
          format: int32
          description: The id of the Collector
          readOnly: true
          type: integer
        ea:
          description: Whether the collector is in EA version
          readOnly: true
          type: boolean
        watchdogUpdatedOnLocal:
          description: The time that the Collector Watchdog was last updated, in local time format
          readOnly: true
          type: string
        hasFailOverDevice:
          description: Whether the collector has failover devices
          readOnly: true
          type: boolean
        collectorGroupName:
          description: The name of the group the Collector is in
          readOnly: true
          type: string
        netscanVersion:
          description: The Netscan version associated with the Collector
          readOnly: true
          type: string
        inSDT:
          description: The SDT status of the collector
          readOnly: true
          type: boolean
        updatedOn:
          format: int64
          description: The time that the Collector was last updated, in epoch format
          readOnly: true
          type: integer
        automaticUpgradeInfo:
          description: The details of the Collector's automatic upgrade schedule, if one exists
          $ref: '#/components/schemas/AutomaticUpgradeInfo'
        numberOfHosts:
          format: int32
          description: The number of devices monitored by the Collector
          readOnly: true
          type: integer
        collectorConf:
          description: The Collector's configuration file
          readOnly: true
          type: string
        sbproxyConf:
          description: The Proxy's configuration
          readOnly: true
          type: string
        lastSentNotificationOnLocal:
          description: The time that a notification was last sent for this Collector, in local time format
          readOnly: true
          type: string
        customProperties:
          description: The custom properties defined for the Collector
          type: array
          items:
            $ref: '#/components/schemas/NameAndValue'
        predefinedConfig:
          description: Collector configurations
          readOnly: true
          type: object
        onetimeUpgradeInfo:
          description: The details of the Collector's one time upgrade, if one has been scheduled
          $ref: '#/components/schemas/OnetimeUpgradeInfo'
        wrapperConf:
          description: The java service wrapper's configuration
          readOnly: true
          type: string
        clearSent:
          description: Whether or not an alert clear notifcation has been sent for this Collector
          readOnly: true
          type: boolean
        status:
          format: int32
          description: 'The registration status of the Collector. Acceptable values are: 0= unregistered, 1= registered, 2= stopped, 3= suspended'
          readOnly: true
          type: integer
        backupAgentId:
          format: int32
          description: The Id of the backup Collector assigned to the Collector
          type: integer
          example: 75.0
        specifiedCollectorDeviceGroupId:
          format: int32
          description: The device group id when create a new collector device
          type: integer
          example: 0.0
        escalatingChainId:
          format: int32
          description: The Id of the escalation chain associated with this Collector
          type: integer
          example: 80.0
        collectorSize:
          description: The size of the collector
          readOnly: true
          type: string
        ackedOnLocal:
          description: The time that the Collector was acknowledged (if it is in alert), in local time format
          readOnly: true
          type: string
        watchdogConf:
          description: The Watchdog's configuration
          readOnly: true
          type: string
        description:
          description: The Collector's description
          type: string
          example: Linux Collector
        createdOn:
          format: int64
          description: The time that the Collector was created, in epoch format
          readOnly: true
          type: integer
        platform:
          description: The OS of the Collector device (e.g. Linux, Windows)
          readOnly: true
          type: string
        isDown:
          description: Whether or not the Collector is currently down
          readOnly: true
          type: boolean
        userVisibleHostsNum:
          format: int32
          description: The number of devices monitored by the Collector and visible to the user that made the query
          readOnly: true
          type: integer
        canDowngrade:
          description: Whether the collector can be downgraded to a lower version
          readOnly: true
          type: boolean
        ackComment:
          description: The comment associated with the Collector acknowledgement (if it is in alert and acknowledged)
          readOnly: true
          type: string
        nextUpgradeInfo:
          description: The details of the Collector's next upgrade, if one has been scheduled
          readOnly: true
          $ref: '#/components/schemas/NextUpgradeInfo'
        suppressAlertClear:
          description: Whether alert clear notifications are suppressed for the Collector
          type: boolean
          example: true
        nextRecipient:
          format: int32
          description: The Id of the next recipient to which alert notifications will be sent
          readOnly: true
          type: integer
        ackedOn:
          format: int64
          description: The epoch at which the Collector was acknowledged (if it is in alert)
          readOnly: true
          type: integer
        userChangeOnLocal:
          description: The last time the Collector was updated, in the account time zone
          readOnly: true
          type: string
        collectorDeviceId:
          format: int32
          description: The device id of the collector device
          readOnly: true
          type: integer
        ackedBy:
          description: The user that acknowledged the Collector (if it is in alert)
          readOnly: true
          type: string
        userPermission:
          description: The permission level of the user that made the API request to get Collector information
          readOnly: true
          type: string
        needAutoCreateCollectorDevice:
          description: Whether to create a collector device when instance collector, the default value is true
          type: boolean
          example: 'true'
        watchdogUpdatedOn:
          format: int64
          description: The time that the Watchdog Services was last updated, in epoch format
          readOnly: true
          type: integer
        canDowngradeReason:
          description: The reason why the collector can be downgraded
          readOnly: true
          type: string
        lastSentNotificationOn:
          format: int64
          description: The time, in epoch format, that a notification was last sent for the Collector
          readOnly: true
          type: integer
        acked:
          description: Whether or not the Collector is currently acknowledged
          readOnly: true
          type: boolean
        onetimeDowngradeInfo:
          description: The details of the Collector's automatic downgrade schedule, if one exists
          $ref: '#/components/schemas/OnetimeUpgradeInfo'
        upTime:
          format: int64
          description: The time the Collector has been up, in seconds
          readOnly: true
          type: integer
        build:
          description: The Collector version
          readOnly: true
          type: string
        previousVersion:
          description: The previous version of the collector, used for downgrading
          readOnly: true
          type: string
        collectorGroupId:
          format: int32
          description: The Id of the group the Collector is in
          type: integer
          example: 10.0
        createdOnLocal:
          description: The time that the Collector was created, in local time format
          readOnly: true
          type: string
        enableFailBack:
          description: Whether or not automatic failback is enabled for the Collector, the default value is true
          type: boolean
          example: 'true'
        resendIval:
          format: int32
          description: The interval, in minutes, after which alert notifications for the Collector will be resent
          type: integer
          example: 15.0
        arch:
          description: The collector architecture (Windows | Linux platform followed by 32 | 64 bit)
          readOnly: true
          type: string
        enableFailOverOnCollectorDevice:
          description: Whether or not the device the Collector is installed on is enabled for fail over
          type: boolean
          example: true
    AckCollectorDown:
      type: object
      properties:
        comment:
          type: string
          example: Collector Down Acknowledged
    CollectorPaginationResponse:
      type: object
      properties:
        total:
          format: int32
          readOnly: true
          type: integer
        searchId:
          readOnly: true
          type: string
        items:
          type: array
          items:
            $ref: '#/components/schemas/CollectorBase'
    Collector:
      type: object
      properties:
        userChangeOn:
          format: int64
          description: The last time the Collector was updated, in epoch format
          readOnly: true
          type: integer
        confVersion:
          description: The version of the agent.conf configuration file
          readOnly: true
          type: string
        updatedOnLocal:
          description: The time that the Collector was last updated, in local time format
          readOnly: true
          type: string
        hostname:
          description: The hostname of the device the Collector is installed on
          re

# --- truncated at 32 KB (79 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/logicmonitor/refs/heads/main/openapi/logicmonitor-collectors-api-openapi.yml