openapi: 3.1.0
info:
  version: 4.0.0
  title: Config API
  description: 'This API allows you to save and retrieve config, catalogs, credentials, watchers, menu actions, and maintenance windows'
  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/catalogs:
    get:
      tags:
        - catalogs
      summary: Returns all catalogs.
      description: ' Returns all catalogs.'
      operationId: getCatalogsV2
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseListOfCatalog'
        '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:
        description: Required user permissions for this endpoint
        value:
          - 'catalog:view'
    post:
      tags:
        - catalogs
      summary: 'Creates a new, empty catalog.'
      description: 'Creates a new, empty catalog.'
      operationId: createNewEmptyCatalogV2
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Catalog'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseCatalog'
        '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:
        description: Required user permissions for this endpoint
        value:
          - 'catalog:edit'
  /v2/catalogs/settings:
    get:
      tags:
        - catalogs
      summary: Returns catalog settings.
      description: ' Returns catalogs settings.'
      operationId: getCatalogSettings
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseCatalogSettings'
        '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:
        description: Required user permissions for this endpoint
        value:
          - 'catalog:view'
  '/v2/catalogs/{id}':
    get:
      tags:
        - catalogs
      summary: Returns the catalog with the given id.
      description: Returns the catalog with the given id.
      operationId: getCatalogV2
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseCatalog'
        '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:
        description: Required user permissions for this endpoint
        value:
          - 'catalog:view'
    delete:
      tags:
        - catalogs
      summary: Deletes the catalog and content documents (by catalog id).
      description: Deletes the catalog and content documents (by catalog id)
      operationId: deleteCatalogV2
      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:
        description: Required user permissions for this endpoint
        value:
          - 'catalog:edit'
  '/v2/catalogs/{id}/batch':
    post:
      tags:
        - catalogs
      summary: Adds a batch of new documents to the catalog.
      description: |-
        Adds a batch of new documents to the catalog. The documents should conform to the catalog schema.
        Note — The document keys in your request are case-sensitive. They should match exactly the field names defined in the catalog schema.
        Send a GET catalogs request to check the schema.
      operationId: addCatalogDocumentsV2
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        description: Add documents data
        required: true
        content:
          application/json:
            schema:
              type: array
              minItems: 1
              items:
                $ref: '#/components/schemas/DocumentDto'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseListOfstring'
                __errors__:
                  '#/components/schemas/MoogResponseListOfstring': No foreign doc with id components found
        '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:
        description: Required user permissions for this endpoint
        value:
          - 'catalog:edit'
  '/v2/catalogs/{id}/documents':
    get:
      tags:
        - catalogs
      summary: Returns the matching documents in the catalog.
      description: Returns the matching documents in the catalog.
      operationId: queryCatalogDocumentsV2
      parameters:
        - name: limit
          in: query
          schema:
            type: integer
            format: int32
        - name: offset
          in: query
          schema:
            type: integer
            format: int32
        - name: query
          in: query
          schema:
            type: string
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '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'
        default:
          description: List of Documents
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseListOfDocumentDto'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        description: Required user permissions for this endpoint
        value:
          - 'catalog:view'
    post:
      tags:
        - catalogs
      summary: Adds a new document (row) to the catalog.
      description: |-
        Adds a new document (row) to the catalog. The document should conform to the catalog schema.
        Note — The document keys in your request are case-sensitive. They should match exactly the field names defined in the catalog schema.
        Send a GET catalogs request to check the schema.
      operationId: addCatalogDocumentV2
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        description: Add document data
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DocumentDto'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseListOfstring'
                __errors__:
                  '#/components/schemas/MoogResponseListOfstring': No foreign doc with id components found
        '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:
        description: Required user permissions for this endpoint
        value:
          - 'catalog:edit'
  '/v2/catalogs/{id}/documents/{documentId}':
    put:
      tags:
        - catalogs
      summary: Replaces a document in the catalog.
      description: Replaces a document in the catalog.
      operationId: replaceCatalogDocumentV2
      parameters:
        - name: documentId
          in: path
          description: The unique identifier of the document (row) in the catalog.
          required: true
          schema:
            type: string
        - name: id
          in: path
          description: The unique identifier of the catalog where the document (row) is located.
          required: true
          schema:
            type: string
      requestBody:
        description: Update document data
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DocumentDto'
      responses:
        '204':
          description: No Content
        '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:
        description: Required user permissions for this endpoint
        value:
          - 'catalog:edit'
    patch:
      tags:
        - catalogs
      summary: Modifies a document in the catalog.
      description: Modifies a document in the catalog.
      operationId: modifyCatalogDocumentV2
      parameters:
        - name: documentId
          in: path
          description: The unique identifier of the document (row) in the catalog.
          required: true
          schema:
            type: string
        - name: id
          in: path
          description: The unique identifier of the catalog where the document (row) is located.
          required: true
          schema:
            type: string
      requestBody:
        description: Update document data
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DocumentDto'
      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:
        description: Required user permissions for this endpoint
        value:
          - 'catalog:edit'
    get:
      tags:
        - catalogs
      summary: Returns a document from the catalog.
      description: Returns a document from the catalog.
      operationId: getCatalogDocumentV2
      parameters:
        - name: documentId
          in: path
          required: true
          schema:
            type: string
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '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'
        default:
          description: Document
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseDocumentDto'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        description: Required user permissions for this endpoint
        value:
          - 'catalog:view'
    delete:
      tags:
        - catalogs
      summary: Deletes a single document in a catalog (by catalog id).
      description: Deletes a single document in a catalog (by catalog id).
      operationId: deleteCatalogDocumentV2
      parameters:
        - name: documentId
          in: path
          required: true
          schema:
            type: string
        - 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:
        description: Required user permissions for this endpoint
        value:
          - 'catalog:edit'
  '/v2/catalogs/{id}/search':
    post:
      tags:
        - catalogs
      summary: Returns the matching documents in the catalog.
      description: Returns the matching documents in the catalog. This is a POST rather than a GET due to the JSON body.
      operationId: searchCatalogDocumentsV2
      parameters:
        - name: limit
          in: query
          schema:
            type: integer
            format: int32
        - name: offset
          in: query
          schema:
            type: integer
            format: int32
        - name: id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        description: 'Dictionary of AND''ed key/column and value pairs to be searched. Values are treated as an exact match and if the queried value is a string, then it is case-insensitive.'
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DocumentDto'
      responses:
        '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'
        default:
          description: List of Documents
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseListOfDocumentDto'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        description: Required user permissions for this endpoint
        value:
          - 'catalog:view'
  /v2/correlation/definitions:
    get:
      tags:
        - correlation-definitions
      summary: Fetches all correlation definitions.
      description: Fetches all correlation definitions.
      operationId: getAllCorrelationDefinitions
      parameters:
        - name: include-catch-all
          in: query
          schema:
            type: boolean
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseListOfCorrelationDefinitionDto'
        '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:
        description: Required user permissions for this endpoint
        value:
          - 'correlation:view'
    post:
      tags:
        - correlation-definitions
      summary: Creates a new correlation definition record.
      description: Creates a new correlation definition record. The record is identified by its name (given in the request body).The name cannot be changed in the future.
      operationId: createCorrelationDefinition
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CorrelationDefinitionDto'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseCorrelationDefinitionDto'
        '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:
        description: Required user permissions for this endpoint
        value:
          - 'correlation:edit'
  '/v2/correlation/definitions/id/{identifier}':
    patch:
      tags:
        - correlation-definitions
      summary: Edits the correlation definition identified in the path parameter (either the id or the name).
      description: Edits the correlation definition identified in the path parameter (either the id or the name).
      operationId: modifyCorrelationDefinition2
      parameters:
        - name: identifier
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CorrelationDefinitionDto'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseCorrelationDefinitionDto'
        '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:
        description: Required user permissions for this endpoint
        value:
          - 'correlation:edit'
    get:
      tags:
        - correlation-definitions
      summary: Fetches correlation definition matching the identifier in the path parameter (either the id or the name).
      description: Fetches correlation definition matching the identifier in the path parameter (either the id or the name).
      operationId: getDefinition2
      parameters:
        - name: identifier
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseCorrelationDefinitionDto'
        '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:
        description: Required user permissions for this endpoint
        value:
          - 'correlation:view'
    delete:
      tags:
        - correlation-definitions
      summary: Deletes the correlation definition identified in the path parameter (either the id or the name).
      description: Deletes the correlation definition identified in the path parameter (either the id or the name).
      operationId: deleteCorrelationDefinition2
      parameters:
        - name: identifier
          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:
        description: Required user permissions for this endpoint
        value:
          - 'correlation:edit'
  '/v2/correlation/definitions/{identifier}':
    patch:
      tags:
        - correlation-definitions
      summary: Edits the correlation definition identified in the path parameter (either the id or the name).
      description: Edits the correlation definition identified in the path parameter (either the id or the name).
      operationId: modifyCorrelationDefinition
      parameters:
        - name: identifier
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CorrelationDefinitionDto'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseCorrelationDefinitionDto'
        '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:
        description: Required user permissions for this endpoint
        value:
          - 'correlation:edit'
    get:
      tags:
        - correlation-definitions
      summary: Fetches correlation definition matching the identifier in the path parameter (either the id or the name).
      description: Fetches correlation definition matching the identifier in the path parameter (either the id or the name).
      operationId: getDefinition
      parameters:
        - name: identifier
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseCorrelationDefinitionDto'
        '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:
        description: Required user permissions for this endpoint
        value:
          - 'correlation:view'
    delete:
      tags:
        - correlation-definitions
      summary: Deletes the correlation definition identified in the path parameter (either the id or the name).
      description: Deletes the correlation definition identified in the path parameter (either the id or the name).
      operationId: deleteCorrelationDefinition
      parameters:
        - name: identifier
          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:
        description: Required user permissions for this endpoint
        value:
          - 'correlation:edit'
  /v2/correlation/groups:
    get:
      tags:
        - correlation-groups
      summary: Fetches all correlation groups.
      description: Fetches all correlation groups.
      operationId: getAllCorrelationGroups
      parameters:
        - name: inline-definitions
          in: query
          schema:
            type: boolean
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseListOfCorrelationGroupDto'
        '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:
        description: Required user permissions for this endpoint
        value:
          - 'correlation:view'
    post:
      tags:
        - correlation-groups
      summary: Creates a new correlation group record.
      description: Creates a new correlation group record. The record is identified by its name (given in the request body).The name cannot be changed in the future.
      operationId: createCorrelationGroup
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CorrelationGroupDto'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseCorrelationGroupDto'
        '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:
        description: Required user permissions for this endpoint
        value:
          - 'correlation:edit'
  '/v2/correlation/groups/id/{identifier}':
    patch:
      tags:
        - correlation-groups
      summary: Edits the correlation group identified in the path parameter (either the id or the name).
      description: Edits the correlation group identified in the path parameter (either the id or the name).
      operationId: modifyCorrelationGroup2
      parameters:
        - name: identifier
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CorrelationGroupDto'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseCorrelationGroupDto'
        '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:
        description: Required user permissions for this endpoint
        value:
          - 'correlation:edit'
    get:
      tags:
        - correlation-groups
      summary: Fetches the correlation group identified in the path parameter (either the id or the name).
      description: Fetches the correlation group identified in the path parameter (either the id or the name).
      operationId: getGroup2
      parameters:
        - name: identifier
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseCorrelationGroupDto'
        '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:
        description: Required user permissions for this endpoint
        value:
          - 'correlation:view'
    delete:
      tags:
        - correlation-groups
      summary: Deletes the correlation group identified in the path parameter (either the id or the name).
      description: Deletes the correlation group identified in the path parameter (either the id or the name).
      operationId: deleteCorrelationGroup2
      parameters:
        - name: identifier
          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:
        description: Required user permissions for this endpoint
        value:
          - 'correlation:edit'
  '/v2/correlation/groups/{identifier}':
    patch:
      tags:
        - correlation-groups
      summary: Edits the correlation group identified in the path parameter (either the id or the name).
      description: Edits the correlation group identified in the path parameter (either the id or the name).
      operationId: modifyCorrelationGroup
      parameters:
        - name: identifier
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CorrelationGroupDto'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseCorrelationGroupDto'
        '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:
        description: Required user permissions for this endpoint
        value:
          - 'correlation:edit'
    get:
      tags:
        - correlation-groups
      summary: Fetches the correlation group identified in the path parameter (either the id or the name).
      description: Fetches the correlation group identified in the path parameter (either the id or the name).
      operationId: getGroup
      parameters:
        - name: identifier
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseCorrelationGroupDto'
        '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:
        description: Required user permissions for this endpoint
        value:
          - 'correlation:view'
    delete:
      tags:
        - correlation-groups
      summary: Deletes the correlation group identified in the path parameter (either the id or the name).
      description: Deletes the correlation group identified in the path parameter (either the id or the name).
      operationId: deleteCorrelationGroup
      parameters:
        - name: identifier
          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:
        description: Required user permissions for this endpoint
        value:
          - 'correlation:edit'
  '/v3/catalogs/{catalogName}/search':
    post:
      tags:
        - catalogs
      summary: Returns the matching documents in the catalog.
      description: Returns the matching documents in the catalog. This is a POST rather than a GET due to the JSON body.
      operationId: searchCatalogDocumentsV3
      parameters:
        - name: limit
          in: query
          schema:
            type: integer
            format: int32
            default: '50'
        - name: offset
          in: query
          schema:
            type: integer
            format: int32
        - name: catalogName
          in: path
          required: true
          schema:
            type: string
      requestBody:
        description: 'List of AND''ed SearchFieldDto to be searched. Values are treated as an exact match and if the queried value is a string, then it is case-insensitive.'
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchFieldsDto'
      responses:
        '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'
        default:
          description: List of Documents
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseListOfDocumentDto'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        description: Required user permissions for this endpoint
        value:
          - 'catalog:view'
  '/v1/catalogs/{catalogName}/documents/{documentId}':
    patch:
      tags:
        - catalogs
      summary: Modifies a document in the catalog.
      description: Modifies a document in the catalog.
      operationId: modifyCatalogDocument
      parameters:
        - name: catalogName
          in: path
          required: true
          schema:
            type: string
        - name: documentId
          in: path
          required: true
          schema:
            type: string
      requestBody:
        description: Updated documenet values.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DocumentDto'
      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:
        description: Required user permissions for this endpoint
        value:
          - 'catalog:edit'
    delete:
      tags:
        - catalogs
      summary: Deletes a single document in a catalog (by catalog name).
      description: Deletes a single document in a catalog (by catalog name).
      operationId: deleteCatalogDocument
      parameters:
        - name: catalogName
          in: path
          required: true
          schema:
            type: string
        - name: documentId
          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:
        description: Required user permissions for this endpoint
        value:
          - 'catalog:edit'
  '/v1/maintenance/occurrences/{id}/cancelled':
    put:
      tags:
        - maintenance windows
      summary: Cancel a maintenance window schedule
      operationId: cancelOccurrence
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseMaintenanceOccurrenceDto'
        '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:
        description: Required user permissions for this endpoint
        value:
          - 'maintenance:edit'
  '/v1/maintenance/windows/{id}/occurrences/expired':
    get:
      tags:
        - maintenance windows
      summary: Get expired occurrences for a specific maintenance window
      operationId: getMaintenanceExpiredOccurrences
      parameters:
        - name: limit
          in: query
          schema:
            type: integer
            description: Specifies limit when retrieving the maintenance occurrences
            format: int32
            exclusiveMinimum: 0
            default: 100
        - name: offset
          in: query
          schema:
            type: integer
            description: Specifies offset record when retrieving the maintenance occurrences
            format: int32
            minimum: 0
            default: 0
        - name: id
          in: path
          required: true
          schema:
            type: string
            description: Specifies the maintenance window id for which to retrieve occurrences
            minLength: 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseMaintenanceOccurrenceListDto'
        '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:
        description: Required user permissions for this endpoint
        value:
          - 'maintenance:view'
  '/v1/catalog-files/{name}':
    patch:
      tags:
        - catalogs
      summary: Replaces a catalog with schema and documents based on the given CSV file.
      description: |-
        Replaces a catalog with schema and documents based on the given CSV file. For an example of the expected format, search for "enrichment CSV" in the API documentation.
        Note — You need to add the catalog file to the form data in the PATCH command. Suppose you want to upload the file using cURL.
        To do this, append a line to the auto-generated command that specifies the path and filename of the CSV you want to upload.
        For example:

            curl --request PATCH \
              --url https://api.moogsoft.ai/v1/catalog-files/data-center \
              --header 'Accept: application/json' \
              --header 'Content-Type: multipart/form-data; boundary=---011000010111000001101001' \
              --header 'apiKey: my-api-key' \
              --form name=data-center-enrichment \
              --form description="Enrichment catalog for Data Center nodes" \
              # append this line....
              --form file=@/users/jane.smith/acme-catalogs/data-center.csv
      operationId: replaceCatalog
      parameters:
        - name: synchronous
          in: query
        - name: name
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                description:
                  type: string
                file:
                  type: string
                  contentMediaType: application/octet-stream
              required:
                - file
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseCatalog'
        '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:
        description: Required user permissions for this endpoint
        value:
          - 'catalog:edit'
  /v1/maintenance/occurrences/expired:
    get:
      tags:
        - maintenance windows
      summary: 'Get expired, skipped, or cancelled maintenance window occurrences (in reverse time order)'
      operationId: getExpiredMaintenanceOccurrences
      parameters:
        - name: limit
          in: query
          description: Specifies limit when retrieving the maintenance occurrences
          schema:
            type: integer
            format: int32
            exclusiveMinimum: 0
            default: 100
        - name: offset
          in: query
          description: Specifies offset record when retrieving the maintenance occurrences
          schema:
            type: integer
            format: int32
            minimum: 0
            default: 0
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseMaintenanceOccurrenceListDto'
        '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:
        description: Required user permissions for this endpoint
        value:
          - 'maintenance:view'
  '/v1/templates/email/{id}':
    patch:
      tags:
        - watchers
      summary: Updates an existing e-mail template.
      operationId: updateTemplate
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmailTemplateDto'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseEmailTemplateDto'
        '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:
        description: Required user permissions for this endpoint
        value:
          - 'incidents:edit'
    get:
      tags:
        - watchers
      summary: Gets an existing e-mail template.
      operationId: getTemplate
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseEmailTemplateDto'
        '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:
        description: Required user permissions for this endpoint
        value:
          - 'incidents:view'
    delete:
      tags:
        - watchers
      summary: Deletes an existing e-mail template.
      operationId: deleteTemplate
      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:
        description: Required user permissions for this endpoint
        value:
          - 'incidents:edit'
  /v1/menu-actions/standalone-workflows:
    get:
      tags:
        - Menu actions
      summary: Returns any menu actions that utilize standalone workflows
      description: 'Returns all menu actions that utilize standalone workflows. If an ID is specified, only returns the menu actions that utilize a workflow with that particular ID.'
      operationId: getStandaloneMenuActions
      parameters:
        - name: id
          in: query
          description: Standalone Workflow Id
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseListOfMenuActionDto'
        '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:
        description: Required user permissions for this endpoint
        value:
          - 'integrations:view'
  '/v1/maintenance/occurrences/{id}':
    get:
      tags:
        - maintenance windows
      summary: Get a maintenance occurrence
      operationId: getMaintenanceOccurrence
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseMaintenanceOccurrenceDto'
        '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:
        description: Required user permissions for this endpoint
        value:
          - 'maintenance:view'
  '/v1/menu-actions/{id}':
    patch:
      tags:
        - Menu actions
      summary: Update the menu action with the given id.
      description: Update the menu action with the given id.
      operationId: updateMenuAction
      parameters:
        - name: id
          in: path
          description: The menu action id
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BaseMenuActionDto'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseMenuActionDto'
        '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:
        description: Required user permissions for this endpoint
        value:
          - 'integrations:edit'
    get:
      tags:
        - Menu actions
      summary: Get the menu action with the given id.
      description: Get the menu action with the given id.
      operationId: getMenuAction
      parameters:
        - name: id
          in: path
          description: The menu action id
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseMenuActionDto'
        '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:
        description: Required user permissions for this endpoint
        value:
          - 'integrations:view'
    delete:
      tags:
        - Menu actions
      summary: Delete the menu action with the given id.
      description: Delete the menu action with the given id.
      operationId: deleteMenuAction
      parameters:
        - name: id
          in: path
          description: The menu action id
          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:
        description: Required user permissions for this endpoint
        value:
          - 'integrations:edit'
  /v1/catalog-files:
    post:
      tags:
        - catalogs
      summary: Creates a new catalog with schema and documents based on the given CSV file.
      description: |-
        Creates a new catalog with schema and documents based on the given CSV file. For an example of the expected format, search for "enrichment CSV" in the Moogsoft documentation.
        Note — You need to add the catalog file to the form data in the POST command. Suppose you want to upload the file using cURL.
        To do this, append a line to the auto-generated command that specifies the path and filename of the CSV you want to upload.
        For example:

            curl --request POST \
              --url https://api.moogsoft.ai/v1/catalog-files \
              --header 'Accept: application/json' \
              --header 'Content-Type: multipart/form-data; boundary=---011000010111000001101001' \
              --header 'apiKey: my-api-key' \
              # append this line....
              --form file=@/users/jane.smith/moogsoft-catalogs/data-center.csv
      operationId: uploadNewCatalog
      parameters:
        - name: synchronous
          in: query
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                name:
                  type: string
                  pattern: '^(?!system\.)[a-zA-Z0-9]([\w \-.]*)$'
                  minLength: 1
                  maxLength: 127
                description:
                  type: string
                  pattern: \S
                  minLength: 1
                file:
                  type: string
                  contentMediaType: application/octet-stream
              required:
                - name
                - description
                - file
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseCatalog'
        '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:
        description: Required user permissions for this endpoint
        value:
          - 'catalog:edit'
  '/v1/catalogs/{catalogName}/documents':
    get:
      tags:
        - catalogs
      summary: Returns the matching documents in the catalog.
      description: Returns the matching documents in the catalog.
      operationId: queryCatalogDocuments
      parameters:
        - name: limit
          in: query
          schema:
            type: integer
            format: int32
        - name: offset
          in: query
          schema:
            type: integer
            format: int32
        - name: query
          in: query
          schema:
            type: string
        - name: catalogName
          in: path
          required: true
          schema:
            type: string
      responses:
        '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'
        default:
          description: List of Documents
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseListOfDocumentDto'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        description: Required user permissions for this endpoint
        value:
          - 'catalog:view'
    delete:
      tags:
        - catalogs
      summary: Deletes all the matching documents in the catalog.
      description: |
        Deletes all documents (rows) from a data catalog which include the specified value. 
        Use the following example to model your API request. Include your API key, 
        and replace `groupsCatalog` with the name of your catalog. Replace `name` with the name of the column containing 
        the value, and replace `53` with your value. 
        For example:

            curl --location --request DELETE 'https://api.dev.moogsoft.cloud/v1/catalogs/groupsCatalog/documents' \
              --header 'apiKey: API_KEY_HERE' \
              --header 'Content-Type: application/json' \
              --data '{
                  "name": "53",
                  "uuid": "53basd12313"
              }'
        You can also delete documents by specifying the document id. 
        You can delete a single document by specifying a single id value, or delete multiple documents by providing an array of up to 10,000 IDs. 
        For example:

            curl --location --request DELETE 'https://api.dev.moogsoft.cloud/v1/catalogs/groupsCatalog/documents' \
              --header 'apiKey: API_KEY_HERE' \
              --header 'Content-Type: application/json' \
              --data '{
                  "_id": ["68c148122e2fa960380928d6", "68c148122e2fa960380928d5"]
              }'
      operationId: deleteCatalogDocuments
      parameters:
        - name: catalogName
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              minProperties: 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseListOfstring'
                __errors__:
                  '#/components/schemas/MoogResponseListOfstring': 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:
        description: Required user permissions for this endpoint
        value:
          - 'catalog:edit'
    post:
      tags:
        - catalogs
      summary: Adds a new document (row) to the catalog.
      description: |-
        Adds a new document (row) to the catalog. The document should conform to the catalog schema.
        Note — The document keys in your request are case-sensitive. They should match exactly the field names defined in the catalog schema.
        Send a GET catalogs request to check the schema.
      operationId: addCatalogDocument
      parameters:
        - name: catalogName
          in: path
          required: true
          schema:
            type: string
      requestBody:
        description: Add catalog document.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DocumentDto'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseListOfstring'
                __errors__:
                  '#/components/schemas/MoogResponseListOfstring': No foreign doc with id components found
        '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:
        description: Required user permissions for this endpoint
        value:
          - 'catalog:edit'
  '/v1/maintenance/windows/{id}/occurrences/pending':
    get:
      tags:
        - maintenance windows
      summary: Get pending occurrences for a specific maintenance window
      operationId: getMaintenancePendingOccurrences
      parameters:
        - name: limit
          in: query
          schema:
            type: integer
            description: Specifies limit when retrieving the maintenance occurrences
            format: int32
            exclusiveMinimum: 0
            default: 100
        - name: offset
          in: query
          schema:
            type: integer
            description: Specifies offset record when retrieving the maintenance occurrences
            format: int32
            minimum: 0
            default: 0
        - name: id
          in: path
          required: true
          schema:
            type: string
            description: Specifies the maintenance window id for which to retrieve occurrences
            minLength: 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseMaintenanceOccurrenceListDto'
        '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:
        description: Required user permissions for this endpoint
        value:
          - 'maintenance:view'
  /v1/maintenance/occurrences/running:
    get:
      tags:
        - maintenance windows
      summary: Gets maintenance window occurrences that are running
      operationId: getRunningMaintenanceOccurrences
      parameters:
        - name: limit
          in: query
          description: Specifies limit when retrieving the maintenance occurrences
          schema:
            type: integer
            format: int32
            exclusiveMinimum: 0
            default: 100
        - name: offset
          in: query
          description: Specifies offset record when retrieving the maintenance occurrences
          schema:
            type: integer
            format: int32
            minimum: 0
            default: 0
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseMaintenanceOccurrenceListDto'
        '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:
        description: Required user permissions for this endpoint
        value:
          - 'maintenance:view'
  '/v1/maintenance/windows/{id}/status':
    get:
      tags:
        - maintenance windows
      summary: Get the current status of a maintenance window
      operationId: getMaintenanceWindowStatus
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseMaintenanceStatusDto'
        '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:
        description: Required user permissions for this endpoint
        value:
          - 'maintenance:view'
  '/v1/maintenance/occurrences/{id}/skipped':
    put:
      tags:
        - maintenance windows
      summary: Skip a maintenance window schedule
      operationId: skipOccurrence
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseMaintenanceOccurrenceDto'
        '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:
        description: Required user permissions for this endpoint
        value:
          - 'maintenance:edit'
  '/v1/maintenance/windows/{id}/occurrences/running':
    get:
      tags:
        - maintenance windows
      summary: Get active occurrences for a specific maintenance window
      operationId: getMaintenanceRunningOccurrences
      parameters:
        - name: limit
          in: query
          schema:
            type: integer
            description: Specifies limit when retrieving the maintenance occurrences
            format: int32
            exclusiveMinimum: 0
            default: 100
        - name: offset
          in: query
          schema:
            type: integer
            description: Specifies offset record when retrieving the maintenance occurrences
            format: int32
            minimum: 0
            default: 0
        - name: id
          in: path
          required: true
          schema:
            type: string
            description: Specifies the maintenance window id for which to retrieve occurrences
            minLength: 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseMaintenanceOccurrenceListDto'
        '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:
        description: Required user permissions for this endpoint
        value:
          - 'maintenance:view'
  /v1/maintenance/windows:
    get:
      tags:
        - maintenance windows
      summary: Get maintenance window schedules
      operationId: getMaintenanceWindows
      parameters:
        - name: deleted
          in: query
          schema:
            type: boolean
            description: Optional flag indicating whether to retrieve ONLY deleted or non-deleted windows (default is to return ALL windows)
        - name: limit
          in: query
          schema:
            type: integer
            description: Specifies limit when retrieving the maintenance windows
            format: int32
            exclusiveMinimum: 0
            default: 100
        - name: offset
          in: query
          schema:
            type: integer
            description: Specifies offset record when retrieving the maintenance windows
            format: int32
            minimum: 0
            default: 0
        - name: sortBy
          in: query
          schema:
            type: string
            enum:
              - created
              - lastUpdated
              - name
              - createdBy
              - lastUpdatedBy
              - start
            description: Specifies the column to sort by when retrieving the maintenance windows
            default: created
        - name: sortOrder
          in: query
          schema:
            type: string
            enum:
              - asc
              - desc
            description: Specifies the sorting order when retrieving the maintenance windows
            default: desc
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseMaintenanceWindowListDto'
        '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:
        description: Required user permissions for this endpoint
        value:
          - 'maintenance:view'
    post:
      tags:
        - maintenance windows
      summary: Creates a new maintenance window schedule.
      operationId: createMaintenanceWindow
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BaseMaintenanceWindowDto'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseMaintenanceWindowDto'
        '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:
        description: Required user permissions for this endpoint
        value:
          - 'maintenance:edit'
  /v1/maintenance/occurrences/pending:
    get:
      tags:
        - maintenance windows
      summary: Get pending maintenance window occurrences
      operationId: getPendingMaintenanceOccurrences
      parameters:
        - name: limit
          in: query
          description: Specifies limit when retrieving the maintenance occurrences
          schema:
            type: integer
            format: int32
            exclusiveMinimum: 0
            default: 100
        - name: offset
          in: query
          description: Specifies offset record when retrieving the maintenance occurrences
          schema:
            type: integer
            format: int32
            minimum: 0
            default: 0
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseMaintenanceOccurrenceListDto'
        '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:
        description: Required user permissions for this endpoint
        value:
          - 'maintenance:view'
  '/v1/maintenance/windows/{id}/occurrences':
    get:
      tags:
        - maintenance windows
      summary: Get all occurrences for a specific maintenance window
      operationId: getMaintenanceOccurrences
      parameters:
        - name: limit
          in: query
          schema:
            type: integer
            description: Specifies limit when retrieving the maintenance occurrences
            format: int32
            exclusiveMinimum: 0
            default: 100
        - name: offset
          in: query
          schema:
            type: integer
            description: Specifies offset record when retrieving the maintenance occurrences
            format: int32
            minimum: 0
            default: 0
        - name: id
          in: path
          required: true
          schema:
            type: string
            description: Specifies the maintenance window id for which to retrieve occurrences
            minLength: 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseMaintenanceOccurrenceListDto'
        '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:
        description: Required user permissions for this endpoint
        value:
          - 'maintenance:view'
  '/v1/watchers/incidents/{id}':
    put:
      tags:
        - watchers
      summary: Creates or updates a Watchers group for an Incident.
      operationId: putIncidentWatchers
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WatchersRequestDto'
      responses:
        '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'
        default:
          description: List of Incident Watchers
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseListOfIncidentWatchersDto'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        description: Required user permissions for this endpoint
        value:
          - 'incidents:edit'
    get:
      tags:
        - watchers
      summary: Gets an existing Incidents Watchers group.
      operationId: getIncidentWatchers
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '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'
        default:
          description: List of Incident Watchers
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseListOfIncidentWatchersDto'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        description: Required user permissions for this endpoint
        value:
          - 'incidents:view'
    delete:
      tags:
        - watchers
      summary: Deletes an existing Incidents Watchers group by Incident ID
      operationId: deleteIncidentWatchers
      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:
        description: Required user permissions for this endpoint
        value:
          - 'incidents:edit'
  '/v1/catalogs/{catalogName}':
    get:
      tags:
        - catalogs
      summary: Returns the catalog with the given name.
      description: Returns the catalog with the given name.
      operationId: getCatalog
      parameters:
        - name: catalogName
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseCatalog'
        '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:
        description: Required user permissions for this endpoint
        value:
          - 'catalog:view'
    delete:
      tags:
        - catalogs
      summary: Deletes the catalog and content documents (by catalog name).
      description: Deletes the catalog and content documents (by catalog name).
      operationId: deleteCatalog
      parameters:
        - name: catalogName
          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:
        description: Required user permissions for this endpoint
        value:
          - 'catalog:edit'
  '/v1/maintenance/windows/{id}':
    patch:
      tags:
        - maintenance windows
      summary: Update a maintenance window schedule
      operationId: updateMaintenanceWindow
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BaseMaintenanceWindowDto'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseMaintenanceWindowDto'
        '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:
        description: Required user permissions for this endpoint
        value:
          - 'maintenance:edit'
    get:
      tags:
        - maintenance windows
      summary: Get a maintenance window schedule
      operationId: getMaintenanceWindow
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseMaintenanceWindowDto'
        '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:
        description: Required user permissions for this endpoint
        value:
          - 'maintenance:view'
    delete:
      tags:
        - maintenance windows
      summary: Delete a maintenance window schedule
      operationId: deleteMaintenanceWindow
      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:
        description: Required user permissions for this endpoint
        value:
          - 'maintenance:edit'
  /v1/menu-actions:
    get:
      tags:
        - Menu actions
      summary: Returns any menu actions that match.
      description: Returns any menu actions that match.
      operationId: findMenuActions
      parameters:
        - name: context_type
          in: query
          description: Menu action context type
          schema:
            $ref: '#/components/schemas/ContextType'
        - name: name
          in: query
          description: Menu action name
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseListOfMenuActionDto'
        '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:
        description: Required user permissions for this endpoint
        value:
          - 'integrations:view'
    post:
      tags:
        - Menu actions
      summary: Create a menu action.
      description: Create a menu action.
      operationId: createMenuAction
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BaseMenuActionDto'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseMenuActionDto'
        '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:
        description: Required user permissions for this endpoint
        value:
          - 'integrations:edit'
  '/v1/watchers/incidents/{id}/self':
    put:
      tags:
        - watchers
      summary: 'Creates or updates a Watchers group for an Incident, for the current user.'
      operationId: putIncidentWatchersSelf
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WatchersRequestSelfDto'
      responses:
        '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'
        default:
          description: List of Incident Watchers
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseListOfIncidentWatchersDto'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        description: Required user permissions for this endpoint
        value:
          - 'incidents:view'
  '/v1/menu-action-categories/{id}':
    patch:
      tags:
        - Menu action categories
      summary: Update the menu action category with the given id.
      description: Update the menu action category with the given id.
      operationId: updateMenuActionCategory
      parameters:
        - name: id
          in: path
          description: The menu action category id
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BaseMenuActionCategoryDto'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseMenuActionCategoryDto'
        '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:
        description: Required user permissions for this endpoint
        value:
          - 'integrations:edit'
    get:
      tags:
        - Menu action categories
      summary: Get the menu action category with the given id.
      description: Get the menu action category with the given id.
      operationId: getMenuActionCategory
      parameters:
        - name: id
          in: path
          description: The menu action category id
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseMenuActionCategoryDto'
        '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:
        description: Required user permissions for this endpoint
        value:
          - 'integrations:view'
    delete:
      tags:
        - Menu action categories
      summary: Delete the menu action category with the given id.
      description: Delete the menu action category with the given id.
      operationId: deleteMenuActionCategory
      parameters:
        - name: id
          in: path
          description: The menu action category id
          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:
        description: Required user permissions for this endpoint
        value:
          - 'integrations:edit'
  '/v1/catalogs/{catalogName}/search':
    post:
      tags:
        - catalogs
      summary: ' Returns the matching documents in the catalog.'
      description: ' Returns the matching documents in the catalog. This is a POST rather than a GET due to the JSON body.'
      operationId: searchCatalogDocuments
      parameters:
        - name: limit
          in: query
          schema:
            type: integer
            format: int32
        - name: offset
          in: query
          schema:
            type: integer
            format: int32
        - name: catalogName
          in: path
          required: true
          schema:
            type: string
      requestBody:
        description: 'Dictionary of AND''ed key/column and value pairs to be searched. Values are treated as an exact match and if the queried value is a string, then it is case-insensitive.'
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DocumentDto'
      responses:
        '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'
        default:
          description: List of Documents
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseListOfDocumentDto'
      security:
        - ApiKeyAuth: []
      servers:
        - url: 'https://api.moogsoft.ai'
        - url: 'https://api.dev.moogsoft.cloud'
      x-permissions:
        description: Required user permissions for this endpoint
        value:
          - 'catalog:view'
  /v1/timezones:
    get:
      tags:
        - maintenance windows
      summary: Get all available timezones.
      operationId: getAllTimezones
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseListOfTimezoneDto'
        '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'
  /v1/menu-action-categories:
    get:
      tags:
        - Menu action categories
      summary: Returns any menu action categories that match.
      description: Returns any menu action categories that match.
      operationId: findMenuActionCategories
      parameters:
        - name: context_type
          in: query
          description: Menu action category context type
          schema:
            $ref: '#/components/schemas/ContextType'
        - name: name
          in: query
          description: Menu action category name
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseListOfMenuActionCategoryDto'
        '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:
        description: Required user permissions for this endpoint
        value:
          - 'integrations:view'
    post:
      tags:
        - Menu action categories
      summary: Create a menu action category.
      description: Create a menu action category.
      operationId: createMenuActionCategory
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BaseMenuActionCategoryDto'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseMenuActionCategoryDto'
        '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:
        description: Required user permissions for this endpoint
        value:
          - 'integrations:edit'
  /v1/catalogs:
    get:
      tags:
        - catalogs
      summary: Returns all catalogs.
      description: ' Returns all catalogs.'
      operationId: getCatalogs
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseListOfCatalog'
        '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:
        description: Required user permissions for this endpoint
        value:
          - 'catalog:view'
    post:
      tags:
        - catalogs
      summary: 'Creates a new, empty catalog.'
      description: 'Creates a new, empty catalog.'
      operationId: createNewEmptyCatalog
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Catalog'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseCatalog'
        '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:
        description: Required user permissions for this endpoint
        value:
          - 'catalog:edit'
  '/v1/catalogs/{catalogName}/batch':
    post:
      tags:
        - catalogs
      summary: Adds a batch of new documents to the catalog.
      description: |2-

         Adds a batch of new documents to the catalog. The documents should conform to the catalog schema.
        Note — The document keys in your request are case-sensitive. They should match exactly the field names defined in the catalog schema.
        Send a GET catalogs request to check the schema.
      operationId: addCatalogDocuments
      parameters:
        - name: catalogName
          in: path
          required: true
          schema:
            type: string
      requestBody:
        description: Add documents data
        required: true
        content:
          application/json:
            schema:
              type: array
              minItems: 1
              items:
                $ref: '#/components/schemas/DocumentDto'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseListOfstring'
                __errors__:
                  '#/components/schemas/MoogResponseListOfstring': No foreign doc with id components found
        '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:
        description: Required user permissions for this endpoint
        value:
          - 'catalog:edit'
  /v1/templates/email:
    get:
      tags:
        - watchers
      summary: Gets all existing e-mail templates.
      operationId: getTemplates
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseListOfEmailTemplateDto'
        '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:
        description: Required user permissions for this endpoint
        value:
          - 'incidents:view'
    post:
      tags:
        - watchers
      summary: Creates an e-mail template.
      operationId: createTemplate
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmailTemplateDto'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseEmailTemplateDto'
        '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:
        description: Required user permissions for this endpoint
        value:
          - 'incidents:edit'
