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 Action Chains API
  version: 3.0.0
servers:
- url: /santaba/rest
tags:
- name: Action Chains
paths:
  /setting/action/chains:
    post:
      summary: Add action chain
      security:
      - LMv1: []
      x-minimum-permissions:
        Settings -> Action Settings: Manage
      description: Create a new action chain
      operationId: addActionChain
      responses:
        '200':
          description: Successfully added the action chain
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActionChain'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
      - Action Chains
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ActionChain'
        required: true
    get:
      summary: Get action chains list
      security:
      - LMv1: []
      x-minimum-permissions:
        Settings -> Action Settings: View
      description: Retrieves a list of action chains
      operationId: getActionChainsList
      responses:
        '200':
          description: Successfully retrieved action chains list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActionChainPaginationResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
      - Action Chains
  /setting/action/chains/{id}:
    patch:
      summary: update action chain
      security:
      - LMv1: []
      x-minimum-permissions:
        Settings -> Action Settings: Manage
      operationId: patchActionChainById
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActionChain'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
          format: int32
      tags:
      - Action Chains
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ActionChain'
        required: true
    get:
      summary: Get action chain by ID
      security:
      - LMv1: []
      x-minimum-permissions:
        Settings -> Action Settings: View
      description: Retrieve details of a specific action chain using its ID
      operationId: getActionChainById
      responses:
        '200':
          description: Successfully retrieved the action chain
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActionChain'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
          format: int32
      tags:
      - Action Chains
    delete:
      summary: delete action chain
      security:
      - LMv1: []
      x-minimum-permissions:
        Settings -> Action Settings: Manage
      description: delete action chain by id
      operationId: deleteActionChainById
      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:
      - Action Chains
    put:
      summary: update action chain
      security:
      - LMv1: []
      x-minimum-permissions:
        Settings -> Action Settings: Manage
      operationId: updateActionChainById
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActionChain'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
          format: int32
      tags:
      - Action Chains
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ActionChain'
        required: true
components:
  schemas:
    Stage:
      description: A stage in the action chain
      type: object
      required:
      - id
      - type
      properties:
        name:
          description: 'The action source name '
          readOnly: true
          type: string
          example: test-diagnostic
        id:
          format: int32
          description: The source ID
          type: integer
          example: 101
        type:
          description: The type of the action source
          type: string
          enum:
          - diagnosticSource
          - remediationSource
          example: diagnosticSource
    ActionChain:
      type: object
      required:
      - name
      - stages
      properties:
        name:
          description: The action chain name
          type: string
          example: Test AC
        stages:
          description: The list of stages in the action chain
          type: array
          items:
            $ref: '#/components/schemas/Stage'
        description:
          description: The action chain description
          type: string
          example: This chain description
        id:
          format: int32
          description: The Id of the action chain
          readOnly: true
          type: integer
    ActionChainPaginationResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/ActionChain'
    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
  securitySchemes:
    LMv1:
      in: header
      name: Authorization
      type: apiKey
externalDocs:
  description: LogicMonitor Support Docs
  url: https://www.logicmonitor.com/support/rest-api-developers-guide/