# Moogsoft Config API

**Canonical:** https://apis.io/apis/moogsoft/config/  
**Provider:** Moogsoft — https://apis.io/providers/moogsoft/  
**Base URL:** https://api.moogsoft.ai  
**Documentation:** https://api.docs.moogsoft.com/docs/latest/branches/main/a2faf5e9de2e7-config-api

Moogsoft Config API is one of 17 APIs that [Moogsoft](https://apis.io/providers/moogsoft/) publishes on the [APIs.io](https://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 allows you to save and retrieve config, catalogs, credentials, watchers, menu actions, and maintenance windows

## Operations (60 of 80)

| Method | Path | Summary |
|---|---|---|
| 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 |

…and 20 more operations. They are listed in full on the page.

## Machine-readable artifacts (4)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/moogsoft/refs/heads/main/openapi/moogsoft-config-openapi.yaml
- **APIReference** — https://api.docs.moogsoft.com/docs/latest/branches/main/a2faf5e9de2e7-config-api
- **Documentation** — https://docs.moogsoft.com/moogsoft-cloud/en/apis.html
- **Overlay** — https://raw.githubusercontent.com/api-evangelist/moogsoft/refs/heads/main/overlays/moogsoft-config-overlay.yaml

## Other Moogsoft APIs (12)

- [Moogsoft Alerts/Incidents API](https://apis.io/apis/moogsoft/alerts-incidents/)
- [Moogsoft Azure Application Insights API](https://apis.io/apis/moogsoft/azure-app-insights/)
- [Moogsoft Create Your Own Integration API](https://apis.io/apis/moogsoft/create-your-own-integration/)
- [Moogsoft Amazon CloudWatch API](https://apis.io/apis/moogsoft/cloudwatch/)
- [Moogsoft Collector V2 API](https://apis.io/apis/moogsoft/collector/)
- [Moogsoft Events Integration API](https://apis.io/apis/moogsoft/events-integration/)
- [Moogsoft On-Call API](https://apis.io/apis/moogsoft/on-call/)
- [Moogsoft Rollup Service API](https://apis.io/apis/moogsoft/rollup-service/)
- [Moogsoft Metrics API](https://apis.io/apis/moogsoft/metrics/)
- [Moogsoft PagerDuty Integration API](https://apis.io/apis/moogsoft/pagerduty/)
- [Moogsoft Probable Root Cause API](https://apis.io/apis/moogsoft/probable-root-cause/)
- [Moogsoft Similar Incidents API](https://apis.io/apis/moogsoft/similar-incidents/)

## Tags

AIOps, Incident Management, Menu action categories, Menu actions, Catalogs, Config, correlation-definitions, correlation-groups, Maintenance Windows, Watchers

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/moogsoft/config/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/moogsoft/.