Enables or disables the specified alert configuration in the specified project. The resource enables the specified alert configuration if currently enabled. The resource disables the specified alert configuration if currently disabled. To use this resource, the requesting Service Account or API Key must have the Project Alerts Manager, Project Monitoring Admin, Organization Owner, or Project Owner role.
NOTE: This endpoint updates only the enabled/disabled state for the alert configuration. To update more than just this configuration, see Update One Alert Configuration.
This resource remains under revision and may change.
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.
NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
Format should match the following pattern: ^([a-f0-9]{24})$.
Unique 24-hexadecimal digit string that identifies the alert configuration that triggered this alert.
Format should match the following pattern: ^([a-f0-9]{24})$.
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
Default value is false.
Flag that indicates whether the response body should be in the prettyprint format.
Default value is false.
OK
Other alerts which don't have extra details beside of basic one.
Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
Flag that indicates whether someone enabled this alert configuration for the specified project.
Default value is false.
Incident that triggered this alert.
Value is CREDIT_CARD_ABOUT_TO_EXPIRE.
Values are CPS_SNAPSHOT_STARTED, CPS_SNAPSHOT_SUCCESSFUL, CPS_SNAPSHOT_FAILED, CPS_CONCURRENT_SNAPSHOT_FAILED_WILL_RETRY, CPS_SNAPSHOT_FALLBACK_SUCCESSFUL, CPS_SNAPSHOT_FALLBACK_FAILED, CPS_COPY_SNAPSHOT_STARTED, CPS_COPY_SNAPSHOT_FAILED, CPS_COPY_SNAPSHOT_FAILED_WILL_RETRY, CPS_COPY_SNAPSHOT_SUCCESSFUL, CPS_RESTORE_SUCCESSFUL, CPS_EXPORT_SUCCESSFUL, CPS_RESTORE_FAILED, CPS_EXPORT_FAILED, CPS_COLLECTION_RESTORE_SUCCESSFUL, CPS_COLLECTION_RESTORE_FAILED, CPS_COLLECTION_RESTORE_PARTIAL_SUCCESS, CPS_COLLECTION_RESTORE_CANCELED, CPS_AUTO_EXPORT_FAILED, CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED, or CPS_OPLOG_CAUGHT_UP.
Values are CPS_DATA_PROTECTION_ENABLE_REQUESTED, CPS_DATA_PROTECTION_ENABLED, CPS_DATA_PROTECTION_UPDATE_REQUESTED, CPS_DATA_PROTECTION_UPDATED, CPS_DATA_PROTECTION_DISABLE_REQUESTED, CPS_DATA_PROTECTION_DISABLED, or CPS_DATA_PROTECTION_APPROVED_FOR_DISABLEMENT.
Values are FTS_INDEX_DELETION_FAILED, FTS_INDEX_BUILD_COMPLETE, FTS_INDEX_BUILD_FAILED, FTS_INDEX_STALE, FTS_INDEXES_RESTORE_FAILED, or FTS_INDEXES_SYNONYM_MAPPING_INVALID.
Values are USERS_WITHOUT_MULTI_FACTOR_AUTH, ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED, ENCRYPTION_AT_REST_CONFIG_NO_LONGER_VALID, GROUP_SERVICE_ACCOUNT_SECRETS_EXPIRING, GROUP_SERVICE_ACCOUNT_SECRETS_EXPIRED, or ACTIVE_LEGACY_TLS_CONNECTIONS.
Value is MONGOTUNE_ALERT.
Values are CLUSTER_INSTANCE_STOP_START, CLUSTER_INSTANCE_RESYNC_REQUESTED, CLUSTER_INSTANCE_UPDATE_REQUESTED, SAMPLE_DATASET_LOAD_REQUESTED, TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL, TENANT_UPGRADE_TO_SERVERLESS_FAILED, NETWORK_PERMISSION_ENTRY_ADDED, NETWORK_PERMISSION_ENTRY_REMOVED, NETWORK_PERMISSION_ENTRY_UPDATED, CLUSTER_BLOCK_WRITE, or CLUSTER_UNBLOCK_WRITE.
Values are MAINTENANCE_IN_ADVANCED, MAINTENANCE_AUTO_DEFERRED, MAINTENANCE_STARTED, MAINTENANCE_COMPLETED, or MAINTENANCE_NO_LONGER_NEEDED.
Values are ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK or ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK.
Values are JOINED_GROUP, REMOVED_FROM_GROUP, or USER_ROLES_CHANGED_AUDIT.
Values are TAGS_MODIFIED, CLUSTER_TAGS_MODIFIED, or GROUP_TAGS_MODIFIED.
Values are STREAM_PROCESSOR_STATE_IS_FAILED or OUTSIDE_STREAM_PROCESSOR_METRIC_THRESHOLD.
Values are COMPUTE_AUTO_SCALE_INITIATED_BASE, COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS, COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE, COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE, COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE, COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS, DISK_AUTO_SCALE_INITIATED, DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL, DISK_AUTO_SCALE_OPLOG_FAIL, PREDICTIVE_COMPUTE_AUTO_SCALE_INITIATED_BASE, PREDICTIVE_COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE, PREDICTIVE_COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE, or CLUSTER_AUTO_SHARDING_INITIATED.
Value is RESOURCE_POLICY_VIOLATED.
Values are HOST_DOWN, HOST_HAS_INDEX_SUGGESTIONS, HOST_MONGOT_CRASHING_OOM, HOST_MONGOT_STOP_REPLICATION, HOST_MONGOT_APPROACHING_STOP_REPLICATION, HOST_MONGOT_PAUSE_INITIAL_SYNC, HOST_SEARCH_NODE_INDEX_FAILED, HOST_EXTERNAL_LOG_SINK_EXPORT_DOWN, HOST_NOT_ENOUGH_DISK_SPACE, SSH_KEY_NDS_HOST_ACCESS_REQUESTED, SSH_KEY_NDS_HOST_ACCESS_REFRESHED, PUSH_BASED_LOG_EXPORT_STOPPED, PUSH_BASED_LOG_EXPORT_DROPPED_LOG, HOST_VERSION_BEHIND, VERSION_BEHIND, HOST_EXPOSED, HOST_SSL_CERTIFICATE_STALE, HOST_SECURITY_CHECKUP_NOT_MET, or ALERT_HOST_SSH_SESSION_STARTED.
Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.
Format should match the following pattern: ^([a-f0-9]{24})$.
Unique 24-hexadecimal digit string that identifies this alert configuration.
Format should match the following pattern: ^([a-f0-9]{24})$.
List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.
Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.
Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.
Matching conditions for target resources.
Rules to apply when comparing an target instance against this alert configuration.
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.
Comparison operator to apply when checking the current metric value against matcher[n].value. The REGEX operator only supports inclusive matches. Use the NOT_CONTAINS operator to exclude values.
Values are EQUALS, CONTAINS, STARTS_WITH, ENDS_WITH, NOT_EQUALS, NOT_CONTAINS, or REGEX.
Value to match or exceed using the specified matchers.operator.
List that contains the targets that MongoDB Cloud sends notifications.
One target that MongoDB Cloud sends notifications when an alert triggers.
At least 1 but not more than 25 elements.
One target that MongoDB Cloud sends notifications when an alert triggers.
Datadog notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Datadog API Key that MongoDB Cloud needs to send alert notifications to Datadog. You can find this API key in the Datadog dashboard. The resource requires this parameter when "notifications.[n].typeName" : "DATADOG".
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Datadog region that indicates which API Uniform Resource Locator (URL) to use. The resource requires this parameter when "notifications.[n].typeName" : "DATADOG".
Values are US, EU, US3, US5, AP1, or US1_FED. Default value is US.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is DATADOG.
Email notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Email address to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "EMAIL". You don't need to set this value to send emails to individual or groups of MongoDB Cloud users including:
"notifications.[n].typeName" : "USER")"notifications.[n].typeName" : "GROUP")"notifications.[n].typeName" : "ORG")"notifications.[n].typeName" : "TEAM")To send emails to one MongoDB Cloud user or grouping of users, set the notifications.[n].emailEnabled parameter.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is EMAIL.
Group notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
List that contains the one or more project roles that receive the configured alert. This parameter is available when "notifications.[n].typeName" : "GROUP" or "notifications.[n].typeName" : "ORG". If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Human-readable label that displays the alert notification type.
Value is GROUP.
HipChat notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
HipChat API token that MongoDB Cloud needs to send alert notifications to HipChat. The resource requires this parameter when "notifications.[n].typeName" : "HIP_CHAT"". If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
HipChat API room name to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "HIP_CHAT"".
Human-readable label that displays the alert notification type.
Value is HIP_CHAT.
Microsoft Teams notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
Microsoft Teams Webhook Uniform Resource Locator (URL) that MongoDB Cloud needs to send this notification via Microsoft Teams. The resource requires this parameter when "notifications.[n].typeName" : "MICROSOFT_TEAMS". If the URL later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: When you view or edit the alert for a Microsoft Teams notification, the URL appears partially redacted.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is MICROSOFT_TEAMS.
OpsGenie notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
API Key that MongoDB Cloud needs to send this notification via OpsGenie. The resource requires this parameter when "notifications.[n].typeName" : "OPS_GENIE". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
OpsGenie region that indicates which API Uniform Resource Locator (URL) to use.
Values are US or EU. Default value is US.
Human-readable label that displays the alert notification type.
Value is OPS_GENIE.
Organization notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
List that contains the one or more organization roles that receive the configured alert. This parameter is available when "notifications.[n].typeName" : "GROUP" or "notifications.[n].typeName" : "ORG". If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.
Values are ORG_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, ORG_BILLING_READ_ONLY, or ORG_READ_ONLY.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Human-readable label that displays the alert notification type.
Value is ORG.
PagerDuty notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
PagerDuty region that indicates which API Uniform Resource Locator (URL) to use.
Values are US or EU. Default value is US.
PagerDuty service key that MongoDB Cloud needs to send notifications via PagerDuty. The resource requires this parameter when "notifications.[n].typeName" : "PAGER_DUTY". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Human-readable label that displays the alert notification type.
Value is PAGER_DUTY.
Slack notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Slack API token or Bot token that MongoDB Cloud needs to send alert notifications via Slack. The resource requires this parameter when "notifications.[n].typeName" : "SLACK". If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes the token.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Name of the Slack channel to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SLACK".
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is SLACK.
SMS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
Mobile phone number to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SMS".
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is SMS.
Team notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Unique 24-hexadecimal digit string that identifies one MongoDB Cloud team. The resource requires this parameter when "notifications.[n].typeName" : "TEAM".
Format should match the following pattern: ^([a-f0-9]{24})$.
Name of the MongoDB Cloud team that receives this notification. The resource requires this parameter when "notifications.[n].typeName" : "TEAM".
Human-readable label that displays the alert notification type.
Value is TEAM.
User notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Human-readable label that displays the alert notification type.
Value is USER.
MongoDB Cloud username of the person to whom MongoDB Cloud sends notifications. Specify only MongoDB Cloud users who belong to the project that owns the alert configuration. The resource requires this parameter when "notifications.[n].typeName" : "USER".
VictorOps notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is VICTOR_OPS.
API key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when "notifications.[n].typeName" : "VICTOR_OPS". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Routing key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when "notifications.[n].typeName" : "VICTOR_OPS". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
Webhook notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is WEBHOOK.
Authentication secret for a webhook-based alert.
Atlas returns this value if you set notifications.[n].typeName :WEBHOOK and either:
notification.[n].webhookSecret to a non-empty stringNOTE: When you view or edit the alert for a webhook notification, the secret appears completely redacted.
Target URL for a webhook-based alert.
Atlas returns this value if you set "notifications.[n].typeName" :"WEBHOOK" and either:
notification.[n].webhookURL to a non-empty stringNOTE: When you view or edit the alert for a Webhook URL notification, the URL appears partially redacted.
Severity of the event.
Values are INFO, WARNING, ERROR, or CRITICAL.
Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
App Services metric alert configuration allows to select which app service conditions and events trigger alerts and how users are notified.
Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
Flag that indicates whether someone enabled this alert configuration for the specified project.
Default value is false.
Event type that triggers an alert.
Values are URL_CONFIRMATION, SUCCESSFUL_DEPLOY, DEPLOYMENT_FAILURE, REQUEST_RATE_LIMIT, LOG_FORWARDER_FAILURE, SYNC_FAILURE, TRIGGER_FAILURE, TRIGGER_AUTO_RESUMED, DEPLOYMENT_MODEL_CHANGE_SUCCESS, or DEPLOYMENT_MODEL_CHANGE_FAILURE.
Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.
Format should match the following pattern: ^([a-f0-9]{24})$.
Unique 24-hexadecimal digit string that identifies this alert configuration.
Format should match the following pattern: ^([a-f0-9]{24})$.
List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.
Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.
Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.
List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the eventTypeName specifies an event for a host, replica set, or sharded cluster.
Rules to apply when comparing an app service metric against this alert configuration.
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.
Value is APPLICATION_ID.
Comparison operator to apply when checking the current metric value against matcher[n].value. The REGEX operator only supports inclusive matches. Use the NOT_CONTAINS operator to exclude values.
Values are EQUALS, CONTAINS, STARTS_WITH, ENDS_WITH, NOT_EQUALS, NOT_CONTAINS, or REGEX.
Value to match or exceed using the specified matchers.operator.
List that contains the targets that MongoDB Cloud sends notifications.
One target that MongoDB Cloud sends notifications when an alert triggers.
At least 1 but not more than 25 elements.
One target that MongoDB Cloud sends notifications when an alert triggers.
Datadog notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Datadog API Key that MongoDB Cloud needs to send alert notifications to Datadog. You can find this API key in the Datadog dashboard. The resource requires this parameter when "notifications.[n].typeName" : "DATADOG".
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Datadog region that indicates which API Uniform Resource Locator (URL) to use. The resource requires this parameter when "notifications.[n].typeName" : "DATADOG".
Values are US, EU, US3, US5, AP1, or US1_FED. Default value is US.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is DATADOG.
Email notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Email address to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "EMAIL". You don't need to set this value to send emails to individual or groups of MongoDB Cloud users including:
"notifications.[n].typeName" : "USER")"notifications.[n].typeName" : "GROUP")"notifications.[n].typeName" : "ORG")"notifications.[n].typeName" : "TEAM")To send emails to one MongoDB Cloud user or grouping of users, set the notifications.[n].emailEnabled parameter.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is EMAIL.
Group notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
List that contains the one or more project roles that receive the configured alert. This parameter is available when "notifications.[n].typeName" : "GROUP" or "notifications.[n].typeName" : "ORG". If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Human-readable label that displays the alert notification type.
Value is GROUP.
HipChat notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
HipChat API token that MongoDB Cloud needs to send alert notifications to HipChat. The resource requires this parameter when "notifications.[n].typeName" : "HIP_CHAT"". If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
HipChat API room name to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "HIP_CHAT"".
Human-readable label that displays the alert notification type.
Value is HIP_CHAT.
Microsoft Teams notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
Microsoft Teams Webhook Uniform Resource Locator (URL) that MongoDB Cloud needs to send this notification via Microsoft Teams. The resource requires this parameter when "notifications.[n].typeName" : "MICROSOFT_TEAMS". If the URL later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: When you view or edit the alert for a Microsoft Teams notification, the URL appears partially redacted.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is MICROSOFT_TEAMS.
OpsGenie notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
API Key that MongoDB Cloud needs to send this notification via OpsGenie. The resource requires this parameter when "notifications.[n].typeName" : "OPS_GENIE". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
OpsGenie region that indicates which API Uniform Resource Locator (URL) to use.
Values are US or EU. Default value is US.
Human-readable label that displays the alert notification type.
Value is OPS_GENIE.
Organization notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
List that contains the one or more organization roles that receive the configured alert. This parameter is available when "notifications.[n].typeName" : "GROUP" or "notifications.[n].typeName" : "ORG". If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.
Values are ORG_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, ORG_BILLING_READ_ONLY, or ORG_READ_ONLY.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Human-readable label that displays the alert notification type.
Value is ORG.
PagerDuty notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
PagerDuty region that indicates which API Uniform Resource Locator (URL) to use.
Values are US or EU. Default value is US.
PagerDuty service key that MongoDB Cloud needs to send notifications via PagerDuty. The resource requires this parameter when "notifications.[n].typeName" : "PAGER_DUTY". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Human-readable label that displays the alert notification type.
Value is PAGER_DUTY.
Slack notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Slack API token or Bot token that MongoDB Cloud needs to send alert notifications via Slack. The resource requires this parameter when "notifications.[n].typeName" : "SLACK". If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes the token.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Name of the Slack channel to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SLACK".
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is SLACK.
SMS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
Mobile phone number to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SMS".
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is SMS.
Team notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Unique 24-hexadecimal digit string that identifies one MongoDB Cloud team. The resource requires this parameter when "notifications.[n].typeName" : "TEAM".
Format should match the following pattern: ^([a-f0-9]{24})$.
Name of the MongoDB Cloud team that receives this notification. The resource requires this parameter when "notifications.[n].typeName" : "TEAM".
Human-readable label that displays the alert notification type.
Value is TEAM.
User notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Human-readable label that displays the alert notification type.
Value is USER.
MongoDB Cloud username of the person to whom MongoDB Cloud sends notifications. Specify only MongoDB Cloud users who belong to the project that owns the alert configuration. The resource requires this parameter when "notifications.[n].typeName" : "USER".
VictorOps notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is VICTOR_OPS.
API key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when "notifications.[n].typeName" : "VICTOR_OPS". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Routing key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when "notifications.[n].typeName" : "VICTOR_OPS". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
Webhook notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is WEBHOOK.
Authentication secret for a webhook-based alert.
Atlas returns this value if you set notifications.[n].typeName :WEBHOOK and either:
notification.[n].webhookSecret to a non-empty stringNOTE: When you view or edit the alert for a webhook notification, the secret appears completely redacted.
Target URL for a webhook-based alert.
Atlas returns this value if you set "notifications.[n].typeName" :"WEBHOOK" and either:
notification.[n].webhookURL to a non-empty stringNOTE: When you view or edit the alert for a Webhook URL notification, the URL appears partially redacted.
Severity of the event.
Values are INFO, WARNING, ERROR, or CRITICAL.
Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
App Services metric alert configuration allows to select which app service metrics trigger alerts and how users are notified.
Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
Flag that indicates whether someone enabled this alert configuration for the specified project.
Default value is false.
Event type that triggers an alert.
Value is OUTSIDE_REALM_METRIC_THRESHOLD.
Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.
Format should match the following pattern: ^([a-f0-9]{24})$.
Unique 24-hexadecimal digit string that identifies this alert configuration.
Format should match the following pattern: ^([a-f0-9]{24})$.
List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.
Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.
Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.
List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the eventTypeName specifies an event for a host, replica set, or sharded cluster.
Rules to apply when comparing an app service metric against this alert configuration.
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.
Value is APPLICATION_ID.
Comparison operator to apply when checking the current metric value against matcher[n].value. The REGEX operator only supports inclusive matches. Use the NOT_CONTAINS operator to exclude values.
Values are EQUALS, CONTAINS, STARTS_WITH, ENDS_WITH, NOT_EQUALS, NOT_CONTAINS, or REGEX.
Value to match or exceed using the specified matchers.operator.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics in the app services.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is REALM_TRIGGERS_FAILED_REQUESTS.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics in the app services.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is REALM_TRIGGERS_EGRESS_BYTES.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics in the app services.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is REALM_TRIGGERS_RESPONSE_MS.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is HOURS.
List that contains the targets that MongoDB Cloud sends notifications.
One target that MongoDB Cloud sends notifications when an alert triggers.
At least 1 but not more than 25 elements.
One target that MongoDB Cloud sends notifications when an alert triggers.
Datadog notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Datadog API Key that MongoDB Cloud needs to send alert notifications to Datadog. You can find this API key in the Datadog dashboard. The resource requires this parameter when "notifications.[n].typeName" : "DATADOG".
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Datadog region that indicates which API Uniform Resource Locator (URL) to use. The resource requires this parameter when "notifications.[n].typeName" : "DATADOG".
Values are US, EU, US3, US5, AP1, or US1_FED. Default value is US.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is DATADOG.
Email notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Email address to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "EMAIL". You don't need to set this value to send emails to individual or groups of MongoDB Cloud users including:
"notifications.[n].typeName" : "USER")"notifications.[n].typeName" : "GROUP")"notifications.[n].typeName" : "ORG")"notifications.[n].typeName" : "TEAM")To send emails to one MongoDB Cloud user or grouping of users, set the notifications.[n].emailEnabled parameter.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is EMAIL.
Group notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
List that contains the one or more project roles that receive the configured alert. This parameter is available when "notifications.[n].typeName" : "GROUP" or "notifications.[n].typeName" : "ORG". If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Human-readable label that displays the alert notification type.
Value is GROUP.
HipChat notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
HipChat API token that MongoDB Cloud needs to send alert notifications to HipChat. The resource requires this parameter when "notifications.[n].typeName" : "HIP_CHAT"". If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
HipChat API room name to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "HIP_CHAT"".
Human-readable label that displays the alert notification type.
Value is HIP_CHAT.
Microsoft Teams notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
Microsoft Teams Webhook Uniform Resource Locator (URL) that MongoDB Cloud needs to send this notification via Microsoft Teams. The resource requires this parameter when "notifications.[n].typeName" : "MICROSOFT_TEAMS". If the URL later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: When you view or edit the alert for a Microsoft Teams notification, the URL appears partially redacted.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is MICROSOFT_TEAMS.
OpsGenie notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
API Key that MongoDB Cloud needs to send this notification via OpsGenie. The resource requires this parameter when "notifications.[n].typeName" : "OPS_GENIE". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
OpsGenie region that indicates which API Uniform Resource Locator (URL) to use.
Values are US or EU. Default value is US.
Human-readable label that displays the alert notification type.
Value is OPS_GENIE.
Organization notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
List that contains the one or more organization roles that receive the configured alert. This parameter is available when "notifications.[n].typeName" : "GROUP" or "notifications.[n].typeName" : "ORG". If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.
Values are ORG_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, ORG_BILLING_READ_ONLY, or ORG_READ_ONLY.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Human-readable label that displays the alert notification type.
Value is ORG.
PagerDuty notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
PagerDuty region that indicates which API Uniform Resource Locator (URL) to use.
Values are US or EU. Default value is US.
PagerDuty service key that MongoDB Cloud needs to send notifications via PagerDuty. The resource requires this parameter when "notifications.[n].typeName" : "PAGER_DUTY". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Human-readable label that displays the alert notification type.
Value is PAGER_DUTY.
Slack notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Slack API token or Bot token that MongoDB Cloud needs to send alert notifications via Slack. The resource requires this parameter when "notifications.[n].typeName" : "SLACK". If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes the token.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Name of the Slack channel to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SLACK".
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is SLACK.
SMS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
Mobile phone number to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SMS".
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is SMS.
Team notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Unique 24-hexadecimal digit string that identifies one MongoDB Cloud team. The resource requires this parameter when "notifications.[n].typeName" : "TEAM".
Format should match the following pattern: ^([a-f0-9]{24})$.
Name of the MongoDB Cloud team that receives this notification. The resource requires this parameter when "notifications.[n].typeName" : "TEAM".
Human-readable label that displays the alert notification type.
Value is TEAM.
User notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Human-readable label that displays the alert notification type.
Value is USER.
MongoDB Cloud username of the person to whom MongoDB Cloud sends notifications. Specify only MongoDB Cloud users who belong to the project that owns the alert configuration. The resource requires this parameter when "notifications.[n].typeName" : "USER".
VictorOps notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is VICTOR_OPS.
API key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when "notifications.[n].typeName" : "VICTOR_OPS". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Routing key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when "notifications.[n].typeName" : "VICTOR_OPS". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
Webhook notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is WEBHOOK.
Authentication secret for a webhook-based alert.
Atlas returns this value if you set notifications.[n].typeName :WEBHOOK and either:
notification.[n].webhookSecret to a non-empty stringNOTE: When you view or edit the alert for a webhook notification, the secret appears completely redacted.
Target URL for a webhook-based alert.
Atlas returns this value if you set "notifications.[n].typeName" :"WEBHOOK" and either:
notification.[n].webhookURL to a non-empty stringNOTE: When you view or edit the alert for a Webhook URL notification, the URL appears partially redacted.
Severity of the event.
Values are INFO, WARNING, ERROR, or CRITICAL.
Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
Billing threshold alert configuration allows to select thresholds for bills and invoices which trigger alerts and how users are notified.
Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
Flag that indicates whether someone enabled this alert configuration for the specified project.
Default value is false.
Event type that triggers an alert.
Values are PENDING_INVOICE_OVER_THRESHOLD or DAILY_BILL_OVER_THRESHOLD.
Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.
Format should match the following pattern: ^([a-f0-9]{24})$.
Unique 24-hexadecimal digit string that identifies this alert configuration.
Format should match the following pattern: ^([a-f0-9]{24})$.
List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.
Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.
Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.
Matching conditions for target resources.
Rules to apply when comparing an target instance against this alert configuration.
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.
Comparison operator to apply when checking the current metric value against matcher[n].value. The REGEX operator only supports inclusive matches. Use the NOT_CONTAINS operator to exclude values.
Values are EQUALS, CONTAINS, STARTS_WITH, ENDS_WITH, NOT_EQUALS, NOT_CONTAINS, or REGEX.
Value to match or exceed using the specified matchers.operator.
List that contains the targets that MongoDB Cloud sends notifications.
One target that MongoDB Cloud sends notifications when an alert triggers.
At least 1 but not more than 25 elements.
One target that MongoDB Cloud sends notifications when an alert triggers.
Datadog notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Datadog API Key that MongoDB Cloud needs to send alert notifications to Datadog. You can find this API key in the Datadog dashboard. The resource requires this parameter when "notifications.[n].typeName" : "DATADOG".
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Datadog region that indicates which API Uniform Resource Locator (URL) to use. The resource requires this parameter when "notifications.[n].typeName" : "DATADOG".
Values are US, EU, US3, US5, AP1, or US1_FED. Default value is US.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is DATADOG.
Email notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Email address to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "EMAIL". You don't need to set this value to send emails to individual or groups of MongoDB Cloud users including:
"notifications.[n].typeName" : "USER")"notifications.[n].typeName" : "GROUP")"notifications.[n].typeName" : "ORG")"notifications.[n].typeName" : "TEAM")To send emails to one MongoDB Cloud user or grouping of users, set the notifications.[n].emailEnabled parameter.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is EMAIL.
Group notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
List that contains the one or more project roles that receive the configured alert. This parameter is available when "notifications.[n].typeName" : "GROUP" or "notifications.[n].typeName" : "ORG". If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Human-readable label that displays the alert notification type.
Value is GROUP.
HipChat notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
HipChat API token that MongoDB Cloud needs to send alert notifications to HipChat. The resource requires this parameter when "notifications.[n].typeName" : "HIP_CHAT"". If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
HipChat API room name to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "HIP_CHAT"".
Human-readable label that displays the alert notification type.
Value is HIP_CHAT.
Microsoft Teams notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
Microsoft Teams Webhook Uniform Resource Locator (URL) that MongoDB Cloud needs to send this notification via Microsoft Teams. The resource requires this parameter when "notifications.[n].typeName" : "MICROSOFT_TEAMS". If the URL later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: When you view or edit the alert for a Microsoft Teams notification, the URL appears partially redacted.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is MICROSOFT_TEAMS.
OpsGenie notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
API Key that MongoDB Cloud needs to send this notification via OpsGenie. The resource requires this parameter when "notifications.[n].typeName" : "OPS_GENIE". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
OpsGenie region that indicates which API Uniform Resource Locator (URL) to use.
Values are US or EU. Default value is US.
Human-readable label that displays the alert notification type.
Value is OPS_GENIE.
Organization notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
List that contains the one or more organization roles that receive the configured alert. This parameter is available when "notifications.[n].typeName" : "GROUP" or "notifications.[n].typeName" : "ORG". If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.
Values are ORG_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, ORG_BILLING_READ_ONLY, or ORG_READ_ONLY.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Human-readable label that displays the alert notification type.
Value is ORG.
PagerDuty notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
PagerDuty region that indicates which API Uniform Resource Locator (URL) to use.
Values are US or EU. Default value is US.
PagerDuty service key that MongoDB Cloud needs to send notifications via PagerDuty. The resource requires this parameter when "notifications.[n].typeName" : "PAGER_DUTY". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Human-readable label that displays the alert notification type.
Value is PAGER_DUTY.
Slack notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Slack API token or Bot token that MongoDB Cloud needs to send alert notifications via Slack. The resource requires this parameter when "notifications.[n].typeName" : "SLACK". If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes the token.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Name of the Slack channel to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SLACK".
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is SLACK.
SMS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
Mobile phone number to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SMS".
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is SMS.
Team notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Unique 24-hexadecimal digit string that identifies one MongoDB Cloud team. The resource requires this parameter when "notifications.[n].typeName" : "TEAM".
Format should match the following pattern: ^([a-f0-9]{24})$.
Name of the MongoDB Cloud team that receives this notification. The resource requires this parameter when "notifications.[n].typeName" : "TEAM".
Human-readable label that displays the alert notification type.
Value is TEAM.
User notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Human-readable label that displays the alert notification type.
Value is USER.
MongoDB Cloud username of the person to whom MongoDB Cloud sends notifications. Specify only MongoDB Cloud users who belong to the project that owns the alert configuration. The resource requires this parameter when "notifications.[n].typeName" : "USER".
VictorOps notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is VICTOR_OPS.
API key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when "notifications.[n].typeName" : "VICTOR_OPS". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Routing key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when "notifications.[n].typeName" : "VICTOR_OPS". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
Webhook notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is WEBHOOK.
Authentication secret for a webhook-based alert.
Atlas returns this value if you set notifications.[n].typeName :WEBHOOK and either:
notification.[n].webhookSecret to a non-empty stringNOTE: When you view or edit the alert for a webhook notification, the secret appears completely redacted.
Target URL for a webhook-based alert.
Atlas returns this value if you set "notifications.[n].typeName" :"WEBHOOK" and either:
notification.[n].webhookURL to a non-empty stringNOTE: When you view or edit the alert for a Webhook URL notification, the URL appears partially redacted.
Severity of the event.
Values are INFO, WARNING, ERROR, or CRITICAL.
A Limit that triggers an alert when greater than a number.
Comparison operator to apply when checking the current metric value.
Value is GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Value is RAW. Default value is RAW.
Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
Cluster alert configuration allows to select which conditions of mongod cluster which trigger alerts and how users are notified.
Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
Flag that indicates whether someone enabled this alert configuration for the specified project.
Default value is false.
Event type that triggers an alert.
Value is CLUSTER_MONGOS_IS_MISSING.
Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.
Format should match the following pattern: ^([a-f0-9]{24})$.
Unique 24-hexadecimal digit string that identifies this alert configuration.
Format should match the following pattern: ^([a-f0-9]{24})$.
List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.
Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.
Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.
List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the eventTypeName specifies an event for a host, replica set, or sharded cluster.
Rules to apply when comparing an cluster against this alert configuration.
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.
Value is CLUSTER_NAME.
Comparison operator to apply when checking the current metric value against matcher[n].value. The REGEX operator only supports inclusive matches. Use the NOT_CONTAINS operator to exclude values.
Values are EQUALS, CONTAINS, STARTS_WITH, ENDS_WITH, NOT_EQUALS, NOT_CONTAINS, or REGEX.
Value to match or exceed using the specified matchers.operator.
List that contains the targets that MongoDB Cloud sends notifications.
One target that MongoDB Cloud sends notifications when an alert triggers.
At least 1 but not more than 25 elements.
One target that MongoDB Cloud sends notifications when an alert triggers.
Datadog notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Datadog API Key that MongoDB Cloud needs to send alert notifications to Datadog. You can find this API key in the Datadog dashboard. The resource requires this parameter when "notifications.[n].typeName" : "DATADOG".
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Datadog region that indicates which API Uniform Resource Locator (URL) to use. The resource requires this parameter when "notifications.[n].typeName" : "DATADOG".
Values are US, EU, US3, US5, AP1, or US1_FED. Default value is US.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is DATADOG.
Email notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Email address to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "EMAIL". You don't need to set this value to send emails to individual or groups of MongoDB Cloud users including:
"notifications.[n].typeName" : "USER")"notifications.[n].typeName" : "GROUP")"notifications.[n].typeName" : "ORG")"notifications.[n].typeName" : "TEAM")To send emails to one MongoDB Cloud user or grouping of users, set the notifications.[n].emailEnabled parameter.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is EMAIL.
Group notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
List that contains the one or more project roles that receive the configured alert. This parameter is available when "notifications.[n].typeName" : "GROUP" or "notifications.[n].typeName" : "ORG". If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Human-readable label that displays the alert notification type.
Value is GROUP.
HipChat notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
HipChat API token that MongoDB Cloud needs to send alert notifications to HipChat. The resource requires this parameter when "notifications.[n].typeName" : "HIP_CHAT"". If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
HipChat API room name to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "HIP_CHAT"".
Human-readable label that displays the alert notification type.
Value is HIP_CHAT.
Microsoft Teams notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
Microsoft Teams Webhook Uniform Resource Locator (URL) that MongoDB Cloud needs to send this notification via Microsoft Teams. The resource requires this parameter when "notifications.[n].typeName" : "MICROSOFT_TEAMS". If the URL later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: When you view or edit the alert for a Microsoft Teams notification, the URL appears partially redacted.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is MICROSOFT_TEAMS.
OpsGenie notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
API Key that MongoDB Cloud needs to send this notification via OpsGenie. The resource requires this parameter when "notifications.[n].typeName" : "OPS_GENIE". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
OpsGenie region that indicates which API Uniform Resource Locator (URL) to use.
Values are US or EU. Default value is US.
Human-readable label that displays the alert notification type.
Value is OPS_GENIE.
Organization notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
List that contains the one or more organization roles that receive the configured alert. This parameter is available when "notifications.[n].typeName" : "GROUP" or "notifications.[n].typeName" : "ORG". If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.
Values are ORG_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, ORG_BILLING_READ_ONLY, or ORG_READ_ONLY.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Human-readable label that displays the alert notification type.
Value is ORG.
PagerDuty notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
PagerDuty region that indicates which API Uniform Resource Locator (URL) to use.
Values are US or EU. Default value is US.
PagerDuty service key that MongoDB Cloud needs to send notifications via PagerDuty. The resource requires this parameter when "notifications.[n].typeName" : "PAGER_DUTY". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Human-readable label that displays the alert notification type.
Value is PAGER_DUTY.
Slack notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Slack API token or Bot token that MongoDB Cloud needs to send alert notifications via Slack. The resource requires this parameter when "notifications.[n].typeName" : "SLACK". If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes the token.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Name of the Slack channel to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SLACK".
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is SLACK.
SMS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
Mobile phone number to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SMS".
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is SMS.
Team notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Unique 24-hexadecimal digit string that identifies one MongoDB Cloud team. The resource requires this parameter when "notifications.[n].typeName" : "TEAM".
Format should match the following pattern: ^([a-f0-9]{24})$.
Name of the MongoDB Cloud team that receives this notification. The resource requires this parameter when "notifications.[n].typeName" : "TEAM".
Human-readable label that displays the alert notification type.
Value is TEAM.
User notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Human-readable label that displays the alert notification type.
Value is USER.
MongoDB Cloud username of the person to whom MongoDB Cloud sends notifications. Specify only MongoDB Cloud users who belong to the project that owns the alert configuration. The resource requires this parameter when "notifications.[n].typeName" : "USER".
VictorOps notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is VICTOR_OPS.
API key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when "notifications.[n].typeName" : "VICTOR_OPS". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Routing key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when "notifications.[n].typeName" : "VICTOR_OPS". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
Webhook notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is WEBHOOK.
Authentication secret for a webhook-based alert.
Atlas returns this value if you set notifications.[n].typeName :WEBHOOK and either:
notification.[n].webhookSecret to a non-empty stringNOTE: When you view or edit the alert for a webhook notification, the secret appears completely redacted.
Target URL for a webhook-based alert.
Atlas returns this value if you set "notifications.[n].typeName" :"WEBHOOK" and either:
notification.[n].webhookURL to a non-empty stringNOTE: When you view or edit the alert for a Webhook URL notification, the URL appears partially redacted.
Severity of the event.
Values are INFO, WARNING, ERROR, or CRITICAL.
Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
Cps Backup threshold alert configuration allows to select thresholds for conditions of CPS backup or oplogs anomalies which trigger alerts and how users are notified.
Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
Flag that indicates whether someone enabled this alert configuration for the specified project.
Default value is false.
Event type that triggers an alert.
Values are CPS_SNAPSHOT_BEHIND, CPS_PREV_SNAPSHOT_OLD, or CPS_OPLOG_BEHIND.
Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.
Format should match the following pattern: ^([a-f0-9]{24})$.
Unique 24-hexadecimal digit string that identifies this alert configuration.
Format should match the following pattern: ^([a-f0-9]{24})$.
List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.
Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.
Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.
Matching conditions for target resources.
Rules to apply when comparing an target instance against this alert configuration.
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.
Comparison operator to apply when checking the current metric value against matcher[n].value. The REGEX operator only supports inclusive matches. Use the NOT_CONTAINS operator to exclude values.
Values are EQUALS, CONTAINS, STARTS_WITH, ENDS_WITH, NOT_EQUALS, NOT_CONTAINS, or REGEX.
Value to match or exceed using the specified matchers.operator.
List that contains the targets that MongoDB Cloud sends notifications.
One target that MongoDB Cloud sends notifications when an alert triggers.
At least 1 but not more than 25 elements.
One target that MongoDB Cloud sends notifications when an alert triggers.
Datadog notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Datadog API Key that MongoDB Cloud needs to send alert notifications to Datadog. You can find this API key in the Datadog dashboard. The resource requires this parameter when "notifications.[n].typeName" : "DATADOG".
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Datadog region that indicates which API Uniform Resource Locator (URL) to use. The resource requires this parameter when "notifications.[n].typeName" : "DATADOG".
Values are US, EU, US3, US5, AP1, or US1_FED. Default value is US.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is DATADOG.
Email notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Email address to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "EMAIL". You don't need to set this value to send emails to individual or groups of MongoDB Cloud users including:
"notifications.[n].typeName" : "USER")"notifications.[n].typeName" : "GROUP")"notifications.[n].typeName" : "ORG")"notifications.[n].typeName" : "TEAM")To send emails to one MongoDB Cloud user or grouping of users, set the notifications.[n].emailEnabled parameter.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is EMAIL.
Group notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
List that contains the one or more project roles that receive the configured alert. This parameter is available when "notifications.[n].typeName" : "GROUP" or "notifications.[n].typeName" : "ORG". If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Human-readable label that displays the alert notification type.
Value is GROUP.
HipChat notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
HipChat API token that MongoDB Cloud needs to send alert notifications to HipChat. The resource requires this parameter when "notifications.[n].typeName" : "HIP_CHAT"". If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
HipChat API room name to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "HIP_CHAT"".
Human-readable label that displays the alert notification type.
Value is HIP_CHAT.
Microsoft Teams notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
Microsoft Teams Webhook Uniform Resource Locator (URL) that MongoDB Cloud needs to send this notification via Microsoft Teams. The resource requires this parameter when "notifications.[n].typeName" : "MICROSOFT_TEAMS". If the URL later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: When you view or edit the alert for a Microsoft Teams notification, the URL appears partially redacted.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is MICROSOFT_TEAMS.
OpsGenie notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
API Key that MongoDB Cloud needs to send this notification via OpsGenie. The resource requires this parameter when "notifications.[n].typeName" : "OPS_GENIE". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
OpsGenie region that indicates which API Uniform Resource Locator (URL) to use.
Values are US or EU. Default value is US.
Human-readable label that displays the alert notification type.
Value is OPS_GENIE.
Organization notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
List that contains the one or more organization roles that receive the configured alert. This parameter is available when "notifications.[n].typeName" : "GROUP" or "notifications.[n].typeName" : "ORG". If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.
Values are ORG_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, ORG_BILLING_READ_ONLY, or ORG_READ_ONLY.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Human-readable label that displays the alert notification type.
Value is ORG.
PagerDuty notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
PagerDuty region that indicates which API Uniform Resource Locator (URL) to use.
Values are US or EU. Default value is US.
PagerDuty service key that MongoDB Cloud needs to send notifications via PagerDuty. The resource requires this parameter when "notifications.[n].typeName" : "PAGER_DUTY". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Human-readable label that displays the alert notification type.
Value is PAGER_DUTY.
Slack notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Slack API token or Bot token that MongoDB Cloud needs to send alert notifications via Slack. The resource requires this parameter when "notifications.[n].typeName" : "SLACK". If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes the token.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Name of the Slack channel to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SLACK".
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is SLACK.
SMS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
Mobile phone number to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SMS".
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is SMS.
Team notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Unique 24-hexadecimal digit string that identifies one MongoDB Cloud team. The resource requires this parameter when "notifications.[n].typeName" : "TEAM".
Format should match the following pattern: ^([a-f0-9]{24})$.
Name of the MongoDB Cloud team that receives this notification. The resource requires this parameter when "notifications.[n].typeName" : "TEAM".
Human-readable label that displays the alert notification type.
Value is TEAM.
User notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Human-readable label that displays the alert notification type.
Value is USER.
MongoDB Cloud username of the person to whom MongoDB Cloud sends notifications. Specify only MongoDB Cloud users who belong to the project that owns the alert configuration. The resource requires this parameter when "notifications.[n].typeName" : "USER".
VictorOps notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is VICTOR_OPS.
API key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when "notifications.[n].typeName" : "VICTOR_OPS". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Routing key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when "notifications.[n].typeName" : "VICTOR_OPS". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
Webhook notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is WEBHOOK.
Authentication secret for a webhook-based alert.
Atlas returns this value if you set notifications.[n].typeName :WEBHOOK and either:
notification.[n].webhookSecret to a non-empty stringNOTE: When you view or edit the alert for a webhook notification, the secret appears completely redacted.
Target URL for a webhook-based alert.
Atlas returns this value if you set "notifications.[n].typeName" :"WEBHOOK" and either:
notification.[n].webhookURL to a non-empty stringNOTE: When you view or edit the alert for a Webhook URL notification, the URL appears partially redacted.
Severity of the event.
Values are INFO, WARNING, ERROR, or CRITICAL.
A Limit that triggers an alert when greater than a time period.
Comparison operator to apply when checking the current metric value.
Value is GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Values are NANOSECONDS, MILLISECONDS, MILLION_MINUTES, SECONDS, MINUTES, HOURS, or DAYS. Default value is HOURS.
Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
Encryption key alert configuration allows to select thresholds which trigger alerts and how users are notified.
Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
Flag that indicates whether someone enabled this alert configuration for the specified project.
Default value is false.
Event type that triggers an alert.
Values are AWS_ENCRYPTION_KEY_NEEDS_ROTATION, AZURE_ENCRYPTION_KEY_NEEDS_ROTATION, GCP_ENCRYPTION_KEY_NEEDS_ROTATION, AWS_ENCRYPTION_KEY_INVALID, AZURE_ENCRYPTION_KEY_INVALID, or GCP_ENCRYPTION_KEY_INVALID.
Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.
Format should match the following pattern: ^([a-f0-9]{24})$.
Unique 24-hexadecimal digit string that identifies this alert configuration.
Format should match the following pattern: ^([a-f0-9]{24})$.
List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.
Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.
Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.
Matching conditions for target resources.
Rules to apply when comparing an target instance against this alert configuration.
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.
Comparison operator to apply when checking the current metric value against matcher[n].value. The REGEX operator only supports inclusive matches. Use the NOT_CONTAINS operator to exclude values.
Values are EQUALS, CONTAINS, STARTS_WITH, ENDS_WITH, NOT_EQUALS, NOT_CONTAINS, or REGEX.
Value to match or exceed using the specified matchers.operator.
List that contains the targets that MongoDB Cloud sends notifications.
One target that MongoDB Cloud sends notifications when an alert triggers.
At least 1 but not more than 25 elements.
One target that MongoDB Cloud sends notifications when an alert triggers.
Datadog notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Datadog API Key that MongoDB Cloud needs to send alert notifications to Datadog. You can find this API key in the Datadog dashboard. The resource requires this parameter when "notifications.[n].typeName" : "DATADOG".
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Datadog region that indicates which API Uniform Resource Locator (URL) to use. The resource requires this parameter when "notifications.[n].typeName" : "DATADOG".
Values are US, EU, US3, US5, AP1, or US1_FED. Default value is US.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is DATADOG.
Email notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Email address to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "EMAIL". You don't need to set this value to send emails to individual or groups of MongoDB Cloud users including:
"notifications.[n].typeName" : "USER")"notifications.[n].typeName" : "GROUP")"notifications.[n].typeName" : "ORG")"notifications.[n].typeName" : "TEAM")To send emails to one MongoDB Cloud user or grouping of users, set the notifications.[n].emailEnabled parameter.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is EMAIL.
Group notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
List that contains the one or more project roles that receive the configured alert. This parameter is available when "notifications.[n].typeName" : "GROUP" or "notifications.[n].typeName" : "ORG". If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Human-readable label that displays the alert notification type.
Value is GROUP.
HipChat notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
HipChat API token that MongoDB Cloud needs to send alert notifications to HipChat. The resource requires this parameter when "notifications.[n].typeName" : "HIP_CHAT"". If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
HipChat API room name to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "HIP_CHAT"".
Human-readable label that displays the alert notification type.
Value is HIP_CHAT.
Microsoft Teams notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
Microsoft Teams Webhook Uniform Resource Locator (URL) that MongoDB Cloud needs to send this notification via Microsoft Teams. The resource requires this parameter when "notifications.[n].typeName" : "MICROSOFT_TEAMS". If the URL later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: When you view or edit the alert for a Microsoft Teams notification, the URL appears partially redacted.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is MICROSOFT_TEAMS.
OpsGenie notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
API Key that MongoDB Cloud needs to send this notification via OpsGenie. The resource requires this parameter when "notifications.[n].typeName" : "OPS_GENIE". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
OpsGenie region that indicates which API Uniform Resource Locator (URL) to use.
Values are US or EU. Default value is US.
Human-readable label that displays the alert notification type.
Value is OPS_GENIE.
Organization notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
List that contains the one or more organization roles that receive the configured alert. This parameter is available when "notifications.[n].typeName" : "GROUP" or "notifications.[n].typeName" : "ORG". If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.
Values are ORG_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, ORG_BILLING_READ_ONLY, or ORG_READ_ONLY.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Human-readable label that displays the alert notification type.
Value is ORG.
PagerDuty notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
PagerDuty region that indicates which API Uniform Resource Locator (URL) to use.
Values are US or EU. Default value is US.
PagerDuty service key that MongoDB Cloud needs to send notifications via PagerDuty. The resource requires this parameter when "notifications.[n].typeName" : "PAGER_DUTY". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Human-readable label that displays the alert notification type.
Value is PAGER_DUTY.
Slack notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Slack API token or Bot token that MongoDB Cloud needs to send alert notifications via Slack. The resource requires this parameter when "notifications.[n].typeName" : "SLACK". If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes the token.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Name of the Slack channel to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SLACK".
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is SLACK.
SMS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
Mobile phone number to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SMS".
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is SMS.
Team notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Unique 24-hexadecimal digit string that identifies one MongoDB Cloud team. The resource requires this parameter when "notifications.[n].typeName" : "TEAM".
Format should match the following pattern: ^([a-f0-9]{24})$.
Name of the MongoDB Cloud team that receives this notification. The resource requires this parameter when "notifications.[n].typeName" : "TEAM".
Human-readable label that displays the alert notification type.
Value is TEAM.
User notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Human-readable label that displays the alert notification type.
Value is USER.
MongoDB Cloud username of the person to whom MongoDB Cloud sends notifications. Specify only MongoDB Cloud users who belong to the project that owns the alert configuration. The resource requires this parameter when "notifications.[n].typeName" : "USER".
VictorOps notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is VICTOR_OPS.
API key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when "notifications.[n].typeName" : "VICTOR_OPS". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Routing key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when "notifications.[n].typeName" : "VICTOR_OPS". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
Webhook notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is WEBHOOK.
Authentication secret for a webhook-based alert.
Atlas returns this value if you set notifications.[n].typeName :WEBHOOK and either:
notification.[n].webhookSecret to a non-empty stringNOTE: When you view or edit the alert for a webhook notification, the secret appears completely redacted.
Target URL for a webhook-based alert.
Atlas returns this value if you set "notifications.[n].typeName" :"WEBHOOK" and either:
notification.[n].webhookURL to a non-empty stringNOTE: When you view or edit the alert for a Webhook URL notification, the URL appears partially redacted.
Severity of the event.
Values are INFO, WARNING, ERROR, or CRITICAL.
Threshold value that triggers an alert.
Comparison operator to apply when checking the current metric value.
Value is GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Value is DAYS.
Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
Host alert configuration allows to select which mongod host events trigger alerts and how users are notified.
Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
Flag that indicates whether someone enabled this alert configuration for the specified project.
Default value is false.
Event type that triggers an alert.
Values are HOST_DOWN, HOST_HAS_INDEX_SUGGESTIONS, HOST_MONGOT_CRASHING_OOM, HOST_MONGOT_STOP_REPLICATION, HOST_MONGOT_APPROACHING_STOP_REPLICATION, HOST_MONGOT_PAUSE_INITIAL_SYNC, HOST_SEARCH_NODE_INDEX_FAILED, HOST_EXTERNAL_LOG_SINK_EXPORT_DOWN, HOST_NOT_ENOUGH_DISK_SPACE, SSH_KEY_NDS_HOST_ACCESS_REQUESTED, SSH_KEY_NDS_HOST_ACCESS_REFRESHED, PUSH_BASED_LOG_EXPORT_STOPPED, PUSH_BASED_LOG_EXPORT_DROPPED_LOG, HOST_VERSION_BEHIND, VERSION_BEHIND, HOST_EXPOSED, HOST_SSL_CERTIFICATE_STALE, HOST_SECURITY_CHECKUP_NOT_MET, or ALERT_HOST_SSH_SESSION_STARTED.
Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.
Format should match the following pattern: ^([a-f0-9]{24})$.
Unique 24-hexadecimal digit string that identifies this alert configuration.
Format should match the following pattern: ^([a-f0-9]{24})$.
List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.
Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.
Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.
List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the eventTypeName specifies an event for a host, replica set, or sharded cluster.
Rules to apply when comparing an host against this alert configuration.
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.
Values are TYPE_NAME, HOSTNAME, PORT, HOSTNAME_AND_PORT, or REPLICA_SET_NAME.
Comparison operator to apply when checking the current metric value against matcher[n].value. The REGEX operator only supports inclusive matches. Use the NOT_CONTAINS operator to exclude values.
Values are EQUALS, CONTAINS, STARTS_WITH, ENDS_WITH, NOT_EQUALS, NOT_CONTAINS, or REGEX.
Value to match or exceed using the specified matchers.operator.
Values are STANDALONE, PRIMARY, SECONDARY, ARBITER, MONGOS, CONFIG, or MONGOT.
List that contains the targets that MongoDB Cloud sends notifications.
One target that MongoDB Cloud sends notifications when an alert triggers.
At least 1 but not more than 25 elements.
One target that MongoDB Cloud sends notifications when an alert triggers.
Datadog notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Datadog API Key that MongoDB Cloud needs to send alert notifications to Datadog. You can find this API key in the Datadog dashboard. The resource requires this parameter when "notifications.[n].typeName" : "DATADOG".
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Datadog region that indicates which API Uniform Resource Locator (URL) to use. The resource requires this parameter when "notifications.[n].typeName" : "DATADOG".
Values are US, EU, US3, US5, AP1, or US1_FED. Default value is US.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is DATADOG.
Email notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Email address to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "EMAIL". You don't need to set this value to send emails to individual or groups of MongoDB Cloud users including:
"notifications.[n].typeName" : "USER")"notifications.[n].typeName" : "GROUP")"notifications.[n].typeName" : "ORG")"notifications.[n].typeName" : "TEAM")To send emails to one MongoDB Cloud user or grouping of users, set the notifications.[n].emailEnabled parameter.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is EMAIL.
Group notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
List that contains the one or more project roles that receive the configured alert. This parameter is available when "notifications.[n].typeName" : "GROUP" or "notifications.[n].typeName" : "ORG". If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Human-readable label that displays the alert notification type.
Value is GROUP.
HipChat notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
HipChat API token that MongoDB Cloud needs to send alert notifications to HipChat. The resource requires this parameter when "notifications.[n].typeName" : "HIP_CHAT"". If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
HipChat API room name to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "HIP_CHAT"".
Human-readable label that displays the alert notification type.
Value is HIP_CHAT.
Microsoft Teams notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
Microsoft Teams Webhook Uniform Resource Locator (URL) that MongoDB Cloud needs to send this notification via Microsoft Teams. The resource requires this parameter when "notifications.[n].typeName" : "MICROSOFT_TEAMS". If the URL later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: When you view or edit the alert for a Microsoft Teams notification, the URL appears partially redacted.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is MICROSOFT_TEAMS.
OpsGenie notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
API Key that MongoDB Cloud needs to send this notification via OpsGenie. The resource requires this parameter when "notifications.[n].typeName" : "OPS_GENIE". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
OpsGenie region that indicates which API Uniform Resource Locator (URL) to use.
Values are US or EU. Default value is US.
Human-readable label that displays the alert notification type.
Value is OPS_GENIE.
Organization notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
List that contains the one or more organization roles that receive the configured alert. This parameter is available when "notifications.[n].typeName" : "GROUP" or "notifications.[n].typeName" : "ORG". If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.
Values are ORG_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, ORG_BILLING_READ_ONLY, or ORG_READ_ONLY.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Human-readable label that displays the alert notification type.
Value is ORG.
PagerDuty notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
PagerDuty region that indicates which API Uniform Resource Locator (URL) to use.
Values are US or EU. Default value is US.
PagerDuty service key that MongoDB Cloud needs to send notifications via PagerDuty. The resource requires this parameter when "notifications.[n].typeName" : "PAGER_DUTY". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Human-readable label that displays the alert notification type.
Value is PAGER_DUTY.
Slack notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Slack API token or Bot token that MongoDB Cloud needs to send alert notifications via Slack. The resource requires this parameter when "notifications.[n].typeName" : "SLACK". If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes the token.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Name of the Slack channel to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SLACK".
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is SLACK.
SMS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
Mobile phone number to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SMS".
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is SMS.
Team notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Unique 24-hexadecimal digit string that identifies one MongoDB Cloud team. The resource requires this parameter when "notifications.[n].typeName" : "TEAM".
Format should match the following pattern: ^([a-f0-9]{24})$.
Name of the MongoDB Cloud team that receives this notification. The resource requires this parameter when "notifications.[n].typeName" : "TEAM".
Human-readable label that displays the alert notification type.
Value is TEAM.
User notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Human-readable label that displays the alert notification type.
Value is USER.
MongoDB Cloud username of the person to whom MongoDB Cloud sends notifications. Specify only MongoDB Cloud users who belong to the project that owns the alert configuration. The resource requires this parameter when "notifications.[n].typeName" : "USER".
VictorOps notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is VICTOR_OPS.
API key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when "notifications.[n].typeName" : "VICTOR_OPS". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Routing key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when "notifications.[n].typeName" : "VICTOR_OPS". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
Webhook notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is WEBHOOK.
Authentication secret for a webhook-based alert.
Atlas returns this value if you set notifications.[n].typeName :WEBHOOK and either:
notification.[n].webhookSecret to a non-empty stringNOTE: When you view or edit the alert for a webhook notification, the secret appears completely redacted.
Target URL for a webhook-based alert.
Atlas returns this value if you set "notifications.[n].typeName" :"WEBHOOK" and either:
notification.[n].webhookURL to a non-empty stringNOTE: When you view or edit the alert for a Webhook URL notification, the URL appears partially redacted.
Severity of the event.
Values are INFO, WARNING, ERROR, or CRITICAL.
Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
Host metric alert configuration allows to select which mongod host metrics trigger alerts and how users are notified.
Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
Flag that indicates whether someone enabled this alert configuration for the specified project.
Default value is false.
Event type that triggers an alert.
Value is OUTSIDE_METRIC_THRESHOLD.
Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.
Format should match the following pattern: ^([a-f0-9]{24})$.
Unique 24-hexadecimal digit string that identifies this alert configuration.
Format should match the following pattern: ^([a-f0-9]{24})$.
List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.
Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.
Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.
List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the eventTypeName specifies an event for a host, replica set, or sharded cluster.
Rules to apply when comparing an host against this alert configuration.
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.
Values are TYPE_NAME, HOSTNAME, PORT, HOSTNAME_AND_PORT, or REPLICA_SET_NAME.
Comparison operator to apply when checking the current metric value against matcher[n].value. The REGEX operator only supports inclusive matches. Use the NOT_CONTAINS operator to exclude values.
Values are EQUALS, CONTAINS, STARTS_WITH, ENDS_WITH, NOT_EQUALS, NOT_CONTAINS, or REGEX.
Value to match or exceed using the specified matchers.operator.
Values are STANDALONE, PRIMARY, SECONDARY, ARBITER, MONGOS, CONFIG, or MONGOT.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is ASSERT_REGULAR.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is ASSERT_WARNING.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is ASSERT_MSG.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is ASSERT_USER.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is OPCOUNTER_CMD.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is OPCOUNTER_QUERY.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is OPCOUNTER_UPDATE.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is OPCOUNTER_DELETE.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is OPCOUNTER_TTL_DELETED.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is OPCOUNTER_INSERT.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is OPCOUNTER_GETMORE.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is OPCOUNTER_REPL_CMD.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is OPCOUNTER_REPL_UPDATE.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is OPCOUNTER_REPL_DELETE.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is OPCOUNTER_REPL_INSERT.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is FTS_MEMORY_RESIDENT.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is FTS_MEMORY_VIRTUAL.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is FTS_MEMORY_MAPPED.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is FTS_PROCESS_CPU_USER.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is FTS_PROCESS_CPU_KERNEL.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is NORMALIZED_FTS_PROCESS_CPU_USER.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is NORMALIZED_FTS_PROCESS_CPU_KERNEL.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is SYSTEM_MEMORY_PERCENT_USED.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is MEMORY_RESIDENT.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is MEMORY_VIRTUAL.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is MEMORY_MAPPED.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is COMPUTED_MEMORY.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is INDEX_COUNTERS_BTREE_ACCESSES.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is INDEX_COUNTERS_BTREE_HITS.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is INDEX_COUNTERS_BTREE_MISSES.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is INDEX_COUNTERS_BTREE_MISS_RATIO.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is GLOBAL_LOCK_PERCENTAGE.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is BACKGROUND_FLUSH_AVG.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is HOURS.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is CONNECTIONS.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is CONNECTIONS_MAX.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is CONNECTIONS_PERCENT.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is GLOBAL_ACCESSES_NOT_IN_MEMORY.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is GLOBAL_LOCK_CURRENT_QUEUE_TOTAL.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is GLOBAL_LOCK_CURRENT_QUEUE_READERS.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is GLOBAL_LOCK_CURRENT_QUEUE_WRITERS.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is CURSORS_TOTAL_OPEN.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is CURSORS_TOTAL_TIMED_OUT.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is CURSORS_TOTAL_CLIENT_CURSORS_SIZE.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is NETWORK_BYTES_IN.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is NETWORK_BYTES_OUT.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is NETWORK_NUM_REQUESTS.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is OPLOG_MASTER_TIME.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is HOURS.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is OPLOG_MASTER_TIME_ESTIMATED_TTL.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is HOURS.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is OPLOG_SLAVE_LAG_MASTER_TIME.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is HOURS.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is OPLOG_MASTER_LAG_TIME_DIFF.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is HOURS.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is OPLOG_RATE_GB_PER_HOUR.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is EXTRA_INFO_PAGE_FAULTS.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is DB_STORAGE_TOTAL.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is DB_DATA_SIZE_TOTAL.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is DB_DATA_SIZE_TOTAL_WO_SYSTEM.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is DB_INDEX_SIZE_TOTAL.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is JOURNALING_COMMITS_IN_WRITE_LOCK.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is JOURNALING_MB.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is JOURNALING_WRITE_DATA_FILES_MB.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is TICKETS_AVAILABLE_READS.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is TICKETS_AVAILABLE_WRITES.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is CACHE_USAGE_DIRTY.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is CACHE_USAGE_USED.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is CACHE_BYTES_READ_INTO.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is CACHE_BYTES_WRITTEN_FROM.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is NORMALIZED_SYSTEM_CPU_USER.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is NORMALIZED_SYSTEM_CPU_STEAL.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is DISK_PARTITION_SPACE_USED_DATA.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is DISK_PARTITION_SPACE_USED_INDEX.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is DISK_PARTITION_SPACE_USED_JOURNAL.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is DISK_PARTITION_READ_IOPS_DATA.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is DISK_PARTITION_READ_IOPS_INDEX.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is DISK_PARTITION_READ_IOPS_JOURNAL.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is DISK_PARTITION_WRITE_IOPS_DATA.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is DISK_PARTITION_WRITE_IOPS_INDEX.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is DISK_PARTITION_WRITE_IOPS_JOURNAL.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is DISK_PARTITION_READ_LATENCY_DATA.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is HOURS.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is DISK_PARTITION_READ_LATENCY_INDEX.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is HOURS.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is DISK_PARTITION_READ_LATENCY_JOURNAL.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is HOURS.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is DISK_PARTITION_WRITE_LATENCY_DATA.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is HOURS.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is DISK_PARTITION_WRITE_LATENCY_INDEX.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is HOURS.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is DISK_PARTITION_WRITE_LATENCY_JOURNAL.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is HOURS.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is DISK_PARTITION_QUEUE_DEPTH_DATA.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is DISK_PARTITION_QUEUE_DEPTH_INDEX.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is DISK_PARTITION_QUEUE_DEPTH_JOURNAL.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is FTS_DISK_UTILIZATION.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is MUNIN_CPU_USER.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is MUNIN_CPU_NICE.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is MUNIN_CPU_SYSTEM.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is MUNIN_CPU_IOWAIT.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is MUNIN_CPU_IRQ.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is MUNIN_CPU_SOFTIRQ.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is MUNIN_CPU_STEAL.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is DOCUMENT_RETURNED.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is DOCUMENT_INSERTED.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is DOCUMENT_UPDATED.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is DOCUMENT_DELETED.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is OPERATIONS_SCAN_AND_ORDER.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is QUERY_EXECUTOR_SCANNED.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is QUERY_EXECUTOR_SCANNED_OBJECTS.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is OPERATION_THROTTLING_REJECTED_OPERATIONS.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is QUERY_SPILL_TO_DISK_DURING_SORT.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is OPERATIONS_QUERIES_KILLED.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is QUERY_TARGETING_SCANNED_PER_RETURNED.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is AVG_READ_EXECUTION_TIME.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is HOURS.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is AVG_WRITE_EXECUTION_TIME.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is HOURS.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is AVG_COMMAND_EXECUTION_TIME.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is HOURS.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is LOGICAL_SIZE.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is RESTARTS_IN_LAST_HOUR.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is SYSTEM_MEMORY_USED.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is SYSTEM_MEMORY_AVAILABLE.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is SWAP_USAGE_USED.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is SWAP_USAGE_FREE.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is SYSTEM_NETWORK_IN.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is SYSTEM_NETWORK_OUT.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is MAX_NORMALIZED_SYSTEM_CPU_USER.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is MAX_NORMALIZED_SYSTEM_CPU_STEAL.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is MAX_DISK_PARTITION_SPACE_USED_DATA.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is MAX_DISK_PARTITION_SPACE_USED_INDEX.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is MAX_DISK_PARTITION_SPACE_USED_JOURNAL.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is MAX_DISK_PARTITION_READ_IOPS_DATA.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is MAX_DISK_PARTITION_READ_IOPS_INDEX.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is MAX_DISK_PARTITION_READ_IOPS_JOURNAL.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is MAX_DISK_PARTITION_WRITE_IOPS_DATA.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is MAX_DISK_PARTITION_WRITE_IOPS_INDEX.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is MAX_DISK_PARTITION_WRITE_IOPS_JOURNAL.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is MAX_DISK_PARTITION_READ_LATENCY_DATA.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is HOURS.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is MAX_DISK_PARTITION_READ_LATENCY_INDEX.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is HOURS.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is MAX_DISK_PARTITION_READ_LATENCY_JOURNAL.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is HOURS.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is MAX_DISK_PARTITION_WRITE_LATENCY_DATA.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is HOURS.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is MAX_DISK_PARTITION_WRITE_LATENCY_INDEX.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is HOURS.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is MAX_DISK_PARTITION_WRITE_LATENCY_JOURNAL.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is HOURS.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is MAX_DISK_PARTITION_QUEUE_DEPTH_DATA.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is MAX_DISK_PARTITION_QUEUE_DEPTH_INDEX.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is MAX_DISK_PARTITION_QUEUE_DEPTH_JOURNAL.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is MAX_SYSTEM_MEMORY_PERCENT_USED.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is MAX_SYSTEM_MEMORY_USED.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is MAX_SYSTEM_MEMORY_AVAILABLE.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is MAX_SWAP_USAGE_USED.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is MAX_SWAP_USAGE_FREE.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is MAX_SYSTEM_NETWORK_IN.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is MAX_SYSTEM_NETWORK_OUT.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is SEARCH_INDEX_SIZE.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is SEARCH_MAX_FIELDS_INDEXED.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is SEARCH_NUMBER_OF_FIELDS_IN_INDEX.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is SEARCH_MAX_NGRAM_FIELDS_INDEXED.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is SEARCH_REPLICATION_LAG.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is HOURS.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is SEARCH_MAX_NUMBER_OF_LUCENE_DOCS.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is SEARCH_OPCOUNTER_INSERT.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is SEARCH_OPCOUNTER_DELETE.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is SEARCH_OPCOUNTER_UPDATE.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is SEARCH_OPCOUNTER_GETMORE.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is SEARCH_NUMBER_OF_QUERIES_TOTAL.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is SEARCH_NUMBER_OF_QUERIES_ERROR.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is SEARCH_NUMBER_OF_QUERIES_SUCCESS.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is FTS_JVM_MAX_MEMORY.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is FTS_JVM_CURRENT_MEMORY.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
List that contains the targets that MongoDB Cloud sends notifications.
One target that MongoDB Cloud sends notifications when an alert triggers.
At least 1 but not more than 25 elements.
One target that MongoDB Cloud sends notifications when an alert triggers.
Datadog notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Datadog API Key that MongoDB Cloud needs to send alert notifications to Datadog. You can find this API key in the Datadog dashboard. The resource requires this parameter when "notifications.[n].typeName" : "DATADOG".
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Datadog region that indicates which API Uniform Resource Locator (URL) to use. The resource requires this parameter when "notifications.[n].typeName" : "DATADOG".
Values are US, EU, US3, US5, AP1, or US1_FED. Default value is US.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is DATADOG.
Email notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Email address to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "EMAIL". You don't need to set this value to send emails to individual or groups of MongoDB Cloud users including:
"notifications.[n].typeName" : "USER")"notifications.[n].typeName" : "GROUP")"notifications.[n].typeName" : "ORG")"notifications.[n].typeName" : "TEAM")To send emails to one MongoDB Cloud user or grouping of users, set the notifications.[n].emailEnabled parameter.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is EMAIL.
Group notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
List that contains the one or more project roles that receive the configured alert. This parameter is available when "notifications.[n].typeName" : "GROUP" or "notifications.[n].typeName" : "ORG". If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Human-readable label that displays the alert notification type.
Value is GROUP.
HipChat notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
HipChat API token that MongoDB Cloud needs to send alert notifications to HipChat. The resource requires this parameter when "notifications.[n].typeName" : "HIP_CHAT"". If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
HipChat API room name to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "HIP_CHAT"".
Human-readable label that displays the alert notification type.
Value is HIP_CHAT.
Microsoft Teams notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
Microsoft Teams Webhook Uniform Resource Locator (URL) that MongoDB Cloud needs to send this notification via Microsoft Teams. The resource requires this parameter when "notifications.[n].typeName" : "MICROSOFT_TEAMS". If the URL later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: When you view or edit the alert for a Microsoft Teams notification, the URL appears partially redacted.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is MICROSOFT_TEAMS.
OpsGenie notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
API Key that MongoDB Cloud needs to send this notification via OpsGenie. The resource requires this parameter when "notifications.[n].typeName" : "OPS_GENIE". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
OpsGenie region that indicates which API Uniform Resource Locator (URL) to use.
Values are US or EU. Default value is US.
Human-readable label that displays the alert notification type.
Value is OPS_GENIE.
Organization notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
List that contains the one or more organization roles that receive the configured alert. This parameter is available when "notifications.[n].typeName" : "GROUP" or "notifications.[n].typeName" : "ORG". If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.
Values are ORG_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, ORG_BILLING_READ_ONLY, or ORG_READ_ONLY.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Human-readable label that displays the alert notification type.
Value is ORG.
PagerDuty notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
PagerDuty region that indicates which API Uniform Resource Locator (URL) to use.
Values are US or EU. Default value is US.
PagerDuty service key that MongoDB Cloud needs to send notifications via PagerDuty. The resource requires this parameter when "notifications.[n].typeName" : "PAGER_DUTY". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Human-readable label that displays the alert notification type.
Value is PAGER_DUTY.
Slack notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Slack API token or Bot token that MongoDB Cloud needs to send alert notifications via Slack. The resource requires this parameter when "notifications.[n].typeName" : "SLACK". If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes the token.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Name of the Slack channel to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SLACK".
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is SLACK.
SMS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
Mobile phone number to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SMS".
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is SMS.
Team notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Unique 24-hexadecimal digit string that identifies one MongoDB Cloud team. The resource requires this parameter when "notifications.[n].typeName" : "TEAM".
Format should match the following pattern: ^([a-f0-9]{24})$.
Name of the MongoDB Cloud team that receives this notification. The resource requires this parameter when "notifications.[n].typeName" : "TEAM".
Human-readable label that displays the alert notification type.
Value is TEAM.
User notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Human-readable label that displays the alert notification type.
Value is USER.
MongoDB Cloud username of the person to whom MongoDB Cloud sends notifications. Specify only MongoDB Cloud users who belong to the project that owns the alert configuration. The resource requires this parameter when "notifications.[n].typeName" : "USER".
VictorOps notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is VICTOR_OPS.
API key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when "notifications.[n].typeName" : "VICTOR_OPS". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Routing key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when "notifications.[n].typeName" : "VICTOR_OPS". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
Webhook notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is WEBHOOK.
Authentication secret for a webhook-based alert.
Atlas returns this value if you set notifications.[n].typeName :WEBHOOK and either:
notification.[n].webhookSecret to a non-empty stringNOTE: When you view or edit the alert for a webhook notification, the secret appears completely redacted.
Target URL for a webhook-based alert.
Atlas returns this value if you set "notifications.[n].typeName" :"WEBHOOK" and either:
notification.[n].webhookURL to a non-empty stringNOTE: When you view or edit the alert for a Webhook URL notification, the URL appears partially redacted.
Severity of the event.
Values are INFO, WARNING, ERROR, or CRITICAL.
Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
Intelligent Workload Management alert configuration allows to select which Intelligent Workload Management events trigger alerts and how users are notified.
Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
Flag that indicates whether someone enabled this alert configuration for the specified project.
Default value is false.
Event type that triggers an alert.
Value is MONGOTUNE_ALERT.
Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.
Format should match the following pattern: ^([a-f0-9]{24})$.
Unique 24-hexadecimal digit string that identifies this alert configuration.
Format should match the following pattern: ^([a-f0-9]{24})$.
List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.
Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.
Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.
Matching conditions for target resources.
Rules to apply when comparing an target instance against this alert configuration.
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.
Comparison operator to apply when checking the current metric value against matcher[n].value. The REGEX operator only supports inclusive matches. Use the NOT_CONTAINS operator to exclude values.
Values are EQUALS, CONTAINS, STARTS_WITH, ENDS_WITH, NOT_EQUALS, NOT_CONTAINS, or REGEX.
Value to match or exceed using the specified matchers.operator.
List that contains the targets that MongoDB Cloud sends notifications.
One target that MongoDB Cloud sends notifications when an alert triggers.
At least 1 but not more than 25 elements.
One target that MongoDB Cloud sends notifications when an alert triggers.
Datadog notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Datadog API Key that MongoDB Cloud needs to send alert notifications to Datadog. You can find this API key in the Datadog dashboard. The resource requires this parameter when "notifications.[n].typeName" : "DATADOG".
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Datadog region that indicates which API Uniform Resource Locator (URL) to use. The resource requires this parameter when "notifications.[n].typeName" : "DATADOG".
Values are US, EU, US3, US5, AP1, or US1_FED. Default value is US.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is DATADOG.
Email notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Email address to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "EMAIL". You don't need to set this value to send emails to individual or groups of MongoDB Cloud users including:
"notifications.[n].typeName" : "USER")"notifications.[n].typeName" : "GROUP")"notifications.[n].typeName" : "ORG")"notifications.[n].typeName" : "TEAM")To send emails to one MongoDB Cloud user or grouping of users, set the notifications.[n].emailEnabled parameter.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is EMAIL.
Group notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
List that contains the one or more project roles that receive the configured alert. This parameter is available when "notifications.[n].typeName" : "GROUP" or "notifications.[n].typeName" : "ORG". If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Human-readable label that displays the alert notification type.
Value is GROUP.
HipChat notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
HipChat API token that MongoDB Cloud needs to send alert notifications to HipChat. The resource requires this parameter when "notifications.[n].typeName" : "HIP_CHAT"". If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
HipChat API room name to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "HIP_CHAT"".
Human-readable label that displays the alert notification type.
Value is HIP_CHAT.
Microsoft Teams notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
Microsoft Teams Webhook Uniform Resource Locator (URL) that MongoDB Cloud needs to send this notification via Microsoft Teams. The resource requires this parameter when "notifications.[n].typeName" : "MICROSOFT_TEAMS". If the URL later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: When you view or edit the alert for a Microsoft Teams notification, the URL appears partially redacted.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is MICROSOFT_TEAMS.
OpsGenie notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
API Key that MongoDB Cloud needs to send this notification via OpsGenie. The resource requires this parameter when "notifications.[n].typeName" : "OPS_GENIE". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
OpsGenie region that indicates which API Uniform Resource Locator (URL) to use.
Values are US or EU. Default value is US.
Human-readable label that displays the alert notification type.
Value is OPS_GENIE.
Organization notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
List that contains the one or more organization roles that receive the configured alert. This parameter is available when "notifications.[n].typeName" : "GROUP" or "notifications.[n].typeName" : "ORG". If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.
Values are ORG_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, ORG_BILLING_READ_ONLY, or ORG_READ_ONLY.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Human-readable label that displays the alert notification type.
Value is ORG.
PagerDuty notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
PagerDuty region that indicates which API Uniform Resource Locator (URL) to use.
Values are US or EU. Default value is US.
PagerDuty service key that MongoDB Cloud needs to send notifications via PagerDuty. The resource requires this parameter when "notifications.[n].typeName" : "PAGER_DUTY". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Human-readable label that displays the alert notification type.
Value is PAGER_DUTY.
Slack notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Slack API token or Bot token that MongoDB Cloud needs to send alert notifications via Slack. The resource requires this parameter when "notifications.[n].typeName" : "SLACK". If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes the token.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Name of the Slack channel to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SLACK".
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is SLACK.
SMS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
Mobile phone number to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SMS".
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is SMS.
Team notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Unique 24-hexadecimal digit string that identifies one MongoDB Cloud team. The resource requires this parameter when "notifications.[n].typeName" : "TEAM".
Format should match the following pattern: ^([a-f0-9]{24})$.
Name of the MongoDB Cloud team that receives this notification. The resource requires this parameter when "notifications.[n].typeName" : "TEAM".
Human-readable label that displays the alert notification type.
Value is TEAM.
User notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Human-readable label that displays the alert notification type.
Value is USER.
MongoDB Cloud username of the person to whom MongoDB Cloud sends notifications. Specify only MongoDB Cloud users who belong to the project that owns the alert configuration. The resource requires this parameter when "notifications.[n].typeName" : "USER".
VictorOps notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is VICTOR_OPS.
API key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when "notifications.[n].typeName" : "VICTOR_OPS". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Routing key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when "notifications.[n].typeName" : "VICTOR_OPS". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
Webhook notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is WEBHOOK.
Authentication secret for a webhook-based alert.
Atlas returns this value if you set notifications.[n].typeName :WEBHOOK and either:
notification.[n].webhookSecret to a non-empty stringNOTE: When you view or edit the alert for a webhook notification, the secret appears completely redacted.
Target URL for a webhook-based alert.
Atlas returns this value if you set "notifications.[n].typeName" :"WEBHOOK" and either:
notification.[n].webhookURL to a non-empty stringNOTE: When you view or edit the alert for a Webhook URL notification, the URL appears partially redacted.
Severity of the event.
Values are INFO, WARNING, ERROR, or CRITICAL.
Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
X509 User Authentication alert configuration allows to select thresholds for expiration of client, CA certificates and CRL which trigger alerts and how users are notified.
Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
Flag that indicates whether someone enabled this alert configuration for the specified project.
Default value is false.
Event type that triggers an alert.
Values are NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK, NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK, or NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK.
Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.
Format should match the following pattern: ^([a-f0-9]{24})$.
Unique 24-hexadecimal digit string that identifies this alert configuration.
Format should match the following pattern: ^([a-f0-9]{24})$.
List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.
Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.
Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.
Matching conditions for target resources.
Rules to apply when comparing an target instance against this alert configuration.
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.
Comparison operator to apply when checking the current metric value against matcher[n].value. The REGEX operator only supports inclusive matches. Use the NOT_CONTAINS operator to exclude values.
Values are EQUALS, CONTAINS, STARTS_WITH, ENDS_WITH, NOT_EQUALS, NOT_CONTAINS, or REGEX.
Value to match or exceed using the specified matchers.operator.
List that contains the targets that MongoDB Cloud sends notifications.
One target that MongoDB Cloud sends notifications when an alert triggers.
At least 1 but not more than 25 elements.
One target that MongoDB Cloud sends notifications when an alert triggers.
Datadog notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Datadog API Key that MongoDB Cloud needs to send alert notifications to Datadog. You can find this API key in the Datadog dashboard. The resource requires this parameter when "notifications.[n].typeName" : "DATADOG".
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Datadog region that indicates which API Uniform Resource Locator (URL) to use. The resource requires this parameter when "notifications.[n].typeName" : "DATADOG".
Values are US, EU, US3, US5, AP1, or US1_FED. Default value is US.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is DATADOG.
Email notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Email address to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "EMAIL". You don't need to set this value to send emails to individual or groups of MongoDB Cloud users including:
"notifications.[n].typeName" : "USER")"notifications.[n].typeName" : "GROUP")"notifications.[n].typeName" : "ORG")"notifications.[n].typeName" : "TEAM")To send emails to one MongoDB Cloud user or grouping of users, set the notifications.[n].emailEnabled parameter.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is EMAIL.
Group notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
List that contains the one or more project roles that receive the configured alert. This parameter is available when "notifications.[n].typeName" : "GROUP" or "notifications.[n].typeName" : "ORG". If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Human-readable label that displays the alert notification type.
Value is GROUP.
HipChat notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
HipChat API token that MongoDB Cloud needs to send alert notifications to HipChat. The resource requires this parameter when "notifications.[n].typeName" : "HIP_CHAT"". If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
HipChat API room name to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "HIP_CHAT"".
Human-readable label that displays the alert notification type.
Value is HIP_CHAT.
Microsoft Teams notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
Microsoft Teams Webhook Uniform Resource Locator (URL) that MongoDB Cloud needs to send this notification via Microsoft Teams. The resource requires this parameter when "notifications.[n].typeName" : "MICROSOFT_TEAMS". If the URL later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: When you view or edit the alert for a Microsoft Teams notification, the URL appears partially redacted.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is MICROSOFT_TEAMS.
OpsGenie notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
API Key that MongoDB Cloud needs to send this notification via OpsGenie. The resource requires this parameter when "notifications.[n].typeName" : "OPS_GENIE". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
OpsGenie region that indicates which API Uniform Resource Locator (URL) to use.
Values are US or EU. Default value is US.
Human-readable label that displays the alert notification type.
Value is OPS_GENIE.
Organization notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
List that contains the one or more organization roles that receive the configured alert. This parameter is available when "notifications.[n].typeName" : "GROUP" or "notifications.[n].typeName" : "ORG". If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.
Values are ORG_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, ORG_BILLING_READ_ONLY, or ORG_READ_ONLY.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Human-readable label that displays the alert notification type.
Value is ORG.
PagerDuty notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
PagerDuty region that indicates which API Uniform Resource Locator (URL) to use.
Values are US or EU. Default value is US.
PagerDuty service key that MongoDB Cloud needs to send notifications via PagerDuty. The resource requires this parameter when "notifications.[n].typeName" : "PAGER_DUTY". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Human-readable label that displays the alert notification type.
Value is PAGER_DUTY.
Slack notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Slack API token or Bot token that MongoDB Cloud needs to send alert notifications via Slack. The resource requires this parameter when "notifications.[n].typeName" : "SLACK". If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes the token.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Name of the Slack channel to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SLACK".
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is SLACK.
SMS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
Mobile phone number to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SMS".
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is SMS.
Team notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Unique 24-hexadecimal digit string that identifies one MongoDB Cloud team. The resource requires this parameter when "notifications.[n].typeName" : "TEAM".
Format should match the following pattern: ^([a-f0-9]{24})$.
Name of the MongoDB Cloud team that receives this notification. The resource requires this parameter when "notifications.[n].typeName" : "TEAM".
Human-readable label that displays the alert notification type.
Value is TEAM.
User notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Human-readable label that displays the alert notification type.
Value is USER.
MongoDB Cloud username of the person to whom MongoDB Cloud sends notifications. Specify only MongoDB Cloud users who belong to the project that owns the alert configuration. The resource requires this parameter when "notifications.[n].typeName" : "USER".
VictorOps notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is VICTOR_OPS.
API key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when "notifications.[n].typeName" : "VICTOR_OPS". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Routing key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when "notifications.[n].typeName" : "VICTOR_OPS". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
Webhook notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is WEBHOOK.
Authentication secret for a webhook-based alert.
Atlas returns this value if you set notifications.[n].typeName :WEBHOOK and either:
notification.[n].webhookSecret to a non-empty stringNOTE: When you view or edit the alert for a webhook notification, the secret appears completely redacted.
Target URL for a webhook-based alert.
Atlas returns this value if you set "notifications.[n].typeName" :"WEBHOOK" and either:
notification.[n].webhookURL to a non-empty stringNOTE: When you view or edit the alert for a Webhook URL notification, the URL appears partially redacted.
Severity of the event.
Values are INFO, WARNING, ERROR, or CRITICAL.
Threshold value that triggers an alert.
Comparison operator to apply when checking the current metric value.
Value is LESS_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Value is DAYS.
Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
Replica Set alert configuration allows to select which conditions of mongod replica set trigger alerts and how users are notified.
Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
Flag that indicates whether someone enabled this alert configuration for the specified project.
Default value is false.
Event type that triggers an alert.
Values are NO_PRIMARY or PRIMARY_ELECTED.
Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.
Format should match the following pattern: ^([a-f0-9]{24})$.
Unique 24-hexadecimal digit string that identifies this alert configuration.
Format should match the following pattern: ^([a-f0-9]{24})$.
List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.
Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.
Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.
List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the eventTypeName specifies an event for a host, replica set, or sharded cluster.
Rules to apply when comparing an replica set against this alert configuration.
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.
Values are REPLICA_SET_NAME, SHARD_NAME, or CLUSTER_NAME.
Comparison operator to apply when checking the current metric value against matcher[n].value. The REGEX operator only supports inclusive matches. Use the NOT_CONTAINS operator to exclude values.
Values are EQUALS, CONTAINS, STARTS_WITH, ENDS_WITH, NOT_EQUALS, NOT_CONTAINS, or REGEX.
Value to match or exceed using the specified matchers.operator.
List that contains the targets that MongoDB Cloud sends notifications.
One target that MongoDB Cloud sends notifications when an alert triggers.
At least 1 but not more than 25 elements.
One target that MongoDB Cloud sends notifications when an alert triggers.
Datadog notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Datadog API Key that MongoDB Cloud needs to send alert notifications to Datadog. You can find this API key in the Datadog dashboard. The resource requires this parameter when "notifications.[n].typeName" : "DATADOG".
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Datadog region that indicates which API Uniform Resource Locator (URL) to use. The resource requires this parameter when "notifications.[n].typeName" : "DATADOG".
Values are US, EU, US3, US5, AP1, or US1_FED. Default value is US.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is DATADOG.
Email notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Email address to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "EMAIL". You don't need to set this value to send emails to individual or groups of MongoDB Cloud users including:
"notifications.[n].typeName" : "USER")"notifications.[n].typeName" : "GROUP")"notifications.[n].typeName" : "ORG")"notifications.[n].typeName" : "TEAM")To send emails to one MongoDB Cloud user or grouping of users, set the notifications.[n].emailEnabled parameter.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is EMAIL.
Group notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
List that contains the one or more project roles that receive the configured alert. This parameter is available when "notifications.[n].typeName" : "GROUP" or "notifications.[n].typeName" : "ORG". If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Human-readable label that displays the alert notification type.
Value is GROUP.
HipChat notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
HipChat API token that MongoDB Cloud needs to send alert notifications to HipChat. The resource requires this parameter when "notifications.[n].typeName" : "HIP_CHAT"". If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
HipChat API room name to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "HIP_CHAT"".
Human-readable label that displays the alert notification type.
Value is HIP_CHAT.
Microsoft Teams notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
Microsoft Teams Webhook Uniform Resource Locator (URL) that MongoDB Cloud needs to send this notification via Microsoft Teams. The resource requires this parameter when "notifications.[n].typeName" : "MICROSOFT_TEAMS". If the URL later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: When you view or edit the alert for a Microsoft Teams notification, the URL appears partially redacted.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is MICROSOFT_TEAMS.
OpsGenie notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
API Key that MongoDB Cloud needs to send this notification via OpsGenie. The resource requires this parameter when "notifications.[n].typeName" : "OPS_GENIE". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
OpsGenie region that indicates which API Uniform Resource Locator (URL) to use.
Values are US or EU. Default value is US.
Human-readable label that displays the alert notification type.
Value is OPS_GENIE.
Organization notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
List that contains the one or more organization roles that receive the configured alert. This parameter is available when "notifications.[n].typeName" : "GROUP" or "notifications.[n].typeName" : "ORG". If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.
Values are ORG_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, ORG_BILLING_READ_ONLY, or ORG_READ_ONLY.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Human-readable label that displays the alert notification type.
Value is ORG.
PagerDuty notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
PagerDuty region that indicates which API Uniform Resource Locator (URL) to use.
Values are US or EU. Default value is US.
PagerDuty service key that MongoDB Cloud needs to send notifications via PagerDuty. The resource requires this parameter when "notifications.[n].typeName" : "PAGER_DUTY". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Human-readable label that displays the alert notification type.
Value is PAGER_DUTY.
Slack notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Slack API token or Bot token that MongoDB Cloud needs to send alert notifications via Slack. The resource requires this parameter when "notifications.[n].typeName" : "SLACK". If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes the token.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Name of the Slack channel to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SLACK".
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is SLACK.
SMS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
Mobile phone number to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SMS".
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is SMS.
Team notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Unique 24-hexadecimal digit string that identifies one MongoDB Cloud team. The resource requires this parameter when "notifications.[n].typeName" : "TEAM".
Format should match the following pattern: ^([a-f0-9]{24})$.
Name of the MongoDB Cloud team that receives this notification. The resource requires this parameter when "notifications.[n].typeName" : "TEAM".
Human-readable label that displays the alert notification type.
Value is TEAM.
User notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Human-readable label that displays the alert notification type.
Value is USER.
MongoDB Cloud username of the person to whom MongoDB Cloud sends notifications. Specify only MongoDB Cloud users who belong to the project that owns the alert configuration. The resource requires this parameter when "notifications.[n].typeName" : "USER".
VictorOps notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is VICTOR_OPS.
API key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when "notifications.[n].typeName" : "VICTOR_OPS". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Routing key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when "notifications.[n].typeName" : "VICTOR_OPS". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
Webhook notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is WEBHOOK.
Authentication secret for a webhook-based alert.
Atlas returns this value if you set notifications.[n].typeName :WEBHOOK and either:
notification.[n].webhookSecret to a non-empty stringNOTE: When you view or edit the alert for a webhook notification, the secret appears completely redacted.
Target URL for a webhook-based alert.
Atlas returns this value if you set "notifications.[n].typeName" :"WEBHOOK" and either:
notification.[n].webhookURL to a non-empty stringNOTE: When you view or edit the alert for a Webhook URL notification, the URL appears partially redacted.
Severity of the event.
Values are INFO, WARNING, ERROR, or CRITICAL.
A Limit that triggers an alert when exceeded. The resource returns this parameter when eventTypeName has not been set to OUTSIDE_METRIC_THRESHOLD.
Comparison operator to apply when checking the current metric value.
Values are < or >.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Values are bits, Kbits, Mbits, Gbits, bytes, KB, MB, GB, TB, PB, nsec, msec, sec, min, hours, million minutes, days, requests, 1000 requests, tokens, million tokens, pixels, billion pixels, GB seconds, GB hours, GB days, RPU, thousand RPU, million RPU, WPU, thousand WPU, million WPU, count, thousand, million, or billion.
Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
Replica Set threshold alert configuration allows to select thresholds for conditions of mongod replica set which trigger alerts and how users are notified.
Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
Flag that indicates whether someone enabled this alert configuration for the specified project.
Default value is false.
Event type that triggers an alert.
Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.
Format should match the following pattern: ^([a-f0-9]{24})$.
Unique 24-hexadecimal digit string that identifies this alert configuration.
Format should match the following pattern: ^([a-f0-9]{24})$.
List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.
Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.
Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.
List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the eventTypeName specifies an event for a host, replica set, or sharded cluster.
Rules to apply when comparing an replica set against this alert configuration.
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.
Values are REPLICA_SET_NAME, SHARD_NAME, or CLUSTER_NAME.
Comparison operator to apply when checking the current metric value against matcher[n].value. The REGEX operator only supports inclusive matches. Use the NOT_CONTAINS operator to exclude values.
Values are EQUALS, CONTAINS, STARTS_WITH, ENDS_WITH, NOT_EQUALS, NOT_CONTAINS, or REGEX.
Value to match or exceed using the specified matchers.operator.
List that contains the targets that MongoDB Cloud sends notifications.
One target that MongoDB Cloud sends notifications when an alert triggers.
At least 1 but not more than 25 elements.
One target that MongoDB Cloud sends notifications when an alert triggers.
Datadog notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Datadog API Key that MongoDB Cloud needs to send alert notifications to Datadog. You can find this API key in the Datadog dashboard. The resource requires this parameter when "notifications.[n].typeName" : "DATADOG".
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Datadog region that indicates which API Uniform Resource Locator (URL) to use. The resource requires this parameter when "notifications.[n].typeName" : "DATADOG".
Values are US, EU, US3, US5, AP1, or US1_FED. Default value is US.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is DATADOG.
Email notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Email address to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "EMAIL". You don't need to set this value to send emails to individual or groups of MongoDB Cloud users including:
"notifications.[n].typeName" : "USER")"notifications.[n].typeName" : "GROUP")"notifications.[n].typeName" : "ORG")"notifications.[n].typeName" : "TEAM")To send emails to one MongoDB Cloud user or grouping of users, set the notifications.[n].emailEnabled parameter.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is EMAIL.
Group notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
List that contains the one or more project roles that receive the configured alert. This parameter is available when "notifications.[n].typeName" : "GROUP" or "notifications.[n].typeName" : "ORG". If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Human-readable label that displays the alert notification type.
Value is GROUP.
HipChat notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
HipChat API token that MongoDB Cloud needs to send alert notifications to HipChat. The resource requires this parameter when "notifications.[n].typeName" : "HIP_CHAT"". If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
HipChat API room name to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "HIP_CHAT"".
Human-readable label that displays the alert notification type.
Value is HIP_CHAT.
Microsoft Teams notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
Microsoft Teams Webhook Uniform Resource Locator (URL) that MongoDB Cloud needs to send this notification via Microsoft Teams. The resource requires this parameter when "notifications.[n].typeName" : "MICROSOFT_TEAMS". If the URL later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: When you view or edit the alert for a Microsoft Teams notification, the URL appears partially redacted.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is MICROSOFT_TEAMS.
OpsGenie notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
API Key that MongoDB Cloud needs to send this notification via OpsGenie. The resource requires this parameter when "notifications.[n].typeName" : "OPS_GENIE". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
OpsGenie region that indicates which API Uniform Resource Locator (URL) to use.
Values are US or EU. Default value is US.
Human-readable label that displays the alert notification type.
Value is OPS_GENIE.
Organization notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
List that contains the one or more organization roles that receive the configured alert. This parameter is available when "notifications.[n].typeName" : "GROUP" or "notifications.[n].typeName" : "ORG". If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.
Values are ORG_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, ORG_BILLING_READ_ONLY, or ORG_READ_ONLY.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Human-readable label that displays the alert notification type.
Value is ORG.
PagerDuty notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
PagerDuty region that indicates which API Uniform Resource Locator (URL) to use.
Values are US or EU. Default value is US.
PagerDuty service key that MongoDB Cloud needs to send notifications via PagerDuty. The resource requires this parameter when "notifications.[n].typeName" : "PAGER_DUTY". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Human-readable label that displays the alert notification type.
Value is PAGER_DUTY.
Slack notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Slack API token or Bot token that MongoDB Cloud needs to send alert notifications via Slack. The resource requires this parameter when "notifications.[n].typeName" : "SLACK". If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes the token.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Name of the Slack channel to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SLACK".
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is SLACK.
SMS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
Mobile phone number to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SMS".
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is SMS.
Team notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Unique 24-hexadecimal digit string that identifies one MongoDB Cloud team. The resource requires this parameter when "notifications.[n].typeName" : "TEAM".
Format should match the following pattern: ^([a-f0-9]{24})$.
Name of the MongoDB Cloud team that receives this notification. The resource requires this parameter when "notifications.[n].typeName" : "TEAM".
Human-readable label that displays the alert notification type.
Value is TEAM.
User notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Human-readable label that displays the alert notification type.
Value is USER.
MongoDB Cloud username of the person to whom MongoDB Cloud sends notifications. Specify only MongoDB Cloud users who belong to the project that owns the alert configuration. The resource requires this parameter when "notifications.[n].typeName" : "USER".
VictorOps notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is VICTOR_OPS.
API key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when "notifications.[n].typeName" : "VICTOR_OPS". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Routing key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when "notifications.[n].typeName" : "VICTOR_OPS". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
Webhook notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is WEBHOOK.
Authentication secret for a webhook-based alert.
Atlas returns this value if you set notifications.[n].typeName :WEBHOOK and either:
notification.[n].webhookSecret to a non-empty stringNOTE: When you view or edit the alert for a webhook notification, the secret appears completely redacted.
Target URL for a webhook-based alert.
Atlas returns this value if you set "notifications.[n].typeName" :"WEBHOOK" and either:
notification.[n].webhookURL to a non-empty stringNOTE: When you view or edit the alert for a Webhook URL notification, the URL appears partially redacted.
Severity of the event.
Values are INFO, WARNING, ERROR, or CRITICAL.
A Limit that triggers an alert when exceeded. The resource returns this parameter when eventTypeName has not been set to OUTSIDE_METRIC_THRESHOLD.
Comparison operator to apply when checking the current metric value.
Values are < or >.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Values are bits, Kbits, Mbits, Gbits, bytes, KB, MB, GB, TB, PB, nsec, msec, sec, min, hours, million minutes, days, requests, 1000 requests, tokens, million tokens, pixels, billion pixels, GB seconds, GB hours, GB days, RPU, thousand RPU, million RPU, WPU, thousand WPU, million WPU, count, thousand, million, or billion.
Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
Serverless metric alert configuration allows to select which serverless database metrics trigger alerts and how users are notified.
Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
Flag that indicates whether someone enabled this alert configuration for the specified project.
Default value is false.
Event type that triggers an alert.
Value is OUTSIDE_SERVERLESS_METRIC_THRESHOLD.
Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.
Format should match the following pattern: ^([a-f0-9]{24})$.
Unique 24-hexadecimal digit string that identifies this alert configuration.
Format should match the following pattern: ^([a-f0-9]{24})$.
List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.
Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.
Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.
Matching conditions for target resources.
Rules to apply when comparing an target instance against this alert configuration.
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.
Comparison operator to apply when checking the current metric value against matcher[n].value. The REGEX operator only supports inclusive matches. Use the NOT_CONTAINS operator to exclude values.
Values are EQUALS, CONTAINS, STARTS_WITH, ENDS_WITH, NOT_EQUALS, NOT_CONTAINS, or REGEX.
Value to match or exceed using the specified matchers.operator.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is SERVERLESS_AVG_COMMAND_EXECUTION_TIME.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is HOURS.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is SERVERLESS_AVG_WRITE_EXECUTION_TIME.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is HOURS.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is SERVERLESS_AVG_READ_EXECUTION_TIME.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is HOURS.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is SERVERLESS_TOTAL_WRITE_UNITS.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Values are RPU or WPU.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is SERVERLESS_TOTAL_READ_UNITS.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Values are RPU or WPU.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is SERVERLESS_OPCOUNTER_UPDATE.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is SERVERLESS_OPCOUNTER_QUERY.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is SERVERLESS_OPCOUNTER_INSERT.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is SERVERLESS_OPCOUNTER_GETMORE.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is SERVERLESS_OPCOUNTER_DELETE.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is SERVERLESS_OPCOUNTER_CMD.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is SERVERLESS_NETWORK_NUM_REQUESTS.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is SERVERLESS_NETWORK_BYTES_OUT.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is SERVERLESS_NETWORK_BYTES_IN.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is SERVERLESS_DATA_SIZE_TOTAL.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is SERVERLESS_CONNECTIONS_PERCENT.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is SERVERLESS_CONNECTIONS.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
List that contains the targets that MongoDB Cloud sends notifications.
One target that MongoDB Cloud sends notifications when an alert triggers.
At least 1 but not more than 25 elements.
One target that MongoDB Cloud sends notifications when an alert triggers.
Datadog notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Datadog API Key that MongoDB Cloud needs to send alert notifications to Datadog. You can find this API key in the Datadog dashboard. The resource requires this parameter when "notifications.[n].typeName" : "DATADOG".
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Datadog region that indicates which API Uniform Resource Locator (URL) to use. The resource requires this parameter when "notifications.[n].typeName" : "DATADOG".
Values are US, EU, US3, US5, AP1, or US1_FED. Default value is US.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is DATADOG.
Email notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Email address to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "EMAIL". You don't need to set this value to send emails to individual or groups of MongoDB Cloud users including:
"notifications.[n].typeName" : "USER")"notifications.[n].typeName" : "GROUP")"notifications.[n].typeName" : "ORG")"notifications.[n].typeName" : "TEAM")To send emails to one MongoDB Cloud user or grouping of users, set the notifications.[n].emailEnabled parameter.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is EMAIL.
Group notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
List that contains the one or more project roles that receive the configured alert. This parameter is available when "notifications.[n].typeName" : "GROUP" or "notifications.[n].typeName" : "ORG". If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Human-readable label that displays the alert notification type.
Value is GROUP.
HipChat notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
HipChat API token that MongoDB Cloud needs to send alert notifications to HipChat. The resource requires this parameter when "notifications.[n].typeName" : "HIP_CHAT"". If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
HipChat API room name to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "HIP_CHAT"".
Human-readable label that displays the alert notification type.
Value is HIP_CHAT.
Microsoft Teams notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
Microsoft Teams Webhook Uniform Resource Locator (URL) that MongoDB Cloud needs to send this notification via Microsoft Teams. The resource requires this parameter when "notifications.[n].typeName" : "MICROSOFT_TEAMS". If the URL later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: When you view or edit the alert for a Microsoft Teams notification, the URL appears partially redacted.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is MICROSOFT_TEAMS.
OpsGenie notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
API Key that MongoDB Cloud needs to send this notification via OpsGenie. The resource requires this parameter when "notifications.[n].typeName" : "OPS_GENIE". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
OpsGenie region that indicates which API Uniform Resource Locator (URL) to use.
Values are US or EU. Default value is US.
Human-readable label that displays the alert notification type.
Value is OPS_GENIE.
Organization notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
List that contains the one or more organization roles that receive the configured alert. This parameter is available when "notifications.[n].typeName" : "GROUP" or "notifications.[n].typeName" : "ORG". If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.
Values are ORG_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, ORG_BILLING_READ_ONLY, or ORG_READ_ONLY.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Human-readable label that displays the alert notification type.
Value is ORG.
PagerDuty notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
PagerDuty region that indicates which API Uniform Resource Locator (URL) to use.
Values are US or EU. Default value is US.
PagerDuty service key that MongoDB Cloud needs to send notifications via PagerDuty. The resource requires this parameter when "notifications.[n].typeName" : "PAGER_DUTY". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Human-readable label that displays the alert notification type.
Value is PAGER_DUTY.
Slack notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Slack API token or Bot token that MongoDB Cloud needs to send alert notifications via Slack. The resource requires this parameter when "notifications.[n].typeName" : "SLACK". If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes the token.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Name of the Slack channel to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SLACK".
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is SLACK.
SMS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
Mobile phone number to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SMS".
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is SMS.
Team notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Unique 24-hexadecimal digit string that identifies one MongoDB Cloud team. The resource requires this parameter when "notifications.[n].typeName" : "TEAM".
Format should match the following pattern: ^([a-f0-9]{24})$.
Name of the MongoDB Cloud team that receives this notification. The resource requires this parameter when "notifications.[n].typeName" : "TEAM".
Human-readable label that displays the alert notification type.
Value is TEAM.
User notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Human-readable label that displays the alert notification type.
Value is USER.
MongoDB Cloud username of the person to whom MongoDB Cloud sends notifications. Specify only MongoDB Cloud users who belong to the project that owns the alert configuration. The resource requires this parameter when "notifications.[n].typeName" : "USER".
VictorOps notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is VICTOR_OPS.
API key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when "notifications.[n].typeName" : "VICTOR_OPS". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Routing key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when "notifications.[n].typeName" : "VICTOR_OPS". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
Webhook notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is WEBHOOK.
Authentication secret for a webhook-based alert.
Atlas returns this value if you set notifications.[n].typeName :WEBHOOK and either:
notification.[n].webhookSecret to a non-empty stringNOTE: When you view or edit the alert for a webhook notification, the secret appears completely redacted.
Target URL for a webhook-based alert.
Atlas returns this value if you set "notifications.[n].typeName" :"WEBHOOK" and either:
notification.[n].webhookURL to a non-empty stringNOTE: When you view or edit the alert for a Webhook URL notification, the URL appears partially redacted.
Severity of the event.
Values are INFO, WARNING, ERROR, or CRITICAL.
Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
Flex metric alert configuration allows to select which Flex database metrics trigger alerts and how users are notified.
Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
Flag that indicates whether someone enabled this alert configuration for the specified project.
Default value is false.
Event type that triggers an alert.
Value is OUTSIDE_FLEX_METRIC_THRESHOLD.
Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.
Format should match the following pattern: ^([a-f0-9]{24})$.
Unique 24-hexadecimal digit string that identifies this alert configuration.
Format should match the following pattern: ^([a-f0-9]{24})$.
List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.
Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.
Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.
Matching conditions for target resources.
Rules to apply when comparing an target instance against this alert configuration.
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.
Comparison operator to apply when checking the current metric value against matcher[n].value. The REGEX operator only supports inclusive matches. Use the NOT_CONTAINS operator to exclude values.
Values are EQUALS, CONTAINS, STARTS_WITH, ENDS_WITH, NOT_EQUALS, NOT_CONTAINS, or REGEX.
Value to match or exceed using the specified matchers.operator.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is FLEX_CONNECTIONS.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is FLEX_CONNECTIONS_PERCENT.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is FLEX_DATA_SIZE_TOTAL.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is FLEX_NETWORK_BYTES_IN.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is FLEX_NETWORK_BYTES_OUT.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is FLEX_NETWORK_NUM_REQUESTS.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is FLEX_OPCOUNTER_CMD.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is FLEX_OPCOUNTER_DELETE.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is FLEX_OPCOUNTER_INSERT.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is FLEX_OPCOUNTER_QUERY.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is FLEX_OPCOUNTER_UPDATE.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is FLEX_OPCOUNTER_GETMORE.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is FLEX_AVG_READ_EXECUTION_TIME.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is HOURS.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is FLEX_AVG_WRITE_EXECUTION_TIME.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is HOURS.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is FLEX_AVG_COMMAND_EXECUTION_TIME.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is HOURS.
List that contains the targets that MongoDB Cloud sends notifications.
One target that MongoDB Cloud sends notifications when an alert triggers.
At least 1 but not more than 25 elements.
One target that MongoDB Cloud sends notifications when an alert triggers.
Datadog notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Datadog API Key that MongoDB Cloud needs to send alert notifications to Datadog. You can find this API key in the Datadog dashboard. The resource requires this parameter when "notifications.[n].typeName" : "DATADOG".
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Datadog region that indicates which API Uniform Resource Locator (URL) to use. The resource requires this parameter when "notifications.[n].typeName" : "DATADOG".
Values are US, EU, US3, US5, AP1, or US1_FED. Default value is US.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is DATADOG.
Email notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Email address to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "EMAIL". You don't need to set this value to send emails to individual or groups of MongoDB Cloud users including:
"notifications.[n].typeName" : "USER")"notifications.[n].typeName" : "GROUP")"notifications.[n].typeName" : "ORG")"notifications.[n].typeName" : "TEAM")To send emails to one MongoDB Cloud user or grouping of users, set the notifications.[n].emailEnabled parameter.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is EMAIL.
Group notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
List that contains the one or more project roles that receive the configured alert. This parameter is available when "notifications.[n].typeName" : "GROUP" or "notifications.[n].typeName" : "ORG". If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Human-readable label that displays the alert notification type.
Value is GROUP.
HipChat notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
HipChat API token that MongoDB Cloud needs to send alert notifications to HipChat. The resource requires this parameter when "notifications.[n].typeName" : "HIP_CHAT"". If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
HipChat API room name to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "HIP_CHAT"".
Human-readable label that displays the alert notification type.
Value is HIP_CHAT.
Microsoft Teams notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
Microsoft Teams Webhook Uniform Resource Locator (URL) that MongoDB Cloud needs to send this notification via Microsoft Teams. The resource requires this parameter when "notifications.[n].typeName" : "MICROSOFT_TEAMS". If the URL later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: When you view or edit the alert for a Microsoft Teams notification, the URL appears partially redacted.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is MICROSOFT_TEAMS.
OpsGenie notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
API Key that MongoDB Cloud needs to send this notification via OpsGenie. The resource requires this parameter when "notifications.[n].typeName" : "OPS_GENIE". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
OpsGenie region that indicates which API Uniform Resource Locator (URL) to use.
Values are US or EU. Default value is US.
Human-readable label that displays the alert notification type.
Value is OPS_GENIE.
Organization notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
List that contains the one or more organization roles that receive the configured alert. This parameter is available when "notifications.[n].typeName" : "GROUP" or "notifications.[n].typeName" : "ORG". If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.
Values are ORG_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, ORG_BILLING_READ_ONLY, or ORG_READ_ONLY.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Human-readable label that displays the alert notification type.
Value is ORG.
PagerDuty notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
PagerDuty region that indicates which API Uniform Resource Locator (URL) to use.
Values are US or EU. Default value is US.
PagerDuty service key that MongoDB Cloud needs to send notifications via PagerDuty. The resource requires this parameter when "notifications.[n].typeName" : "PAGER_DUTY". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Human-readable label that displays the alert notification type.
Value is PAGER_DUTY.
Slack notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Slack API token or Bot token that MongoDB Cloud needs to send alert notifications via Slack. The resource requires this parameter when "notifications.[n].typeName" : "SLACK". If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes the token.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Name of the Slack channel to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SLACK".
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is SLACK.
SMS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
Mobile phone number to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SMS".
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is SMS.
Team notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Unique 24-hexadecimal digit string that identifies one MongoDB Cloud team. The resource requires this parameter when "notifications.[n].typeName" : "TEAM".
Format should match the following pattern: ^([a-f0-9]{24})$.
Name of the MongoDB Cloud team that receives this notification. The resource requires this parameter when "notifications.[n].typeName" : "TEAM".
Human-readable label that displays the alert notification type.
Value is TEAM.
User notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Human-readable label that displays the alert notification type.
Value is USER.
MongoDB Cloud username of the person to whom MongoDB Cloud sends notifications. Specify only MongoDB Cloud users who belong to the project that owns the alert configuration. The resource requires this parameter when "notifications.[n].typeName" : "USER".
VictorOps notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is VICTOR_OPS.
API key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when "notifications.[n].typeName" : "VICTOR_OPS". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Routing key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when "notifications.[n].typeName" : "VICTOR_OPS". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
Webhook notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is WEBHOOK.
Authentication secret for a webhook-based alert.
Atlas returns this value if you set notifications.[n].typeName :WEBHOOK and either:
notification.[n].webhookSecret to a non-empty stringNOTE: When you view or edit the alert for a webhook notification, the secret appears completely redacted.
Target URL for a webhook-based alert.
Atlas returns this value if you set "notifications.[n].typeName" :"WEBHOOK" and either:
notification.[n].webhookURL to a non-empty stringNOTE: When you view or edit the alert for a Webhook URL notification, the URL appears partially redacted.
Severity of the event.
Values are INFO, WARNING, ERROR, or CRITICAL.
Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
Host metric alert configuration allows to select which Atlas streams processors trigger alerts and how users are notified.
Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
Flag that indicates whether someone enabled this alert configuration for the specified project.
Default value is false.
Event type that triggers an alert.
Value is STREAM_PROCESSOR_STATE_IS_FAILED.
Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.
Format should match the following pattern: ^([a-f0-9]{24})$.
Unique 24-hexadecimal digit string that identifies this alert configuration.
Format should match the following pattern: ^([a-f0-9]{24})$.
List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.
Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.
Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.
List of rules that determine whether MongoDB Cloud checks an object for the alert configuration.
Rules to apply when comparing a stream processing workspace or stream processor against this alert configuration.
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.
Values are INSTANCE_NAME or PROCESSOR_NAME.
Comparison operator to apply when checking the current metric value against matcher[n].value. The REGEX operator only supports inclusive matches. Use the NOT_CONTAINS operator to exclude values.
Values are EQUALS, CONTAINS, STARTS_WITH, ENDS_WITH, NOT_EQUALS, NOT_CONTAINS, or REGEX.
Value to match or exceed using the specified matchers.operator.
List that contains the targets that MongoDB Cloud sends notifications.
One target that MongoDB Cloud sends notifications when an alert triggers.
At least 1 but not more than 25 elements.
One target that MongoDB Cloud sends notifications when an alert triggers.
Datadog notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Datadog API Key that MongoDB Cloud needs to send alert notifications to Datadog. You can find this API key in the Datadog dashboard. The resource requires this parameter when "notifications.[n].typeName" : "DATADOG".
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Datadog region that indicates which API Uniform Resource Locator (URL) to use. The resource requires this parameter when "notifications.[n].typeName" : "DATADOG".
Values are US, EU, US3, US5, AP1, or US1_FED. Default value is US.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is DATADOG.
Email notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Email address to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "EMAIL". You don't need to set this value to send emails to individual or groups of MongoDB Cloud users including:
"notifications.[n].typeName" : "USER")"notifications.[n].typeName" : "GROUP")"notifications.[n].typeName" : "ORG")"notifications.[n].typeName" : "TEAM")To send emails to one MongoDB Cloud user or grouping of users, set the notifications.[n].emailEnabled parameter.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is EMAIL.
Group notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
List that contains the one or more project roles that receive the configured alert. This parameter is available when "notifications.[n].typeName" : "GROUP" or "notifications.[n].typeName" : "ORG". If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Human-readable label that displays the alert notification type.
Value is GROUP.
HipChat notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
HipChat API token that MongoDB Cloud needs to send alert notifications to HipChat. The resource requires this parameter when "notifications.[n].typeName" : "HIP_CHAT"". If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
HipChat API room name to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "HIP_CHAT"".
Human-readable label that displays the alert notification type.
Value is HIP_CHAT.
Microsoft Teams notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
Microsoft Teams Webhook Uniform Resource Locator (URL) that MongoDB Cloud needs to send this notification via Microsoft Teams. The resource requires this parameter when "notifications.[n].typeName" : "MICROSOFT_TEAMS". If the URL later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: When you view or edit the alert for a Microsoft Teams notification, the URL appears partially redacted.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is MICROSOFT_TEAMS.
OpsGenie notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
API Key that MongoDB Cloud needs to send this notification via OpsGenie. The resource requires this parameter when "notifications.[n].typeName" : "OPS_GENIE". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
OpsGenie region that indicates which API Uniform Resource Locator (URL) to use.
Values are US or EU. Default value is US.
Human-readable label that displays the alert notification type.
Value is OPS_GENIE.
Organization notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
List that contains the one or more organization roles that receive the configured alert. This parameter is available when "notifications.[n].typeName" : "GROUP" or "notifications.[n].typeName" : "ORG". If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.
Values are ORG_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, ORG_BILLING_READ_ONLY, or ORG_READ_ONLY.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Human-readable label that displays the alert notification type.
Value is ORG.
PagerDuty notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
PagerDuty region that indicates which API Uniform Resource Locator (URL) to use.
Values are US or EU. Default value is US.
PagerDuty service key that MongoDB Cloud needs to send notifications via PagerDuty. The resource requires this parameter when "notifications.[n].typeName" : "PAGER_DUTY". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Human-readable label that displays the alert notification type.
Value is PAGER_DUTY.
Slack notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Slack API token or Bot token that MongoDB Cloud needs to send alert notifications via Slack. The resource requires this parameter when "notifications.[n].typeName" : "SLACK". If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes the token.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Name of the Slack channel to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SLACK".
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is SLACK.
SMS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
Mobile phone number to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SMS".
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is SMS.
Team notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Unique 24-hexadecimal digit string that identifies one MongoDB Cloud team. The resource requires this parameter when "notifications.[n].typeName" : "TEAM".
Format should match the following pattern: ^([a-f0-9]{24})$.
Name of the MongoDB Cloud team that receives this notification. The resource requires this parameter when "notifications.[n].typeName" : "TEAM".
Human-readable label that displays the alert notification type.
Value is TEAM.
User notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Human-readable label that displays the alert notification type.
Value is USER.
MongoDB Cloud username of the person to whom MongoDB Cloud sends notifications. Specify only MongoDB Cloud users who belong to the project that owns the alert configuration. The resource requires this parameter when "notifications.[n].typeName" : "USER".
VictorOps notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is VICTOR_OPS.
API key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when "notifications.[n].typeName" : "VICTOR_OPS". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Routing key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when "notifications.[n].typeName" : "VICTOR_OPS". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
Webhook notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is WEBHOOK.
Authentication secret for a webhook-based alert.
Atlas returns this value if you set notifications.[n].typeName :WEBHOOK and either:
notification.[n].webhookSecret to a non-empty stringNOTE: When you view or edit the alert for a webhook notification, the secret appears completely redacted.
Target URL for a webhook-based alert.
Atlas returns this value if you set "notifications.[n].typeName" :"WEBHOOK" and either:
notification.[n].webhookURL to a non-empty stringNOTE: When you view or edit the alert for a Webhook URL notification, the URL appears partially redacted.
Severity of the event.
Values are INFO, WARNING, ERROR, or CRITICAL.
Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
Stream Processor threshold alert configuration allows to select thresholds on metrics which trigger alerts and how users are notified.
Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
Flag that indicates whether someone enabled this alert configuration for the specified project.
Default value is false.
Event type that triggers an alert.
Value is OUTSIDE_STREAM_PROCESSOR_METRIC_THRESHOLD.
Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.
Format should match the following pattern: ^([a-f0-9]{24})$.
Unique 24-hexadecimal digit string that identifies this alert configuration.
Format should match the following pattern: ^([a-f0-9]{24})$.
List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.
Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.
Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.
List of rules that determine whether MongoDB Cloud checks an object for the alert configuration.
Rules to apply when comparing a stream processing workspace or stream processor against this alert configuration.
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.
Values are INSTANCE_NAME or PROCESSOR_NAME.
Comparison operator to apply when checking the current metric value against matcher[n].value. The REGEX operator only supports inclusive matches. Use the NOT_CONTAINS operator to exclude values.
Values are EQUALS, CONTAINS, STARTS_WITH, ENDS_WITH, NOT_EQUALS, NOT_CONTAINS, or REGEX.
Value to match or exceed using the specified matchers.operator.
List that contains the targets that MongoDB Cloud sends notifications.
One target that MongoDB Cloud sends notifications when an alert triggers.
At least 1 but not more than 25 elements.
One target that MongoDB Cloud sends notifications when an alert triggers.
Datadog notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Datadog API Key that MongoDB Cloud needs to send alert notifications to Datadog. You can find this API key in the Datadog dashboard. The resource requires this parameter when "notifications.[n].typeName" : "DATADOG".
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Datadog region that indicates which API Uniform Resource Locator (URL) to use. The resource requires this parameter when "notifications.[n].typeName" : "DATADOG".
Values are US, EU, US3, US5, AP1, or US1_FED. Default value is US.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is DATADOG.
Email notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Email address to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "EMAIL". You don't need to set this value to send emails to individual or groups of MongoDB Cloud users including:
"notifications.[n].typeName" : "USER")"notifications.[n].typeName" : "GROUP")"notifications.[n].typeName" : "ORG")"notifications.[n].typeName" : "TEAM")To send emails to one MongoDB Cloud user or grouping of users, set the notifications.[n].emailEnabled parameter.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is EMAIL.
Group notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
List that contains the one or more project roles that receive the configured alert. This parameter is available when "notifications.[n].typeName" : "GROUP" or "notifications.[n].typeName" : "ORG". If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Human-readable label that displays the alert notification type.
Value is GROUP.
HipChat notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
HipChat API token that MongoDB Cloud needs to send alert notifications to HipChat. The resource requires this parameter when "notifications.[n].typeName" : "HIP_CHAT"". If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
HipChat API room name to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "HIP_CHAT"".
Human-readable label that displays the alert notification type.
Value is HIP_CHAT.
Microsoft Teams notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
Microsoft Teams Webhook Uniform Resource Locator (URL) that MongoDB Cloud needs to send this notification via Microsoft Teams. The resource requires this parameter when "notifications.[n].typeName" : "MICROSOFT_TEAMS". If the URL later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: When you view or edit the alert for a Microsoft Teams notification, the URL appears partially redacted.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is MICROSOFT_TEAMS.
OpsGenie notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
API Key that MongoDB Cloud needs to send this notification via OpsGenie. The resource requires this parameter when "notifications.[n].typeName" : "OPS_GENIE". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
OpsGenie region that indicates which API Uniform Resource Locator (URL) to use.
Values are US or EU. Default value is US.
Human-readable label that displays the alert notification type.
Value is OPS_GENIE.
Organization notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
List that contains the one or more organization roles that receive the configured alert. This parameter is available when "notifications.[n].typeName" : "GROUP" or "notifications.[n].typeName" : "ORG". If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.
Values are ORG_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, ORG_BILLING_READ_ONLY, or ORG_READ_ONLY.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Human-readable label that displays the alert notification type.
Value is ORG.
PagerDuty notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
PagerDuty region that indicates which API Uniform Resource Locator (URL) to use.
Values are US or EU. Default value is US.
PagerDuty service key that MongoDB Cloud needs to send notifications via PagerDuty. The resource requires this parameter when "notifications.[n].typeName" : "PAGER_DUTY". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Human-readable label that displays the alert notification type.
Value is PAGER_DUTY.
Slack notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Slack API token or Bot token that MongoDB Cloud needs to send alert notifications via Slack. The resource requires this parameter when "notifications.[n].typeName" : "SLACK". If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes the token.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Name of the Slack channel to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SLACK".
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is SLACK.
SMS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
Mobile phone number to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SMS".
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is SMS.
Team notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Unique 24-hexadecimal digit string that identifies one MongoDB Cloud team. The resource requires this parameter when "notifications.[n].typeName" : "TEAM".
Format should match the following pattern: ^([a-f0-9]{24})$.
Name of the MongoDB Cloud team that receives this notification. The resource requires this parameter when "notifications.[n].typeName" : "TEAM".
Human-readable label that displays the alert notification type.
Value is TEAM.
User notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:
"notifications.[n].typeName" : "ORG""notifications.[n].typeName" : "GROUP""notifications.[n].typeName" : "USER"Human-readable label that displays the alert notification type.
Value is USER.
MongoDB Cloud username of the person to whom MongoDB Cloud sends notifications. Specify only MongoDB Cloud users who belong to the project that owns the alert configuration. The resource requires this parameter when "notifications.[n].typeName" : "USER".
VictorOps notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is VICTOR_OPS.
API key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when "notifications.[n].typeName" : "VICTOR_OPS". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
View or edit the alert through the Atlas UI.
Query the alert for the notification through the Atlas Administration API.
Routing key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when "notifications.[n].typeName" : "VICTOR_OPS". If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
Webhook notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
The id of the associated integration, the credentials of which to use for requests.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
Minimum value is 5.
The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that displays the alert notification type.
Value is WEBHOOK.
Authentication secret for a webhook-based alert.
Atlas returns this value if you set notifications.[n].typeName :WEBHOOK and either:
notification.[n].webhookSecret to a non-empty stringNOTE: When you view or edit the alert for a webhook notification, the secret appears completely redacted.
Target URL for a webhook-based alert.
Atlas returns this value if you set "notifications.[n].typeName" :"WEBHOOK" and either:
notification.[n].webhookURL to a non-empty stringNOTE: When you view or edit the alert for a Webhook URL notification, the URL appears partially redacted.
Severity of the event.
Values are INFO, WARNING, ERROR, or CRITICAL.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics in stream processors.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is STREAM_PROCESSOR_KAFKA_LAG.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics in stream processors.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is STREAM_PROCESSOR_CHANGE_STREAM_LAG.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is HOURS.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics in stream processors.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is STREAM_PROCESSOR_DLQ_MESSAGE_COUNT.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics in stream processors.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
Value is STREAM_PROCESSOR_OUTPUT_MESSAGE_COUNT.
MongoDB Cloud computes the current metric value as an average.
Value is AVERAGE.
Comparison operator to apply when checking the current metric value.
Values are LESS_THAN or GREATER_THAN.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Default value is RAW.
Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
Unauthorized.
Bad request detail.
Describes the specific conditions or reasons that cause each type of error.
HTTP status code returned with this error.
Application error code returned with this error.
Parameters used to give more information about the error.
Application error message returned with this error.
Forbidden.
Bad request detail.
Describes the specific conditions or reasons that cause each type of error.
HTTP status code returned with this error.
Application error code returned with this error.
Parameters used to give more information about the error.
Application error message returned with this error.
Not Found.
Bad request detail.
Describes the specific conditions or reasons that cause each type of error.
HTTP status code returned with this error.
Application error code returned with this error.
Parameters used to give more information about the error.
Application error message returned with this error.
Internal Server Error.
Bad request detail.
Describes the specific conditions or reasons that cause each type of error.
HTTP status code returned with this error.
Application error code returned with this error.
Parameters used to give more information about the error.
Application error message returned with this error.
atlas api alertConfigurations toggleAlertConfig --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20241113001/admin"
)
func main() {
ctx := context.Background()
clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")
// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))
if err != nil {
log.Fatalf("Error: %v", err)
}
params = &sdk.ToggleGroupAlertConfigApiParams{}
sdkResp, httpResp, err := client.AlertConfigurationsApi.
ToggleGroupAlertConfigWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2024-11-13+json" \
--header "Content-Type: application/json" \
-X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" \
-d '{ <Payload> }'curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2024-11-13+json" \
--header "Content-Type: application/json" \
-X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" \
-d '{ <Payload> }'{
"enabled": true
}{
"created": "2026-05-04T09:42:00Z",
"enabled": false,
"eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"matchers": [
{
"fieldName": "string",
"operator": "EQUALS",
"value": "event-replica-set"
}
],
"notifications": [
{
"datadogApiKey": "****************************a23c",
"datadogRegion": "US",
"delayMin": 42,
"integrationId": "32b6e34b3d91647abb20e7b8",
"intervalMin": 42,
"notifierId": "32b6e34b3d91647abb20e7b8",
"typeName": "DATADOG"
}
],
"severityOverride": "INFO",
"updated": "2026-05-04T09:42:00Z"
}{
"created": "2026-05-04T09:42:00Z",
"enabled": false,
"eventTypeName": "DEPLOYMENT_FAILURE",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"matchers": [
{
"fieldName": "APPLICATION_ID",
"operator": "EQUALS",
"value": "event-replica-set"
}
],
"notifications": [
{
"datadogApiKey": "****************************a23c",
"datadogRegion": "US",
"delayMin": 42,
"integrationId": "32b6e34b3d91647abb20e7b8",
"intervalMin": 42,
"notifierId": "32b6e34b3d91647abb20e7b8",
"typeName": "DATADOG"
}
],
"severityOverride": "INFO",
"updated": "2026-05-04T09:42:00Z"
}{
"created": "2026-05-04T09:42:00Z",
"enabled": false,
"eventTypeName": "OUTSIDE_REALM_METRIC_THRESHOLD",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"matchers": [
{
"fieldName": "APPLICATION_ID",
"operator": "EQUALS",
"value": "event-replica-set"
}
],
"metricThreshold": {
"metricName": "REALM_TRIGGERS_FAILED_REQUESTS",
"mode": "AVERAGE",
"operator": "LESS_THAN",
"threshold": 42.0,
"units": "RAW"
},
"notifications": [
{
"datadogApiKey": "****************************a23c",
"datadogRegion": "US",
"delayMin": 42,
"integrationId": "32b6e34b3d91647abb20e7b8",
"intervalMin": 42,
"notifierId": "32b6e34b3d91647abb20e7b8",
"typeName": "DATADOG"
}
],
"severityOverride": "INFO",
"updated": "2026-05-04T09:42:00Z"
}{
"created": "2026-05-04T09:42:00Z",
"enabled": false,
"eventTypeName": "PENDING_INVOICE_OVER_THRESHOLD",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"matchers": [
{
"fieldName": "string",
"operator": "EQUALS",
"value": "event-replica-set"
}
],
"notifications": [
{
"datadogApiKey": "****************************a23c",
"datadogRegion": "US",
"delayMin": 42,
"integrationId": "32b6e34b3d91647abb20e7b8",
"intervalMin": 42,
"notifierId": "32b6e34b3d91647abb20e7b8",
"typeName": "DATADOG"
}
],
"severityOverride": "INFO",
"threshold": {
"operator": "GREATER_THAN",
"threshold": 42,
"units": "RAW"
},
"updated": "2026-05-04T09:42:00Z"
}{
"created": "2026-05-04T09:42:00Z",
"enabled": false,
"eventTypeName": "CLUSTER_MONGOS_IS_MISSING",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"matchers": [
{
"fieldName": "CLUSTER_NAME",
"operator": "EQUALS",
"value": "event-replica-set"
}
],
"notifications": [
{
"datadogApiKey": "****************************a23c",
"datadogRegion": "US",
"delayMin": 42,
"integrationId": "32b6e34b3d91647abb20e7b8",
"intervalMin": 42,
"notifierId": "32b6e34b3d91647abb20e7b8",
"typeName": "DATADOG"
}
],
"severityOverride": "INFO",
"updated": "2026-05-04T09:42:00Z"
}{
"created": "2026-05-04T09:42:00Z",
"enabled": false,
"eventTypeName": "CPS_SNAPSHOT_BEHIND",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"matchers": [
{
"fieldName": "string",
"operator": "EQUALS",
"value": "event-replica-set"
}
],
"notifications": [
{
"datadogApiKey": "****************************a23c",
"datadogRegion": "US",
"delayMin": 42,
"integrationId": "32b6e34b3d91647abb20e7b8",
"intervalMin": 42,
"notifierId": "32b6e34b3d91647abb20e7b8",
"typeName": "DATADOG"
}
],
"severityOverride": "INFO",
"threshold": {
"operator": "GREATER_THAN",
"threshold": 42,
"units": "HOURS"
},
"updated": "2026-05-04T09:42:00Z"
}{
"created": "2026-05-04T09:42:00Z",
"enabled": false,
"eventTypeName": "AWS_ENCRYPTION_KEY_NEEDS_ROTATION",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"matchers": [
{
"fieldName": "string",
"operator": "EQUALS",
"value": "event-replica-set"
}
],
"notifications": [
{
"datadogApiKey": "****************************a23c",
"datadogRegion": "US",
"delayMin": 42,
"integrationId": "32b6e34b3d91647abb20e7b8",
"intervalMin": 42,
"notifierId": "32b6e34b3d91647abb20e7b8",
"typeName": "DATADOG"
}
],
"severityOverride": "INFO",
"threshold": {
"operator": "GREATER_THAN",
"threshold": 42,
"units": "DAYS"
},
"updated": "2026-05-04T09:42:00Z"
}{
"created": "2026-05-04T09:42:00Z",
"enabled": false,
"eventTypeName": "HOST_DOWN",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"matchers": [
{
"fieldName": "HOSTNAME",
"operator": "EQUALS",
"value": "STANDALONE"
}
],
"notifications": [
{
"datadogApiKey": "****************************a23c",
"datadogRegion": "US",
"delayMin": 42,
"integrationId": "32b6e34b3d91647abb20e7b8",
"intervalMin": 42,
"notifierId": "32b6e34b3d91647abb20e7b8",
"typeName": "DATADOG"
}
],
"severityOverride": "INFO",
"updated": "2026-05-04T09:42:00Z"
}{
"created": "2026-05-04T09:42:00Z",
"enabled": false,
"eventTypeName": "OUTSIDE_METRIC_THRESHOLD",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"matchers": [
{
"fieldName": "HOSTNAME",
"operator": "EQUALS",
"value": "STANDALONE"
}
],
"metricThreshold": {
"metricName": "ASSERT_REGULAR",
"mode": "AVERAGE",
"operator": "LESS_THAN",
"threshold": 42.0,
"units": "RAW"
},
"notifications": [
{
"datadogApiKey": "****************************a23c",
"datadogRegion": "US",
"delayMin": 42,
"integrationId": "32b6e34b3d91647abb20e7b8",
"intervalMin": 42,
"notifierId": "32b6e34b3d91647abb20e7b8",
"typeName": "DATADOG"
}
],
"severityOverride": "INFO",
"updated": "2026-05-04T09:42:00Z"
}{
"created": "2026-05-04T09:42:00Z",
"enabled": false,
"eventTypeName": "MONGOTUNE_ALERT",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"matchers": [
{
"fieldName": "string",
"operator": "EQUALS",
"value": "event-replica-set"
}
],
"notifications": [
{
"datadogApiKey": "****************************a23c",
"datadogRegion": "US",
"delayMin": 42,
"integrationId": "32b6e34b3d91647abb20e7b8",
"intervalMin": 42,
"notifierId": "32b6e34b3d91647abb20e7b8",
"typeName": "DATADOG"
}
],
"severityOverride": "INFO",
"updated": "2026-05-04T09:42:00Z"
}{
"created": "2026-05-04T09:42:00Z",
"enabled": false,
"eventTypeName": "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"matchers": [
{
"fieldName": "string",
"operator": "EQUALS",
"value": "event-replica-set"
}
],
"notifications": [
{
"datadogApiKey": "****************************a23c",
"datadogRegion": "US",
"delayMin": 42,
"integrationId": "32b6e34b3d91647abb20e7b8",
"intervalMin": 42,
"notifierId": "32b6e34b3d91647abb20e7b8",
"typeName": "DATADOG"
}
],
"severityOverride": "INFO",
"threshold": {
"operator": "LESS_THAN",
"threshold": 42,
"units": "DAYS"
},
"updated": "2026-05-04T09:42:00Z"
}{
"created": "2026-05-04T09:42:00Z",
"enabled": false,
"eventTypeName": "NO_PRIMARY",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"matchers": [
{
"fieldName": "REPLICA_SET_NAME",
"operator": "EQUALS",
"value": "event-replica-set"
}
],
"notifications": [
{
"datadogApiKey": "****************************a23c",
"datadogRegion": "US",
"delayMin": 42,
"integrationId": "32b6e34b3d91647abb20e7b8",
"intervalMin": 42,
"notifierId": "32b6e34b3d91647abb20e7b8",
"typeName": "DATADOG"
}
],
"severityOverride": "INFO",
"threshold": {
"operator": "<",
"threshold": 42,
"units": "bits"
},
"updated": "2026-05-04T09:42:00Z"
}{
"created": "2026-05-04T09:42:00Z",
"enabled": false,
"eventTypeName": "TOO_MANY_ELECTIONS",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"matchers": [
{
"fieldName": "REPLICA_SET_NAME",
"operator": "EQUALS",
"value": "event-replica-set"
}
],
"notifications": [
{
"datadogApiKey": "****************************a23c",
"datadogRegion": "US",
"delayMin": 42,
"integrationId": "32b6e34b3d91647abb20e7b8",
"intervalMin": 42,
"notifierId": "32b6e34b3d91647abb20e7b8",
"typeName": "DATADOG"
}
],
"severityOverride": "INFO",
"threshold": {
"operator": "<",
"threshold": 42,
"units": "bits"
},
"updated": "2026-05-04T09:42:00Z"
}{
"created": "2026-05-04T09:42:00Z",
"enabled": false,
"eventTypeName": "OUTSIDE_SERVERLESS_METRIC_THRESHOLD",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"matchers": [
{
"fieldName": "string",
"operator": "EQUALS",
"value": "event-replica-set"
}
],
"metricThreshold": {
"metricName": "SERVERLESS_AVG_COMMAND_EXECUTION_TIME",
"mode": "AVERAGE",
"operator": "LESS_THAN",
"threshold": 42.0,
"units": "HOURS"
},
"notifications": [
{
"datadogApiKey": "****************************a23c",
"datadogRegion": "US",
"delayMin": 42,
"integrationId": "32b6e34b3d91647abb20e7b8",
"intervalMin": 42,
"notifierId": "32b6e34b3d91647abb20e7b8",
"typeName": "DATADOG"
}
],
"severityOverride": "INFO",
"updated": "2026-05-04T09:42:00Z"
}{
"created": "2026-05-04T09:42:00Z",
"enabled": false,
"eventTypeName": "OUTSIDE_FLEX_METRIC_THRESHOLD",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"matchers": [
{
"fieldName": "string",
"operator": "EQUALS",
"value": "event-replica-set"
}
],
"metricThreshold": {
"metricName": "FLEX_CONNECTIONS",
"mode": "AVERAGE",
"operator": "LESS_THAN",
"threshold": 42.0,
"units": "RAW"
},
"notifications": [
{
"datadogApiKey": "****************************a23c",
"datadogRegion": "US",
"delayMin": 42,
"integrationId": "32b6e34b3d91647abb20e7b8",
"intervalMin": 42,
"notifierId": "32b6e34b3d91647abb20e7b8",
"typeName": "DATADOG"
}
],
"severityOverride": "INFO",
"updated": "2026-05-04T09:42:00Z"
}{
"created": "2026-05-04T09:42:00Z",
"enabled": false,
"eventTypeName": "STREAM_PROCESSOR_STATE_IS_FAILED",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"matchers": [
{
"fieldName": "INSTANCE_NAME",
"operator": "EQUALS",
"value": "event-replica-set"
}
],
"notifications": [
{
"datadogApiKey": "****************************a23c",
"datadogRegion": "US",
"delayMin": 42,
"integrationId": "32b6e34b3d91647abb20e7b8",
"intervalMin": 42,
"notifierId": "32b6e34b3d91647abb20e7b8",
"typeName": "DATADOG"
}
],
"severityOverride": "INFO",
"updated": "2026-05-04T09:42:00Z"
}{
"created": "2026-05-04T09:42:00Z",
"enabled": false,
"eventTypeName": "OUTSIDE_STREAM_PROCESSOR_METRIC_THRESHOLD",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"matchers": [
{
"fieldName": "INSTANCE_NAME",
"operator": "EQUALS",
"value": "event-replica-set"
}
],
"notifications": [
{
"datadogApiKey": "****************************a23c",
"datadogRegion": "US",
"delayMin": 42,
"integrationId": "32b6e34b3d91647abb20e7b8",
"intervalMin": 42,
"notifierId": "32b6e34b3d91647abb20e7b8",
"typeName": "DATADOG"
}
],
"severityOverride": "INFO",
"threshold": {
"metricName": "STREAM_PROCESSOR_KAFKA_LAG",
"mode": "AVERAGE",
"operator": "LESS_THAN",
"threshold": 42.0,
"units": "RAW"
},
"updated": "2026-05-04T09:42:00Z"
}{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}{
"error": 404,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
"reason": "Not Found",
"errorCode": "RESOURCE_NOT_FOUND"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}