Moogsoft

Moogsoft Config API

This API allows you to save and retrieve config, catalogs, credentials, watchers, menu actions, and maintenance windows

GitHub OpenAPI

Operations 80

GET /v2/catalogs Returns all catalogs. #
POST /v2/catalogs Creates a new, empty catalog. #
GET /v2/catalogs/settings Returns catalog settings. #
GET /v2/catalogs/{id} Returns the catalog with the given id. #
DELETE /v2/catalogs/{id} Deletes the catalog and content documents (by catalog id). #
POST /v2/catalogs/{id}/batch Adds a batch of new documents to the catalog. #
GET /v2/catalogs/{id}/documents Returns the matching documents in the catalog. #
POST /v2/catalogs/{id}/documents Adds a new document (row) to the catalog. #
PUT /v2/catalogs/{id}/documents/{documentId} Replaces a document in the catalog. #
PATCH /v2/catalogs/{id}/documents/{documentId} Modifies a document in the catalog. #
GET /v2/catalogs/{id}/documents/{documentId} Returns a document from the catalog. #
DELETE /v2/catalogs/{id}/documents/{documentId} Deletes a single document in a catalog (by catalog id). #
POST /v2/catalogs/{id}/search Returns the matching documents in the catalog. #
GET /v2/correlation/definitions Fetches all correlation definitions. #
POST /v2/correlation/definitions Creates a new correlation definition record. #
PATCH /v2/correlation/definitions/id/{identifier} Edits the correlation definition identified in the path parameter (either the id or the name). #
GET /v2/correlation/definitions/id/{identifier} Fetches correlation definition matching the identifier in the path parameter (either the id or the name). #
DELETE /v2/correlation/definitions/id/{identifier} Deletes the correlation definition identified in the path parameter (either the id or the name). #
PATCH /v2/correlation/definitions/{identifier} Edits the correlation definition identified in the path parameter (either the id or the name). #
GET /v2/correlation/definitions/{identifier} Fetches correlation definition matching the identifier in the path parameter (either the id or the name). #
DELETE /v2/correlation/definitions/{identifier} Deletes the correlation definition identified in the path parameter (either the id or the name). #
GET /v2/correlation/groups Fetches all correlation groups. #
POST /v2/correlation/groups Creates a new correlation group record. #
PATCH /v2/correlation/groups/id/{identifier} Edits the correlation group identified in the path parameter (either the id or the name). #
GET /v2/correlation/groups/id/{identifier} Fetches the correlation group identified in the path parameter (either the id or the name). #
DELETE /v2/correlation/groups/id/{identifier} Deletes the correlation group identified in the path parameter (either the id or the name). #
PATCH /v2/correlation/groups/{identifier} Edits the correlation group identified in the path parameter (either the id or the name). #
GET /v2/correlation/groups/{identifier} Fetches the correlation group identified in the path parameter (either the id or the name). #
DELETE /v2/correlation/groups/{identifier} Deletes the correlation group identified in the path parameter (either the id or the name). #
POST /v3/catalogs/{catalogName}/search Returns the matching documents in the catalog. #
PATCH /v1/catalogs/{catalogName}/documents/{documentId} Modifies a document in the catalog. #
DELETE /v1/catalogs/{catalogName}/documents/{documentId} Deletes a single document in a catalog (by catalog name). #
PUT /v1/maintenance/occurrences/{id}/cancelled Cancel a maintenance window schedule #
GET /v1/maintenance/windows/{id}/occurrences/expired Get expired occurrences for a specific maintenance window #
PATCH /v1/catalog-files/{name} Replaces a catalog with schema and documents based on the given CSV file. #
GET /v1/maintenance/occurrences/expired Get expired, skipped, or cancelled maintenance window occurrences (in reverse time order) #
PATCH /v1/templates/email/{id} Updates an existing e-mail template. #
GET /v1/templates/email/{id} Gets an existing e-mail template. #
DELETE /v1/templates/email/{id} Deletes an existing e-mail template. #
GET /v1/menu-actions/standalone-workflows Returns any menu actions that utilize standalone workflows #
GET /v1/maintenance/occurrences/{id} Get a maintenance occurrence #
PATCH /v1/menu-actions/{id} Update the menu action with the given id. #
GET /v1/menu-actions/{id} Get the menu action with the given id. #
DELETE /v1/menu-actions/{id} Delete the menu action with the given id. #
POST /v1/catalog-files Creates a new catalog with schema and documents based on the given CSV file. #
GET /v1/catalogs/{catalogName}/documents Returns the matching documents in the catalog. #
DELETE /v1/catalogs/{catalogName}/documents Deletes all the matching documents in the catalog. #
POST /v1/catalogs/{catalogName}/documents Adds a new document (row) to the catalog. #
GET /v1/maintenance/windows/{id}/occurrences/pending Get pending occurrences for a specific maintenance window #
GET /v1/maintenance/occurrences/running Gets maintenance window occurrences that are running #
GET /v1/maintenance/windows/{id}/status Get the current status of a maintenance window #
PUT /v1/maintenance/occurrences/{id}/skipped Skip a maintenance window schedule #
GET /v1/maintenance/windows/{id}/occurrences/running Get active occurrences for a specific maintenance window #
GET /v1/maintenance/windows Get maintenance window schedules #
POST /v1/maintenance/windows Creates a new maintenance window schedule. #
GET /v1/maintenance/occurrences/pending Get pending maintenance window occurrences #
GET /v1/maintenance/windows/{id}/occurrences Get all occurrences for a specific maintenance window #
PUT /v1/watchers/incidents/{id} Creates or updates a Watchers group for an Incident. #
GET /v1/watchers/incidents/{id} Gets an existing Incidents Watchers group. #
DELETE /v1/watchers/incidents/{id} Deletes an existing Incidents Watchers group by Incident ID #
GET /v1/catalogs/{catalogName} Returns the catalog with the given name. #
DELETE /v1/catalogs/{catalogName} Deletes the catalog and content documents (by catalog name). #
PATCH /v1/maintenance/windows/{id} Update a maintenance window schedule #
GET /v1/maintenance/windows/{id} Get a maintenance window schedule #
DELETE /v1/maintenance/windows/{id} Delete a maintenance window schedule #
GET /v1/menu-actions Returns any menu actions that match. #
POST /v1/menu-actions Create a menu action. #
PUT /v1/watchers/incidents/{id}/self Creates or updates a Watchers group for an Incident, for the current user. #
PATCH /v1/menu-action-categories/{id} Update the menu action category with the given id. #
GET /v1/menu-action-categories/{id} Get the menu action category with the given id. #
DELETE /v1/menu-action-categories/{id} Delete the menu action category with the given id. #
POST /v1/catalogs/{catalogName}/search Returns the matching documents in the catalog. #
GET /v1/timezones Get all available timezones. #
GET /v1/menu-action-categories Returns any menu action categories that match. #
POST /v1/menu-action-categories Create a menu action category. #
GET /v1/catalogs Returns all catalogs. #
POST /v1/catalogs Creates a new, empty catalog. #
POST /v1/catalogs/{catalogName}/batch Adds a batch of new documents to the catalog. #
GET /v1/templates/email Gets all existing e-mail templates. #
POST /v1/templates/email Creates an e-mail template. #

Documentation

📖
APIReference
https://api.docs.moogsoft.com/docs/latest/branches/main/a2faf5e9de2e7-config-api
📖
Documentation
https://docs.moogsoft.com/moogsoft-cloud/en/apis.html

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/moogsoft/refs/heads/main/openapi/moogsoft-config-openapi.yaml

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/moogsoft/refs/heads/main/overlays/moogsoft-config-overlay.yaml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/config"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

moogsoft-config-openapi.yaml Raw ↑ 
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:
  

# --- truncated at 32 KB (189 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/moogsoft/refs/heads/main/openapi/moogsoft-config-openapi.yaml