openapi: 3.1.0
info:
  version: 3.0.0
  title: Alerts/Incidents API
  description: 'This API enables you to retrieve and update alerts and incidents, and other APIs relating to them'
  termsOfService: 'https://www.moogsoft.com/legal-information/express-terms-conditions/'
  contact:
    name: API Support
    url: 'https://docs.moogsoft.com/en/moogsoft-apis.html'
    email: support@moogsoft.com
  license:
    url: 'https://www.moogsoft.com/legal-information'
    name: Apex AIOps Incident Management Proprietary
servers:
  - url: 'https://api.moogsoft.ai'
  - url: 'https://api.dev.moogsoft.cloud'
paths:
  /v2/alerts/columns:
    get:
      tags:
        - Alert Columns Resource V 2
      summary: Get column names of alert DTO.
      description: Column names for filtering alerts via /alerts endpoint
      operationId: alertDtoColumnNames
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseColumnsDto'
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'alerts:view'
        description: Required user permissions for this endpoint
  /v2/autoclose-config:
    get:
      tags:
        - autoclose-config
      summary: Get autoclose configs
      description: 'Get autoclose configs for alert, incident, or both'
      operationId: getAutoCloseConfig
      parameters:
        - name: type
          in: query
          schema:
            type: string
            description: 'Type of configuration to retrieve (incident or alert), retrieves both types if empty'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseListOfAutoCloseConfigDto'
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'automation:view'
        description: Required user permissions for this endpoint
  '/v2/autoclose-config/{id}':
    patch:
      tags:
        - autoclose-config
      summary: Update autoclose config
      description: Update autoclose config for alerts or incidents.
      operationId: patchAutoCloseConfig
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        description: Configs used to update existing configs.
        required: true
        content:
          application/json:
            schema:
              type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseAutoCloseConfigDto'
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'automation:edit'
        description: Required user permissions for this endpoint
  /v2/autoclose-policy:
    get:
      tags:
        - autoclose-policy
      summary: Get autoclose policies
      description: 'Get autoclose policies for alert, incident, or both'
      operationId: getAutoClosePolicies
      parameters:
        - name: type
          in: query
          schema:
            type: string
            description: 'Type of policy to retrieve (incident or alert), retrieves both types if empty'
            default: ''
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseListOfAutoClosePolicyDto'
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'automation:view'
        description: Required user permissions for this endpoint
    post:
      tags:
        - autoclose-policy
      summary: Create autoclose policy
      description: Create autoclose policy for alerts or incidents.
      operationId: postAutoClosePolicy
      requestBody:
        description: Settings used to create new policy
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BaseAutoClosePolicyDto'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseAutoClosePolicyDto'
        '400':
          description: Bad Request
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'automation:edit'
        description: Required user permissions for this endpoint
  '/v2/autoclose-policy/{id}':
    patch:
      tags:
        - autoclose-policy
      summary: Update autoclose policy
      description: Update autoclose policy for alerts or incidents.
      operationId: patchAutoClosePolicy
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        description: Settings used to update existing policies.
        required: true
        content:
          application/json:
            schema:
              type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseAutoClosePolicyDto'
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'automation:edit'
        description: Required user permissions for this endpoint
    get:
      tags:
        - autoclose-policy
      summary: Get autoclose policy
      description: Get autoclose policy by id
      operationId: getAutoClosePolicy
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseAutoClosePolicyDto'
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'automation:view'
        description: Required user permissions for this endpoint
    delete:
      tags:
        - autoclose-policy
      summary: Delete autoclose policy
      description: Delete autoclose policy with specified id
      operationId: deleteAutoClosePolicy
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '204':
          description: No Content
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'automation:edit'
        description: Required user permissions for this endpoint
  /v2/event-columns:
    get:
      tags:
        - event-columns
      summary: get columns names of Event
      description: get columns names of Event
      operationId: eventDtoColumnNames
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseColumnsDto'
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value: []
        description: Required user permissions for this endpoint
  /v2/incidents/columns:
    get:
      tags:
        - incident columns resource
      summary: Get column names of IncidentDTO.
      description: 'Column names for filtering alerts in outbound integrations, returns a list of strings'
      operationId: incidentDtoColumnNames
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseColumnsDto'
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'incidents:view'
        description: Required user permissions for this endpoint
  '/v2/situation-room/{incidentId}/alerts':
    post:
      tags:
        - alerts
      summary: 'Get alerts for an incident, for the situation room'
      description: 'Get alerts for an incident, for the situation room'
      operationId: getSituationRoomAlertsV2
      parameters:
        - name: incidentId
          in: path
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SituationRoomAlertsRequestV2'
              __errors__:
                '#/components/schemas/ColumnFilterMap': No foreign doc with id components found
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseSituationRoomAlertList'
        '400':
          description: Bad Request
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'alerts:view'
        description: Required user permissions for this endpoint
  /v2/stats/overview:
    get:
      tags:
        - overviewStats
      summary: Get overview statistics for dashboard
      description: Get overview statistics for dashboard
      operationId: getOverviewStats
      parameters:
        - name: activeOnly
          in: query
          description: active only
          schema:
            type: boolean
            default: 'false'
        - name: end
          in: query
          description: end time
          schema:
            type: integer
            format: int64
            exclusiveMinimum: 0
        - name: start
          in: query
          description: time used to filter out the Opensearch data
          schema:
            type: integer
            format: int64
            exclusiveMinimum: 0
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseOverviewWebResponse'
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
  /v3/service/summary:
    post:
      tags:
        - dashboardSummaryPost
      summary: Get alert/incident summary for dashboard
      description: Get alert/incident summary for dashboard
      operationId: getServiceSummaryPost
      requestBody:
        description: Dashboard Summary request
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DashboardSummaryRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseIncidentSummaryResponse'
        '400':
          description: Bad Request
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'incidents:view'
        description: Required user permissions for this endpoint
  /v1/alert-workflows/dependent-on:
    get:
      tags:
        - alert-workflows
      summary: Checks for any alert workflows dependent on a specific resource.
      description: Checks for any alert workflows dependent on a specific resource.
      operationId: getAlertWorkflowsDependentOnResource
      parameters:
        - name: resource_name
          in: query
          required: true
          schema:
            type: string
            pattern: \S
        - name: resource_type
          in: query
          required: true
          schema:
            $ref: '#/components/schemas/ResourceType'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseListOfWorkflowDependentOnResponseDto'
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value: []
        description: Required user permissions for this endpoint
  '/v1/alerts/{alertId}/external-ids/{integrationId}':
    get:
      tags:
        - alerts
      summary: Get details associated with specific external system.
      description: Get details associated with a specific external system in the alert. Returns the systemName and all the details
      operationId: getAlertExternalId
      parameters:
        - name: alertId
          in: path
          description: alert ID
          required: true
          schema:
            type: integer
            format: int64
            exclusiveMinimum: 0
        - name: integrationId
          in: path
          description: integration ID
          required: true
          schema:
            type: string
            minLength: 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseExternalSystemDto'
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'alerts:view'
        description: Required user permissions for this endpoint
    patch:
      tags:
        - alerts
      summary: Add externalID information to an alert.
      description: Add details about an external system to the alert
      operationId: patchAlertExternalId
      parameters:
        - name: alertId
          in: path
          description: alert ID
          required: true
          schema:
            type: integer
            format: int64
            exclusiveMinimum: 0
        - name: integrationId
          in: path
          description: integration ID
          required: true
          schema:
            type: string
            minLength: 1
      requestBody:
        description: Configs used to update existing configs.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalSystemDto'
      responses:
        '204':
          description: No Content
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'alerts:edit'
        description: Required user permissions for this endpoint
    delete:
      tags:
        - alerts
      summary: Delete externalID information to an alert.
      description: Delete details about an external system in the alert
      operationId: deleteAlertExternalId
      parameters:
        - name: alertId
          in: path
          description: alert ID
          required: true
          schema:
            type: integer
            format: int64
            exclusiveMinimum: 0
        - name: integrationId
          in: path
          description: integration ID
          required: true
          schema:
            type: string
            minLength: 1
      responses:
        '204':
          description: No Content
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'alerts:edit'
        description: Required user permissions for this endpoint
    post:
      tags:
        - alerts
      summary: Add externalID information to an alert.
      description: Add details about an external system to the alert
      operationId: postAlertExternalId
      parameters:
        - name: alertId
          in: path
          description: alert ID
          required: true
          schema:
            type: integer
            format: int64
            exclusiveMinimum: 0
        - name: integrationId
          in: path
          description: integration ID
          required: true
          schema:
            type: string
            minLength: 1
      requestBody:
        description: Configs used to update existing configs.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalSystemDto'
      responses:
        '201':
          description: Created
        '400':
          description: Bad Request
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'alerts:edit'
        description: Required user permissions for this endpoint
  /v1/alert-workflows/validate:
    post:
      tags:
        - alert-workflows
      summary: Validates an alert workflows.
      description: Validates an alert workflow.
      operationId: validateAlertWorkflow
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BaseWorkflowDto'
      responses:
        '201':
          description: Created
        '400':
          description: Bad Request
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'workflows:edit'
        description: Required user permissions for this endpoint
  /v1/automation-config:
    patch:
      tags:
        - automation-config
      summary: Update automation config for auto close of alerts and incidents.
      description: Update automation config for auto close of alerts and incidents.
      operationId: patchAutomationConfig
      requestBody:
        description: Configs used to update existing configs.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AutomationConfigDto'
      responses:
        '204':
          description: No Content
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'automation:edit'
        description: Required user permissions for this endpoint
    get:
      tags:
        - automation-config
      summary: Get automation config for auto close of alerts and incidents.
      description: Get automation config for auto close of alerts and incidents.
      operationId: getAutomationConfig
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseAutomationConfigDto'
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'automation:view'
        description: Required user permissions for this endpoint
  '/v1/incidents/{incidentId}/comments':
    get:
      tags:
        - incident-comments
      summary: Get all comments of an existing incident
      operationId: getComments
      parameters:
        - name: incidentId
          in: path
          description: ID of the incident to return list of comments. Returns 400 (Invalid ID Supplied) if this value is anything other than a non-negative integer.
          required: true
          schema:
            type: integer
            format: int64
            exclusiveMinimum: 0
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseIncidentCommentResponse'
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'incidents:view'
        description: Required user permissions for this endpoint
    post:
      tags:
        - incident-comments
      summary: Add comment to existing incident
      operationId: addComment
      parameters:
        - name: incidentId
          in: path
          description: Incident id
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        description: Incident comment to be added
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CommentRequestDto'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseIncidentCommentDto'
        '400':
          description: Bad Request
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'incidents:edit'
        description: Required user permissions for this endpoint
  /v1/alerts-search:
    get:
      tags:
        - alerts-search
      summary: Search for alerts for given namespace
      description: Search for alerts matching the following criteria.
      operationId: search
      parameters:
        - name: namespace
          in: query
          description: Namespace of the alerts to search
          required: true
          schema:
            type: string
            minLength: 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseListOfinteger'
                __errors__:
                  '#/components/schemas/MoogResponseListOfinteger': No foreign doc with id components found
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'alerts:view'
        description: Required user permissions for this endpoint
  /v1/alert-workflows/test/bulk:
    post:
      tags:
        - alert-workflows
      summary: 'Tests alert workflows, in bulk.'
      description: 'Tests alert workflows, in bulk.'
      operationId: testAlertWorkflows
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkTestWorkflowDto'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseListOfBulkTestWorkflowResultsDto'
        '400':
          description: Bad Request
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'workflows:edit'
        description: Required user permissions for this endpoint
  /v1/incident-workflows/validate:
    post:
      tags:
        - incident-workflows
      summary: Validates an incident workflow.
      description: Validates an incident workflow.
      operationId: validateIncidentWorkflow
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BaseWorkflowDto'
      responses:
        '201':
          description: Created
        '400':
          description: Bad Request
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'workflows:edit'
        description: Required user permissions for this endpoint
  '/v1/incidents/{incidentId}':
    put:
      tags:
        - incidents
      summary: Update incident information.
      description: Update incident information.
      operationId: updateIncidentPut
      parameters:
        - name: incidentId
          in: path
          description: Id of the incident that is being updated
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        description: Update payload for the incident
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchPayloadDto'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseIncidentDto'
        '400':
          description: Bad Request
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'incidents:edit'
        description: Required user permissions for this endpoint
    patch:
      tags:
        - incidents
      summary: Update the incident to the given status and/or assignee.
      description: Update the incident to the given status and/or assignee.
      operationId: updateIncident
      parameters:
        - name: incidentId
          in: path
          description: Id of the incident that is being updated
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        description: JSON Patch payload for the incident
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchPayloadDto'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseIncidentDto'
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'incidents:edit'
        description: Required user permissions for this endpoint
    get:
      tags:
        - incidents
      summary: Get incident by id.
      description: Get incident by id.
      operationId: getIncident
      parameters:
        - name: incidentId
          in: path
          description: Id of the incident that is being retrieved
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseIncidentDto'
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'incidents:view'
        description: Required user permissions for this endpoint
  '/v1/alerts/{alert_id}/events-timeline':
    get:
      tags:
        - alerts
      summary: List the event timeline buckets associated with the specified alert
      description: 'Get the event timeline buckets that represent the count of event severities, for specified interval and start time'
      operationId: getEventTimelineByAlertId
      parameters:
        - name: bucket_interval
          in: query
          description: Time interval of each bucket (in seconds).
          required: true
          schema:
            type: integer
            format: int64
            exclusiveMinimum: 0
            examples:
              - 3600
          examples:
            default:
              value: 3600
        - name: bucket_start_time
          in: query
          description: 'Start time of the first bucket. If it is not provided, the default will be considered as the first_event_time.'
          schema:
            type: integer
            format: int64
            examples:
              - 1720083965000
          examples:
            default:
              value: 1720083965000
        - name: alert_id
          in: path
          description: 'ID of the alert to use, returns 404 if there is no alert for the alertId.'
          required: true
          schema:
            type: integer
            format: int64
            exclusiveMinimum: 0
            examples:
              - 1
          examples:
            default:
              value: 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseListOfEventTimelineBucket'
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'alerts:view'
        description: Required user permissions for this endpoint
  /v1/operational-stats:
    post:
      tags:
        - operationalStats
      summary: Provides details for operational stats in executive summary
      description: Returns incident trend and time to resolve chart details
      operationId: 'getOperationalStats,'
      requestBody:
        description: Operational stats request
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OperationalStatsRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseOperationalStatsWebResponse'
        '400':
          description: Bad Request
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'incidents:view'
        description: Required user permissions for this endpoint
  /v1/incident-workflows/dependent-on:
    get:
      tags:
        - incident-workflows
      summary: Checks for any alert workflows dependent on a specific resource.
      description: Checks for any alert workflows dependent on a specific resource.
      operationId: getIncidentWorkflowsDependentOnResource
      parameters:
        - name: resource_name
          in: query
          required: true
          schema:
            type: string
            pattern: \S
        - name: resource_type
          in: query
          required: true
          schema:
            $ref: '#/components/schemas/ResourceType'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseListOfWorkflowDependentOnResponseDto'
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value: []
        description: Required user permissions for this endpoint
  '/v1/alerts/{alertId}/snapshot':
    get:
      tags:
        - alerts
      summary: 'Get an alert snapshots, with highest severity.'
      description: The alert returned is a snapshot of the earliest and highest severity.
      operationId: getAlertSnapshot
      parameters:
        - name: alertId
          in: path
          description: ID of the alert to use. Returns 404 if there is no alert for the alertId.
          required: true
          schema:
            type: integer
            format: int64
            exclusiveMinimum: 0
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseAlertDto'
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'alerts:view'
        description: Required user permissions for this endpoint
  /v1/incidents:
    patch:
      tags:
        - incidents
      summary: Update multiple incidents to the given status and/or assignee.
      description: Update the incidents to the given status and/or assignee.
      operationId: updateIncidents
      requestBody:
        description: Bulk update payload for the incidents
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkPatchPayloadDto'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseListOfIncidentDto'
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'incidents:edit'
        description: Required user permissions for this endpoint
    get:
      tags:
        - incidents
      summary: List incidents that match the given filter.
      description: 'List incidents that match the given filter. Note that all GET requests are limited to a maximum of 10,000 items per query.'
      operationId: listIncidents
      parameters:
        - name: User-Agent
          in: header
          schema:
            type: string
        - name: filter
          in: query
          description: Query string to filter the incidents by. The string must be in AIOps query language. You may use any of the columns for filtering.
          schema:
            type: string
            examples:
              - 'class in (Middleware, Hardware)'
          examples:
            default:
              value: 'class in (Middleware, Hardware)'
        - name: jsonFilter
          in: query
          description: 'Return only incidents that match this AG-Grid-style JSON filter, such as {"status":{"values":["open","in progress","resolved"],"filterType":"set"}}'
          deprecated: true
          schema:
            type: string
        - name: jsonSort
          in: query
          description: 'Sort the results according to this AG-Grid-style JSON sort info, such as [{"sort":"asc","colId":"severity"}]'
          deprecated: true
          schema:
            type: string
        - name: keyword
          in: query
          description: Return only incidents that contain these keywords.
          deprecated: true
          schema:
            type: string
            examples:
              - support
          examples:
            default:
              value: support
        - name: limit
          in: query
          description: 'Number of incidents to fetch, after skipping the number specified in the ''start'' parameter if any. Between 1 and 5000'
          schema:
            type: integer
            format: int32
            exclusiveMinimum: 0
            maximum: 5000
            default: '100'
            examples:
              - 100
          examples:
            default:
              value: 100
        - name: start
          in: query
          description: 'Number of incidents to skip. That is, the first incident returned will be object # start + 1.'
          schema:
            type: integer
            format: int32
            minimum: 0
            default: '0'
            examples:
              - 0
          examples:
            default:
              value: 0
        - name: utcOffset
          in: query
          description: The difference in hours from Coordinated Universal Time (UTC) to user's local time.
          schema:
            type: string
            default: GMT
            examples:
              - 'GMT-7/GMT+7:30'
          examples:
            default:
              value: 'GMT-7/GMT+7:30'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseIncidentList'
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'incidents:view'
        description: Required user permissions for this endpoint
    post:
      tags:
        - incidents
      summary: Get a list of all incidents with matching criteria.
      description: 'Get a list of all incidents with matching criteria. Note that all POST requests are limited to a maximum of 10,000 items per query.'
      operationId: listIncidentsPost
      requestBody:
        description: List incidents request specification
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListIncidentsRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseIncidentList'
        '400':
          description: Bad Request
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'incidents:view'
        description: Required user permissions for this endpoint
  /v1/incident-workflows/test:
    post:
      tags:
        - incident-workflows
      summary: Tests an incident workflow.
      description: Tests an incident workflow.
      operationId: testIncidentWorkflow
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkflowTestWrapperDto'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseListOfWorkflowTestResultDto'
        '400':
          description: Bad Request
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'workflows:edit'
        description: Required user permissions for this endpoint
  /v1/alert-workflows/standalone:
    post:
      tags:
        - alert-workflows
      summary: Invokes the given standalone workflow on a single alert.
      description: Invokes the given standalone workflow on a single alert.
      operationId: invokeAlertStandaloneWorkflow
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StandaloneWorkflowInvocationRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseVoid'
        '400':
          description: Bad Request
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'alerts:edit'
        description: Required user permissions for this endpoint
  /v1/incident-filters/columns:
    get:
      tags:
        - incident-filters
      summary: Get column names available for use with incident filters.
      description: 'Column names for filtering incidents in workflows, outbound integrations, etc.'
      operationId: incidentFilterColumnNames
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseColumnsDto'
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value: []
        description: Required user permissions for this endpoint
  '/v1/alerts/{alertId}':
    patch:
      tags:
        - alerts
      summary: Update the "status" or "assignee" or "assigned_groups" field in a specific alert.
      description: Updates a single alert.
      operationId: updateAlert
      parameters:
        - name: alertId
          in: path
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlertUpdateRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseAlertDto'
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'alerts:edit'
        description: Required user permissions for this endpoint
    get:
      tags:
        - alerts
      summary: Get details of the alert with the specified ID.
      description: Returns a single alert.
      operationId: alertDetails
      parameters:
        - name: User-Agent
          in: header
          schema:
            type: string
        - name: alertId
          in: path
          description: ID of the alert to return. Returns 400 (Invalid ID Supplied) if this value is anything other than a non-negative integer.
          required: true
          schema:
            type: integer
            format: int64
            exclusiveMinimum: 0
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseAlertDto'
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'alerts:view'
        description: Required user permissions for this endpoint
  /v1/alert-workflows/inputs:
    get:
      tags:
        - alert-workflows
      summary: Returns inputs previously seen at the input of alert workflow engine.
      description: Returns inputs previously seen at the input of alert workflow engine.
      operationId: getRecentAlerts
      parameters:
        - name: entryFilter
          in: query
          schema:
            type: string
            description: Entry filter for the workflow (can be empty)
        - name: limit
          in: query
          schema:
            type: integer
            description: Maximum number of previously stored inputs to return
            format: int32
            minimum: 1
            default: 100
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseListOfRecentInputDto'
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value: []
        description: Required user permissions for this endpoint
  /v1/alert-filters/validate:
    post:
      tags:
        - alert-filters
      summary: Validate Alert Filter
      operationId: validateAlertFilter
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              minItems: 1
              items:
                $ref: '#/components/schemas/FilterStringDto'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseFilterStringResultDto'
        '400':
          description: Bad Request
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value: []
        description: Required user permissions for this endpoint
  /v1/incident-tags-config:
    patch:
      tags:
        - incident-tags-config
      summary: Update tags config for incidents.
      description: Update tags config for incidents.
      operationId: patchIncidentTagsConfig
      requestBody:
        description: Configs used to update existing configs.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IncidentTagsConfigDto'
      responses:
        '204':
          description: No Content
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'incident-config:edit'
        description: Required user permissions for this endpoint
    get:
      tags:
        - incident-tags-config
      summary: Get tags config for incidents.
      description: Get tags config for incidents.
      operationId: getIncidentTagsConfig
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseIncidentTagsConfigDto'
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'incident-config:view'
        description: Required user permissions for this endpoint
  '/v1/alerts/{alertId}/tags':
    patch:
      tags:
        - alerts
      summary: Overwrite the tags of an alert with the supplied tags.
      description: Updates the tags of an alert.
      operationId: updateAlertTags
      parameters:
        - name: alertId
          in: path
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetAlertTagsPayloadDto'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseAlertDto'
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'alerts:edit'
        description: Required user permissions for this endpoint
  /v1/incident-workflows/test/bulk:
    post:
      tags:
        - incident-workflows
      summary: 'Tests incident workflows, in bulk.'
      description: 'Tests incident workflows, in bulk.'
      operationId: testIncidentWorkflows
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkTestWorkflowDto'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseListOfBulkTestWorkflowResultsDto'
        '400':
          description: Bad Request
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'workflows:edit'
        description: Required user permissions for this endpoint
  '/v1/incidents/{incidentId}/comments/{commentId}':
    patch:
      tags:
        - incident-comments
      summary: update existing comment
      operationId: updateComment
      parameters:
        - name: commentId
          in: path
          description: Comment id
          required: true
          schema:
            type: string
        - name: incidentId
          in: path
          description: Incident id
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        description: Incident comment to be updated
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CommentRequestDto'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseIncidentCommentDto'
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'incidents:edit'
        description: Required user permissions for this endpoint
    delete:
      tags:
        - incident-comments
      summary: Delete comment of an incident
      operationId: deleteComment
      parameters:
        - name: commentId
          in: path
          description: Comment ID
          required: true
          schema:
            type: string
        - name: incidentId
          in: path
          description: Incident ID
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '204':
          description: No Content
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'incidents:edit'
        description: Required user permissions for this endpoint
  /v1/alert-filters/columns:
    get:
      tags:
        - alert-filters
      summary: Get column names available for use with alert filters.
      description: 'Column names for filtering alerts in workflows, outbound integrations, etc.'
      operationId: alertFilterColumnNames
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseColumnsDto'
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value: []
        description: Required user permissions for this endpoint
  '/v1/alerts/{alert_id}/events':
    get:
      tags:
        - alerts
      summary: List event by alertId with given timeline
      description: Get event details for given filter and pagination parameters
      operationId: listEventsByAlertId
      parameters:
        - name: end_time
          in: query
          description: End time to fetch events up to. If not provided then consider alert's last event time as default
          schema:
            type: integer
            format: int64
            examples:
              - 1720083965000
          examples:
            default:
              value: 1720083965000
        - name: limit
          in: query
          description: Maximum number of events to return per page.
          schema:
            type: integer
            format: int32
            exclusiveMinimum: 0
            maximum: 1000
            default: 1000
            examples:
              - 1000
          examples:
            default:
              value: 1000
        - name: offset
          in: query
          description: Number of events to skip
          schema:
            type: integer
            format: int32
            minimum: 0
            default: 0
            examples:
              - 0
          examples:
            default:
              value: 0
        - name: start_time
          in: query
          description: Start time to fetch events from.
          schema:
            type: integer
            format: int64
            examples:
              - 1720083965000
          examples:
            default:
              value: 1720083965000
        - name: alert_id
          in: path
          description: ID of the alert to use. Returns 404 if there is no alert for the alertId.
          required: true
          schema:
            type: integer
            format: int64
            exclusiveMinimum: 0
            examples:
              - 1
          examples:
            default:
              value: 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseEventList'
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'alerts:view'
        description: Required user permissions for this endpoint
  '/v1/alerts/{alertId}/external-ids':
    get:
      tags:
        - alerts
      summary: Get all externalIds associated with the alert.
      description: Get all externalIds associated with the alert. Returns the systemName and all the details
      operationId: getAllAlertExternalIds
      parameters:
        - name: alertId
          in: path
          description: alert ID
          required: true
          schema:
            type: integer
            format: int64
            exclusiveMinimum: 0
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseListOfExternalSystemDto'
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'alerts:view'
        description: Required user permissions for this endpoint
  /v1/situation-room/columns:
    get:
      tags:
        - Situation Room Resource
      summary: Get column names of situation room alert DTO.
      description: Column names for filtering situation room alerts
      operationId: situationAlertDtoColumnNames
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseColumnsDto'
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'alerts:view'
        description: Required user permissions for this endpoint
  /v1/alerts/snapshot:
    post:
      tags:
        - alerts
      summary: 'Get a list of alert snapshots, with highest severity.'
      description: Each alert returned is a snapshot of the earliest and highest severity.
      operationId: listAlertSnapshots
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListSnapshotRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseAlertList'
        '400':
          description: Bad Request
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'alerts:view'
        description: Required user permissions for this endpoint
  '/v1/situation-room/{incidentId}/alerts/unlabeled':
    get:
      tags:
        - alerts
      summary: 'Get alerts for an incident, that are unlabeled'
      description: Get alerts for an incident as recommended alerts to take action on
      operationId: getUnlabeledAlerts
      parameters:
        - name: limit
          in: query
          schema:
            type: integer
            format: int32
            exclusiveMinimum: 0
            default: 100
        - name: rc_bucket
          in: query
          schema:
            $ref: '#/components/schemas/PrcBucket'
        - name: sort_by
          in: query
          required: true
          schema:
            type: string
            enum:
              - rc_probability
              - rc_bucket
            description: Specifies the sort criteria to use
            pattern: ^(rc_probability|rc_bucket)$
            default: rc_probability
        - name: sort_order
          in: query
          required: true
          schema:
            type: object
            description: Sort order
            default: desc
        - name: incidentId
          in: path
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseSituationRoomAlertList'
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'alerts:view'
        description: Required user permissions for this endpoint
  /v1/situation-room/alerts/unlabeled:
    post:
      tags:
        - alerts
      summary: 'Get total count of unlabeled incidents/alerts, for a set of incidents'
      description: 'Count number of incidents and alerts that are unlabeled, given a set of incident IDs'
      operationId: getUnlabeledCount
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UnlabeledRequestDto'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseUnlabeledResponseDto'
        '400':
          description: Bad Request
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'alerts:view'
        description: Required user permissions for this endpoint
  /v1/alerts:
    patch:
      tags:
        - alerts
      summary: Update the "status" or "assignee" or "assigned_groups" field in multiple alerts.
      description: Updates bulk alerts.
      operationId: updateAlerts
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkAlertUpdateRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseListOfAlertDto'
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'alerts:edit'
        description: Required user permissions for this endpoint
    post:
      tags:
        - alerts
      summary: Get a list of all alerts with matching criteria.
      description: 'Get a list of all alerts with matching criteria. Note that all POST requests are limited to a maximum of 10,000 items per query.'
      operationId: listAlertsPost
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListAlertsRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseAlertList'
        '400':
          description: Bad Request
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'alerts:view'
        description: Required user permissions for this endpoint
    get:
      tags:
        - alerts
      summary: Get a list of all alerts with matching criteria.
      description: 'Get a list of all alerts with matching criteria. Note that all GET requests are limited to a maximum of 10,000 items per query.'
      operationId: listAlerts
      parameters:
        - name: User-Agent
          in: header
          schema:
            type: string
        - name: filter
          in: query
          description: Return only alerts that match this filter.<br>Returns **400 (Invalid parameters)** if the filter format is invalid.
          schema:
            type: string
            examples:
              - '''event count'' > 3 AND severity in (Critical, Major, Minor, Warning)'
          examples:
            default:
              value: '''event count'' > 3 AND severity in (Critical, Major, Minor, Warning)'
        - name: jsonFilter
          in: query
          description: 'Return only alerts that match this AG-Grid-style JSON filter, such as {"status":{"values":["open","in progress","resolved"],"filterType":"set"}}'
          deprecated: true
          schema:
            type: string
        - name: jsonSort
          in: query
          description: 'Sort the results according to this AG-Grid-style JSON sort info, such as [{"sort":"asc","colId":"severity"}]'
          deprecated: true
          schema:
            type: string
        - name: keyword
          in: query
          description: Return only alerts that contain these keywords.
          schema:
            type: string
            examples:
              - compute
          examples:
            default:
              value: compute
        - name: limit
          in: query
          description: Maximum number of alerts to return. This is equivalent to the maximum number of alerts per page. Between 1 and 5
          schema:
            type: integer
            format: int32
            exclusiveMinimum: 0
            maximum: 5000
            default: 100
            examples:
              - 100
          examples:
            default:
              value: 100
        - name: start
          in: query
          description: 'The starting offset of alerts to retrieve. The initial offset to use is 0 and thereafter is typically multiples of ''limit''. <b>NOTE:</b> ''start'' + ''limit'' must not exceed 10,000 -- use ''searchAfter'' with the listAlertsPost operation instead.'
          schema:
            type: integer
            format: int32
            minimum: 0
            default: 0
            examples:
              - 0
          examples:
            default:
              value: 0
        - name: utcOffset
          in: query
          description: UTC Offset
          schema:
            type: string
            default: GMT-0
            examples:
              - GMT-0
          examples:
            default:
              value: GMT-0
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseAlertList'
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'alerts:view'
        description: Required user permissions for this endpoint
  '/v1/incidents/{incidentId}/external-ids':
    get:
      tags:
        - incidents
      summary: Get all externalIds associated with the incident.
      description: Get all externalIds associated with the incident. Returns the systemName and all the details
      operationId: getAllIncidentExternalIds
      parameters:
        - name: incidentId
          in: path
          description: incident ID
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseListOfExternalSystemDto'
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'incidents:view'
        description: Required user permissions for this endpoint
  '/v1/incidents/{incidentId}/external-ids/{integrationId}':
    get:
      tags:
        - incidents
      summary: Get details associated with specific external system.
      description: Get details associated with a specific external system in the incident. Returns the systemName and all the details
      operationId: getIncidentExternalId
      parameters:
        - name: incidentId
          in: path
          description: incident ID
          required: true
          schema:
            type: integer
            format: int64
        - name: integrationId
          in: path
          description: integration ID
          required: true
          schema:
            type: string
            minLength: 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseExternalSystemDto'
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'incidents:view'
        description: Required user permissions for this endpoint
    patch:
      tags:
        - incidents
      summary: Update externalID information to an incident.
      description: Updates details about an external system to the incident
      operationId: patchIncidentExternalId
      parameters:
        - name: incidentId
          in: path
          description: incident ID
          required: true
          schema:
            type: integer
            format: int64
        - name: integrationId
          in: path
          description: integration ID
          required: true
          schema:
            type: string
            pattern: \S
      requestBody:
        description: Configs used to update existing configs.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalSystemDto'
      responses:
        '204':
          description: No Content
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'incidents:edit'
        description: Required user permissions for this endpoint
    delete:
      tags:
        - incidents
      summary: Delete externalID information from an incident.
      description: Delete details about an external system in the incident
      operationId: deleteIncidentExternalId
      parameters:
        - name: incidentId
          in: path
          description: incident ID
          required: true
          schema:
            type: integer
            format: int64
        - name: integrationId
          in: path
          description: integration ID
          required: true
          schema:
            type: string
            minLength: 1
      responses:
        '204':
          description: No Content
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'incidents:edit'
        description: Required user permissions for this endpoint
    post:
      tags:
        - incidents
      summary: Add externalID information to an incident.
      description: Add details about an external system to the incident
      operationId: postIncidentExternalId
      parameters:
        - name: incidentId
          in: path
          description: incident ID
          required: true
          schema:
            type: integer
            format: int64
        - name: integrationId
          in: path
          description: integration ID
          required: true
          schema:
            type: string
            pattern: \S
      requestBody:
        description: Configs used to update existing configs.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalSystemDto'
      responses:
        '201':
          description: Created
        '400':
          description: Bad Request
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'incidents:edit'
        description: Required user permissions for this endpoint
  /v1/incident-workflows/standalone:
    post:
      tags:
        - incident-workflows
      summary: Invokes the named standalone workflow on a single incident.
      description: Invokes the named standalone workflow on a single incident.
      operationId: invokeIncidentStandaloneWorkflow
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StandaloneWorkflowInvocationRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseVoid'
        '400':
          description: Bad Request
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value: []
        description: Required user permissions for this endpoint
  '/v1/incidents/{incidentId}/tags':
    patch:
      tags:
        - incidents
      summary: Update the incident with the given tags
      description: 'Update the incident '
      operationId: updateIncidentTags
      parameters:
        - name: incidentId
          in: path
          description: Id of the incident being updated
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        description: Tags to attach to the incident
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetIncidentTagsPayloadDto'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseIncidentDto'
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'incidents:edit'
        description: Required user permissions for this endpoint
  /v1/incident-filters/validate:
    post:
      tags:
        - incident-filters
      summary: Validate Incident Filter
      operationId: validateIncidentFilter
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              minItems: 1
              items:
                $ref: '#/components/schemas/IncidentFilterStrDto'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseIncidentFilterStrResultDto'
        '400':
          description: Bad Request
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value: []
        description: Required user permissions for this endpoint
  /v1/alert-workflows/test:
    post:
      tags:
        - alert-workflows
      summary: Tests an alert workflow.
      description: Tests an alert workflow.
      operationId: testAlertWorkflow
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkflowTestWrapperDto'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseListOfWorkflowTestResultDto'
        '400':
          description: Bad Request
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'workflows:edit'
        description: Required user permissions for this endpoint
  '/v1/situation-room/{incidentId}/alerts':
    post:
      tags:
        - alerts
      summary: 'Get alerts for an incident, for the situation room'
      description: 'Get alerts for an incident, for the situation room'
      operationId: getSituationRoomAlerts
      parameters:
        - name: incidentId
          in: path
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SituationRoomAlertsRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseSituationRoomAlertList'
        '400':
          description: Bad Request
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'alerts:view'
        description: Required user permissions for this endpoint
  /v1/incident-workflows/inputs:
    get:
      tags:
        - incident-workflows
      summary: Returns inputs previously seen at the input of incident workflow engine.
      description: Returns inputs previously seen at the input of incident workflow engine.
      operationId: getRecentIncidents
      parameters:
        - name: entryFilter
          in: query
          schema:
            type: string
            description: Entry filter for the workflow (can be empty)
        - name: limit
          in: query
          schema:
            type: integer
            description: Maximum number of previously stored inputs to return
            format: int32
            minimum: 1
            default: 100
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseListOfRecentInputDto'
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value: []
        description: Required user permissions for this endpoint
  '/v1/situation-room/{incidentId}/timeline':
    get:
      tags:
        - incidents
      summary: Get timeline for an incident
      description: Get timeline for an incident
      operationId: getIncidentTimeline
      parameters:
        - name: incidentId
          in: path
          description: Incident Id
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseListOfIncidentTimelineDto'
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        value:
          - 'incidents:view'
        description: Required user permissions for this endpoint
