Moogsoft Alerts/Incidents API
This API enables you to retrieve and update alerts and incidents, and other APIs relating to them
Moogsoft Alerts/Incidents 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, alert-filters, alert-workflows, and Alerts. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and API documentation.
This API exposes 71 operations across 51 paths, organized into 19 resource areas, and defines 138 schemas. It is described by OpenAPI 3.1.0, at version 3.0.0.
Requests are made against 2 base URLs: https://api.moogsoft.ai, https://api.dev.moogsoft.cloud.
71 operations
51 paths
138 schemas
4 DELETE31 GET13 PATCH22 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Moogsoft Alerts/Incidents 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 Alerts/Incidents API
Paths & Operations 71
Across 51 paths, the API surfaces 71 operations — 4 DELETE, 31 GET, 13 PATCH, 22 POST, 1 PUT. They span 19 resource areas, including Alert Columns Resource V 2, autoclose-config, autoclose-policy, event-columns, incident columns resource, alerts, overviewStats, dashboardSummaryPost, and 11 more. Each is listed below with its method, path, parameters, and response codes.
Alert Columns Resource V 2 1
GET
/v2/alerts/columns
Get column names of alert DTO.
autoclose-config 2
Autoclose config for alerts and incidents
GET
/v2/autoclose-config
Get autoclose configs
PATCH
/v2/autoclose-config/{id}
Update autoclose config
autoclose-policy 5
Autoclose policy for alerts and incidents
GET
/v2/autoclose-policy
Get autoclose policies
POST
/v2/autoclose-policy
Create autoclose policy
PATCH
/v2/autoclose-policy/{id}
Update autoclose policy
GET
/v2/autoclose-policy/{id}
Get autoclose policy
DELETE
/v2/autoclose-policy/{id}
Delete autoclose policy
event-columns 1
Endpoints relating to getting event columns
GET
/v2/event-columns
get columns names of Event
incident columns resource 1
Returns incident columns names and types
GET
/v2/incidents/columns
Get column names of IncidentDTO.
alerts 19
Alerts generated by Moogsoft Cloud
POST
/v2/situation-room/{incidentId}/alerts
Get alerts for an incident, for the situation room
GET
/v1/alerts/{alertId}/external-ids/{integrationId}
Get details associated with specific external system.
PATCH
/v1/alerts/{alertId}/external-ids/{integrationId}
Add externalID information to an alert.
DELETE
/v1/alerts/{alertId}/external-ids/{integrationId}
Delete externalID information to an alert.
POST
/v1/alerts/{alertId}/external-ids/{integrationId}
Add externalID information to an alert.
GET
/v1/alerts/{alert_id}/events-timeline
List the event timeline buckets associated with the specified alert
GET
/v1/alerts/{alertId}/snapshot
Get an alert snapshots, with highest severity.
PATCH
/v1/alerts/{alertId}
Update the "status" or "assignee" or "assignedgroups" field in a specific alert.
GET
/v1/alerts/{alertId}
Get details of the alert with the specified ID.
PATCH
/v1/alerts/{alertId}/tags
Overwrite the tags of an alert with the supplied tags.
GET
/v1/alerts/{alert_id}/events
List event by alertId with given timeline
GET
/v1/alerts/{alertId}/external-ids
Get all externalIds associated with the alert.
POST
/v1/alerts/snapshot
Get a list of alert snapshots, with highest severity.
GET
/v1/situation-room/{incidentId}/alerts/unlabeled
Get alerts for an incident, that are unlabeled
POST
/v1/situation-room/alerts/unlabeled
Get total count of unlabeled incidents/alerts, for a set of incidents
PATCH
/v1/alerts
Update the "status" or "assignee" or "assignedgroups" field in multiple alerts.
POST
/v1/alerts
Get a list of all alerts with matching criteria.
GET
/v1/alerts
Get a list of all alerts with matching criteria.
POST
/v1/situation-room/{incidentId}/alerts
Get alerts for an incident, for the situation room
overviewStats 1
GET
/v2/stats/overview
Get overview statistics for dashboard
dashboardSummaryPost 1
POST
/v3/service/summary
Get alert/incident summary for dashboard
alert-workflows 6
Alert Workflow related endpoints
GET
/v1/alert-workflows/dependent-on
Checks for any alert workflows dependent on a specific resource.
POST
/v1/alert-workflows/validate
Validates an alert workflows.
POST
/v1/alert-workflows/test/bulk
Tests alert workflows, in bulk.
POST
/v1/alert-workflows/standalone
Invokes the given standalone workflow on a single alert.
GET
/v1/alert-workflows/inputs
Returns inputs previously seen at the input of alert workflow engine.
POST
/v1/alert-workflows/test
Tests an alert workflow.
automation-config 2
Automation config for auto close of alerts and incidents
PATCH
/v1/automation-config
Update automation config for auto close of alerts and incidents.
GET
/v1/automation-config
Get automation config for auto close of alerts and incidents.
incident-comments 4
Get, save and edit incident comments
GET
/v1/incidents/{incidentId}/comments
Get all comments of an existing incident
POST
/v1/incidents/{incidentId}/comments
Add comment to existing incident
PATCH
/v1/incidents/{incidentId}/comments/{commentId}
update existing comment
DELETE
/v1/incidents/{incidentId}/comments/{commentId}
Delete comment of an incident
alerts-search 1
GET
/v1/alerts-search
Search for alerts for given namespace
incident-workflows 6
Incident Workflow endpoints
POST
/v1/incident-workflows/validate
Validates an incident workflow.
GET
/v1/incident-workflows/dependent-on
Checks for any alert workflows dependent on a specific resource.
POST
/v1/incident-workflows/test
Tests an incident workflow.
POST
/v1/incident-workflows/test/bulk
Tests incident workflows, in bulk.
POST
/v1/incident-workflows/standalone
Invokes the named standalone workflow on a single incident.
GET
/v1/incident-workflows/inputs
Returns inputs previously seen at the input of incident workflow engine.
incidents 13
CRUD operations for incidents
PUT
/v1/incidents/{incidentId}
Update incident information.
PATCH
/v1/incidents/{incidentId}
Update the incident to the given status and/or assignee.
GET
/v1/incidents/{incidentId}
Get incident by id.
PATCH
/v1/incidents
Update multiple incidents to the given status and/or assignee.
GET
/v1/incidents
List incidents that match the given filter.
POST
/v1/incidents
Get a list of all incidents with matching criteria.
GET
/v1/incidents/{incidentId}/external-ids
Get all externalIds associated with the incident.
GET
/v1/incidents/{incidentId}/external-ids/{integrationId}
Get details associated with specific external system.
PATCH
/v1/incidents/{incidentId}/external-ids/{integrationId}
Update externalID information to an incident.
DELETE
/v1/incidents/{incidentId}/external-ids/{integrationId}
Delete externalID information from an incident.
POST
/v1/incidents/{incidentId}/external-ids/{integrationId}
Add externalID information to an incident.
PATCH
/v1/incidents/{incidentId}/tags
Update the incident with the given tags
GET
/v1/situation-room/{incidentId}/timeline
Get timeline for an incident
operationalStats 1
POST
/v1/operational-stats
Provides details for operational stats in executive summary
incident-filters 2
Validate incident filters
GET
/v1/incident-filters/columns
Get column names available for use with incident filters.
POST
/v1/incident-filters/validate
Validate Incident Filter
alert-filters 2
Validate filters for alerts
POST
/v1/alert-filters/validate
Validate Alert Filter
GET
/v1/alert-filters/columns
Get column names available for use with alert filters.
incident-tags-config 2
Incident tags configuration
PATCH
/v1/incident-tags-config
Update tags config for incidents.
GET
/v1/incident-tags-config
Get tags config for incidents.
Situation Room Resource 1
GET
/v1/situation-room/columns
Get column names of situation room alert DTO.
Schemas 138
The contract defines 138 schemas that model the data the API accepts and returns. The most detailed are IncidentDto (43 properties), SituationRoomAlertDto (35 properties), AlertDto (34 properties), IncidentTimelineDto (22 properties). Each schema is shown below with its type and property counts.
MoogResponseColumnsDto
object
Alerts/Incidents API ColumnsDto response body
2 properties
2 required
ColumnsDto
object
1 property
ColumnInfo
object
6 properties
FilterOptions
object
4 properties
ComparisonType
string
Comparison operator type to use for the filter
FieldCategory
string
MoogFailureResponse
object
Alerts/Incidents API failure response body
3 properties
2 required
MoogErrorResponse
object
Alerts/Incidents API error response body
3 properties
2 required
MoogResponseListOfAutoCloseConfigDto
object
Alerts/Incidents API AutoCloseConfigDto response body
2 properties
2 required
AutoCloseConfigDto
object
9 properties
Instant
number
MoogResponseAutoCloseConfigDto
object
Alerts/Incidents API AutoCloseConfigDto response body
2 properties
2 required
MoogResponseListOfAutoClosePolicyDto
object
Alerts/Incidents API AutoClosePolicyDto response body
2 properties
2 required
AutoClosePolicyDto
object
11 properties
BaseAutoClosePolicyDto
object
6 properties
MoogResponseAutoClosePolicyDto
object
Alerts/Incidents API AutoClosePolicyDto response body
2 properties
2 required
SituationRoomAlertsRequestV2
object
Situation Room alerts POST request body.
4 properties
1 required
QueryFilter
object
Types of inputs for the queryFilter.
SituationTextFilterDto
object
3 properties
1 required
SortCriteriaDto
object
2 properties
SortOrder
string
SituationJsonFilterDto
object
3 properties
1 required
AgGridSortColumn
object
Sorting criteria to use for searches
2 properties
2 required
MoogResponseSituationRoomAlertList
object
Alerts/Incidents API SituationRoomAlertList response body
2 properties
2 required
SituationRoomAlertList
object
2 properties
SituationRoomAlertDto
object
35 properties
Status
string
Status for incidents and alerts (case-insensitive)
Severity
string
Severity Level (case-insensitive)
MaintenanceWindowStatDto
object
4 properties
ExternalSystemDto
object
6 properties
AlertPrc
object
3 properties
PrcLabel
string
Root-Cause Label (case-insensitive)
PrcBucket
string
Root-Cause Level (case-insensitive)
MoogResponseOverviewWebResponse
object
Alerts/Incidents API OverviewWebResponse response body
2 properties
2 required
OverviewWebResponse
object
3 properties
DashboardSummaryRequest
object
Dashboard summary POST request body
4 properties
2 required
ColumnFilter
object
Polymorphic column filter, based upon filterType
DateColumnFilter
object
Filter a date-based column based on date or date ranges, and a comparison type filterType = "date"
4 properties
2 required
NumberColumnFilter
object
Filter a numeric column based on numeric value(s) and a comparison type filterType = "number"
4 properties
2 required
SetColumnFilter
object
Filter a column based on a set of values provided for comparison filterType = "set"
3 properties
3 required
TextColumnFilter
object
Filter a text column based on a string comparison filterType = "text"
3 properties
2 required
BooleanColumnFilter
object
Filter a boolean column based on a boolean comparison filterType = "boolean"
3 properties
3 required
SortBy
string
Dashboard sort by options
MoogResponseIncidentSummaryResponse
object
Alerts/Incidents API IncidentSummaryResponse response body
2 properties
2 required
IncidentSummaryResponse
object
7 properties
DashboardTile
object
5 properties
ResourceType
Representing different types of resources used by workflow action
MoogResponseListOfWorkflowDependentOnResponseDto
object
Alerts/Incidents API WorkflowDependentOnResponseDto response body
2 properties
2 required
WorkflowDependentOnResponseDto
object
Response DTO used to represent workflow that is dependent on resources
3 properties
WorkflowType
string
MoogResponseExternalSystemDto
object
Alerts/Incidents API ExternalSystemDto response body
2 properties
2 required
BaseWorkflowDto
object
Base workflow attributes.
6 properties
5 required
WorkflowTriggerDto
object
The trigger definition for a workflow.
2 properties
1 required
WorkflowTriggerType
string
WorkflowActionDto
object
A configured action.
5 properties
2 required
AutomationConfigDto
object
5 properties
5 required
MoogResponseAutomationConfigDto
object
Alerts/Incidents API AutomationConfigDto response body
2 properties
2 required
MoogResponseIncidentCommentResponse
object
Alerts/Incidents API IncidentCommentResponse response body
2 properties
2 required
IncidentCommentResponse
object
6 properties
IncidentCommentDto
object
Comment details which are returned from comments endpoint
11 properties
CommentUserDto
object
7 properties
CommentType
string
CommentType for incidents comments
CommentRequestDto
object
Comment details which are needed to create a comment
2 properties
MoogResponseIncidentCommentDto
object
Alerts/Incidents API IncidentCommentDto response body
2 properties
2 required
BulkTestWorkflowDto
object
A bulk test workflow representing multiple workflows and test inputs.
3 properties
3 required
WorkflowDto
object
Workflow with base and generated attributes.
15 properties
5 required
WorkflowStatus
string
WorkflowMetricsDto
object
Metrics about a running workflow.
13 properties
FilterMetricsDto
object
Metrics about a running filter.
7 properties
ActionMetricsDto
object
Metrics about a running action.
8 properties
WorkflowTestResultDto
object
Test results for a workflow.
11 properties
WorkflowTestStatus
string
FilterTestDto
object
Test results for a filter.
5 properties
ActionTestDto
object
Test results for an action.
9 properties
MoogResponseListOfBulkTestWorkflowResultsDto
object
Alerts/Incidents API BulkTestWorkflowResultsDto response body
2 properties
2 required
BulkTestWorkflowResultsDto
object
A bulk test workflow results.
2 properties
PatchPayloadDto
object
Incident update payload
7 properties
Priority
string
Priority of an incident
Impact
string
Impact of an incident
Urgency
string
Urgency of an incident
MoogResponseIncidentDto
object
Alerts/Incidents API IncidentDto response body
2 properties
2 required
IncidentDto
object
Incidents returned from list endpoint
43 properties
CommentDto
object
7 properties
MoogResponseListOfEventTimelineBucket
object
Alerts/Incidents API EventTimelineBucket response body
2 properties
2 required
EventTimelineBucket
object
3 properties
OperationalStatsRequest
object
Executive summary request body
5 properties
3 required
HistogramInterval
string
Histogram calendar interval
TopResourcesType
string
Top Resources Type to fetch
MoogResponseOperationalStatsWebResponse
object
Alerts/Incidents API OperationalStatsWebResponse response body
2 properties
2 required
OperationalStatsWebResponse
object
Incident Operational stats response
3 properties
TimeToResolveDto
object
Incidents resolution details
2 properties
TimeToResolveBucketDto
object
2 properties
IncidentTrendDto
object
Incident trend data for the provided time period
2 properties
IncidentTopResourcesDto
object
Incident top resources for the provided time period
3 properties
MoogResponseAlertDto
object
Alerts/Incidents API AlertDto response body
2 properties
2 required
AlertDto
object
34 properties
BulkPatchPayloadDto
object
Incident bulk update payload
8 properties
1 required
MoogResponseListOfIncidentDto
object
Alerts/Incidents API IncidentDto response body
2 properties
2 required
MoogResponseIncidentList
object
Alerts/Incidents API IncidentList response body
2 properties
2 required
IncidentList
object
3 properties
ListIncidentsRequest
object
List incidents POST request body
8 properties
WorkflowTestWrapperDto
object
A test workflow representing a workflow and test input.
8 properties
6 required
MoogResponseListOfWorkflowTestResultDto
object
Alerts/Incidents API WorkflowTestResultDto response body
2 properties
2 required
StandaloneWorkflowInvocationRequest
object
Request for invoking a standalone workflow
3 properties
3 required
MoogResponseVoid
object
Empty (no data) response
1 property
1 required
AlertUpdateRequest
object
3 properties
MoogResponseListOfRecentInputDto
object
Alerts/Incidents API RecentInputDto response body
2 properties
2 required
RecentInputDto
object
Previously stored sample of input data
3 properties
FilterStringDto
object
A filter string to validate
1 property
1 required
MoogResponseFilterStringResultDto
object
Alerts/Incidents API FilterStringResultDto response body
2 properties
2 required
FilterStringResultDto
object
The result of validating a filter string
1 property
IncidentTagsConfigDto
object
3 properties
1 required
MoogResponseIncidentTagsConfigDto
object
Alerts/Incidents API IncidentTagsConfigDto response body
2 properties
2 required
SetAlertTagsPayloadDto
object
1 property
1 required
MoogResponseEventList
object
Alerts/Incidents API EventList response body
2 properties
2 required
EventList
object
2 properties
EventTimelineDto
object
21 properties
4 required
LocationDto
object
17 properties
GeoLocationDto
object
2 properties
MoogResponseListOfExternalSystemDto
object
Alerts/Incidents API ExternalSystemDto response body
2 properties
2 required
ListSnapshotRequest
object
List alert snapshot POST request body.
2 properties
1 required
MoogResponseAlertList
object
Alerts/Incidents API AlertList response body
2 properties
2 required
AlertList
object
4 properties
UnlabeledRequestDto
object
1 property
1 required
MoogResponseUnlabeledResponseDto
object
Alerts/Incidents API UnlabeledResponseDto response body
2 properties
2 required
UnlabeledResponseDto
object
3 properties
BulkAlertUpdateRequest
object
4 properties
1 required
MoogResponseListOfAlertDto
object
Alerts/Incidents API AlertDto response body
2 properties
2 required
ListAlertsRequest
object
List alerts POST request body.
11 properties
SetIncidentTagsPayloadDto
object
1 property
1 required
IncidentFilterStrDto
object
An incident's filter string to validate
1 property
1 required
MoogResponseIncidentFilterStrResultDto
object
Alerts/Incidents API IncidentFilterStrResultDto response body
2 properties
2 required
IncidentFilterStrResultDto
object
The result of validating an incident's filter string
1 property
SituationRoomAlertsRequest
object
Situation Room alerts POST request body.
5 properties
MoogResponseListOfIncidentTimelineDto
object
Alerts/Incidents API IncidentTimelineDto response body
2 properties
2 required
IncidentTimelineDto
object
Incident timeline entry details
22 properties
ActivityType
string
Activity type for incident timeline
TimelineUserDto
object
7 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Moogsoft 12
Other APIs Moogsoft publishes across the network.
Moogsoft Azure Application Insights API
Moogsoft Create Your Own Integration API
Moogsoft Amazon CloudWatch API
Moogsoft Collector V2 API
Moogsoft Config API
Moogsoft Events Integration API
Moogsoft On-Call API
Moogsoft Rollup Service API
Moogsoft Metrics API
Moogsoft PagerDuty Integration API
Moogsoft Probable Root Cause API
Moogsoft Similar Incidents API
#AIOps#Incident Management#alert-filters#alert-workflows#Alerts#Alerts Search#autoclose-config#autoclose-policy#automation-config
Where this information came from
This is an independent, third-party profile of Moogsoft Alerts/Incidents 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.