openapi: 3.2.0
info:
  title: Logicmonitor Escalation Chains API
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  version: '1.0'
  description: 'Operations tagged Escalation Chains 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: Escalation Chains
paths:
  /setting/alert/chains:
    post:
      summary: add escalation chain
      security:
      - LMv1: []
      description: ''
      operationId: addEscalationChain
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EscalatingChain'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
      - Escalation Chains
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EscalatingChain'
        required: true
    get:
      summary: get escalation chain list
      security:
      - LMv1: []
      description: ''
      operationId: getEscalationChainList
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EscalationChainPaginationResponse'
        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:
      - Escalation Chains
    servers:
    - url: /santaba/rest
  /setting/alert/chains/{id}:
    patch:
      summary: update escalation chain
      security:
      - LMv1: []
      description: ''
      operationId: patchEscalationChainById
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EscalatingChain'
        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:
      - Escalation Chains
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EscalatingChain'
        required: true
    get:
      summary: get escalation chain by id
      security:
      - LMv1: []
      description: ''
      operationId: getEscalationChainById
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EscalatingChain'
        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:
      - Escalation Chains
    delete:
      summary: delete escalation chain
      security:
      - LMv1: []
      description: ''
      operationId: deleteEscalationChainById
      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:
      - Escalation Chains
    put:
      summary: update escalation chain
      security:
      - LMv1: []
      description: ''
      operationId: updateEscalationChainById
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EscalatingChain'
        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:
      - Escalation Chains
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EscalatingChain'
        required: true
    servers:
    - url: /santaba/rest
components:
  schemas:
    Chain:
      type: object
      required:
      - stages
      - type
      properties:
        period:
          $ref: '#/components/schemas/Period'
        stages:
          type: array
          items:
            type: array
            items:
              $ref: '#/components/schemas/Recipient'
        type:
          description: single
          type: string
    Recipient:
      type: object
      required:
      - method
      - type
      properties:
        method:
          description: Admin | Arbitrary, where Admin = a user, and Arbitrary = an arbitrary email
          type: string
          example: EMAIL
        contact:
          type: string
        type:
          description: email | sms | voice, where type must be email if method = arbitrary
          type: string
          example: Admin
        addr:
          description: the user name if method = admin, or the email address if method = arbitrary
          type: string
          example: john.doe@logicmonitor.com
    EscalationChainPaginationResponse:
      type: object
      properties:
        total:
          format: int32
          readOnly: true
          type: integer
        searchId:
          readOnly: true
          type: string
        items:
          type: array
          items:
            $ref: '#/components/schemas/EscalatingChain'
    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
    EscalatingChain:
      type: object
      required:
      - destinations
      - name
      properties:
        inAlerting:
          readOnly: true
          type: boolean
        throttlingAlerts:
          format: int32
          type: integer
          example: 40.0
        enableThrottling:
          type: boolean
          example: true
        destinations:
          type: array
          items:
            $ref: '#/components/schemas/Chain'
        name:
          type: string
          example: NOC Team
        description:
          type: string
          example: For alerts escalated to the NOC Team
        id:
          format: int32
          readOnly: true
          type: integer
        ccDestinations:
          type: array
          items:
            $ref: '#/components/schemas/Recipient'
        throttlingPeriod:
          format: int32
          type: integer
          example: 30.0
    Period:
      type: object
      required:
      - endMinutes
      - startMinutes
      - timezone
      - weekDays
      properties:
        weekDays:
          type: array
          items:
            format: int32
            type: integer
        timezone:
          type: string
        startMinutes:
          format: int32
          type: integer
        endMinutes:
          format: int32
          type: integer
    Chain_2:
      description: The chain destinations
      type: object
      required:
      - stages
      - type
      properties:
        period:
          $ref: '#/components/schemas/Period_2'
        stages:
          description: List of recipients list
          type: array
          items:
            description: List of recipients list
            type: array
            items:
              $ref: '#/components/schemas/Recipient_2'
        type:
          description: Type of stages in this chain. The values can be timebased|simple
          type: string
    Recipient_2:
      description: The chain's cc destinations
      type: object
      required:
      - addr
      - contact
      - method
      - type
      properties:
        method:
          description: "Recipient method for each type. \nThe values can be EMAIL|SMEMAIL|VOICE|SMS \n            group: \"method\" not used\n            arbitrary: The method should be email.\n            admin: The method should be email, smsEmail, voice, sms, or defaultMethod;\n"
          type: string
          example: EMAIL
        contact:
          description: Contact details, email address or phone number
          type: string
        type:
          description: "The recipient type. \nThe values can be GROUP|ARBITRARY|ADMIN, where Admin = a user, and Arbitrary = an arbitrary email"
          type: string
          example: Admin
        addr:
          description: "The recipient address. \nThe value will be user name if method = admin, or the email address if method = arbitrary"
          type: string
          example: user@domain.com
    EscalatingChain_2:
      type: object
      required:
      - destinations
      - name
      properties:
        inAlerting:
          description: Whether or not chain in alerting
          readOnly: true
          type: boolean
        throttlingAlerts:
          format: int32
          description: Maximum number of alerts can be sent during a throttle period
          type: integer
          example: 40
        enableThrottling:
          description: If throttle needs to be enabled then true if not then false.
          type: boolean
          example: true
        destinations:
          description: The chain destinations
          type: array
          items:
            $ref: '#/components/schemas/Chain_2'
        name:
          description: The chain name
          type: string
          example: NOC Team
        description:
          description: The description for chain
          type: string
          example: For alerts escalated to the NOC Team
        id:
          format: int32
          description: The Id of the chain
          readOnly: true
          type: integer
        ccDestinations:
          description: The chain's cc destinations
          type: array
          items:
            $ref: '#/components/schemas/Recipient_2'
        throttlingPeriod:
          format: int32
          description: The throttle period
          type: integer
          example: 30
    Period_2:
      description: 'If type is timebased then effective time when recipient receive notification.

        '
      type: object
      required:
      - endMinutes
      - startMinutes
      - timezone
      - weekDays
      properties:
        weekDays:
          description: The list of week day of this period
          type: array
          items:
            format: int32
            description: The list of week day of this period
            type: integer
        timezone:
          description: The timezone for this period
          type: string
        startMinutes:
          format: int32
          description: The start minute of this period
          type: integer
        endMinutes:
          format: int32
          description: The end minute of this period
          type: integer
  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