tags:
  - name: alert-filters
    description: Validate filters for alerts
  - name: alert-workflows
    description: Alert Workflow related endpoints
  - name: alerts
    description: Alerts generated by Moogsoft Cloud
  - name: alerts-search
  - name: autoclose-config
    description: Autoclose config for alerts and incidents
  - name: autoclose-policy
    description: Autoclose policy for alerts and incidents
  - name: automation-config
    description: Automation config for auto close of alerts and incidents
  - name: dashboardSummaryPost
  - name: event-columns
    description: Endpoints relating to getting event columns
  - name: events
    description: Endpoints related to event deduplication
  - name: incident columns resource
    description: Returns incident columns names and types
  - name: incident-comments
    description: 'Get, save and edit incident comments'
  - name: incident-filters
    description: Validate incident filters
  - name: incident-license-restrictions
    description: Incident based license restrictions
  - name: incident-tags-config
    description: Incident tags configuration
  - name: incident-workflows
    description: Incident Workflow endpoints
  - name: incidents
    description: CRUD operations for incidents
  - name: operationalStats
  - name: overviewStats
externalDocs:
  url: 'https://docs.moogsoft.com/en/moogsoft-apis.html'
  description: Find out more about Apex AIOps Incident Management
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      description: API Key for accessing Alerts/Incidents API
      name: apiKey
      in: header
  schemas:
    MoogResponseColumnsDto:
      type: object
      description: Alerts/Incidents API ColumnsDto response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
            - success
        data:
          $ref: '#/components/schemas/ColumnsDto'
      required:
        - status
        - data
    ColumnsDto:
      type: object
      title: Columns Dto
      properties:
        fields:
          type: array
          items:
            $ref: '#/components/schemas/ColumnInfo'
    ColumnInfo:
      type: object
      title: Column Info
      properties:
        colId:
          type: string
        headerName:
          type: string
        cellRenderer:
          type: string
        sortable:
          type: boolean
        hide:
          type: boolean
        filterOptions:
          $ref: '#/components/schemas/FilterOptions'
    FilterOptions:
      type: object
      title: Filter Options
      properties:
        type:
          type: string
        operators:
          type: array
          items:
            $ref: '#/components/schemas/ComparisonType'
        setValues:
          type: array
          items:
            type: string
        category:
          $ref: '#/components/schemas/FieldCategory'
    ComparisonType:
      type: string
      enum:
        - equals
        - notEqual
        - contains
        - notContains
        - startsWith
        - endsWith
        - lessThan
        - lessThanOrEqual
        - greaterThan
        - greaterThanOrEqual
        - inRange
        - blank
        - notBlank
        - exactMatch
        - notExactMatch
      title: Comparison Type
      description: Comparison operator type to use for the filter
    FieldCategory:
      type: string
      enum:
        - primitive
        - array
      title: Field Category
    MoogFailureResponse:
      type: object
      description: Alerts/Incidents API failure response body
      properties:
        status:
          type: string
          description: Failure status indicator (always "failure")
          examples:
            - failure
        message:
          type: string
        additional:
          type: array
          items:
            type: string
      required:
        - status
        - message
    MoogErrorResponse:
      type: object
      description: Alerts/Incidents API error response body
      properties:
        status:
          type: string
          description: Error status indicator (always "error")
          examples:
            - error
        message:
          type: string
        additional:
          type: array
          items:
            type: string
      required:
        - status
        - message
    MoogResponseListOfAutoCloseConfigDto:
      type: object
      description: Alerts/Incidents API AutoCloseConfigDto response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
            - success
        data:
          type: array
          items:
            $ref: '#/components/schemas/AutoCloseConfigDto'
      required:
        - status
        - data
    AutoCloseConfigDto:
      type: object
      title: Auto Close Config Dto
      properties:
        never_auto_close_enabled:
          type: boolean
          description: Indicates whether to use the provided Never Auto Close filters when auto-closing incidents or alerts
        never_auto_close_filters:
          type: array
          description: List of filters used to determine which incidents or alerts will never be auto-closed
          items:
            type: string
        close_alerts_when_all_incidents_closed:
          type: boolean
          description: 'When set to true, alerts will be automatically closed when all related incidents are closed. When set to false, alerts will be automatically closed when any related incident is closed.'
        id:
          type: string
          description: ID of the auto-close config
        type:
          type: string
          description: 'Type of auto-close config, either incident or alert'
        incidents_processed:
          type: integer
          description: Number of incidents processed by the configuration
          format: int32
        alerts_processed:
          type: integer
          description: Number of alerts processed by the configuration
          format: int32
        last_updated:
          $ref: '#/components/schemas/Instant'
          description: Time at which the configuration was last updated
        last_updated_by:
          type: string
          description: Email of the user who last updated the configuration
    Instant:
      type: number
      title: Instant
      format: int64
      examples:
        - '2022-03-10T16:15:50Z'
    MoogResponseAutoCloseConfigDto:
      type: object
      description: Alerts/Incidents API AutoCloseConfigDto response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
            - success
        data:
          $ref: '#/components/schemas/AutoCloseConfigDto'
      required:
        - status
        - data
    MoogResponseListOfAutoClosePolicyDto:
      type: object
      description: Alerts/Incidents API AutoClosePolicyDto response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
            - success
        data:
          type: array
          items:
            $ref: '#/components/schemas/AutoClosePolicyDto'
      required:
        - status
        - data
    AutoClosePolicyDto:
      type: object
      title: Auto Close Policy Dto
      properties:
        name:
          type: string
        type:
          type: string
        description:
          type: string
        filter:
          type: string
        close_resolved_in_seconds:
          type: integer
          format: int64
        close_all_in_seconds:
          type: integer
          format: int64
        id:
          type: string
        created_at:
          $ref: '#/components/schemas/Instant'
        created_by:
          type: string
        last_updated:
          $ref: '#/components/schemas/Instant'
        last_updated_by:
          type: string
    BaseAutoClosePolicyDto:
      type: object
      title: Base Auto Close Policy Dto
      properties:
        name:
          type: string
        type:
          type: string
        description:
          type: string
        filter:
          type: string
        close_resolved_in_seconds:
          type: integer
          format: int64
        close_all_in_seconds:
          type: integer
          format: int64
    MoogResponseAutoClosePolicyDto:
      type: object
      description: Alerts/Incidents API AutoClosePolicyDto response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
            - success
        data:
          $ref: '#/components/schemas/AutoClosePolicyDto'
      required:
        - status
        - data
    SituationRoomAlertsRequestV2:
      type: object
      title: Situation Room Alerts Request V2
      description: Situation Room alerts POST request body.
      properties:
        filter:
          $ref: '#/components/schemas/QueryFilter'
          description: The filter type and object to retrieve data by
        start:
          type: integer
          description: 'The starting offset of alerts to retrieve. The initial offset to use is 0 and thereafter is typically multiples of ''limit''. <b>NOTE:</b> ''start'' + ''limit'' must not exceed 10,000 -- use ''searchAfter'' instead.'
          format: int32
          minimum: 0
          default: 0
        limit:
          type: integer
          description: Maximum number of alerts to return. This is equivalent to the maximum number of alerts per page. Between 1 and 5000
          format: int32
          exclusiveMinimum: 0
          maximum: 5000
          default: 100
        fields:
          type: array
          description: Subset of fields to return (default is all non-null alert fields
          examples:
            - []
          items:
            type: string
      required:
        - filter
    QueryFilter:
      type: object
      title: Query Filter
      description: Types of inputs for the queryFilter.
      oneOf:
        - $ref: '#/components/schemas/SituationTextFilterDto'
        - $ref: '#/components/schemas/SituationJsonFilterDto'
    SituationTextFilterDto:
      type: object
      title: Situation Text Filter Dto
      properties:
        type:
          const: TEXT
          description: Declares text filter type
        filter_object:
          type: string
        sort_criteria:
          $ref: '#/components/schemas/SortCriteriaDto'
      required:
        - type
    SortCriteriaDto:
      type: object
      title: Sort Criteria Dto
      properties:
        sort_by:
          type: string
        sort_order:
          $ref: '#/components/schemas/SortOrder'
    SortOrder:
      type: string
      enum:
        - asc
        - desc
      title: Sort Order
      default: desc
    SituationJsonFilterDto:
      type: object
      title: Situation Json Filter Dto
      properties:
        type:
          const: JSON
          description: Declares json filter type
        filter_object:
          $ref: '#/components/schemas/ColumnFilterMap'
          description: Return only alerts that match this AG-Grid-style JSON filter (See ColumnFilter schema).
        sort_criteria:
          type: array
          description: Sort the results according to this AG-Grid-style JSON sort array.
          examples:
            - - sort: asc
                colId: severity
              - sort: desc
                colId: alert_id
          items:
            $ref: '#/components/schemas/AgGridSortColumn'
      required:
        - type
    AgGridSortColumn:
      type: object
      title: Ag Grid Sort Column
      description: Sorting criteria to use for searches
      properties:
        colId:
          type: string
          description: The column on which to sort
          minLength: 1
        sort:
          type: string
          enum:
            - asc
            - desc
          description: The direction in which to sort
          pattern: asc|desc
      required:
        - colId
        - sort
    MoogResponseSituationRoomAlertList:
      type: object
      description: Alerts/Incidents API SituationRoomAlertList response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
            - success
        data:
          $ref: '#/components/schemas/SituationRoomAlertList'
      required:
        - status
        - data
    SituationRoomAlertList:
      type: object
      title: Situation Room Alert List
      properties:
        result:
          type: array
          items:
            $ref: '#/components/schemas/SituationRoomAlertDto'
        count:
          type: integer
          format: int64
    SituationRoomAlertDto:
      type: object
      title: SituationRoomAlertDetails
      properties:
        status:
          $ref: '#/components/schemas/Status'
          description: alert/incident status
        severity:
          $ref: '#/components/schemas/Severity'
          description: alert/incident severity level
        severity_high_water:
          $ref: '#/components/schemas/Severity'
          description: alert/incident high-water severity level
        assignee:
          type: string
          description: email of the user who is assigned to the alert/incident
          examples:
            - test@moogsoft.com
        assigned_groups:
          type: array
          description: An array of group ids
          examples:
            - - goupid1
              - groupid2
          items:
            type: string
        first_event_time:
          type: integer
          description: Epoch timestamp in seconds of the first event for this alert/incident
          format: int64
          examples:
            - 1607985505
        last_event_time:
          type: integer
          description: Epoch timestamp in seconds of the last event for this alert/incident
          format: int64
          examples:
            - 1607985505
        description:
          type: string
          description: 'description that usually contains the alert/incident ID, source and service'
          examples:
            - |
              1 Source: www.your-source.com Affected retail, support
        status_numeric:
          type: integer
          format: int32
        severity_numeric:
          type: integer
          format: int32
        severity_high_water_numeric:
          type: integer
          format: int32
        alert_id:
          type: integer
          format: int64
        class:
          type: string
        event_count:
          type: integer
          format: int32
        manager_id:
          type: string
        location:
          type: object
          description: Mapping of location name/value pairs
          examples:
            - street: 1234 Battery St.
              city: San Francisco
              state: CA
              postcode: '95454'
        service:
          type: array
          items:
            type: string
        incidents:
          type: array
          items:
            type: integer
            format: int64
        source:
          type: string
        in_maintenance:
          type: boolean
          description: Boolean indicating if the alert is currently in maintenance
        maintenance:
          type: string
          description: The id of the current or most recent maintenance window occurrence the alert was in
        maintenance_windows:
          type: array
          description: Set of all maintenance windows and occurrences the alert has been associated with
          uniqueItems: true
          items:
            $ref: '#/components/schemas/MaintenanceWindowStatDto'
        tags:
          type: object
          description: Mapping of tag name/value pairs
          examples:
            - key1: value1
              key2: value2
        namespace:
          type: string
        manager:
          type: string
        dedupe_key:
          type: string
        created_at:
          type: integer
          description: Epoch timestamp in seconds indicating when the alert was created
          format: int64
          examples:
            - 1607985505
        last_status_change_time:
          type: integer
          format: int64
        alias:
          type: string
        check:
          type: string
        type:
          type: string
        policy:
          type: string
        external_details:
          type: array
          items:
            $ref: '#/components/schemas/ExternalSystemDto'
        external_names:
          type: array
          items:
            type: string
        root_cause:
          $ref: '#/components/schemas/AlertPrc'
    Status:
      type: string
      enum:
        - error
        - open
        - in progress
        - superseded
        - resolved
        - closed
      title: Status
      description: Status for incidents and alerts (case-insensitive)
    Severity:
      type: string
      enum:
        - clear
        - unknown
        - warning
        - minor
        - major
        - critical
      title: Severity
      description: Severity Level (case-insensitive)
    MaintenanceWindowStatDto:
      type: object
      title: Maintenance Window Stat Dto
      properties:
        window_id:
          type: string
          description: unique id of the maintenance window
        occurrence_id:
          type: string
          description: unique id of the maintenance window occurrence
        enter:
          type: integer
          description: Epoch timestamp in millis of when the alert entered maintenance
          format: int64
        exit:
          type: integer
          description: Epoch timestamp in millis of when the alert left maintenance
          format: int64
    ExternalSystemDto:
      type: object
      title: External System Dto
      properties:
        integration_id:
          type: string
        external_name:
          type: string
        external_id:
          type: string
        external_link:
          type: string
        integration_name:
          type: string
        integration_type:
          type: string
    AlertPrc:
      type: object
      title: SituationRoomAlertDetails
      properties:
        rc_probability:
          type: number
          description: 'The computed root cause probability, 0.0 - 1.0, if any'
        rc_label:
          $ref: '#/components/schemas/PrcLabel'
          description: 'The user-assigned label, if any'
        rc_bucket:
          $ref: '#/components/schemas/PrcBucket'
          description: 'The computed level: high, medium, low'
    PrcLabel:
      type: string
      enum:
        - RootCause
        - NonCausal
        - DontKnow
      title: Prc Label
      description: Root-Cause Label (case-insensitive)
    PrcBucket:
      type: string
      enum:
        - High
        - Medium
        - Low
      title: Prc Bucket
      description: Root-Cause Level (case-insensitive)
    MoogResponseOverviewWebResponse:
      type: object
      description: Alerts/Incidents API OverviewWebResponse response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
            - success
        data:
          $ref: '#/components/schemas/OverviewWebResponse'
      required:
        - status
        - data
    OverviewWebResponse:
      type: object
      title: Overview Web Response
      properties:
        incident_count:
          type: integer
          format: int64
        alert_count:
          type: integer
          format: int64
        event_count:
          type: integer
          format: int64
    DashboardSummaryRequest:
      type: object
      title: Dashboard Summary Request
      description: Dashboard summary POST request body
      properties:
        json_filter:
          type: object
          description: Return only incidents that match this AG-Grid-style JSON filter. Each filter can be of a different filterType.
          additionalProperties:
            $ref: '#/components/schemas/ColumnFilter'
          examples:
            - status:
                values:
                  - open
                  - in progress
                  - resolved
                filterType: set
        utc_offset:
          type: string
          description: The difference in hours from Coordinated Universal Time (UTC) to user's local time.
          default: GMT
          examples:
            - 'GMT-7/GMT+7:30'
        tile_by:
          type: string
          description: defines the grouping of alert/incident summary data
          pattern: services|classes|types|^tags\..*
        sort_by:
          $ref: '#/components/schemas/SortBy'
          description: defines the sorting of incident summary data
      required:
        - tile_by
        - sort_by
    ColumnFilter:
      type: object
      title: Column Filter
      description: 'Polymorphic column filter, based upon filterType'
      oneOf:
        - $ref: '#/components/schemas/DateColumnFilter'
        - $ref: '#/components/schemas/NumberColumnFilter'
        - $ref: '#/components/schemas/SetColumnFilter'
        - $ref: '#/components/schemas/TextColumnFilter'
        - $ref: '#/components/schemas/BooleanColumnFilter'
      discriminator:
        propertyName: filterType
        mapping:
          text: '#/components/schemas/TextColumnFilter'
          set: '#/components/schemas/SetColumnFilter'
          number: '#/components/schemas/NumberColumnFilter'
          date: '#/components/schemas/DateColumnFilter'
          boolean: '#/components/schemas/BooleanColumnFilter'
    DateColumnFilter:
      type: object
      title: Date Column Filter
      description: 'Filter a date-based column based on date or date ranges, and a comparison type<br>filterType = "date"'
      properties:
        type:
          $ref: '#/components/schemas/ComparisonType'
          description: Comparison operator
        dateFrom:
          type: string
          description: Date filter value to used with comparison operator
        dateTo:
          type: string
          description: Date filter value to used when comparison operator is inRange
        filterType:
          const: date
          description: Declares date filterType
      required:
        - type
        - filterType
    NumberColumnFilter:
      type: object
      title: Number Column Filter
      description: Filter a numeric column based on numeric value(s) and a comparison type<br>filterType = "number"
      properties:
        type:
          $ref: '#/components/schemas/ComparisonType'
          description: Comparison operator
        filter:
          type: integer
          description: Numeric filter value to used with comparison operator
          format: int64
        filterTo:
          type: integer
          description: Numeric filter value to used when comparison operator is inRange
          format: int64
        filterType:
          const: number
          description: Declares number filterType
      required:
        - type
        - filterType
    SetColumnFilter:
      type: object
      title: Set Column Filter
      description: Filter a column based on a set of values provided for comparison<br>filterType = "set"
      properties:
        type:
          $ref: '#/components/schemas/ComparisonType'
          description: Comparison operator
        values:
          type: array
          description: Set filter value(s) to used with comparison operator
          items:
            type: string
        filterType:
          const: set
          description: Declares set filterType
      required:
        - type
        - values
        - filterType
    TextColumnFilter:
      type: object
      title: Text Column Filter
      description: Filter a text column based on a string comparison<br>filterType = "text"
      properties:
        type:
          $ref: '#/components/schemas/ComparisonType'
          description: Comparison operator
        filter:
          type: string
          description: Text filter value to used with comparison operator
        filterType:
          const: text
          description: Declares text filterType
      required:
        - type
        - filterType
    BooleanColumnFilter:
      type: object
      title: Boolean Column Filter
      description: Filter a boolean column based on a boolean comparison<br>filterType = "boolean"
      properties:
        type:
          $ref: '#/components/schemas/ComparisonType'
          description: Comparison operator
        filter:
          type: boolean
          description: Boolean value to used for comparison
        filterType:
          const: boolean
          description: Declares boolean filterType
      required:
        - type
        - filter
        - filterType
    SortBy:
      type: string
      enum:
        - severity
        - priority
      title: Sort By
      description: Dashboard sort by options
    MoogResponseIncidentSummaryResponse:
      type: object
      description: Alerts/Incidents API IncidentSummaryResponse response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
            - success
        data:
          $ref: '#/components/schemas/IncidentSummaryResponse'
      required:
        - status
        - data
    IncidentSummaryResponse:
      type: object
      title: Incident Summary Response
      properties:
        tiles:
          type: array
          description: dashboard tile data
          items:
            $ref: '#/components/schemas/DashboardTile'
        incident_count:
          type: integer
          description: total incident count for summary view
          format: int64
        alert_count:
          type: integer
          description: total alert count for summary view
          format: int64
        event_count:
          type: integer
          description: total event count for summary view
          format: int64
        open_incident_count:
          type: integer
          description: 'total of open, in progress and resolved incident count for summary view'
          format: int64
        mttr:
          type: number
          description: mean time to resolve(in seconds) for incidents in summary view
          format: double
        mtta:
          type: number
          description: mean time to acknowledge(in seconds) for incidents in summary view
          format: double
    DashboardTile:
      type: object
      title: Dashboard Tile
      properties:
        name:
          type: string
          description: name of the tile
        open_count:
          type: integer
          description: number of "open + in progress + resolved" incidents
          format: int64
        closed_count:
          type: integer
          description: number of closed incidents
          format: int64
        severity_count:
          type: object
          description: this contains per severity counts
          additionalProperties:
            type: integer
            format: int64
          examples:
            - '{critical: 10, major: 10}'
        priority_count:
          type: object
          description: this contains per priority counts
          additionalProperties:
            type: integer
            format: int64
          examples:
            - '{P1: 10, P2: 10}'
    ResourceType:
      const: CATALOG
      title: Resource Type
      description: Representing different types of resources used by workflow action
    MoogResponseListOfWorkflowDependentOnResponseDto:
      type: object
      description: Alerts/Incidents API WorkflowDependentOnResponseDto response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
            - success
        data:
          type: array
          items:
            $ref: '#/components/schemas/WorkflowDependentOnResponseDto'
      required:
        - status
        - data
    WorkflowDependentOnResponseDto:
      type: object
      title: Workflow Dependent On Response Dto
      description: Response DTO used to represent workflow that is dependent on resources
      properties:
        id:
          type: string
          description: ID of the workflow
        name:
          type: string
          description: Name of the workflow
        type:
          $ref: '#/components/schemas/WorkflowType'
          description: Type of the workflow
    WorkflowType:
      type: string
      enum:
        - EVENT
        - ALERT
        - INCIDENT
        - ALERT_STANDALONE
        - INCIDENT_STANDALONE
      title: Workflow Type
    MoogResponseExternalSystemDto:
      type: object
      description: Alerts/Incidents API ExternalSystemDto response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
            - success
        data:
          $ref: '#/components/schemas/ExternalSystemDto'
      required:
        - status
        - data
    BaseWorkflowDto:
      type: object
      title: Base Workflow Dto
      description: Base workflow attributes.
      properties:
        name:
          type: string
          description: Name of the workflow. This name cannot be empty and must be unique.
        description:
          type: string
          description: Optional description of the workflow.
        trigger:
          $ref: '#/components/schemas/WorkflowTriggerDto'
          description: Trigger of the workflow.
        type:
          $ref: '#/components/schemas/WorkflowType'
          description: Type of the workflow.
        priority:
          type: integer
          description: The priority of the workflow.
          format: int32
        steps:
          type: array
          description: List of the configured workflow action(s).
          items:
            $ref: '#/components/schemas/WorkflowActionDto'
      required:
        - name
        - trigger
        - type
        - priority
        - steps
    WorkflowTriggerDto:
      type: object
      title: Workflow Trigger Dto
      description: The trigger definition for a workflow.
      properties:
        type:
          $ref: '#/components/schemas/WorkflowTriggerType'
          description: The workflow trigger type
        entryFilter:
          type: string
          description: Entry filter for the workflow (can be empty)
      required:
        - type
    WorkflowTriggerType:
      type: string
      enum:
        - EVENT_CREATED
        - ALERT_CREATED
        - ALERT_UPDATED
        - ALERT_DEDUPLICATED
        - INCIDENT_CREATED
        - INCIDENT_UPDATED
        - ALERT_CREATED_OR_UPDATED
        - ALERT_CREATED_OR_DEDUPLICATED
        - INCIDENT_CREATED_OR_UPDATED
        - ALERT_INVOKED
        - INCIDENT_INVOKED
      title: Workflow Trigger Type
    WorkflowActionDto:
      type: object
      title: Workflow Action Dto
      description: A configured action.
      properties:
        actionName:
          type: string
          description: Computer name of the action
          minLength: 1
          maxLength: 127
        description:
          type: string
          description: Description of the configured action
        configuration:
          type: object
          description: Configuration for the action
        error:
          type: string
          description: Error message associated with the configured action
          readOnly: true
        valid:
          type: boolean
          description: Indicates if the workflow action is valid
          readOnly: true
      required:
        - actionName
        - configuration
    AutomationConfigDto:
      type: object
      title: Automation Config Dto
      properties:
        closeAlertsWhenAllIncidentsClosed:
          type: boolean
          description: 'When set to true, alerts will be automatically closed when all related incidents are closed. When set to false, alerts will be automatically closed when any related incident is closed.'
        closeResolvedIncidentsInSeconds:
          type: integer
          description: Automatically close resolved incidents that have not been updated for XX seconds
          format: int64
        closeResolvedAlertsInSeconds:
          type: integer
          description: Automatically close resolved alerts that have not been updated for XX seconds
          format: int64
        closeIncidentsInSeconds:
          type: integer
          description: Automatically close any incidents that are older than XX seconds
          format: int64
        closeAlertsInSeconds:
          type: integer
          description: Automatically close any alerts that are older than XX seconds
          format: int64
      required:
        - closeAlertsWhenAllIncidentsClosed
        - closeResolvedIncidentsInSeconds
        - closeResolvedAlertsInSeconds
        - closeIncidentsInSeconds
        - closeAlertsInSeconds
    MoogResponseAutomationConfigDto:
      type: object
      description: Alerts/Incidents API AutomationConfigDto response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
            - success
        data:
          $ref: '#/components/schemas/AutomationConfigDto'
      required:
        - status
        - data
    MoogResponseIncidentCommentResponse:
      type: object
      description: Alerts/Incidents API IncidentCommentResponse response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
            - success
        data:
          $ref: '#/components/schemas/IncidentCommentResponse'
      required:
        - status
        - data
    IncidentCommentResponse:
      type: object
      title: Incident Comment Response
      properties:
        result:
          type: array
          items:
            $ref: '#/components/schemas/IncidentCommentDto'
        count:
          type: integer
          format: int64
        resolving_step_count:
          type: integer
          format: int64
        announcement_count:
          type: integer
          format: int64
        resolvingStepCount:
          type: integer
          description: Use resolving_step_count instead
          format: int64
        announcementCount:
          type: integer
          description: Use announcement_count instead
          format: int64
    IncidentCommentDto:
      type: object
      title: Incident Comment Dto
      description: Comment details which are returned from comments endpoint
      properties:
        comment_id:
          type: string
          description: The unique comment ID of the comment
          examples:
            - 8b5ac7f4-b054-4d2f-9292-380618ecab11
        incident_id:
          type: integer
          description: The unique incident ID of the incident where the comment belongs
          format: int64
          examples:
            - 101
        comment:
          type: string
          description: The comment's message
          examples:
            - This issue has been resolved
        user:
          $ref: '#/components/schemas/CommentUserDto'
          description: The comment owner's user details
        is_edited:
          type: boolean
          description: The flag indicates whether the comment is edited or not
          examples:
            - false
        type:
          $ref: '#/components/schemas/CommentType'
          description: 'The types of comment ''STANDARD'', ''RESOLVING'' & ''ANNOUNCEMENT''. The ''ANNOUNCEMENT'' type is immutable while the other types are interchangeable'
        created_at:
          $ref: '#/components/schemas/Instant'
          description: Epoch timestamp in seconds indicating when the comment was created
        commentId:
          type: string
          description: Use comment_id instead
          x-deprecated: true
        incidentId:
          type: integer
          description: Use incident_id instead
          format: int64
        isEdited:
          type: boolean
          description: Use is_edited instead
          x-deprecated: true
        createdAt:
          $ref: '#/components/schemas/Instant'
          description: Use created_at instead
    CommentUserDto:
      type: object
      title: Comment User Dto
      properties:
        id:
          type: string
        family_name:
          type: string
        given_name:
          type: string
        email:
          type: string
        picture:
          type: string
        familyName:
          type: string
          description: Use family_name instead
          x-deprecated: true
        givenName:
          type: string
          description: Use given_name instead
          x-deprecated: true
    CommentType:
      type: string
      enum:
        - STANDARD
        - RESOLVING
        - ANNOUNCEMENT
      title: Comment Type
      description: CommentType for incidents comments
    CommentRequestDto:
      type: object
      title: Comment Request Dto
      description: Comment details which are needed to create a comment
      properties:
        comment:
          type: string
          description: The comment's message
          examples:
            - This issue has been resolved
        type:
          $ref: '#/components/schemas/CommentType'
          description: 'The types of comment ''STANDARD'', ''RESOLVING'' & ''ANNOUNCEMENT''. The ''ANNOUNCEMENT'' type is immutable while the other types are interchangeable'
    MoogResponseIncidentCommentDto:
      type: object
      description: Alerts/Incidents API IncidentCommentDto response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
            - success
        data:
          $ref: '#/components/schemas/IncidentCommentDto'
      required:
        - status
        - data
    BulkTestWorkflowDto:
      type: object
      title: Bulk Test Workflow Dto
      description: A bulk test workflow representing multiple workflows and test inputs.
      properties:
        triggerType:
          $ref: '#/components/schemas/WorkflowTriggerType'
          description: The workflow trigger type
        workflows:
          type: array
          description: The list of workflows to test with
          items:
            $ref: '#/components/schemas/WorkflowDto'
        inputs:
          type: array
          description: The list of inputs for the bulk workflow test
          items:
            type: object
      required:
        - triggerType
        - workflows
        - inputs
    WorkflowDto:
      type: object
      title: Workflow Dto
      description: Workflow with base and generated attributes.
      properties:
        name:
          type: string
          description: Name of the workflow. This name cannot be empty and must be unique.
        description:
          type: string
          description: Optional description of the workflow.
        trigger:
          $ref: '#/components/schemas/WorkflowTriggerDto'
          description: Trigger of the workflow.
        type:
          $ref: '#/components/schemas/WorkflowType'
          description: Type of the workflow.
        priority:
          type: integer
          description: The priority of the workflow.
          format: int32
        steps:
          type: array
          description: List of the configured workflow action(s).
          items:
            $ref: '#/components/schemas/WorkflowActionDto'
        id:
          type: string
          description: ID of the workflow
          readOnly: true
        createdBy:
          type: string
          description: Creator of the workflow
          readOnly: true
        lastUpdatedBy:
          type: string
          description: Creator of the workflow
          readOnly: true
        status:
          $ref: '#/components/schemas/WorkflowStatus'
          description: Status of the workflow
        metrics:
          $ref: '#/components/schemas/WorkflowMetricsDto'
          description: Metrics about the running workflow
        test:
          $ref: '#/components/schemas/WorkflowTestResultDto'
          description: The last asynchronous test results for the workflow
        lastUpdated:
          $ref: '#/components/schemas/Instant'
          description: The last updated time in milliseconds
        created:
          $ref: '#/components/schemas/Instant'
          description: The created time in milliseconds
        valid:
          type: boolean
          description: Indicates if the workflow-actions are valid
          readOnly: true
      required:
        - name
        - trigger
        - type
        - priority
        - steps
    WorkflowStatus:
      type: string
      enum:
        - DELETED
        - NOT_RUNNING
        - RUNNING
      title: Workflow Status
    WorkflowMetricsDto:
      type: object
      title: Workflow Metrics Dto
      description: Metrics about a running workflow.
      properties:
        processed:
          type: integer
          description: Number processed
          format: int64
        errors:
          type: integer
          description: Number processed with error
          format: int64
        skipped:
          type: integer
          description: Number of events ignored
          format: int64
        discarded:
          type: integer
          description: Number of events discarded
          format: int64
        filterMetrics:
          $ref: '#/components/schemas/FilterMetricsDto'
          description: The metrics for the workflow filter
        actionMetricsMap:
          type: object
          description: Map of the action name to action metrics
          additionalProperties:
            $ref: '#/components/schemas/ActionMetricsDto'
        highWatermarkProcessingDurationMillis:
          type: integer
          description: The highest watermark for processing duration (0 indicates less then 1ms)
          format: int64
        averageProcessingDurationMillis:
          type: integer
          description: The average processing duration (0 indicates less then 1ms)
          format: int64
        lowWatermarkProcessingDurationMillis:
          type: integer
          description: The lowest watermark for processing duration (0 indicates less then 1ms)
          format: int64
        lastException:
          type: string
          description: A description of the last exception that occurred any where in the workflow
        lastExceptionMillis:
          type: integer
          description: The time in millis when the exception occurred
          format: int64
        generalError:
          type: string
          description: A general error that occurred outside of the workflow
        generalErrorMillis:
          type: integer
          description: The time in millis when the general error occurred
          format: int64
    FilterMetricsDto:
      type: object
      title: Filter Metrics Dto
      description: Metrics about a running filter.
      properties:
        included:
          type: integer
          description: Number included in the workflow
          format: int64
        excluded:
          type: integer
          description: Number excluded from the workflow
          format: int64
        errors:
          type: integer
          description: Number processed with error
          format: int64
        processed:
          type: integer
          description: Number processed
          format: int64
        highWatermarkProcessingDurationMillis:
          type: integer
          description: The highest watermark for processing duration (0 indicates less then 1ms)
          format: int64
        averageProcessingDurationMillis:
          type: integer
          description: The average processing duration (0 indicates less then 1ms)
          format: int64
        lowWatermarkProcessingDurationMillis:
          type: integer
          description: The lowest watermark for processing duration (0 indicates less then 1ms)
          format: int64
    ActionMetricsDto:
      type: object
      title: Action Metrics Dto
      description: Metrics about a running action.
      properties:
        actionName:
          type: string
          description: The computer name for the action
        processed:
          type: integer
          description: Number processed
          format: int64
        errors:
          type: integer
          description: Number processed with error
          format: int64
        highWatermarkProcessingDurationMillis:
          type: integer
          description: The highest watermark for processing duration (0 indicates less then 1ms)
          format: int64
        averageProcessingDurationMillis:
          type: integer
          description: The average processing duration (0 indicates less then 1ms)
          format: int64
        lowWatermarkProcessingDurationMillis:
          type: integer
          description: The lowest watermark for processing duration (0 indicates less then 1ms)
          format: int64
        skipped:
          type: integer
          description: Number of events skipped
          format: int64
        discarded:
          type: integer
          description: Number of events discarded
          format: int64
    WorkflowTestResultDto:
      type: object
      title: Workflow Test Result Dto
      description: Test results for a workflow.
      properties:
        status:
          $ref: '#/components/schemas/WorkflowTestStatus'
          description: Status of the test
        input:
          type: object
          description: Input for the workflow test
        output:
          type: object
          description: Output of the workflow test
        startMillis:
          type: integer
          description: Start time in millis of the workflow test
          format: int64
        endMillis:
          type: integer
          description: End time in millis of the workflow test
          format: int64
        filterTest:
          $ref: '#/components/schemas/FilterTestDto'
          description: Test results for the filter
        actionsTestList:
          type: array
          description: List of test results for each action
          items:
            $ref: '#/components/schemas/ActionTestDto'
        exception:
          type: string
          description: Description of any exceptions that occurred
        generalError:
          type: string
          description: Description of any error that occurred outside of the workflow
        skipped:
          type: boolean
          description: Input was skipped by one of the workflow actions
        discarded:
          type: boolean
          description: Input was discarded by one of the workflow actions
    WorkflowTestStatus:
      type: string
      enum:
        - RUNNING
        - FAILED
        - SUCCESS
      title: Workflow Test Status
    FilterTestDto:
      type: object
      title: Filter Test Dto
      description: Test results for a filter.
      properties:
        input:
          type: object
          description: Input for the filter
        startMillis:
          type: integer
          description: Start time in millis of the filter
          format: int64
        endMillis:
          type: integer
          description: End time in millis of the filter
          format: int64
        result:
          type: boolean
          description: Boolean result of running the filter
        exception:
          type: string
          description: Description of any exceptions that occurred
    ActionTestDto:
      type: object
      title: Action Test Dto
      description: Test results for an action.
      properties:
        actionName:
          type: string
          description: The computer name of the action
        input:
          type: object
          description: Input for the action
        output:
          type: object
          description: Output from the action
        startMillis:
          type: integer
          description: Start time in millis of the workflow action
          format: int64
        endMillis:
          type: integer
          description: End time in millis of the workflow action
          format: int64
        exception:
          type: string
          description: Description of any exceptions that occurred
        skipped:
          type: boolean
          description: Input was skipped by the workflow action
        discarded:
          type: boolean
          description: Input was discarded by the workflow action
        outputViolations:
          type: array
          description: Validation error messages generated while validating the action output
          items:
            type: string
    MoogResponseListOfBulkTestWorkflowResultsDto:
      type: object
      description: Alerts/Incidents API BulkTestWorkflowResultsDto response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
            - success
        data:
          type: array
          items:
            $ref: '#/components/schemas/BulkTestWorkflowResultsDto'
      required:
        - status
        - data
    BulkTestWorkflowResultsDto:
      type: object
      title: Bulk Test Workflow Results Dto
      description: A bulk test workflow results.
      properties:
        input:
          type: object
          description: Original input provided to the workflows under test
        workflows:
          type: array
          description: Workflow status and test results for each workflow tested
          items:
            $ref: '#/components/schemas/WorkflowDto'
    PatchPayloadDto:
      type: object
      title: Patch Payload Dto
      description: Incident update payload
      properties:
        status:
          $ref: '#/components/schemas/Status'
          description: status that gets assigned to the incident
        assignee:
          type: string
          description: user email that gets assigned to the incident
          examples:
            - exampleUser@moogsoft.com
        assigned_groups:
          type: array
          description: 'An array of group ids or group names, returns error if any of them not found'
          examples:
            - - goupid1
              - groupid2
          items:
            type: string
        description:
          type:
            - string
            - 'null'
          description: Allows for overriding calculated description with a manual one. Restore calculated behavior by setting to an empty string.
          maxLength: 32500
          examples:
            - New description text
        priority:
          $ref: '#/components/schemas/Priority'
        impact:
          $ref: '#/components/schemas/Impact'
        urgency:
          $ref: '#/components/schemas/Urgency'
    Priority:
      type: string
      enum:
        - P1
        - P2
        - P3
        - P4
        - P5
      title: Priority
      description: Priority of an incident
    Impact:
      type: string
      enum:
        - high
        - medium
        - low
      title: Impact
      description: Impact of an incident
    Urgency:
      type: string
      enum:
        - high
        - medium
        - low
      title: Urgency
      description: Urgency of an incident
    MoogResponseIncidentDto:
      type: object
      description: Alerts/Incidents API IncidentDto response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
            - success
        data:
          $ref: '#/components/schemas/IncidentDto'
      required:
        - status
        - data
    IncidentDto:
      type: object
      title: Incident Dto
      description: Incidents returned from list endpoint
      properties:
        status:
          $ref: '#/components/schemas/Status'
          description: alert/incident status
        severity:
          $ref: '#/components/schemas/Severity'
          description: alert/incident severity level
        severity_high_water:
          $ref: '#/components/schemas/Severity'
          description: alert/incident high-water severity level
        assignee:
          type: string
          description: email of the user who is assigned to the alert/incident
          examples:
            - test@moogsoft.com
        assigned_groups:
          type: array
          description: An array of group ids
          examples:
            - - goupid1
              - groupid2
          items:
            type: string
        first_event_time:
          type: integer
          description: Epoch timestamp in seconds of the first event for this alert/incident
          format: int64
          examples:
            - 1607985505
        last_event_time:
          type: integer
          description: Epoch timestamp in seconds of the last event for this alert/incident
          format: int64
          examples:
            - 1607985505
        description:
          type: string
          description: 'description that usually contains the alert/incident ID, source and service'
          examples:
            - |
              1 Source: www.your-source.com Affected retail, support
        status_numeric:
          type: integer
          format: int32
        severity_numeric:
          type: integer
          format: int32
        severity_high_water_numeric:
          type: integer
          format: int32
        incident_id:
          type: integer
          description: incident ID
          format: int64
          examples:
            - 101
        closed_on:
          type: integer
          description: Epoch timestamp in seconds indicating when the incident was closed
          format: int64
          examples:
            - 1607985505
        created_at:
          type: integer
          description: Epoch timestamp in seconds indicating when the incident was created
          format: int64
          examples:
            - 1607985505
        classes:
          type: array
          description: incident classes
          items:
            type: string
        services:
          type: array
          description: incident services
          items:
            type: string
        in_progress_on:
          type: integer
          description: Epoch timestamp in seconds indicating when the incident was moved to in progress
          format: int64
          examples:
            - 1607985505
        last_state_change:
          type: integer
          description: Epoch timestamp in seconds indicating when the incident status was changed
          format: int64
          examples:
            - 1607985505
        resolved_on:
          type: integer
          description: Epoch timestamp in seconds indicating when the incident was resolved
          format: int64
          examples:
            - 1607985505
        superseded_on:
          type: integer
          description: Epoch timestamp in seconds indicating when the incident was superseded
          format: int64
          examples:
            - 1607985505
        superseded_by:
          type: integer
          description: the superseded by incident ID
          format: int64
          examples:
            - 33
        merged_into_incident:
          type: integer
          description: the ID of the incident that this incident was merged into
          format: int64
          examples:
            - 33
        correlation_definition:
          type: string
          description: correlation definition uuid used to create the incident
          examples:
            - a551ab9f-c5ab-4dfe-a52d-b325393176af
        source_correlation_name:
          type: string
          description: correlation definition name used to create the incident
          examples:
            - Similar Sources
        tags:
          type: object
          description: the tags belong to the incident
          additionalProperties:
            type: array
            items:
              type: string
        types:
          type: array
          description: the unique types belong to the incident
          items:
            type: string
        policies:
          type: array
          description: the unique policies belong to the incident
          items:
            type: string
        alerts:
          type: array
          items:
            type: integer
            format: int64
        maintenance_windows:
          type: array
          description: Set of all maintenance windows and occurrences the incident has been associated with
          items:
            $ref: '#/components/schemas/MaintenanceWindowStatDto'
        auto_closed_on:
          type: integer
          format: int64
        priority:
          $ref: '#/components/schemas/Priority'
        impact:
          $ref: '#/components/schemas/Impact'
        urgency:
          $ref: '#/components/schemas/Urgency'
        external_details:
          type: array
          items:
            $ref: '#/components/schemas/ExternalSystemDto'
        comments:
          type: array
          items:
            $ref: '#/components/schemas/CommentDto'
        sources:
          type: array
          description: incident sources
          items:
            type: string
        total_alerts:
          type: integer
          description: the total alerts belong to the incident
          format: int64
          examples:
            - 30
        external_names:
          type: array
          items:
            type: string
        in_maintenance:
          type: boolean
        manual_description_set:
          type: boolean
        priority_numeric:
          type: integer
          format: int32
        resolving_steps:
          type: integer
          description: the total number of resolving steps
          format: int64
          examples:
            - 30
        resolve_time:
          type: integer
          description: 'Time taken to resolve, resolved or closed incidents (in seconds).'
          format: int64
    CommentDto:
      type: object
      title: Comment Dto
      properties:
        id:
          type: string
        comment:
          type: string
        created_by:
          type: string
        created_at:
          type: integer
          format: int64
        is_resolving_step:
          type: boolean
          writeOnly: true
        type:
          $ref: '#/components/schemas/CommentType'
        is_edited:
          type: boolean
    MoogResponseListOfEventTimelineBucket:
      type: object
      description: Alerts/Incidents API EventTimelineBucket response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
            - success
        data:
          type: array
          items:
            $ref: '#/components/schemas/EventTimelineBucket'
      required:
        - status
        - data
    EventTimelineBucket:
      type: object
      title: Event Timeline Bucket
      properties:
        start_time:
          type: integer
          description: Bucket start time in epoch timestamp in milliseconds
          format: int64
          examples:
            - 1720083965000
        end_time:
          type: integer
          description: Bucket end time in epoch timestamp in milliseconds
          format: int64
          examples:
            - 1720084565000
        severity_count:
          type: object
          description: Bucket severity count
          additionalProperties:
            type: integer
            format: int32
          examples:
            - critical: 5
              major: 2
              minor: 3
    OperationalStatsRequest:
      type: object
      title: Operational Stats Request
      description: Executive summary request body
      properties:
        start:
          type: integer
          description: Epoch timestamp(in milliseconds) used to filter out the results based on created at
          format: int64
          exclusiveMinimum: 0
        end:
          type: integer
          description: Epoch timestamp(in milliseconds) used to filter out the results till this time
          format: int64
          exclusiveMinimum: 0
        bucket_size:
          $ref: '#/components/schemas/HistogramInterval'
          description: Bucket size is used to fetch incident trend results per hour/day
        utc_offset:
          type: string
          description: The difference in hours from Coordinated Universal Time (UTC) to user's local time use for incident trend results
          default: GMT
          examples:
            - 'GMT-7/GMT+7:30'
        resource:
          $ref: '#/components/schemas/TopResourcesType'
          description: resource type to fetch
      required:
        - start
        - end
        - bucket_size
    HistogramInterval:
      type: string
      enum:
        - hour
        - day
      title: Histogram Interval
      description: Histogram calendar interval
    TopResourcesType:
      type: string
      enum:
        - services
        - sources
      title: Top Resources Type
      description: Top Resources Type to fetch
    MoogResponseOperationalStatsWebResponse:
      type: object
      description: Alerts/Incidents API OperationalStatsWebResponse response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
            - success
        data:
          $ref: '#/components/schemas/OperationalStatsWebResponse'
      required:
        - status
        - data
    OperationalStatsWebResponse:
      type: object
      title: Operational Stats Web Response
      description: Incident Operational stats response
      properties:
        time_to_resolve:
          $ref: '#/components/schemas/TimeToResolveDto'
          description: Time to resolve aggregated result of incidents
        incident_trend:
          type: array
          description: Incident trend list by severity
          items:
            $ref: '#/components/schemas/IncidentTrendDto'
        top_resources:
          type: array
          description: Incident top 20 resources list
          items:
            $ref: '#/components/schemas/IncidentTopResourcesDto'
    TimeToResolveDto:
      type: object
      title: Time To Resolve Dto
      description: Incidents resolution details
      properties:
        mttr_mins:
          type: number
          description: mean time to resolution(in minutes)
          format: double
        buckets:
          type: array
          description: List of time to resolve aggregated results
          items:
            $ref: '#/components/schemas/TimeToResolveBucketDto'
    TimeToResolveBucketDto:
      type: object
      title: Time To Resolve Bucket Dto
      properties:
        index:
          type: integer
          description: Time taken to resolve incident in hours range
          format: int64
          examples:
            - '0, 2, 5 where 0 means incidents resolved in 0 to 1hr, 5 means 5 to 6hr'
        incident_count:
          type: integer
          description: Total incidents resolved
          format: int64
    IncidentTrendDto:
      type: object
      title: Incident Trend Dto
      description: Incident trend data for the provided time period
      properties:
        incident_time:
          type: integer
          description: Incident creation time
          format: int64
        incident_severity:
          type: object
          description: Incident counts by severity
          additionalProperties:
            type: integer
            format: int64
    IncidentTopResourcesDto:
      type: object
      title: Incident Top Resources Dto
      description: Incident top resources for the provided time period
      properties:
        resource:
          type: string
          description: Incident resource name
        incident_count:
          type: integer
          description: Total incident count against the resource
          format: int64
        incident_severity:
          type: object
          description: Incident counts by severity
          additionalProperties:
            type: integer
            format: int64
    MoogResponseAlertDto:
      type: object
      description: Alerts/Incidents API AlertDto response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
            - success
        data:
          $ref: '#/components/schemas/AlertDto'
      required:
        - status
        - data
    AlertDto:
      type: object
      title: AlertDetails
      properties:
        status:
          $ref: '#/components/schemas/Status'
          description: alert/incident status
        severity:
          $ref: '#/components/schemas/Severity'
          description: alert/incident severity level
        severity_high_water:
          $ref: '#/components/schemas/Severity'
          description: alert/incident high-water severity level
        assignee:
          type: string
          description: email of the user who is assigned to the alert/incident
          examples:
            - test@moogsoft.com
        assigned_groups:
          type: array
          description: An array of group ids
          examples:
            - - goupid1
              - groupid2
          items:
            type: string
        first_event_time:
          type: integer
          description: Epoch timestamp in seconds of the first event for this alert/incident
          format: int64
          examples:
            - 1607985505
        last_event_time:
          type: integer
          description: Epoch timestamp in seconds of the last event for this alert/incident
          format: int64
          examples:
            - 1607985505
        description:
          type: string
          description: 'description that usually contains the alert/incident ID, source and service'
          examples:
            - |
              1 Source: www.your-source.com Affected retail, support
        status_numeric:
          type: integer
          format: int32
        severity_numeric:
          type: integer
          format: int32
        severity_high_water_numeric:
          type: integer
          format: int32
        alert_id:
          type: integer
          format: int64
        class:
          type: string
        event_count:
          type: integer
          format: int32
        manager_id:
          type: string
        location:
          type: object
          description: Mapping of location name/value pairs
          examples:
            - street: 1234 Battery St.
              city: San Francisco
              state: CA
              postcode: '95454'
        service:
          type: array
          items:
            type: string
        incidents:
          type: array
          items:
            type: integer
            format: int64
        source:
          type: string
        in_maintenance:
          type: boolean
          description: Boolean indicating if the alert is currently in maintenance
        maintenance:
          type: string
          description: The id of the current or most recent maintenance window occurrence the alert was in
        maintenance_windows:
          type: array
          description: Set of all maintenance windows and occurrences the alert has been associated with
          uniqueItems: true
          items:
            $ref: '#/components/schemas/MaintenanceWindowStatDto'
        tags:
          type: object
          description: Mapping of tag name/value pairs
          examples:
            - key1: value1
              key2: value2
        namespace:
          type: string
        manager:
          type: string
        dedupe_key:
          type: string
        created_at:
          type: integer
          description: Epoch timestamp in seconds indicating when the alert was created
          format: int64
          examples:
            - 1607985505
        last_status_change_time:
          type: integer
          format: int64
        alias:
          type: string
        check:
          type: string
        type:
          type: string
        policy:
          type: string
        external_details:
          type: array
          items:
            $ref: '#/components/schemas/ExternalSystemDto'
        external_names:
          type: array
          items:
            type: string
    BulkPatchPayloadDto:
      type: object
      title: Bulk Patch Payload Dto
      description: Incident bulk update payload
      properties:
        status:
          $ref: '#/components/schemas/Status'
          description: status that gets assigned to the incident
        assignee:
          type: string
          description: user email that gets assigned to the incident
          examples:
            - exampleUser@moogsoft.com
        assigned_groups:
          type: array
          description: 'An array of group ids or group names, returns error if any of them not found'
          examples:
            - - goupid1
              - groupid2
          items:
            type: string
        description:
          type:
            - string
            - 'null'
          description: Allows for overriding calculated description with a manual one. Restore calculated behavior by setting to an empty string.
          maxLength: 32500
          examples:
            - New description text
        priority:
          $ref: '#/components/schemas/Priority'
        impact:
          $ref: '#/components/schemas/Impact'
        urgency:
          $ref: '#/components/schemas/Urgency'
        ids:
          type: array
          description: Unique incident ids to update
          minItems: 1
          uniqueItems: true
          items:
            type: integer
            format: int64
      required:
        - ids
    MoogResponseListOfIncidentDto:
      type: object
      description: Alerts/Incidents API IncidentDto response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
            - success
        data:
          type: array
          items:
            $ref: '#/components/schemas/IncidentDto'
      required:
        - status
        - data
    MoogResponseIncidentList:
      type: object
      description: Alerts/Incidents API IncidentList response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
            - success
        data:
          $ref: '#/components/schemas/IncidentList'
      required:
        - status
        - data
    IncidentList:
      type: object
      title: Incident List
      properties:
        result:
          type: array
          items:
            $ref: '#/components/schemas/IncidentDto'
        count:
          type: integer
          format: int64
        search_after:
          type: array
          description: 'When needing to scroll through a large number of incidents, the value of this field can be provided to the ''searchAfter'' parameter of the next query invocation.'
    ListIncidentsRequest:
      type: object
      title: List Incidents Request
      description: List incidents POST request body
      properties:
        start:
          type: integer
          description: 'Number of incidents to skip. That is, the first incident returned will be object # start + 1.'
          format: int32
          minimum: 0
          default: 0
          examples:
            - 0
        limit:
          type: integer
          description: 'Number of incidents to fetch, after skipping the number specified in the ''start'' parameter if any. Between 1 and 5000'
          format: int32
          exclusiveMinimum: 0
          maximum: 5000
          default: 100
          examples:
            - 100
        json_filter:
          type: object
          description: Return only incidents that match this AG-Grid-style JSON filter. Each filter can be of a different filterType.
          additionalProperties:
            $ref: '#/components/schemas/ColumnFilter'
          examples:
            - status:
                values:
                  - open
                  - in progress
                  - resolved
                filterType: set
        json_sort:
          type: array
          description: Sort the results according to this AG-Grid-style JSON sort info.
          examples:
            - - sort: asc
                colId: severity
          items:
            $ref: '#/components/schemas/AgGridSortColumn'
        keyword:
          type: string
          description: Return only incidents that contain these keywords.
          examples:
            - support
        utc_offset:
          type: string
          description: The difference in hours from Coordinated Universal Time (UTC) to user's local time.
          default: GMT
          examples:
            - 'GMT-7/GMT+7:30'
        search_after:
          type: array
          description: 'When needing to scroll through a large number of incidents, this parameter can be used instead of ''start'' to proceed with incidents that follow the previous search result. The ''searchAfter'' from the previous response must be provided along with the same filter and sort criteria. All results are exhausted when a search response includes no more incidents.'
        fields:
          type: array
          description: Subset of fields to return (default is all non-null incident fields
          items:
            type: string
    WorkflowTestWrapperDto:
      type: object
      title: Workflow Test Wrapper Dto
      description: A test workflow representing a workflow and test input.
      properties:
        name:
          type: string
          description: Name of the workflow. This name cannot be empty and must be unique.
        description:
          type: string
          description: Optional description of the workflow.
        trigger:
          $ref: '#/components/schemas/WorkflowTriggerDto'
          description: Trigger of the workflow.
        type:
          $ref: '#/components/schemas/WorkflowType'
          description: Type of the workflow.
        priority:
          type: integer
          description: The priority of the workflow.
          format: int32
        steps:
          type: array
          description: List of the configured workflow action(s).
          items:
            $ref: '#/components/schemas/WorkflowActionDto'
        id:
          type: string
          description: ID of the workflow if it has already been saved
        input:
          type: array
          description: The input or list of inputs for the workflow test
          minItems: 1
          items:
            type: object
      required:
        - name
        - trigger
        - type
        - priority
        - steps
        - input
    MoogResponseListOfWorkflowTestResultDto:
      type: object
      description: Alerts/Incidents API WorkflowTestResultDto response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
            - success
        data:
          type: array
          items:
            $ref: '#/components/schemas/WorkflowTestResultDto'
      required:
        - status
        - data
    StandaloneWorkflowInvocationRequest:
      type: object
      title: Standalone Workflow Invocation Request
      description: Request for invoking a standalone workflow
      properties:
        workflow_id:
          type: string
          description: The id of the workflow to invoke.
        workflow_context:
          type: object
          description: Additional workflow context information.
        ids:
          type: array
          description: The ids of the workflow target.
          minItems: 1
          items:
            type: integer
            format: int64
      required:
        - workflow_id
        - workflow_context
        - ids
    MoogResponseVoid:
      type: object
      description: Empty (no data) response
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
            - success
      required:
        - status
    AlertUpdateRequest:
      type: object
      title: Alert Update Request
      properties:
        status:
          $ref: '#/components/schemas/Status'
        assignee:
          type: string
          description: 'Username of the assignee, specified as one string. Returns an error if the username is not found.'
          examples:
            - john.doe@company.com
        assigned_groups:
          type: array
          description: 'An array of group ids or group names, returns error if any of them not found'
          examples:
            - - groupid1
              - groupid2
          uniqueItems: true
          items:
            type: string
    MoogResponseListOfRecentInputDto:
      type: object
      description: Alerts/Incidents API RecentInputDto response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
            - success
        data:
          type: array
          items:
            $ref: '#/components/schemas/RecentInputDto'
      required:
        - status
        - data
    RecentInputDto:
      type: object
      title: Recent Input Dto
      description: Previously stored sample of input data
      properties:
        id:
          type: string
          description: The unique id of the input data
        type:
          type: string
          description: The workflow type
        data:
          type: object
          description: The raw data itself
    FilterStringDto:
      type: object
      title: Filter String Dto
      description: A filter string to validate
      properties:
        filterString:
          type: string
          description: The filter string to validate
          pattern: \S
          examples:
            - severity = Clear AND source = www.my-source.com
      required:
        - filterString
    MoogResponseFilterStringResultDto:
      type: object
      description: Alerts/Incidents API FilterStringResultDto response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
            - success
        data:
          $ref: '#/components/schemas/FilterStringResultDto'
      required:
        - status
        - data
    FilterStringResultDto:
      type: object
      title: Filter String Result Dto
      description: The result of validating a filter string
      properties:
        isValid:
          type: boolean
    IncidentTagsConfigDto:
      type: object
      title: Incident Tags Config Dto
      properties:
        tags_propagation:
          type: boolean
          description: Flag to enable/disable incident tags propagation
        tags:
          type: array
          description: List of flags to propagate. NULL will propagate all. Empty will propagate none.
          items:
            type: string
        tagsPropagation:
          type: boolean
          description: Use tags_propagation instead
          x-deprecated: true
      required:
        - tags_propagation
    MoogResponseIncidentTagsConfigDto:
      type: object
      description: Alerts/Incidents API IncidentTagsConfigDto response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
            - success
        data:
          $ref: '#/components/schemas/IncidentTagsConfigDto'
      required:
        - status
        - data
    SetAlertTagsPayloadDto:
      type: object
      title: Set Alert Tags Payload Dto
      properties:
        tags:
          type: object
          description: The tags being added to the alert.
          additionalProperties:
            type: string
      required:
        - tags
    MoogResponseEventList:
      type: object
      description: Alerts/Incidents API EventList response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
            - success
        data:
          $ref: '#/components/schemas/EventList'
      required:
        - status
        - data
    EventList:
      type: object
      title: Event List
      properties:
        total_results:
          type: integer
          format: int32
        results:
          type: array
          items:
            $ref: '#/components/schemas/EventTimelineDto'
    EventTimelineDto:
      type: object
      title: Event Timeline Dto
      properties:
        event_id:
          type: string
        source:
          type: string
        check:
          type: string
        severity:
          $ref: '#/components/schemas/Severity'
        description:
          type: string
        dedupe_key:
          type: string
        time:
          type: integer
          format: int64
        services:
          type: array
          items:
            type: string
        alias:
          type: string
        utc_offset:
          type: string
        manager:
          type: string
        manager_id:
          type: string
        class:
          type: string
        namespace:
          type: string
        maintenance:
          type: string
        type:
          type: string
        tags:
          type: object
        location:
          $ref: '#/components/schemas/LocationDto'
        policy:
          type: string
        additional_info:
          type: object
        sequence_id:
          type: integer
          format: int32
      required:
        - source
        - check
        - severity
        - description
    LocationDto:
      type: object
      title: Location
      properties:
        street:
          type: string
        building:
          type: string
        suite:
          type: integer
          format: int32
        floor:
          type: string
        city:
          type: string
        state_or_province:
          type: string
        country:
          type: string
        postcode:
          type: string
        geo_coordinates:
          $ref: '#/components/schemas/GeoLocationDto'
        rack:
          type: string
        aisle:
          type: string
        u_position:
          type: string
        region:
          type: string
        data_center:
          type: string
        availability_zone:
          type: string
        geo_coordinates_lat:
          type: integer
          format: int32
        geo_coordinates_long:
          type: integer
          format: int32
    GeoLocationDto:
      type: object
      title: GeoLocation
      properties:
        lat:
          type: number
          format: float
        long:
          type: number
          format: float
    MoogResponseListOfExternalSystemDto:
      type: object
      description: Alerts/Incidents API ExternalSystemDto response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
            - success
        data:
          type: array
          items:
            $ref: '#/components/schemas/ExternalSystemDto'
      required:
        - status
        - data
    ListSnapshotRequest:
      type: object
      title: List Snapshot Request
      description: List alert snapshot POST request body.
      properties:
        ids:
          type: array
          description: Unique alert IDs for which to retrieve earliest/highest severity snapshot
          minItems: 1
          examples:
            - - 12
              - 29
          items:
            type: integer
            format: int64
        fields:
          type: array
          description: Subset of fields to return (default is all non-null alert fields)
          items:
            type: string
      required:
        - ids
    MoogResponseAlertList:
      type: object
      description: Alerts/Incidents API AlertList response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
            - success
        data:
          $ref: '#/components/schemas/AlertList'
      required:
        - status
        - data
    AlertList:
      type: object
      title: Alert List
      properties:
        result:
          type: array
          items:
            $ref: '#/components/schemas/AlertDto'
        count:
          type: integer
          format: int64
        search_after:
          type: array
          description: 'When needing to scroll through a large number of alerts, the value of this field can be provided to the ''searchAfter'' parameter of the next query invocation.'
        searchAfter:
          type: array
          description: Use search_after instead
          readOnly: true
          x-deprecated: true
    UnlabeledRequestDto:
      type: object
      title: Unlabeled Request Dto
      properties:
        incident_ids:
          type: array
          description: Set of unique incident IDs which are to be queried
          minItems: 1
          uniqueItems: true
          items:
            type: integer
            format: int64
      required:
        - incident_ids
    MoogResponseUnlabeledResponseDto:
      type: object
      description: Alerts/Incidents API UnlabeledResponseDto response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
            - success
        data:
          $ref: '#/components/schemas/UnlabeledResponseDto'
      required:
        - status
        - data
    UnlabeledResponseDto:
      type: object
      title: Unlabeled Response Dto
      properties:
        total_incidents:
          type: integer
          format: int64
        total_alerts:
          type: integer
          format: int64
        unlabeled_counts:
          type: object
          additionalProperties:
            type: integer
            format: int64
    BulkAlertUpdateRequest:
      type: object
      title: Bulk Alert Update Request
      properties:
        status:
          $ref: '#/components/schemas/Status'
        assignee:
          type: string
          description: 'Username of the assignee, specified as one string. Returns an error if the username is not found.'
          examples:
            - john.doe@company.com
        assigned_groups:
          type: array
          description: 'An array of group ids or group names, returns error if any of them not found'
          examples:
            - - groupid1
              - groupid2
          uniqueItems: true
          items:
            type: string
        ids:
          type: array
          description: Unique alert ids to update
          minItems: 1
          examples:
            - - 12
              - 29
          uniqueItems: true
          items:
            type: integer
            format: int64
      required:
        - ids
    MoogResponseListOfAlertDto:
      type: object
      description: Alerts/Incidents API AlertDto response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
            - success
        data:
          type: array
          items:
            $ref: '#/components/schemas/AlertDto'
      required:
        - status
        - data
    ListAlertsRequest:
      type: object
      title: List Alerts Request
      description: List alerts POST request body.
      properties:
        filter:
          type: string
          description: Return only alerts that match this filter.<br>Returns **400 (Invalid parameters)** if the filter format is invalid.
          examples:
            - '''event count'' > 3 AND severity in (Critical, Major, Minor, Warning)'
        json_filter:
          type: object
          description: Return only alerts that match this AG-Grid-style JSON filter. Each filter can be of a different filterType.
          additionalProperties:
            $ref: '#/components/schemas/ColumnFilter'
          examples:
            - status:
                values:
                  - open
                  - in progress
                  - resolved
                filterType: set
        json_sort:
          type: array
          description: Sort the results according to this AG-Grid-style JSON sort array.
          examples:
            - - sort: asc
                colId: severity
              - sort: desc
                colId: alert_id
          items:
            $ref: '#/components/schemas/AgGridSortColumn'
        keyword:
          type: string
          description: Return only alerts that contain these keywords.
        utc_offset:
          type: string
          description: UTC Offset
          default: GMT-0
        start:
          type: integer
          description: 'The starting offset of alerts to retrieve. The initial offset to use is 0 and thereafter is typically multiples of ''limit''. <b>NOTE:</b> ''start'' + ''limit'' must not exceed 10,000 -- use ''searchAfter'' instead.'
          format: int32
          minimum: 0
          default: 0
        limit:
          type: integer
          description: Maximum number of alerts to return. This is equivalent to the maximum number of alerts per page. Between 1 and 5000
          format: int32
          exclusiveMinimum: 0
          maximum: 5000
          default: 100
        sort_by:
          type: string
          description: Field to sort by
        sort_order:
          $ref: '#/components/schemas/SortOrder'
          description: Sort order
        search_after:
          type: array
          description: 'When needing to scroll through a large number of alerts, this parameter can be used instead of ''start'' to proceed with alerts that follow the previous search result. The ''searchAfter'' from the previous response must be provided along with the same filter and sort criteria. All results are exhausted when a search response includes no more alerts.'
        fields:
          type: array
          description: Subset of fields to return (default is all non-null alert fields
          items:
            type: string
    SetIncidentTagsPayloadDto:
      type: object
      title: Set Incident Tags Payload Dto
      properties:
        tags:
          type: object
          description: The tags being added to the incident
          additionalProperties:
            type: array
            items:
              type: string
      required:
        - tags
    IncidentFilterStrDto:
      type: object
      title: Incident Filter Str Dto
      description: An incident's filter string to validate
      properties:
        filterString:
          type: string
          description: The incident's filter string to validate
          pattern: \S
          examples:
            - severity = Clear AND source = www.my-source.com
      required:
        - filterString
    MoogResponseIncidentFilterStrResultDto:
      type: object
      description: Alerts/Incidents API IncidentFilterStrResultDto response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
            - success
        data:
          $ref: '#/components/schemas/IncidentFilterStrResultDto'
      required:
        - status
        - data
    IncidentFilterStrResultDto:
      type: object
      title: Incident Filter Str Result Dto
      description: The result of validating an incident's filter string
      properties:
        isValid:
          type: boolean
    SituationRoomAlertsRequest:
      type: object
      title: Situation Room Alerts Request
      description: Situation Room alerts POST request body.
      properties:
        json_filter:
          type: object
          description: Return only alerts that match this AG-Grid-style JSON filter. Each filter can be of a different filterType.
          additionalProperties:
            $ref: '#/components/schemas/ColumnFilter'
          examples:
            - status:
                values:
                  - open
                  - in progress
                  - resolved
                filterType: set
        json_sort:
          type: array
          description: Sort the results according to this AG-Grid-style JSON sort array.
          examples:
            - - sort: asc
                colId: severity
              - sort: desc
                colId: alert_id
          items:
            $ref: '#/components/schemas/AgGridSortColumn'
        start:
          type: integer
          description: 'The starting offset of alerts to retrieve. The initial offset to use is 0 and thereafter is typically multiples of ''limit''. <b>NOTE:</b> ''start'' + ''limit'' must not exceed 10,000 -- use ''searchAfter'' instead.'
          format: int32
          minimum: 0
          default: 0
        limit:
          type: integer
          description: Maximum number of alerts to return. This is equivalent to the maximum number of alerts per page. Between 1 and 5000
          format: int32
          exclusiveMinimum: 0
          maximum: 5000
          default: 100
        fields:
          type: array
          description: Subset of fields to return (default is all non-null alert fields
          items:
            type: string
    MoogResponseListOfIncidentTimelineDto:
      type: object
      description: Alerts/Incidents API IncidentTimelineDto response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
            - success
        data:
          type: array
          items:
            $ref: '#/components/schemas/IncidentTimelineDto'
      required:
        - status
        - data
    IncidentTimelineDto:
      type: object
      title: Incident Timeline Dto
      description: Incident timeline entry details
      properties:
        summary_title:
          type: string
          description: The activity title
          examples:
            - First Event
        summary_subtitle:
          type: string
          description: The activity subtitle
          examples:
            - Alert 4
        activity_type:
          $ref: '#/components/schemas/ActivityType'
          description: The timeline entry activity type
        severity:
          type: string
          description: The severity of the alert. Used only for alerts activity
          examples:
            - MINOR
        redirection_id:
          type: string
          description: The ID which can be used to redirect
          examples:
            - '4'
        description:
          type: string
          description: The activity description
          examples:
            - Assigned groups changed to Cloud Team
        activity_time:
          type: integer
          description: Epoch timestamp in milliseconds indicating when the activity happened
          format: int64
          examples:
            - 1681968617138
        correlation_definition:
          type: object
          description: The correlation definition for incident/alert related activities
        notification_sent:
          type: object
          description: An on-call notification sent for this incident
        manual_description_set:
          type: boolean
          description: Indicates an incident description was created manually
          examples:
            - true
        comment_type:
          $ref: '#/components/schemas/CommentType'
          description: The type of comment. Used only for comments activity
        user:
          $ref: '#/components/schemas/TimelineUserDto'
          description: The user that performed the activity
        action_by:
          type: string
          description: The user mail id that performed the activity
        reference_alert_id:
          type: integer
          description: The ID other alerts were referenced against
          format: int64
          examples:
            - 4
        fields:
          type: string
          description: The fields and values from the correlation definition associated with the reference alert
        summaryTitle:
          type: string
          description: Use summary_title instead
          x-deprecated: true
        summarySubtitle:
          type: string
          description: Use summary_subtitle instead
          x-deprecated: true
        activityType:
          $ref: '#/components/schemas/ActivityType'
          description: Use activity_type instead
        redirectionId:
          type: string
          description: Use redirection_id instead
          x-deprecated: true
        activityTime:
          type: integer
          description: Use activity_time instead
          format: int64
        correlationDefinition:
          type: object
          description: Use correlation_definition instead
          x-deprecated: true
        manualDescriptionSet:
          type: boolean
          description: Use manual_description_set instead
          x-deprecated: true
    ActivityType:
      type: string
      enum:
        - FIRST_EVENT
        - INCIDENT_CREATED
        - ALERT_ADDED
        - ALERT_STATUS_CHANGE
        - ALERT_ASSIGNMENT
        - INCIDENT_STATUS_CHANGE
        - INCIDENT_ASSIGNMENT
        - COMMENT_ADDED
        - COMMENT_EDITED
        - DESCRIPTION_CHANGE
        - INCIDENT_GROUP_ASSIGNMENT
        - ALERT_GROUP_ASSIGNMENT
        - ANNOUNCEMENT
        - WATCHER_ADDED
        - WATCHER_REMOVED
      title: Activity Type
      description: Activity type for incident timeline
    TimelineUserDto:
      type: object
      title: Timeline User Dto
      properties:
        id:
          type: string
        family_name:
          type: string
        given_name:
          type: string
        email:
          type: string
        picture:
          type: string
        familyName:
          type: string
          description: Use family_name instead
          x-deprecated: true
        givenName:
          type: string
          description: Use given_name instead
          x-deprecated: true
security:
  - ApiKeyAuth: []