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

MongoDB Alert Configurations API

Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. This collection remains under revision and may change.

MongoDB Alert Configurations API is one of 53 APIs that MongoDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Alert Configurations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, rate-limit docs, and a changelog.

This API exposes 8 operations across 4 paths, and defines 276 schemas. It is described by OpenAPI 3.2.0, at version 2.0.

Requests are made against a single base URL, https://cloud.mongodb.com.

8 operations 4 paths 276 schemas 1 DELETE4 GET1 PATCH1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Base URL
https://cloud.mongodb.com/api/atlas/v2
Authentication
HTTP Digest, OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 2

MongoDB Alert Configurations API declares 2 security schemes for authenticating requests. It uses HTTP digest authentication (DigestAuth). It supports OAuth 2.0 (ServiceAccounts) using the clientCredentials flow. By default, every request must be authenticated.

  • ServiceAccounts — Learn more about [Service Accounts](https://www.mongodb.com/docs/atlas/api/service-accounts-overview).

Paths & Operations 8

Across 4 paths, the API surfaces 8 operations — 1 DELETE, 4 GET, 1 PATCH, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Alert Configurations 8

Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. This collection remains under revision and may change.

GET
/api/atlas/v2/alertConfigs/matchers/fieldNames
Return All Alert Configuration Matchers Field Names
listAlertConfigMatcherFieldNames 2 params → 200401403429500
GET
/api/atlas/v2/groups/{groupId}/alertConfigs
Return All Alert Configurations in One Project
listGroupAlertConfigs 6 params → 200401403404429500
POST
/api/atlas/v2/groups/{groupId}/alertConfigs
Create One Alert Configuration in One Project
createGroupAlertConfig 3 params body → 200400401403404429500
DELETE
/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}
Remove One Alert Configuration from One Project
deleteGroupAlertConfig 4 params → 204401403404429500
GET
/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}
Return One Alert Configuration from One Project
getGroupAlertConfig 4 params → 200401403404429500
PATCH
/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}
Toggle State of One Alert Configuration in One Project
toggleGroupAlertConfig 4 params body → 200401403404429500
PUT
/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}
Update One Alert Configuration in One Project
updateGroupAlertConfig 4 params body → 200400401403404429500
GET
/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs
Return All Alert Configurations Set for One Alert
getGroupAlertAlertConfigs 7 params → 200401403404429500

Schemas 276

The contract defines 276 schemas that model the data the API accepts and returns. The most detailed are StreamProcessorMetricAlertConfigViewForNdsGroup (12 properties), ReplicaSetThresholdAlertConfigViewForNdsGroup (11 properties), NDSX509UserAuthenticationAlertConfigViewForNdsGroup (11 properties), BillingThresholdAlertConfigViewForNdsGroup (11 properties). Each schema is shown below with its type and property counts.