tags:
  - name: Menu action categories
  - name: Menu actions
  - name: catalogs
    description: Catalog management
  - name: config
    description: Configuration and Credentials
  - name: correlation-definitions
    description: ''
  - name: correlation-groups
  - name: maintenance windows
    description: Maintenance Window scheduling
  - name: watchers
    description: Watchers configuration
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 Config API
      name: apiKey
      in: header
  schemas:
    MoogResponseListOfCatalog:
      type: object
      description: Config API Catalog response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
            - success
        data:
          type: array
          items:
            $ref: '#/components/schemas/Catalog'
      required:
        - status
        - data
    Catalog:
      type: object
      title: Catalog
      properties:
        id:
          type: string
          description: Unique id of the catalog
          readOnly: true
        name:
          type: string
          description: Unique name of the catalog
          pattern: '^(?!system\.)[a-zA-Z0-9]([\w \-.]*)$'
        description:
          type: string
          description: Description of the catalog
          pattern: \S
          minLength: 1
        schema:
          $ref: '#/components/schemas/CatalogSchema'
          description: Optional schema definition of the catalog
        created_by:
          type: string
          description: User id who created the catalog
          readOnly: true
        last_updated_by:
          type: string
          description: User id who last updated the catalog
          readOnly: true
        entries:
          type: integer
          description: Total number of entries in the catalog
          format: int64
          readOnly: true
        version:
          type: integer
          description: Version of the catalog with regard to full catalog replace operations.
          format: int64
          readOnly: true
        write_token:
          type: string
          description: Token to manage write access.
          readOnly: true
        last_updated:
          type: integer
          description: When the catalog was last updated
          format: int64
          readOnly: true
        created:
          type: integer
          description: When the catalog was created
          format: int64
          readOnly: true
        status:
          type: string
          description: Status of the catalog
          readOnly: true
        details:
          type: object
          description: Specific details regarding the catalog
          readOnly: true
        createdBy:
          type: string
          description: Use created_by instead
          readOnly: true
          x-deprecated: true
        lastUpdatedBy:
          type: string
          description: Use last_updated_by instead
          readOnly: true
          x-deprecated: true
        lastUpdated:
          type: integer
          description: Use last_updated instead
          format: int64
          readOnly: true
      required:
        - name
        - description
    CatalogSchema:
      type: object
      title: Catalog Schema
      properties:
        fields:
          type: array
          items:
            $ref: '#/components/schemas/CatalogFieldSchema'
      required:
        - fields
    CatalogFieldSchema:
      type: object
      title: Catalog Field Schema
      properties:
        name:
          type: string
          pattern: '^[a-zA-Z\d-_]+$'
          minLength: 1
        required:
          type: boolean
        type:
          $ref: '#/components/schemas/CatalogFieldSchemaType'
      required:
        - name
        - required
        - type
    CatalogFieldSchemaType:
      type: string
      enum:
        - STRING
        - NUMBER
        - BOOLEAN
        - JSON_OBJECT
        - JSON_ARRAY
      title: Catalog Field Schema Type
    MoogFailureResponse:
      type: object
      description: Config 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: Config 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
    MoogResponseCatalog:
      type: object
      description: Config API Catalog response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
            - success
        data:
          $ref: '#/components/schemas/Catalog'
      required:
        - status
        - data
    MoogResponseCatalogSettings:
      type: object
      description: Config API CatalogSettings response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
            - success
        data:
          $ref: '#/components/schemas/CatalogSettings'
      required:
        - status
        - data
    CatalogSettings:
      type: object
      title: Catalog Settings
      properties:
        max_catalogs:
          type: integer
          description: Maximum number of allowed catalogs
          format: int64
          readOnly: true
        num_catalogs:
          type: integer
          description: Current number of catalogs
          format: int64
          readOnly: true
        maxCatalogs:
          type: integer
          description: Use max_catalogs instead
          format: int64
          readOnly: true
        numCatalogs:
          type: integer
          description: Use num_catalogs instead
          format: int64
          readOnly: true
    DocumentDto:
      type: object
      title: Document Dto
      additionalProperties:
        type: string
    MoogResponseListOfDocumentDto:
      type: object
      description: Config API DocumentDto response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
            - success
        data:
          type: array
          items:
            $ref: '#/components/schemas/DocumentDto'
      required:
        - status
        - data
    MoogResponseDocumentDto:
      type: object
      description: Config API DocumentDto response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
            - success
        data:
          $ref: '#/components/schemas/DocumentDto'
      required:
        - status
        - data
    MoogResponseListOfCorrelationDefinitionDto:
      type: object
      description: Config API CorrelationDefinitionDto response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
            - success
        data:
          type: array
          items:
            $ref: '#/components/schemas/CorrelationDefinitionDto'
      required:
        - status
        - data
    CorrelationDefinitionDto:
      type: object
      title: CorrelationDefinition
      properties:
        name:
          type: string
          description: 'The name of the correlation definition. During an update, this field can be omitted to retain the existing value.'
          pattern: '^[a-zA-Z0-9()_\-\s/]+$'
          maxLength: 127
          examples:
            - Similar Sources
        description:
          type: string
          description: The description for the correlation definition.
          examples:
            - Correlates incidents according to the similarity of their sources.
        type:
          $ref: '#/components/schemas/DefinitionType'
        uuid:
          type: string
          description: Populated with the internal ID of the retrieved definition. Not used when creating or updating a definition.
          readOnly: true
        fields_to_correlate:
          type: object
          description: 'The set of alert fields to consider for correlation, and the similarity required for a match between an alert and an incident. Object keys are the field name and values are the similarity as a value from 0.0 to 1.0. During an update, this field can be omitted to retain the existing value.'
          additionalProperties:
            type: number
            format: double
          examples:
            - source: 0.45
        correlation_time_period:
          type: integer
          description: 'The window (in seconds) for correlating alerts into the same incident. During an update, this field can be omitted to retain the existing value.'
          format: int32
          minimum: 0
          default: 3900
          examples:
            - 3600
        incident_description:
          type: string
          description: 'The description to use for all incidents that get generated from this correlation definition. You can use macros to generate incident descriptions dynamically based on the member alerts. During an update, this field can be omitted to retain the existing value.'
          examples:
            - 'unique_count(source) Source: unique(source,3) Affected unique(service,3) unique(class,3)'
        group_id:
          type:
            - string
            - 'null'
          description: 'Read-only reference to the correlation group, if any, that contains this definition.'
          readOnly: true
        catchAll:
          type: boolean
          writeOnly: true
        created_by:
          type: string
          description: User ID or email of the creator
          readOnly: true
          examples:
            - user@example.com
        last_updated_by:
          type: string
          description: User ID or email of the last updater
          readOnly: true
          examples:
            - user@example.com
        created:
          type:
            - number
            - 'null'
          description: Read-only reference to the created time. Time is a UTC timestamp.
          readOnly: true
          anyOf:
            - $ref: '#/components/schemas/Instant'
            - type: 'null'
        last_updated:
          type:
            - number
            - 'null'
          description: Read-only reference to the last updated time. Time is a UTC timestamp.
          readOnly: true
          anyOf:
            - $ref: '#/components/schemas/Instant'
            - type: 'null'
      required:
        - type
      default: scoped
      discriminator:
        propertyName: type
        mapping:
          scoped: '#/components/schemas/ScopedCorrelationDefinitionDto'
          seeded: '#/components/schemas/SeededCorrelationDefinitionDto'
    DefinitionType:
      type: string
      enum:
        - scoped
        - seeded
      title: Definition Type
      description: The type of correlation definition.
    Instant:
      type: number
      title: Instant
      format: int64
      examples:
        - '2022-03-10T16:15:50Z'
    MoogResponseCorrelationDefinitionDto:
      type: object
      description: Config API CorrelationDefinitionDto response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
            - success
        data:
          $ref: '#/components/schemas/CorrelationDefinitionDto'
      required:
        - status
        - data
    MoogResponseListOfCorrelationGroupDto:
      type: object
      description: Config API CorrelationGroupDto response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
            - success
        data:
          type: array
          items:
            $ref: '#/components/schemas/CorrelationGroupDto'
      required:
        - status
        - data
    CorrelationGroupDto:
      type: object
      title: CorrelationDefinitionGroup
      properties:
        name:
          type: string
          description: 'The name of the correlation definition group. During an update, this field can be omitted to retain the existing value.'
          maxLength: 127
          examples:
            - Default Group
        uuid:
          type: string
          description: Populated with the generated ID of the definition group. Not used when creating or updating a definition.
          readOnly: true
        disabled:
          type: boolean
          description: Allows for disabling correlation processing by this group and definitions referenced by it.
          default: false
        catch_all:
          type: boolean
          description: 'If set to true, an alert will always land in a catch all definition, if no other definitions match'
        definitions:
          type: array
          description: Ordered reference to the correlation definitions in this group
          items:
            $ref: '#/components/schemas/DefinitionReferenceDto'
        incident_merge_threshold:
          $ref: '#/components/schemas/IncidentMergeThreshold'
          description: 'Specifies how many alerts the active and candidate incidents should have in common in order to be merged and/or superseded. During an update, this field can be omitted to retain the existing value.'
        short_circuit_evaluation:
          type: boolean
          description: 'If set to true, first matched definition stops any further definition evaluations'
        scope:
          type:
            - string
            - 'null'
          description: 'Optional alert filter to limit the scope of alerts to consider for this group. An empty can be set to disable the scope filter. During an update, this field can be omitted to retain the existing value.'
        created_by:
          type: string
          description: User ID or email of the creator
          readOnly: true
          examples:
            - user@example.com
        last_updated_by:
          type: string
          description: User ID or email of the last updater
          readOnly: true
          examples:
            - user@example.com
        created:
          type:
            - number
            - 'null'
          description: Read-only reference to the created time. Time is a UTC timestamp.
          readOnly: true
          anyOf:
            - $ref: '#/components/schemas/Instant'
            - type: 'null'
        last_updated:
          type:
            - number
            - 'null'
          description: Read-only reference to the last updated time. Time is a UTC timestamp.
          readOnly: true
          anyOf:
            - $ref: '#/components/schemas/Instant'
            - type: 'null'
    DefinitionReferenceDto:
      type: object
      title: Definition Reference Dto
      properties:
        uuid:
          type: string
          description: The ID of a correlation definition
        disabled:
          type: boolean
      required:
        - uuid
    IncidentMergeThreshold:
      type: string
      enum:
        - default
        - any
        - ten
        - twenty
        - thirty
        - forty
        - fifty
        - sixty
        - seventy
        - eighty
        - ninety
        - never
      title: Incident Merge Threshold
    MoogResponseCorrelationGroupDto:
      type: object
      description: Config API CorrelationGroupDto response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
            - success
        data:
          $ref: '#/components/schemas/CorrelationGroupDto'
      required:
        - status
        - data
    SearchFieldsDto:
      type: array
      title: Search Fields Dto
      items:
        $ref: '#/components/schemas/SearchFieldDto'
    SearchFieldDto:
      type: object
      title: Search Field Dto
      properties:
        field_name:
          type: string
          minLength: 1
        match_type:
          $ref: '#/components/schemas/SearchMatchType'
          description: The type of match to use for the field.
        match_value: {}
        comparison_operator:
          $ref: '#/components/schemas/ComparisonOperator'
          description: 'The comparison operator to use for filtering. Note that this field only affects the search if the match_type is STRING. For other match types (RANGE, REGEX), this field is ignored.'
      required:
        - field_name
    SearchMatchType:
      type: string
      enum:
        - STRING
        - REGEX
        - RANGE
      title: Search Match Type
    ComparisonOperator:
      type: string
      enum:
        - equals
        - contains
      title: Comparison Operator
      description: Comparison operator type to use for the filter
    MoogResponseMaintenanceOccurrenceDto:
      type: object
      description: Config API MaintenanceOccurrenceDto response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
            - success
        data:
          $ref: '#/components/schemas/MaintenanceOccurrenceDto'
      required:
        - status
        - data
    MaintenanceOccurrenceDto:
      type: object
      title: Maintenance Occurrence Dto
      description: Definition for a specific occurrence of a maintenance window
      properties:
        name:
          type: string
          description: Name of the maintenance window
          pattern: '^[a-zA-Z0-9()_\-\s]+$'
        description:
          type: string
          description: Description of the maintenance window
        external_link:
          type: string
          description: Optional change Record link to an external system
        filter:
          type: string
          description: Required filter string
        start:
          $ref: '#/components/schemas/Timestamp'
          description: 'Start time of the maintenance window, milliseconds since Jan 1, 1970 GMT'
        duration:
          type: integer
          description: 'Duration of the maintenance window, in seconds'
          format: int32
          minimum: 60
        timezone:
          type: string
          description: Optional timezone of the maintenance window; used for display purposes
        repeats:
          $ref: '#/components/schemas/Repeatable'
          description: 'Optional repeating operation (note: only one of ''until'' and ''times'' is allowed to be used)'
          discriminator:
            propertyName: period
            mapping:
              daily: '#/components/schemas/DailyRepeatable'
              weekly: '#/components/schemas/WeeklyRepeatable'
              monthly: '#/components/schemas/MonthlyRepeatable'
              monthly_nth_day: '#/components/schemas/MonthlyDaysRepeatable'
        status:
          $ref: '#/components/schemas/MaintenanceStatus'
          description: 'Status of the maintenance window, based upon occurrences'
        created:
          $ref: '#/components/schemas/Timestamp'
          description: When the maintenance window was created
        last_updated:
          $ref: '#/components/schemas/Timestamp'
          description: When the maintenance window was last updated
        created_by:
          type: string
          description: User who created the maintenance window
          readOnly: true
        last_updated_by:
          type: string
          description: User who last updated the maintenance window
          readOnly: true
        id:
          type: string
          description: Unique id of the maintenance window occurrence
          readOnly: true
        window_id:
          type: string
          description: Unique id of the maintenance window associated with this occurrence
          readOnly: true
        actual_start:
          $ref: '#/components/schemas/Timestamp'
          description: 'Actual start time of the occurrence, milliseconds since Jan 1, 1970 GMT'
        actual_duration:
          type: integer
          description: 'Actual duration of the occurrence, in seconds'
          format: int32
          readOnly: true
      required:
        - filter
        - start
        - duration
    Timestamp:
      type: integer
      title: Timestamp
      description: 'Number of milliseconds since Jan 1, 1970 UTC'
      format: int64
    Repeatable:
      type: object
      title: Repeatable
      properties:
        period:
          $ref: '#/components/schemas/SchedulePeriod'
          description: Periodicity of the schedule
        until:
          $ref: '#/components/schemas/Timestamp'
          description: '(Optional) Final run time of the schedule, milliseconds since Jan 1, 1970 GMT'
        times:
          type: integer
          description: '(Optional) Maximum number of times to run the schedule (note: only one of ''until'' and ''times'' is allowed to be used)'
          format: int32
          exclusiveMinimum: 0
      required:
        - period
    SchedulePeriod:
      type: string
      enum:
        - daily
        - weekly
        - monthly
        - monthly_nth_day
      title: Schedule Period
      description: Scheduling Periodicity
    MaintenanceStatus:
      type: string
      enum:
        - pending
        - running
        - completed
        - skipped
        - cancelled
      title: Maintenance Status
      description: Maintenance Status
    MoogResponseMaintenanceOccurrenceListDto:
      type: object
      description: Config API MaintenanceOccurrenceListDto response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
            - success
        data:
          $ref: '#/components/schemas/MaintenanceOccurrenceListDto'
      required:
        - status
        - data
    MaintenanceOccurrenceListDto:
      type: object
      title: Maintenance Occurrence List Dto
      properties:
        result:
          type: array
          description: 'List of maintenance window occurrences, as per sortOrder/sortBy/offset/limit; an empty list indicates no more to be retrieved'
          items:
            $ref: '#/components/schemas/MaintenanceOccurrenceDto'
        count:
          type: integer
          description: Total number of occurrences that would have been returned in the absence of offset and limit and unique
          format: int64
    EmailTemplateDto:
      type: object
      title: Email Template Dto
      description: Definition for an email template
      properties:
        id:
          type: string
          description: Unique ID for the template
          readOnly: true
        name:
          type: string
          description: Name of the template
        template:
          type: string
          description: 'The actual template, which can contain embedded HTML'
    MoogResponseEmailTemplateDto:
      type: object
      description: Config API EmailTemplateDto response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
            - success
        data:
          $ref: '#/components/schemas/EmailTemplateDto'
      required:
        - status
        - data
    MoogResponseListOfMenuActionDto:
      type: object
      description: Config API MenuActionDto response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
            - success
        data:
          type: array
          items:
            $ref: '#/components/schemas/MenuActionDto'
      required:
        - status
        - data
    MenuActionDto:
      type: object
      title: Menu Action Dto
      description: Menu action attributes.
      properties:
        name:
          type: string
          description: The name of the menu action.
          pattern: \S
          minLength: 1
          maxLength: 127
        description:
          type: string
          description: Optional description of the menu action
        category_id:
          type: string
          description: Optional ID of the menu action category
        context_type:
          $ref: '#/components/schemas/ContextType'
          description: The context type this menu action is associated with.
        prompted_fields:
          type: array
          description: Optional list of prompted fields for the menu action.
          items:
            $ref: '#/components/schemas/PromptedField'
        operation:
          $ref: '#/components/schemas/MenuActionOperation'
          description: The operation this menu action is associated with.
        id:
          type: string
          description: ID of the menu action
      required:
        - name
        - context_type
        - operation
    ContextType:
      type: string
      enum:
        - ALERT
        - INCIDENT
      title: Context Type
    PromptedField:
      type: object
      title: Prompted Field
      description: Prompted fields for the menu action.
      oneOf:
        - $ref: '#/components/schemas/StringPromptedFieldDto'
        - $ref: '#/components/schemas/NumberPromptedFieldDto'
        - $ref: '#/components/schemas/SelectionListPromptedFieldDto'
    StringPromptedFieldDto:
      type: object
      title: String Prompted Field Dto
      description: String prompted field attributes.
      properties:
        type:
          const: STRING
        name:
          type: string
          description: The name of the prompted field.
          pattern: '^[a-zA-Z0-9-_]+$'
          minLength: 1
          maxLength: 64
        display_name:
          type: string
          description: The display name of the prompted field.
          maxLength: 64
        default_value:
          type: string
          description: Optional default value of the string prompted field.
        min:
          type: integer
          description: Optional minimum length of the string prompted field.
          format: int32
          minimum: 0
        max:
          type: integer
          description: Optional maximum length of the string prompted field.
          format: int32
          minimum: 0
      required:
        - name
    NumberPromptedFieldDto:
      type: object
      title: Number Prompted Field Dto
      description: Number prompted field attributes.
      properties:
        type:
          const: NUMBER
        name:
          type: string
          description: The name of the prompted field.
          pattern: '^[a-zA-Z0-9-_]+$'
          minLength: 1
          maxLength: 64
        display_name:
          type: string
          description: The display name of the prompted field.
          maxLength: 64
        default_value:
          type: number
          description: Optional default value of the number prompted field.
        min:
          type: integer
          description: Optional minimum value of the number prompted field.
          format: int32
        max:
          type: integer
          description: Optional maximum value of the number prompted field.
          format: int32
      required:
        - name
    SelectionListPromptedFieldDto:
      type: object
      title: Selection List Prompted Field Dto
      description: Selection list prompted field attributes.
      properties:
        type:
          const: SELECTION_LIST
        name:
          type: string
          description: The name of the prompted field.
          pattern: '^[a-zA-Z0-9-_]+$'
          minLength: 1
          maxLength: 64
        display_name:
          type: string
          description: The display name of the prompted field.
          maxLength: 64
        default_value:
          $ref: '#/components/schemas/SelectionListValue'
          description: Optional default value from the selection list.
        selection_list:
          type: array
          description: List of values for the user to pick from.
          minItems: 1
          items:
            $ref: '#/components/schemas/SelectionListValue'
      required:
        - name
        - selection_list
    SelectionListValue:
      type: object
      title: Selection List Value
      description: Selection List Value.
      oneOf:
        - $ref: '#/components/schemas/SelectionListStringValueDto'
        - $ref: '#/components/schemas/SelectionListNumberValueDto'
    SelectionListStringValueDto:
      type: object
      title: Selection List String Value Dto
      description: Selection list string value field attributes.
      properties:
        type:
          const: STRING
        value:
          type: string
          description: String value.
          pattern: \S
      required:
        - value
    SelectionListNumberValueDto:
      type: object
      title: Selection List Number Value Dto
      description: Selection list number value field attributes.
      properties:
        type:
          const: NUMBER
        value:
          type: number
          description: Number value.
      required:
        - value
    MenuActionOperation:
      type: object
      title: Menu Action Operation
      description: The operation which menu action is associated with.
      oneOf:
        - $ref: '#/components/schemas/WebhookOperationDto'
        - $ref: '#/components/schemas/ServerApiOperationDto'
        - $ref: '#/components/schemas/SetTagsOperationDto'
        - $ref: '#/components/schemas/StandaloneWorkflowOperationDto'
    WebhookOperationDto:
      type: object
      title: Webhook Operation Dto
      description: Menu action webhook operation attributes.
      properties:
        type:
          const: WEBHOOK
        headers:
          type: object
          description: Any headers required by the webhook operation.
          additionalProperties:
            type: string
          examples:
            - Content-Type: application/json
        request_method:
          $ref: '#/components/schemas/HttpRequestMethod'
          description: The http request method for this operation.
        base_urls:
          type: array
          description: Optional base url for this operation.
          items:
            type: string
            pattern: '^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]'
        url:
          type: string
          description: The url for this operation.
          pattern: '^(https?://|\$\{(\w++)\}).*'
        body:
          type: string
          description: The http request body for this operation.
          examples:
            - '{"id":"${incident_id}","info":"${info}"}'
        response_display_type:
          $ref: '#/components/schemas/ResponseDisplayType'
          description: The response display type for this operation.
      required:
        - request_method
        - url
        - response_display_type
    HttpRequestMethod:
      type: string
      enum:
        - GET
        - PATCH
        - POST
        - PUT
        - DELETE
      title: Http Request Method
    ResponseDisplayType:
      type: string
      enum:
        - NEW_TAB
        - POPUP
        - NONE
      title: Response Display Type
    ServerApiOperationDto:
      type: object
      title: Server Api Operation Dto
      description: Menu action server API operation attributes.
      properties:
        type:
          const: SERVER_API
        headers:
          type: object
          description: Any headers required by the webhook operation.
          additionalProperties:
            type: string
          examples:
            - Content-Type: application/json
        request_method:
          $ref: '#/components/schemas/HttpRequestMethod'
          description: The http request method for this operation.
        base_urls:
          type: array
          description: Optional base url for this operation.
          items:
            type: string
            pattern: '^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]'
        url:
          type: string
          description: The url for this operation.
          pattern: '^(https?://|\$\{(\w++)\}).*'
        body:
          type: string
          description: The http request body for this operation.
          examples:
            - '{"id":"${incident_id}","info":"${info}"}'
        response_display_type:
          $ref: '#/components/schemas/ResponseDisplayType'
          description: The response display type for this operation.
      required:
        - request_method
        - url
        - response_display_type
    SetTagsOperationDto:
      type: object
      title: Set Tags Operation Dto
      description: Menu action set tags operation attributes.
      properties:
        type:
          const: SET_TAGS
        tags:
          type: object
          description: The tags for the operation to set.
          additionalProperties:
            type: string
      required:
        - tags
    StandaloneWorkflowOperationDto:
      type: object
      title: Standalone Workflow Operation Dto
      description: Menu action standalone workflow operation attributes.
      properties:
        type:
          const: STANDALONE_WORKFLOW
        workflow_id:
          type: string
          description: The id of the workflow to invoke.
        workflow_context:
          type: object
          description: Additional workflow context information.
      required:
        - workflow_id
    BaseMenuActionDto:
      type: object
      title: Base Menu Action Dto
      description: Base menu action attributes.
      properties:
        name:
          type: string
          description: The name of the menu action.
          pattern: \S
          minLength: 1
          maxLength: 127
        description:
          type: string
          description: Optional description of the menu action
        category_id:
          type: string
          description: Optional ID of the menu action category
        context_type:
          $ref: '#/components/schemas/ContextType'
          description: The context type this menu action is associated with.
        prompted_fields:
          type: array
          description: Optional list of prompted fields for the menu action.
          items:
            $ref: '#/components/schemas/PromptedField'
        operation:
          $ref: '#/components/schemas/MenuActionOperation'
          description: The operation this menu action is associated with.
      required:
        - name
        - context_type
        - operation
    MoogResponseMenuActionDto:
      type: object
      description: Config API MenuActionDto response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
            - success
        data:
          $ref: '#/components/schemas/MenuActionDto'
      required:
        - status
        - data
    MoogResponseMaintenanceStatusDto:
      type: object
      description: Config API MaintenanceStatusDto response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
            - success
        data:
          $ref: '#/components/schemas/MaintenanceStatusDto'
      required:
        - status
        - data
    MaintenanceStatusDto:
      type: object
      title: Maintenance Status Dto
      description: Definition for a given maintenance window's status
      properties:
        id:
          type: string
          description: Unique id of the maintenance window
          readOnly: true
        name:
          type: string
          description: Name of the maintenance window
          readOnly: true
        status:
          $ref: '#/components/schemas/MaintenanceStatus'
          description: 'Overall status, based on window occurrences'
        expired_occurrence:
          $ref: '#/components/schemas/MaintenanceOccurrenceDto'
          description: Previous occurrence that ran or was cancelled
        running_occurrence:
          $ref: '#/components/schemas/MaintenanceOccurrenceDto'
          description: 'Currently running occurrence, if any'
        pending_occurrence:
          $ref: '#/components/schemas/MaintenanceOccurrenceDto'
          description: 'Next pending occurrence, if any'
    MoogResponseMaintenanceWindowListDto:
      type: object
      description: Config API MaintenanceWindowListDto response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
            - success
        data:
          $ref: '#/components/schemas/MaintenanceWindowListDto'
      required:
        - status
        - data
    MaintenanceWindowListDto:
      type: object
      title: Maintenance Window List Dto
      properties:
        result:
          type: array
          description: 'List of maintenance windows, as per sortOrder/sortBy/offset/limit; an empty list indicates no more to be retrieved'
          items:
            $ref: '#/components/schemas/MaintenanceWindowDto'
        count:
          type: integer
          description: Total number of maintenace windows that would have been returned in the absence of offset and limit
          format: int64
    MaintenanceWindowDto:
      type: object
      title: Maintenance Window Dto
      description: Definition for a given scheduled maintenance window
      properties:
        name:
          type: string
          description: Name of the maintenance window
          pattern: '^[a-zA-Z0-9()_\-\s]+$'
        description:
          type: string
          description: Description of the maintenance window
        external_link:
          type: string
          description: Optional change Record link to an external system
        filter:
          type: string
          description: Required filter string
        start:
          $ref: '#/components/schemas/Timestamp'
          description: 'Start time of the maintenance window, milliseconds since Jan 1, 1970 GMT'
        duration:
          type: integer
          description: 'Duration of the maintenance window, in seconds'
          format: int32
          minimum: 60
        timezone:
          type: string
          description: Optional timezone of the maintenance window; used for display purposes
        repeats:
          $ref: '#/components/schemas/Repeatable'
          description: 'Optional repeating operation (note: only one of ''until'' and ''times'' is allowed to be used)'
          discriminator:
            propertyName: period
            mapping:
              daily: '#/components/schemas/DailyRepeatable'
              weekly: '#/components/schemas/WeeklyRepeatable'
              monthly: '#/components/schemas/MonthlyRepeatable'
              monthly_nth_day: '#/components/schemas/MonthlyDaysRepeatable'
        status:
          $ref: '#/components/schemas/MaintenanceStatus'
          description: 'Status of the maintenance window, based upon occurrences'
        created:
          $ref: '#/components/schemas/Timestamp'
          description: When the maintenance window was created
        last_updated:
          $ref: '#/components/schemas/Timestamp'
          description: When the maintenance window was last updated
        created_by:
          type: string
          description: User who created the maintenance window
          readOnly: true
        last_updated_by:
          type: string
          description: User who last updated the maintenance window
          readOnly: true
        id:
          type: string
          description: Unique id of the maintenance window
          readOnly: true
        deleted:
          type: boolean
          description: Indicates whether the maintenance window was DELETED
          readOnly: true
      required:
        - filter
        - start
        - duration
    BaseMaintenanceWindowDto:
      type: object
      title: Base Maintenance Window Dto
      description: Definition for creating or updating a given scheduled maintenance window
      properties:
        name:
          type: string
          description: Name of the maintenance window
          pattern: '^[a-zA-Z0-9()_\-\s]+$'
        description:
          type: string
          description: Description of the maintenance window
        external_link:
          type: string
          description: Optional change Record link to an external system
        filter:
          type: string
          description: Required filter string
        start:
          $ref: '#/components/schemas/Timestamp'
          description: 'Start time of the maintenance window, milliseconds since Jan 1, 1970 GMT'
        duration:
          type: integer
          description: 'Duration of the maintenance window, in seconds'
          format: int32
          minimum: 60
        timezone:
          type: string
          description: Optional timezone of the maintenance window; used for display purposes
        repeats:
          $ref: '#/components/schemas/Repeatable'
          description: 'Optional repeating operation (note: only one of ''until'' and ''times'' is allowed to be used)'
          discriminator:
            propertyName: period
            mapping:
              daily: '#/components/schemas/DailyRepeatable'
              weekly: '#/components/schemas/WeeklyRepeatable'
              monthly: '#/components/schemas/MonthlyRepeatable'
              monthly_nth_day: '#/components/schemas/MonthlyDaysRepeatable'
      required:
        - filter
        - start
        - duration
    MoogResponseMaintenanceWindowDto:
      type: object
      description: Config API MaintenanceWindowDto response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
            - success
        data:
          $ref: '#/components/schemas/MaintenanceWindowDto'
      required:
        - status
        - data
    WatchersRequestDto:
      type: object
      title: Watchers Request Dto
      description: Request to create or update a Watchers group
      properties:
        id:
          type: string
          description: Unique ID for the watcher group
          readOnly: true
        name:
          type: string
          description: Optional name to assign to the watcher group
        email_template_id:
          type: string
          description: Email template to use for watcher notification (missing indicates default template is used)
        email_subject:
          type: string
          description: Email subject to use for watcher notification (missing indicates default subject is used)
        users:
          type: array
          description: Individual users watching the incident
          items:
            type: string
            pattern: \S
        groups:
          type: array
          description: User Groups watching the incident
          items:
            type: string
            pattern: \S
        operation:
          $ref: '#/components/schemas/WatchersOperation'
          description: 'Request operation: ADD, REMOVE, or REPLACE'
    WatchersOperation:
      type: string
      enum:
        - ADD
        - REPLACE
        - REMOVE
      title: Watchers Operation
    MoogResponseListOfIncidentWatchersDto:
      type: object
      description: Config API IncidentWatchersDto response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
            - success
        data:
          type: array
          items:
            $ref: '#/components/schemas/IncidentWatchersDto'
      required:
        - status
        - data
    IncidentWatchersDto:
      type: object
      title: Incident Watchers Dto
      description: Definition for a given incident watcher group
      properties:
        id:
          type: string
          description: Unique ID for the watcher group
          readOnly: true
        name:
          type: string
          description: Optional name to assign to the watcher group
        email_template_id:
          type: string
          description: Email template to use for watcher notification (missing indicates default template is used)
        email_subject:
          type: string
          description: Email subject to use for watcher notification (missing indicates default subject is used)
        users:
          type: array
          description: Individual users watching the incident
          items:
            type: string
            pattern: \S
        groups:
          type: array
          description: User Groups watching the incident
          items:
            type: string
            pattern: \S
        incident_id:
          type: integer
          description: Incident being watched
          format: int64
      required:
        - incident_id
    WatchersRequestSelfDto:
      type: object
      title: Watchers Request Self Dto
      description: Request to add or remove self to/from a Watchers group
      properties:
        operation:
          $ref: '#/components/schemas/WatchersOperation'
          description: 'Request operation: ADD, or REMOVE'
    BaseMenuActionCategoryDto:
      type: object
      title: Base Menu Action Category Dto
      description: Base menu action category attributes.
      properties:
        name:
          type: string
          description: The name of the menu action category.
          pattern: \S
          minLength: 1
          maxLength: 127
        context_type:
          $ref: '#/components/schemas/ContextType'
          description: The context type this menu action category is associated with.
      required:
        - name
        - context_type
    MoogResponseMenuActionCategoryDto:
      type: object
      description: Config API MenuActionCategoryDto response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
            - success
        data:
          $ref: '#/components/schemas/MenuActionCategoryDto'
      required:
        - status
        - data
    MenuActionCategoryDto:
      type: object
      title: Menu Action Category Dto
      description: Menu action category attributes.
      properties:
        name:
          type: string
          description: The name of the menu action category.
          pattern: \S
          minLength: 1
          maxLength: 127
        context_type:
          $ref: '#/components/schemas/ContextType'
          description: The context type this menu action category is associated with.
        id:
          type: string
          description: ID of the menu action category
      required:
        - name
        - context_type
    MoogResponseListOfTimezoneDto:
      type: object
      description: Config API TimezoneDto response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
            - success
        data:
          type: array
          items:
            $ref: '#/components/schemas/TimezoneDto'
      required:
        - status
        - data
    TimezoneDto:
      type: object
      title: Timezone Dto
      properties:
        zoneId:
          type: string
        offset:
          type: string
    MoogResponseListOfMenuActionCategoryDto:
      type: object
      description: Config API MenuActionCategoryDto response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
            - success
        data:
          type: array
          items:
            $ref: '#/components/schemas/MenuActionCategoryDto'
      required:
        - status
        - data
    MoogResponseListOfEmailTemplateDto:
      type: object
      description: Config API EmailTemplateDto response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
            - success
        data:
          type: array
          items:
            $ref: '#/components/schemas/EmailTemplateDto'
      required:
        - status
        - data
security:
  - ApiKeyAuth: []