How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Moogsoft

Moogsoft Config API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

Moogsoft Config API is one of 17 APIs that Moogsoft publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include AIOps, Incident Management, Menu action categories, Menu actions, and Catalogs. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and API documentation.

This API exposes 80 operations across 45 paths, organized into 7 resource areas, and defines 75 schemas. It is described by OpenAPI 3.1.0, at version 4.0.0.

Requests are made against 2 base URLs: https://api.moogsoft.ai, https://api.dev.moogsoft.cloud.

80 operations 45 paths 75 schemas 14 DELETE34 GET11 PATCH16 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
4.0.0
Base URL
https://api.moogsoft.ai
Authentication
API Key
Contact
API Support
License
Apex AIOps Incident Management Proprietary
Terms of Service
View terms
Resource Areas
7

Authentication & Security 1

Moogsoft Config API declares 1 security scheme for authenticating requests. An API key is passed in the header as apiKey (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — API Key for accessing Config API

Paths & Operations 80

Across 45 paths, the API surfaces 80 operations — 14 DELETE, 34 GET, 11 PATCH, 16 POST, 5 PUT. They span 7 resource areas: catalogs, correlation-definitions, correlation-groups, maintenance windows, watchers, Menu actions, Menu action categories. Each is listed below with its method, path, parameters, and response codes.

catalogs 27

Catalog management

GET
/v2/catalogs
Returns all catalogs.
getCatalogsV2 → 2004004044XX5XX
POST
/v2/catalogs
Creates a new, empty catalog.
createNewEmptyCatalogV2 body → 2004004044XX5XX
GET
/v2/catalogs/settings
Returns catalog settings.
getCatalogSettings → 2004004044XX5XX
GET
/v2/catalogs/{id}
Returns the catalog with the given id.
getCatalogV2 1 param → 2004004044XX5XX
DELETE
/v2/catalogs/{id}
Deletes the catalog and content documents (by catalog id).
deleteCatalogV2 1 param → 2044004044XX5XX
POST
/v2/catalogs/{id}/batch
Adds a batch of new documents to the catalog.
addCatalogDocumentsV2 1 param body → 2004004044XX5XX
GET
/v2/catalogs/{id}/documents
Returns the matching documents in the catalog.
queryCatalogDocumentsV2 4 params → 4004044XX5XXdefault
POST
/v2/catalogs/{id}/documents
Adds a new document (row) to the catalog.
addCatalogDocumentV2 1 param body → 2004004044XX5XX
PUT
/v2/catalogs/{id}/documents/{documentId}
Replaces a document in the catalog.
replaceCatalogDocumentV2 2 params body → 2044004044XX5XX
PATCH
/v2/catalogs/{id}/documents/{documentId}
Modifies a document in the catalog.
modifyCatalogDocumentV2 2 params body → 2044004044XX5XX
GET
/v2/catalogs/{id}/documents/{documentId}
Returns a document from the catalog.
getCatalogDocumentV2 2 params → 4004044XX5XXdefault
DELETE
/v2/catalogs/{id}/documents/{documentId}
Deletes a single document in a catalog (by catalog id).
deleteCatalogDocumentV2 2 params → 2044004044XX5XX
POST
/v2/catalogs/{id}/search
Returns the matching documents in the catalog.
searchCatalogDocumentsV2 3 params body → 4004044XX5XXdefault
POST
/v3/catalogs/{catalogName}/search
Returns the matching documents in the catalog.
searchCatalogDocumentsV3 3 params body → 4004044XX5XXdefault
PATCH
/v1/catalogs/{catalogName}/documents/{documentId}
Modifies a document in the catalog.
modifyCatalogDocument 2 params body → 2044004044XX5XX
DELETE
/v1/catalogs/{catalogName}/documents/{documentId}
Deletes a single document in a catalog (by catalog name).
deleteCatalogDocument 2 params → 2044004044XX5XX
PATCH
/v1/catalog-files/{name}
Replaces a catalog with schema and documents based on the given CSV file.
replaceCatalog 2 params body → 2004004044XX5XX
POST
/v1/catalog-files
Creates a new catalog with schema and documents based on the given CSV file.
uploadNewCatalog 1 param body → 2004004044XX5XX
GET
/v1/catalogs/{catalogName}/documents
Returns the matching documents in the catalog.
queryCatalogDocuments 4 params → 4004044XX5XXdefault
DELETE
/v1/catalogs/{catalogName}/documents
Deletes all the matching documents in the catalog.
deleteCatalogDocuments 1 param body → 2004004044XX5XX
POST
/v1/catalogs/{catalogName}/documents
Adds a new document (row) to the catalog.
addCatalogDocument 1 param body → 2004004044XX5XX
GET
/v1/catalogs/{catalogName}
Returns the catalog with the given name.
getCatalog 1 param → 2004004044XX5XX
DELETE
/v1/catalogs/{catalogName}
Deletes the catalog and content documents (by catalog name).
deleteCatalog 1 param → 2044004044XX5XX
POST
/v1/catalogs/{catalogName}/search
Returns the matching documents in the catalog.
searchCatalogDocuments 3 params body → 4004044XX5XXdefault
GET
/v1/catalogs
Returns all catalogs.
getCatalogs → 2004004044XX5XX
POST
/v1/catalogs
Creates a new, empty catalog.
createNewEmptyCatalog body → 2004004044XX5XX
POST
/v1/catalogs/{catalogName}/batch
Adds a batch of new documents to the catalog.
addCatalogDocuments 1 param body → 2004004044XX5XX
correlation-definitions 8
GET
/v2/correlation/definitions
Fetches all correlation definitions.
getAllCorrelationDefinitions 1 param → 2004004044XX5XX
POST
/v2/correlation/definitions
Creates a new correlation definition record.
createCorrelationDefinition body → 2004004044XX5XX
PATCH
/v2/correlation/definitions/id/{identifier}
Edits the correlation definition identified in the path parameter (either the id or the name).
modifyCorrelationDefinition2 1 param body → 2004004044XX5XX
GET
/v2/correlation/definitions/id/{identifier}
Fetches correlation definition matching the identifier in the path parameter (either the id or the name).
getDefinition2 1 param → 2004004044XX5XX
DELETE
/v2/correlation/definitions/id/{identifier}
Deletes the correlation definition identified in the path parameter (either the id or the name).
deleteCorrelationDefinition2 1 param → 2044004044XX5XX
PATCH
/v2/correlation/definitions/{identifier}
Edits the correlation definition identified in the path parameter (either the id or the name).
modifyCorrelationDefinition 1 param body → 2004004044XX5XX
GET
/v2/correlation/definitions/{identifier}
Fetches correlation definition matching the identifier in the path parameter (either the id or the name).
getDefinition 1 param → 2004004044XX5XX
DELETE
/v2/correlation/definitions/{identifier}
Deletes the correlation definition identified in the path parameter (either the id or the name).
deleteCorrelationDefinition 1 param → 2044004044XX5XX
correlation-groups 8
GET
/v2/correlation/groups
Fetches all correlation groups.
getAllCorrelationGroups 1 param → 2004004044XX5XX
POST
/v2/correlation/groups
Creates a new correlation group record.
createCorrelationGroup body → 2004004044XX5XX
PATCH
/v2/correlation/groups/id/{identifier}
Edits the correlation group identified in the path parameter (either the id or the name).
modifyCorrelationGroup2 1 param body → 2004004044XX5XX
GET
/v2/correlation/groups/id/{identifier}
Fetches the correlation group identified in the path parameter (either the id or the name).
getGroup2 1 param → 2004004044XX5XX
DELETE
/v2/correlation/groups/id/{identifier}
Deletes the correlation group identified in the path parameter (either the id or the name).
deleteCorrelationGroup2 1 param → 2044004044XX5XX
PATCH
/v2/correlation/groups/{identifier}
Edits the correlation group identified in the path parameter (either the id or the name).
modifyCorrelationGroup 1 param body → 2004004044XX5XX
GET
/v2/correlation/groups/{identifier}
Fetches the correlation group identified in the path parameter (either the id or the name).
getGroup 1 param → 2004004044XX5XX
DELETE
/v2/correlation/groups/{identifier}
Deletes the correlation group identified in the path parameter (either the id or the name).
deleteCorrelationGroup 1 param → 2044004044XX5XX
maintenance windows 17

Maintenance Window scheduling

PUT
/v1/maintenance/occurrences/{id}/cancelled
Cancel a maintenance window schedule
cancelOccurrence 1 param → 2004004044XX5XX
GET
/v1/maintenance/windows/{id}/occurrences/expired
Get expired occurrences for a specific maintenance window
getMaintenanceExpiredOccurrences 3 params → 2004004044XX5XX
GET
/v1/maintenance/occurrences/expired
Get expired, skipped, or cancelled maintenance window occurrences (in reverse time order)
getExpiredMaintenanceOccurrences 2 params → 2004004044XX5XX
GET
/v1/maintenance/occurrences/{id}
Get a maintenance occurrence
getMaintenanceOccurrence 1 param → 2004004044XX5XX
GET
/v1/maintenance/windows/{id}/occurrences/pending
Get pending occurrences for a specific maintenance window
getMaintenancePendingOccurrences 3 params → 2004004044XX5XX
GET
/v1/maintenance/occurrences/running
Gets maintenance window occurrences that are running
getRunningMaintenanceOccurrences 2 params → 2004004044XX5XX
GET
/v1/maintenance/windows/{id}/status
Get the current status of a maintenance window
getMaintenanceWindowStatus 1 param → 2004004044XX5XX
PUT
/v1/maintenance/occurrences/{id}/skipped
Skip a maintenance window schedule
skipOccurrence 1 param → 2004004044XX5XX
GET
/v1/maintenance/windows/{id}/occurrences/running
Get active occurrences for a specific maintenance window
getMaintenanceRunningOccurrences 3 params → 2004004044XX5XX
GET
/v1/maintenance/windows
Get maintenance window schedules
getMaintenanceWindows 5 params → 2004004044XX5XX
POST
/v1/maintenance/windows
Creates a new maintenance window schedule.
createMaintenanceWindow body → 2004004044XX5XX
GET
/v1/maintenance/occurrences/pending
Get pending maintenance window occurrences
getPendingMaintenanceOccurrences 2 params → 2004004044XX5XX
GET
/v1/maintenance/windows/{id}/occurrences
Get all occurrences for a specific maintenance window
getMaintenanceOccurrences 3 params → 2004004044XX5XX
PATCH
/v1/maintenance/windows/{id}
Update a maintenance window schedule
updateMaintenanceWindow 1 param body → 2004004044XX5XX
GET
/v1/maintenance/windows/{id}
Get a maintenance window schedule
getMaintenanceWindow 1 param → 2004004044XX5XX
DELETE
/v1/maintenance/windows/{id}
Delete a maintenance window schedule
deleteMaintenanceWindow 1 param → 2044004044XX5XX
GET
/v1/timezones
Get all available timezones.
getAllTimezones → 2004004044XX5XX
watchers 9

Watchers configuration

PATCH
/v1/templates/email/{id}
Updates an existing e-mail template.
updateTemplate 1 param body → 2004004044XX5XX
GET
/v1/templates/email/{id}
Gets an existing e-mail template.
getTemplate 1 param → 2004004044XX5XX
DELETE
/v1/templates/email/{id}
Deletes an existing e-mail template.
deleteTemplate 1 param → 2044004044XX5XX
PUT
/v1/watchers/incidents/{id}
Creates or updates a Watchers group for an Incident.
putIncidentWatchers 1 param body → 4004044XX5XXdefault
GET
/v1/watchers/incidents/{id}
Gets an existing Incidents Watchers group.
getIncidentWatchers 1 param → 4004044XX5XXdefault
DELETE
/v1/watchers/incidents/{id}
Deletes an existing Incidents Watchers group by Incident ID
deleteIncidentWatchers 1 param → 2044004044XX5XX
PUT
/v1/watchers/incidents/{id}/self
Creates or updates a Watchers group for an Incident, for the current user.
putIncidentWatchersSelf 1 param body → 4004044XX5XXdefault
GET
/v1/templates/email
Gets all existing e-mail templates.
getTemplates → 2004004044XX5XX
POST
/v1/templates/email
Creates an e-mail template.
createTemplate body → 2004004044XX5XX
Menu actions 6
GET
/v1/menu-actions/standalone-workflows
Returns any menu actions that utilize standalone workflows
getStandaloneMenuActions 1 param → 2004004044XX5XX
PATCH
/v1/menu-actions/{id}
Update the menu action with the given id.
updateMenuAction 1 param body → 2004004044XX5XX
GET
/v1/menu-actions/{id}
Get the menu action with the given id.
getMenuAction 1 param → 2004004044XX5XX
DELETE
/v1/menu-actions/{id}
Delete the menu action with the given id.
deleteMenuAction 1 param → 2044004044XX5XX
GET
/v1/menu-actions
Returns any menu actions that match.
findMenuActions 2 params → 2004004044XX5XX
POST
/v1/menu-actions
Create a menu action.
createMenuAction body → 2004004044XX5XX
Menu action categories 5
PATCH
/v1/menu-action-categories/{id}
Update the menu action category with the given id.
updateMenuActionCategory 1 param body → 2004004044XX5XX
GET
/v1/menu-action-categories/{id}
Get the menu action category with the given id.
getMenuActionCategory 1 param → 2004004044XX5XX
DELETE
/v1/menu-action-categories/{id}
Delete the menu action category with the given id.
deleteMenuActionCategory 1 param → 2044004044XX5XX
GET
/v1/menu-action-categories
Returns any menu action categories that match.
findMenuActionCategories 2 params → 2004004044XX5XX
POST
/v1/menu-action-categories
Create a menu action category.
createMenuActionCategory body → 2004004044XX5XX

Schemas 75

The contract defines 75 schemas that model the data the API accepts and returns. The most detailed are MaintenanceOccurrenceDto (17 properties), Catalog (16 properties), MaintenanceWindowDto (15 properties), CorrelationDefinitionDto (13 properties). Each schema is shown below with its type and property counts.

MoogResponseListOfCatalog
object
Config API Catalog response body
2 properties 2 required
Catalog
object
16 properties 2 required
CatalogSchema
object
1 property 1 required
CatalogFieldSchema
object
3 properties 3 required
CatalogFieldSchemaType
string
MoogFailureResponse
object
Config API failure response body
3 properties 2 required
MoogErrorResponse
object
Config API error response body
3 properties 2 required
MoogResponseCatalog
object
Config API Catalog response body
2 properties 2 required
MoogResponseCatalogSettings
object
Config API CatalogSettings response body
2 properties 2 required
CatalogSettings
object
4 properties
DocumentDto
object
MoogResponseListOfDocumentDto
object
Config API DocumentDto response body
2 properties 2 required
MoogResponseDocumentDto
object
Config API DocumentDto response body
2 properties 2 required
MoogResponseListOfCorrelationDefinitionDto
object
Config API CorrelationDefinitionDto response body
2 properties 2 required
CorrelationDefinitionDto
object
13 properties 1 required
DefinitionType
string
The type of correlation definition.
Instant
number
MoogResponseCorrelationDefinitionDto
object
Config API CorrelationDefinitionDto response body
2 properties 2 required
MoogResponseListOfCorrelationGroupDto
object
Config API CorrelationGroupDto response body
2 properties 2 required
CorrelationGroupDto
object
12 properties
DefinitionReferenceDto
object
2 properties 1 required
IncidentMergeThreshold
string
MoogResponseCorrelationGroupDto
object
Config API CorrelationGroupDto response body
2 properties 2 required
SearchFieldsDto
array
SearchFieldDto
object
4 properties 1 required
SearchMatchType
string
ComparisonOperator
string
Comparison operator type to use for the filter
MoogResponseMaintenanceOccurrenceDto
object
Config API MaintenanceOccurrenceDto response body
2 properties 2 required
MaintenanceOccurrenceDto
object
Definition for a specific occurrence of a maintenance window
17 properties 3 required
Timestamp
integer
Number of milliseconds since Jan 1, 1970 UTC
Repeatable
object
3 properties 1 required
SchedulePeriod
string
Scheduling Periodicity
MaintenanceStatus
string
Maintenance Status
MoogResponseMaintenanceOccurrenceListDto
object
Config API MaintenanceOccurrenceListDto response body
2 properties 2 required
MaintenanceOccurrenceListDto
object
2 properties
EmailTemplateDto
object
Definition for an email template
3 properties
MoogResponseEmailTemplateDto
object
Config API EmailTemplateDto response body
2 properties 2 required
MoogResponseListOfMenuActionDto
object
Config API MenuActionDto response body
2 properties 2 required
MenuActionDto
object
Menu action attributes.
7 properties 3 required
ContextType
string
PromptedField
object
Prompted fields for the menu action.
StringPromptedFieldDto
object
String prompted field attributes.
6 properties 1 required
NumberPromptedFieldDto
object
Number prompted field attributes.
6 properties 1 required
SelectionListPromptedFieldDto
object
Selection list prompted field attributes.
5 properties 2 required
SelectionListValue
object
Selection List Value.
SelectionListStringValueDto
object
Selection list string value field attributes.
2 properties 1 required
SelectionListNumberValueDto
object
Selection list number value field attributes.
2 properties 1 required
MenuActionOperation
object
The operation which menu action is associated with.
WebhookOperationDto
object
Menu action webhook operation attributes.
7 properties 3 required
HttpRequestMethod
string
ResponseDisplayType
string
ServerApiOperationDto
object
Menu action server API operation attributes.
7 properties 3 required
SetTagsOperationDto
object
Menu action set tags operation attributes.
2 properties 1 required
StandaloneWorkflowOperationDto
object
Menu action standalone workflow operation attributes.
3 properties 1 required
BaseMenuActionDto
object
Base menu action attributes.
6 properties 3 required
MoogResponseMenuActionDto
object
Config API MenuActionDto response body
2 properties 2 required
MoogResponseMaintenanceStatusDto
object
Config API MaintenanceStatusDto response body
2 properties 2 required
MaintenanceStatusDto
object
Definition for a given maintenance window's status
6 properties
MoogResponseMaintenanceWindowListDto
object
Config API MaintenanceWindowListDto response body
2 properties 2 required
MaintenanceWindowListDto
object
2 properties
MaintenanceWindowDto
object
Definition for a given scheduled maintenance window
15 properties 3 required
BaseMaintenanceWindowDto
object
Definition for creating or updating a given scheduled maintenance window
8 properties 3 required
MoogResponseMaintenanceWindowDto
object
Config API MaintenanceWindowDto response body
2 properties 2 required
WatchersRequestDto
object
Request to create or update a Watchers group
7 properties
WatchersOperation
string
MoogResponseListOfIncidentWatchersDto
object
Config API IncidentWatchersDto response body
2 properties 2 required
IncidentWatchersDto
object
Definition for a given incident watcher group
7 properties 1 required
WatchersRequestSelfDto
object
Request to add or remove self to/from a Watchers group
1 property
BaseMenuActionCategoryDto
object
Base menu action category attributes.
2 properties 2 required
MoogResponseMenuActionCategoryDto
object
Config API MenuActionCategoryDto response body
2 properties 2 required
MenuActionCategoryDto
object
Menu action category attributes.
3 properties 2 required
MoogResponseListOfTimezoneDto
object
Config API TimezoneDto response body
2 properties 2 required
TimezoneDto
object
2 properties
MoogResponseListOfMenuActionCategoryDto
object
Config API MenuActionCategoryDto response body
2 properties 2 required
MoogResponseListOfEmailTemplateDto
object
Config API EmailTemplateDto response body
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

moogsoft-config-openapi.yaml Raw ↑

Other APIs Moogsoft publishes across the network.

Moogsoft Alerts/Incidents API
AE Profile APIs.io
Moogsoft Azure Application Insights API
AE Profile APIs.io
Moogsoft Create Your Own Integration API
AE Profile APIs.io
Moogsoft Amazon CloudWatch API
AE Profile APIs.io
Moogsoft Collector V2 API
AE Profile APIs.io
Moogsoft Events Integration API
AE Profile APIs.io
Moogsoft On-Call API
AE Profile APIs.io
Moogsoft Rollup Service API
AE Profile APIs.io
Moogsoft Metrics API
AE Profile APIs.io
Moogsoft PagerDuty Integration API
AE Profile APIs.io
Moogsoft Probable Root Cause API
AE Profile APIs.io
Moogsoft Similar Incidents API
AE Profile APIs.io
#AIOps#Incident Management#Menu action categories#Menu actions#Catalogs#Config#correlation-definitions#correlation-groups#Maintenance Windows#Watchers
← Back to M APIs
API Details
ID
moogsoft:config
Base URL
https://api.moogsoft.ai
Docs
https://api.docs.moogsoft.com/docs/latest/branches/main/a2faf5e9de2e7-config-api
Provider
Moogsoft
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=config&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/config"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Moogsoft Config API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.