GreaterThanDaysThresholdView
object
Threshold value that triggers an alert.
3 properties
TimeMetricThresholdView
object
5 properties 1 required
OpCounterReplCmdRawMetricThresholdView
object
5 properties 1 required
SearchIndexSizeDataMetricThresholdView
object
5 properties 1 required
DbDataSizeTotalDataMetricThresholdView
object
5 properties 1 required
EncryptionKeyAlertConfigViewForNdsGroup
object
Encryption key alert configuration allows to select thresholds which trigger alerts and how users are notified.
11 properties 2 required
DbIndexSizeTotalDataMetricThresholdView
object
5 properties 1 required
ConnectionsMaxRawMetricThresholdView
object
5 properties 1 required
MaxSwapUsageFreeDataMetricThresholdView
object
5 properties 1 required
OpCounterDeleteRawMetricThresholdView
object
5 properties 1 required
ServerlessConnectionPercentageRawMetricThresholdView
object
5 properties 1 required
GlobalLockCurrentQueueTotalRawMetricThresholdView
object
5 properties 1 required
FtsDiskUtilizationDataMetricThresholdView
object
5 properties 1 required
SearchOpCounterInsertRawMetricThresholdView
object
5 properties 1 required
AlertsThresholdInteger
object
A Limit that triggers an alert when exceeded. The resource returns this parameter when eventTypeName has not been set to OUTSIDEMETRICTHRESHOLD.
3 properties
DiskPartitionWriteLatencyDataTimeMetricThresholdView
object
5 properties 1 required
FieldViolation
object
2 properties 2 required
ExtraInfoPageFaultsRawMetricThresholdView
object
5 properties 1 required
ServerlessNetworkBytesOutDataMetricThresholdView
object
5 properties 1 required
GreaterThanTimeThreshold
object
A Limit that triggers an alert when greater than a time period.
3 properties
SearchNumberOfQueriesTotalRawMetricThresholdView
object
5 properties 1 required
NormalizedSystemCpuStealRawMetricThresholdView
object
5 properties 1 required
DiskPartitionReadLatencyDataTimeMetricThresholdView
object
5 properties 1 required
ServerlessOpCounterUpdateRawMetricThresholdView
object
5 properties 1 required
GroupAlertsConfig
object
FlexOpCounterDeleteRawMetricThresholdView
object
5 properties 1 required
MaxDiskPartitionQueueDepthDataRawMetricThresholdView
object
5 properties 1 required
DocumentInsertedRawMetricThresholdView
object
5 properties 1 required
AppServiceEventTypeViewAlertableWithThreshold
string
Event type that triggers an alert.
OrgNotification
object
Organization notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
7 properties 1 required
DiskPartitionWriteIopsDataRawMetricThresholdView
object
5 properties 1 required
ReplicaSetThresholdAlertConfigViewForNdsGroup
object
Replica Set threshold alert configuration allows to select thresholds for conditions of mongod replica set which trigger alerts and how users are notified.
11 properties 2 required
MaxDiskPartitionSpaceUsedIndexRawMetricThresholdView
object
5 properties 1 required
ReplicaSetMatcherField
string
Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.
EventSeverity
string
Severity of the event.
DiskPartitionQueueDepthIndexRawMetricThresholdView
object
5 properties 1 required
Operator
string
Comparison operator to apply when checking the current metric value.
GlobalPageFaultExceptionsThrownRawMetricThresholdView
object
5 properties 1 required
ServerlessNetworkNumRequestRawMetricThresholdView
object
5 properties 1 required
FlexOpCounterUpdateRawMetricThresholdView
object
5 properties 1 required
CpsBackupThresholdAlertConfigViewForNdsGroup
object
Cps Backup threshold alert configuration allows to select thresholds for conditions of CPS backup or oplogs anomalies which trigger alerts and how users are no…
11 properties 2 required
FtsProcessCpuUserRawMetricThresholdView
object
5 properties 1 required
OpCounterQueryRawMetricThresholdView
object
5 properties 1 required
NormalizedSystemCpuUserRawMetricThresholdView
object
5 properties 1 required
PaginatedAlertConfigView
object
3 properties 1 required
MaxNormalizedSystemCpuUserRawMetricThresholdView
object
5 properties 1 required
ReplicaSetAlertConfigViewForNdsGroup
object
Replica Set alert configuration allows to select which conditions of mongod replica set trigger alerts and how users are notified.
11 properties 2 required
FlexAVGWriteExecutionTimeMetricThresholdView
object
5 properties 1 required
OpCounterCmdRawMetricThresholdView
object
5 properties 1 required
SlackNotification
object
Slack notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
7 properties 1 required
SearchMaxFieldsIndexedRawMetricThresholdView
object
5 properties 1 required
AppServiceMetricAlertConfigViewForNdsGroup
object
App Services metric alert configuration allows to select which app service metrics trigger alerts and how users are notified.
11 properties 2 required
MemoryMappedDataMetricThresholdView
object
5 properties 1 required
AlertsToggle
object
Enables or disables the specified alert configuration in the specified project.
1 property
FtsMemoryMappedDataMetricThresholdView
object
5 properties 1 required
AvgCommandExecutionTimeTimeMetricThresholdView
object
5 properties 1 required
DatadogNotification
object
Datadog notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
7 properties 1 required
MuninCpuIowaitRawMetricThresholdView
object
5 properties 1 required
OpCounterReplUpdateRawMetricThresholdView
object
5 properties 1 required
LessThanDaysThresholdView
object
Threshold value that triggers an alert.
3 properties
MaxDiskPartitionQueueDepthJournalRawMetricThresholdView
object
5 properties 1 required
AppServiceMetricMatcherField
string
Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.
SearchNumberOfFieldsInIndexRawMetricThresholdView
object
5 properties 1 required
MaxDiskPartitionSpaceUsedJournalRawMetricThresholdView
object
5 properties 1 required
ReplicaSetEventTypeViewForNdsGroupAlertableNoThreshold
string
Event type that triggers an alert.
GlobalAccessesNotInMemoryRawMetricThresholdView
object
5 properties 1 required
AvgReadExecutionTimeTimeMetricThresholdView
object
5 properties 1 required
FlexOpCounterGetMoreRawMetricThresholdView
object
5 properties 1 required
OpCounterReplInsertRawMetricThresholdView
object
5 properties 1 required
MaxNormalizedSystemCpuStealRawMetricThresholdView
object
5 properties 1 required
HostMatcher
object
Rules to apply when comparing an host against this alert configuration.
3 properties 2 required
BillingEventTypeViewAlertableWithThreshold
string
Event type that triggers an alert.
CursorsTotalOpenRawMetricThresholdView
object
5 properties 1 required
OplogRateGbPerHourDataMetricThresholdView
object
5 properties 1 required
MaxSwapUsageUsedDataMetricThresholdView
object
5 properties 1 required
MuninCpuNiceRawMetricThresholdView
object
5 properties 1 required
ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold
string
Event type that triggers an alert.
UserNotification
object
User notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
7 properties 1 required
DiskPartitionReadIopsIndexRawMetricThresholdView
object
5 properties 1 required
OperationThrottlingRejectedOperationsRawMetricThresholdView
object
5 properties 1 required
MongotuneEventTypeViewAlertable
string
Event type that triggers an alert.
TicketsAvailableReadsRawMetricThresholdView
object
5 properties 1 required
TicketsAvailableWritesRawMetricThresholdView
object
5 properties 1 required
FtsMemoryVirtualDataMetricThresholdView
object
5 properties 1 required
NDSX509UserAuthenticationEventTypeViewAlertable
string
Event type that triggers an alert.
ServerlessOpCounterDeleteRawMetricThresholdView
object
5 properties 1 required
MaxDiskPartitionWriteIopsIndexRawMetricThresholdView
object
5 properties 1 required
MaxDiskPartitionWriteLatencyDataTimeMetricThresholdView
object
5 properties 1 required
SearchNumberOfQueriesSuccessRawMetricThresholdView
object
5 properties 1 required
ServerlessMetricUnits
string
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
OperationsQueriesKilledRawMetricThresholdView
object
5 properties 1 required
RPUMetricThresholdView
object
5 properties 1 required
ApiError
object
6 properties 2 required
MemoryVirtualDataMetricThresholdView
object
5 properties 1 required
FlexNetworkBytesOutDataMetricThresholdView
object
5 properties 1 required
CacheBytesWrittenFromDataMetricThresholdView
object
5 properties 1 required
DiskPartitionReadIopsDataRawMetricThresholdView
object
5 properties 1 required
SMSNotification
object
SMS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
5 properties 1 required
ServerlessAVGWriteExecutionTimeMetricThresholdView
object
5 properties 1 required
MaxDiskPartitionReadLatencyIndexTimeMetricThresholdView
object
5 properties 1 required
SystemMemoryUsedDataMetricThresholdView
object
5 properties 1 required
SystemMemoryAvailableDataMetricThresholdView
object
5 properties 1 required
DiskPartitionReadLatencyIndexTimeMetricThresholdView
object
5 properties 1 required
DataMetricThresholdView
object
5 properties 1 required
FlexNetworkBytesInDataMetricThresholdView
object
5 properties 1 required
WebhookNotification
object
Webhook notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
7 properties 1 required
MatcherFieldView
object
MaxDiskPartitionReadIopsJournalRawMetricThresholdView
object
5 properties 1 required
OpCounterInsertRawMetricThresholdView
object
5 properties 1 required
NumberMetricUnits
string
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
DiskPartitionQueueDepthJournalRawMetricThresholdView
object
5 properties 1 required
SystemMemoryPercentUsedRawMetricThresholdView
object
5 properties 1 required
DiskPartitionReadIopsJournalRawMetricThresholdView
object
5 properties 1 required
MaxDiskPartitionReadIopsDataRawMetricThresholdView
object
5 properties 1 required
MaxSystemNetworkOutDataMetricThresholdView
object
5 properties 1 required
ClusterAlertConfigViewForNdsGroup
object
Cluster alert configuration allows to select which conditions of mongod cluster which trigger alerts and how users are notified.
10 properties 2 required
NormalizedFtsProcessCpuKernelRawMetricThresholdView
object
5 properties 1 required
MaxDiskPartitionReadLatencyDataTimeMetricThresholdView
object
5 properties 1 required
DiskPartitionWriteLatencyIndexTimeMetricThresholdView
object
5 properties 1 required
CacheUsageUsedDataMetricThresholdView
object
5 properties 1 required
RawMetricThresholdView
object
5 properties 1 required
OperationsScanAndOrderRawMetricThresholdView
object
5 properties 1 required
IndexCountersBtreeMissesRawMetricThresholdView
object
5 properties 1 required
NumberMetricThresholdView
object
5 properties 1 required
DocumentUpdatedRawMetricThresholdView
object
5 properties 1 required
GlobalLockCurrentQueueReadersRawMetricThresholdView
object
5 properties 1 required
ServerlessNetworkBytesInDataMetricThresholdView
object
5 properties 1 required
BillingThresholdAlertConfigViewForNdsGroup
object
Billing threshold alert configuration allows to select thresholds for bills and invoices which trigger alerts and how users are notified.
11 properties 2 required
QuerySpillToDiskDuringSortRawMetricThresholdView
object
5 properties 1 required
StreamProcessorMetricThreshold
object
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metric…
5 properties 1 required
AssertRegularRawMetricThresholdView
object
5 properties 1 required
DbDataSizeTotalWoSystemDataMetricThresholdView
object
5 properties 1 required
StreamProcessorEventTypeViewAlertableNoThreshold
string
Event type that triggers an alert.
DiskPartitionSpaceUsedDataRawMetricThresholdView
object
5 properties 1 required
KafkaRawMetricThresholdView
object
5 properties 1 required
EmailNotification
object
Email notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
5 properties 1 required
SearchProcessThrottlingRawMetricThresholdView
object
5 properties 1 required
HipChatNotification
object
HipChat notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
7 properties 1 required
SearchOpCounterGetMoreRawMetricThresholdView
object
5 properties 1 required
DiskPartitionWriteIopsJournalRawMetricThresholdView
object
5 properties 1 required
ServerlessMetricThreshold
object
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metric…
5 properties 1 required
ServerlessOpCounterInsertRawMetricThresholdView
object
5 properties 1 required
ServerlessOpCounterQueryRawMetricThresholdView
object
5 properties 1 required
AvgWriteExecutionTimeTimeMetricThresholdView
object
5 properties 1 required
Link
object
2 properties
CacheUsageDirtyDataMetricThresholdView
object
5 properties 1 required
QueryTargetingScannedObjectsPerReturnedRawMetricThresholdView
object
5 properties 1 required
OpCounterReplDeleteRawMetricThresholdView
object
5 properties 1 required
CursorsTotalTimedOutRawMetricThresholdView
object
5 properties 1 required
MuninCpuStealRawMetricThresholdView
object
5 properties 1 required
DiskPartitionWriteIopsIndexRawMetricThresholdView
object
5 properties 1 required
FlexOpCounterQueryRawMetricThresholdView
object
5 properties 1 required
AppServiceMetricMatcher
object
Rules to apply when comparing an app service metric against this alert configuration.
3 properties 3 required
MaxDiskPartitionWriteIopsJournalRawMetricThresholdView
object
5 properties 1 required
ServerlessOpCounterGetMoreRawMetricThresholdView
object
5 properties 1 required
GlobalLockPercentageRawMetricThresholdView
object
5 properties 1 required
MaxSystemMemoryPercentUsedRawMetricThresholdView
object
5 properties 1 required
HostMatcherField
string
Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.
SearchNumberOfQueriesErrorRawMetricThresholdView
object
5 properties 1 required
AssertWarningRawMetricThresholdView
object
5 properties 1 required
StreamProcessorEventTypeViewAlertableWithThreshold
string
Event type that triggers an alert.
FlexMetricAlertConfigViewForNdsGroup
object
Flex metric alert configuration allows to select which Flex database metrics trigger alerts and how users are notified.
11 properties 2 required
SearchMaxNgramFieldsIndexedRawMetricThresholdView
object
5 properties 1 required
TimeMetricUnits
string
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
DiskPartitionReadLatencyJournalTimeMetricThresholdView
object
5 properties 1 required
RestartsInLastHourRawMetricThresholdView
object
5 properties 1 required
HostMetricThreshold
object
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metric…
5 properties 1 required
OpCounterGetMoreRawMetricThresholdView
object
5 properties 1 required
MuninCpuIrqRawMetricThresholdView
object
5 properties 1 required
StreamProcessorMetricAlertConfigViewForNdsGroup
object
Stream Processor threshold alert configuration allows to select thresholds on metrics which trigger alerts and how users are notified.
12 properties 2 required
IndexCountersBtreeHitsRawMetricThresholdView
object
5 properties 1 required
MaxDiskPartitionQueueDepthIndexRawMetricThresholdView
object
5 properties 1 required
NetworkNumRequestsRawMetricThresholdView
object
5 properties 1 required
MaxSystemMemoryUsedDataMetricThresholdView
object
5 properties 1 required
CacheBytesReadIntoDataMetricThresholdView
object
5 properties 1 required
ClusterMatcherField
string
Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.
ServerlessMetricAlertConfigViewForNdsGroup
object
Serverless metric alert configuration allows to select which serverless database metrics trigger alerts and how users are notified.
11 properties 2 required
FtsJvmCurrentMemoryDataMetricThresholdView
object
5 properties 1 required
ServerlessTotalWriteUnitsRPUMetricThresholdView
object
5 properties 1 required
ConnectionsPercentRawMetricThresholdView
object
5 properties 1 required
FlexMetricEventTypeViewAlertable
string
Event type that triggers an alert.
DataMetricUnits
string
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
HostMetricAlertConfigViewForNdsGroup
object
Host metric alert configuration allows to select which mongod host metrics trigger alerts and how users are notified.
11 properties 2 required
JournalingWriteDataFilesMbDataMetricThresholdView
object
5 properties 1 required
GreaterThanRawThreshold
object
A Limit that triggers an alert when greater than a number.
3 properties
BadRequestDetail
object
Bad request detail.
1 property
QueryTargetingScannedPerReturnedRawMetricThresholdView
object
5 properties 1 required
AppServiceEventTypeViewAlertableNoThreshold
string
Event type that triggers an alert.
ClusterMatcher
object
Rules to apply when comparing an cluster against this alert configuration.
3 properties 3 required
DbStorageTotalDataMetricThresholdView
object
5 properties 1 required
MuninCpuSoftirqRawMetricThresholdView
object
5 properties 1 required
SwapUsageUsedDataMetricThresholdView
object
5 properties 1 required
MaxDiskPartitionReadIopsIndexRawMetricThresholdView
object
5 properties 1 required
DocumentDeletedRawMetricThresholdView
object
5 properties 1 required
FlexClusterMetricThreshold
object
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metric…
5 properties 1 required
HostEventTypeViewForNdsGroupAlertable
string
Event type that triggers an alert.
MicrosoftTeamsNotification
object
Microsoft Teams notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
6 properties 1 required
AssertMsgRawMetricThresholdView
object
5 properties 1 required
StreamsMatcherField
string
Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.
DiskPartitionQueueDepthDataRawMetricThresholdView
object
5 properties 1 required
NDSX509UserAuthenticationAlertConfigViewForNdsGroup
object
X509 User Authentication alert configuration allows to select thresholds for expiration of client, CA certificates and CRL which trigger alerts and how users a…
11 properties 2 required
OpCounterTtlDeletedRawMetricThresholdView
object
5 properties 1 required
GlobalLockCurrentQueueWritersRawMetricThresholdView
object
5 properties 1 required
DiskPartitionSpaceUsedJournalRawMetricThresholdView
object
5 properties 1 required
SearchOpCounterUpdateRawMetricThresholdView
object
5 properties 1 required
GroupNotification
object
Group notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
7 properties 1 required
SearchOpCounterDeleteRawMetricThresholdView
object
5 properties 1 required
IndexCountersBtreeAccessesRawMetricThresholdView
object
5 properties 1 required
AlertMatcher
object
Rules to apply when comparing an target instance against this alert configuration.
3 properties 3 required
MaxDiskPartitionWriteIopsDataRawMetricThresholdView
object
5 properties 1 required
MatcherHostType
string
Value to match or exceed using the specified matchers.operator.
QueryExecutorScannedObjectsRawMetricThresholdView
object
5 properties 1 required
TeamNotification
object
Team notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
8 properties 1 required
OplogMasterTimeTimeMetricThresholdView
object
5 properties 1 required
LogicalSizeDataMetricThresholdView
object
5 properties 1 required
OplogMasterLagTimeDiffTimeMetricThresholdView
object
5 properties 1 required
IndexCountersBtreeMissRatioRawMetricThresholdView
object
5 properties 1 required
MaxDiskPartitionWriteLatencyJournalTimeMetricThresholdView
object
5 properties 1 required
HostAlertConfigViewForNdsGroup
object
Host alert configuration allows to select which mongod host events trigger alerts and how users are notified.
10 properties 2 required
AlertsNotificationRootForGroup
object
One target that MongoDB Cloud sends notifications when an alert triggers.
RawMetricUnits
string
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
StreamProcessorAlertConfigViewForNdsGroup
object
Host metric alert configuration allows to select which Atlas streams processors trigger alerts and how users are notified.
10 properties 2 required
EncryptionKeyEventTypeViewAlertable
string
Event type that triggers an alert.
ComputedMemoryDataMetricThresholdView
object
5 properties 1 required
NetworkBytesOutDataMetricThresholdView
object
5 properties 1 required
MaxDiskPartitionSpaceUsedDataRawMetricThresholdView
object
5 properties 1 required
MaxSystemMemoryAvailableDataMetricThresholdView
object
5 properties 1 required
QueryExecutorScannedRawMetricThresholdView
object
5 properties 1 required
ConnectionsRawMetricThresholdView
object
5 properties 1 required
NormalizedFtsProcessCpuUserRawMetricThresholdView
object
5 properties 1 required
DiskPartitionWriteLatencyJournalTimeMetricThresholdView
object
5 properties 1 required
MongotuneAlertConfigViewForNdsGroup
object
Intelligent Workload Management alert configuration allows to select which Intelligent Workload Management events trigger alerts and how users are notified.
10 properties 2 required
OpsGenieNotification
object
OpsGenie notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
7 properties 1 required
ServerlessEventTypeViewAlertable
string
Event type that triggers an alert.
CpsBackupEventTypeViewForNdsGroupAlertableWithThreshold
string
Event type that triggers an alert.
FtsMemoryResidentDataMetricThresholdView
object
5 properties 1 required
FlexOpCounterCMDRawMetricThresholdView
object
5 properties 1 required
AppServiceMetricThreshold
object
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metric…
5 properties 1 required
SwapUsageFreeDataMetricThresholdView
object
5 properties 1 required
OpCounterUpdateRawMetricThresholdView
object
5 properties 1 required
FlexNetworkNumRequestsRawMetricThresholdView
object
5 properties 1 required
CursorsTotalClientCursorsSizeRawMetricThresholdView
object
5 properties 1 required
DefaultAlertConfigViewForNdsGroup
object
Other alerts which don't have extra details beside of basic one.
10 properties 2 required
SystemNetworkOutDataMetricThresholdView
object
5 properties 1 required
FtsJvmMaxMemoryDataMetricThresholdView
object
5 properties 1 required
AppServiceAlertConfigViewForNdsGroup
object
App Services metric alert configuration allows to select which app service conditions and events trigger alerts and how users are notified.
10 properties 2 required
ReplicaSetMatcher
object
Rules to apply when comparing an replica set against this alert configuration.
3 properties 3 required
MaxSystemNetworkInDataMetricThresholdView
object
5 properties 1 required
HostMetricEventTypeViewAlertable
string
Event type that triggers an alert.
JournalingCommitsInWriteLockRawMetricThresholdView
object
5 properties 1 required
JournalingMbDataMetricThresholdView
object
5 properties 1 required
ServerlessAVGCommandExecutionTimeMetricThresholdView
object
5 properties 1 required
OplogMasterTimeEstimatedTtlTimeMetricThresholdView
object
5 properties 1 required
FlexConnectionPercentRawMetricThresholdView
object
5 properties 1 required
FlexOpCounterInsertRawMetricThresholdView
object
5 properties 1 required
VictorOpsNotification
object
VictorOps notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
7 properties 1 required
SystemNetworkInDataMetricThresholdView
object
5 properties 1 required
PagerDutyNotification
object
PagerDuty notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
7 properties 1 required
DeprecatedStreamProcessorMetricThreshold
object
Threshold value that triggers an alert. Deprecated: use metricThreshold instead.
5 properties 1 required
MemoryResidentDataMetricThresholdView
object
5 properties 1 required
MaxDiskPartitionReadLatencyJournalTimeMetricThresholdView
object
5 properties 1 required
DLQRawMetricThresholdView
object
5 properties 1 required
ServerlessOpCounterCDMRawMetricThresholdView
object
5 properties 1 required
StreamsMatcher
object
Rules to apply when comparing a stream processing workspace or stream processor against this alert configuration.
3 properties 3 required
MuninCpuUserRawMetricThresholdView
object
5 properties 1 required
FlexAVGCommandExecutionTimeMetricThresholdView
object
5 properties 1 required
NetworkBytesInDataMetricThresholdView
object
5 properties 1 required
MaxDiskPartitionWriteLatencyIndexTimeMetricThresholdView
object
5 properties 1 required
FtsProcessCpuKernelRawMetricThresholdView
object
5 properties 1 required
SearchReplicationLagTimeMetricThresholdView
object
5 properties 1 required
ClusterEventTypeViewForNdsGroupAlertable
string
Event type that triggers an alert.
MuninCpuSystemRawMetricThresholdView
object
5 properties 1 required
OplogSlaveLagMasterTimeTimeMetricThresholdView
object
5 properties 1 required
AssertUserRawMetricThresholdView
object
5 properties 1 required
DiskPartitionSpaceUsedIndexRawMetricThresholdView
object
5 properties 1 required
DocumentReturnedRawMetricThresholdView
object
5 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mongodb-alert-configurations-api-openapi.yml Raw ↑

Other APIs MongoDB publishes across the network.

MongoDB Atlas Data API
MongoDB Atlas App Services Admin API
MongoDB Access Tracking API
MongoDB Activity Feed API
MongoDB Alerts API
MongoDB Atlas Search API
MongoDB Auditing API
MongoDB AWS Clusters DNS API
MongoDB Cloud Backups API
MongoDB Cloud Migration Service API
MongoDB Cloud Provider Access API
MongoDB Cluster Outage Simulation API
Where this information came from

This is an independent, third-party profile of MongoDB Alert Configurations 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.