Create One Alert Configuration in One Project

POST /api/atlas/v2/groups/{groupId}/alertConfigs

Creates one alert configuration for the specified project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role.

This resource remains under revision and may change.

Path parameters

groupId string Required

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})$.

Query parameters

envelope boolean

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.
pretty boolean

Flag that indicates whether the response body should be in the prettyprint format.

Default value is false.

Prettyprint

application/vnd.atlas.2023-01-01+json

Body object Required

Creates one alert configuration for the specified project.

Other alerts which don't have extra details beside of basic one.

enabled boolean

Flag that indicates whether someone enabled this alert configuration for the specified project.

Default value is false.
eventTypeName string Required

Incident that triggered this alert.

One of:
Billing Event Types string Cps Backup Event Types string Data Protection Event Types string FTS Index Audit Types string Group Event Types string NDS Audit Types string NDS Maintenance Window Audit Types string Online Archive Event Types string User Event Types string Resource Event Types string Stream Processor Event Types string NDS Auto Scaling Audit Types string Atlas Resource Policy Audit Types string

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, or GROUP_SERVICE_ACCOUNT_SECRETS_EXPIRED.

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, 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.
matchers array[object]

Matching conditions for target resources.

Rules to apply when comparing an target instance against this alert configuration.
Hide matchers attributes Show matchers attributes object
- fieldName string Required
  
  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.
- operator string Required
  
  Comparison operator to apply when checking the current metric value against matcher[n].value.
  
  Values are EQUALS, CONTAINS, STARTS_WITH, ENDS_WITH, NOT_EQUALS, NOT_CONTAINS, or REGEX.
- value string Required
  
  Value to match or exceed using the specified matchers.operator.
notifications array[object] Required

List that contains the targets that MongoDB Cloud sends notifications.

One target that MongoDB Cloud sends notifications when an alert triggers.
One target that MongoDB Cloud sends notifications when an alert triggers.
One of:
DatadogNotification object EmailNotification object GroupNotification object HipChatNotification object MicrosoftTeamsNotification object OpsGenieNotification object OrgNotification object PagerDutyNotification object SlackNotification object SMSNotification object TeamNotification object UserNotification object VictorOpsNotification object WebhookNotification object
Datadog notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Hide attributes Show attributes

datadogApiKey string

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.

datadogRegion string

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.

Datadog regions

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailAddress string(email)

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:

specific MongoDB Cloud users ("notifications.[n].typeName" : "USER")

MongoDB Cloud users with specific project roles ("notifications.[n].typeName" : "GROUP")

MongoDB Cloud users with specific organization roles ("notifications.[n].typeName" : "ORG")

MongoDB Cloud teams ("notifications.[n].typeName" : "TEAM")

To send emails to one MongoDB Cloud user or grouping of users, set the notifications.[n].emailEnabled parameter.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailEnabled boolean

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"

intervalMin integer(int32)

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.

notifierId string

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})$.

roles array[string]

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.

Values are GROUP_BACKUP_MANAGER, GROUP_CLUSTER_MANAGER, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_ONLY, GROUP_DATA_ACCESS_READ_WRITE, GROUP_DATABASE_ACCESS_ADMIN, GROUP_OBSERVABILITY_VIEWER, GROUP_OWNER, GROUP_READ_ONLY, GROUP_SEARCH_INDEX_EDITOR, or GROUP_STREAM_PROCESSING_OWNER.

smsEnabled boolean

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"

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notificationToken string

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.

notifierId string

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})$.

roomName string

HipChat API room name to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "HIP_CHAT"".

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

microsoftTeamsWebhookUrl string

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.

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

opsGenieApiKey string

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.

opsGenieRegion string

Opsgenie region that indicates which API Uniform Resource Locator (URL) to use.

Values are US or EU. Default value is US.

typeName string Required

Human-readable label that displays the alert notification type.

Value is OPS_GENIE.
Org notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailEnabled boolean

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"

intervalMin integer(int32)

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.

notifierId string

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})$.

roles array[string]

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.

smsEnabled boolean

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"

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

region string

PagerDuty region that indicates which API Uniform Resource Locator (URL) to use.

Values are US or EU. Default value is US.

serviceKey string

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.

typeName string Required

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.
Hide attributes Show attributes

apiToken string

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.

channelName string

Name of the Slack channel to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SLACK".

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

intervalMin integer(int32)

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.

mobileNumber string

Mobile phone number to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SMS".

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailEnabled boolean

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"

intervalMin integer(int32)

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.

notifierId string

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})$.

smsEnabled boolean

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"

teamId string

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})$.

teamName string

Name of the MongoDB Cloud team that receives this notification. The resource requires this parameter when "notifications.[n].typeName" : "TEAM".

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailEnabled boolean

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"

intervalMin integer(int32)

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.

notifierId string

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})$.

smsEnabled boolean

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"

typeName string Required

Human-readable label that displays the alert notification type.

Value is USER.

username string(email)

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

Human-readable label that displays the alert notification type.

Value is VICTOR_OPS.

victorOpsApiKey string

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.

victorOpsRoutingKey string

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

Human-readable label that displays the alert notification type.

Value is WEBHOOK.

webhookSecret string(password)

Authentication secret for a webhook-based alert.

Atlas returns this value if you set "notifications.[n].typeName" :"WEBHOOK" and either:

You set notification.[n].webhookSecret to a non-empty string

You set a default webhookSecret either on the Integrations page, or with the Integrations API

NOTE: When you view or edit the alert for a webhook notification, the secret appears completely redacted.

Integrations page

webhookUrl string

Target URL for a webhook-based alert.

Atlas returns this value if you set "notifications.[n].typeName" :"WEBHOOK" and either:

You set notification.[n].webhookURL to a non-empty string

You set a default webhookUrl either on the Integrations page, or with the Integrations API

NOTE: When you view or edit the alert for a Webhook URL notification, the URL appears partially redacted.
severityOverride string

Severity of the event.

Values are INFO, WARNING, ERROR, or CRITICAL.

App Services metric alert configuration allows to select which app service conditions and events trigger alerts and how users are notified.

enabled boolean

Flag that indicates whether someone enabled this alert configuration for the specified project.

Default value is false.
eventTypeName string Required

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.
matchers array[object]

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.
Hide matchers attributes Show matchers attributes object
- fieldName string Required
  
  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.
- operator string Required
  
  Comparison operator to apply when checking the current metric value against matcher[n].value.
  
  Values are EQUALS, CONTAINS, STARTS_WITH, ENDS_WITH, NOT_EQUALS, NOT_CONTAINS, or REGEX.
- value string Required
  
  Value to match or exceed using the specified matchers.operator.
notifications array[object] Required

List that contains the targets that MongoDB Cloud sends notifications.

One target that MongoDB Cloud sends notifications when an alert triggers.
One target that MongoDB Cloud sends notifications when an alert triggers.
One of:
DatadogNotification object EmailNotification object GroupNotification object HipChatNotification object MicrosoftTeamsNotification object OpsGenieNotification object OrgNotification object PagerDutyNotification object SlackNotification object SMSNotification object TeamNotification object UserNotification object VictorOpsNotification object WebhookNotification object
Datadog notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Hide attributes Show attributes

datadogApiKey string

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.

datadogRegion string

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.

Datadog regions

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailAddress string(email)

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:

specific MongoDB Cloud users ("notifications.[n].typeName" : "USER")

MongoDB Cloud users with specific project roles ("notifications.[n].typeName" : "GROUP")

MongoDB Cloud users with specific organization roles ("notifications.[n].typeName" : "ORG")

MongoDB Cloud teams ("notifications.[n].typeName" : "TEAM")

To send emails to one MongoDB Cloud user or grouping of users, set the notifications.[n].emailEnabled parameter.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailEnabled boolean

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"

intervalMin integer(int32)

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.

notifierId string

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})$.

roles array[string]

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.

Values are GROUP_BACKUP_MANAGER, GROUP_CLUSTER_MANAGER, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_ONLY, GROUP_DATA_ACCESS_READ_WRITE, GROUP_DATABASE_ACCESS_ADMIN, GROUP_OBSERVABILITY_VIEWER, GROUP_OWNER, GROUP_READ_ONLY, GROUP_SEARCH_INDEX_EDITOR, or GROUP_STREAM_PROCESSING_OWNER.

smsEnabled boolean

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"

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notificationToken string

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.

notifierId string

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})$.

roomName string

HipChat API room name to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "HIP_CHAT"".

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

microsoftTeamsWebhookUrl string

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.

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

opsGenieApiKey string

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.

opsGenieRegion string

Opsgenie region that indicates which API Uniform Resource Locator (URL) to use.

Values are US or EU. Default value is US.

typeName string Required

Human-readable label that displays the alert notification type.

Value is OPS_GENIE.
Org notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailEnabled boolean

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"

intervalMin integer(int32)

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.

notifierId string

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})$.

roles array[string]

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.

smsEnabled boolean

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"

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

region string

PagerDuty region that indicates which API Uniform Resource Locator (URL) to use.

Values are US or EU. Default value is US.

serviceKey string

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.

typeName string Required

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.
Hide attributes Show attributes

apiToken string

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.

channelName string

Name of the Slack channel to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SLACK".

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

intervalMin integer(int32)

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.

mobileNumber string

Mobile phone number to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SMS".

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailEnabled boolean

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"

intervalMin integer(int32)

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.

notifierId string

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})$.

smsEnabled boolean

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"

teamId string

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})$.

teamName string

Name of the MongoDB Cloud team that receives this notification. The resource requires this parameter when "notifications.[n].typeName" : "TEAM".

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailEnabled boolean

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"

intervalMin integer(int32)

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.

notifierId string

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})$.

smsEnabled boolean

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"

typeName string Required

Human-readable label that displays the alert notification type.

Value is USER.

username string(email)

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

Human-readable label that displays the alert notification type.

Value is VICTOR_OPS.

victorOpsApiKey string

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.

victorOpsRoutingKey string

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

Human-readable label that displays the alert notification type.

Value is WEBHOOK.

webhookSecret string(password)

Authentication secret for a webhook-based alert.

Atlas returns this value if you set "notifications.[n].typeName" :"WEBHOOK" and either:

You set notification.[n].webhookSecret to a non-empty string

You set a default webhookSecret either on the Integrations page, or with the Integrations API

NOTE: When you view or edit the alert for a webhook notification, the secret appears completely redacted.

Integrations page

webhookUrl string

Target URL for a webhook-based alert.

Atlas returns this value if you set "notifications.[n].typeName" :"WEBHOOK" and either:

You set notification.[n].webhookURL to a non-empty string

You set a default webhookUrl either on the Integrations page, or with the Integrations API

NOTE: When you view or edit the alert for a Webhook URL notification, the URL appears partially redacted.
severityOverride string

Severity of the event.

Values are INFO, WARNING, ERROR, or CRITICAL.

App Services metric alert configuration allows to select which app service metrics trigger alerts and how users are notified.

enabled boolean

Flag that indicates whether someone enabled this alert configuration for the specified project.

Default value is false.
eventTypeName string Required

Event type that triggers an alert.

Value is OUTSIDE_REALM_METRIC_THRESHOLD.
matchers array[object]

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.
Hide matchers attributes Show matchers attributes object
- fieldName string Required
  
  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.
- operator string Required
  
  Comparison operator to apply when checking the current metric value against matcher[n].value.
  
  Values are EQUALS, CONTAINS, STARTS_WITH, ENDS_WITH, NOT_EQUALS, NOT_CONTAINS, or REGEX.
- value string Required
  
  Value to match or exceed using the specified matchers.operator.
metricThreshold object
One of:
REALM_AUTH_LOGIN_FAIL object REALM_ENDPOINTS_COMPUTE_MS object REALM_ENDPOINTS_EGRESS_BYTES object REALM_ENDPOINTS_FAILED_REQUESTS object REALM_ENDPOINTS_RESPONSE_MS object REALM_GQL_COMPUTE_MS object REALM_GQL_EGRESS_BYTES object REALM_GQL_FAILED_REQUESTS object REALM_GQL_RESPONSE_MS object REALM_OVERALL_COMPUTE_MS object REALM_OVERALL_EGRESS_BYTES object REALM_OVERALL_FAILED_REQUESTS object REALM_SDKFNS_FAILED_REQUESTS object REALM_SDK_FNS_RESPONSE_MS object REALM_SDK_FUNCTIONS_COMPUTE_MS object REALM_SDK_FUNCTIONS_EGRESS_BYTES object REALM_SDK_MQL_COMPUTE_MS object REALM_SDK_MQL_EGRESS_BYTES object REALM_SDK_MQL_RESPONSE_MS object REALM_SYNC_CLIENT_BOOTSTRAP_MS object REALM_SYNC_CLIENT_CHANGESETS_INVALID object REALM_SYNC_CLIENT_READS_FAILED object REALM_SYNC_CLIENT_UPLOADS_FAILED object REALM_SYNC_CURRENT_OPLOG_LAG_MS_SUM object REALM_SYNC_EGRESS_BYTES object REALM_SYNC_FAILED_REQUESTS object REALM_SYNC_NUM_UNSYNCABLE_DOCS_PERCENT object REALM_SYNC_SESSIONS_ENDED object REALM_TRIGGERS_COMPUTE_MS object REALM_TRIGGERS_CURRENT_OPLOG_LAG_MS_SUM object REALM_TRIGGERS_EGRESS_BYTES object REALM_TRIGGERS_FAILED_REQUESTS object REALM_TRIGGERS_RESPONSE_MS object
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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is REALM_AUTH_LOGIN_FAIL.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is REALM_ENDPOINTS_COMPUTE_MS.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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 the app services.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is REALM_ENDPOINTS_EGRESS_BYTES.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is REALM_ENDPOINTS_FAILED_REQUESTS.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is REALM_ENDPOINTS_RESPONSE_MS.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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 the app services.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is REALM_GQL_COMPUTE_MS.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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 the app services.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is REALM_GQL_EGRESS_BYTES.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is REALM_GQL_FAILED_REQUESTS.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is REALM_GQL_RESPONSE_MS.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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 the app services.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is REALM_OVERALL_COMPUTE_MS.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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 the app services.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is REALM_OVERALL_EGRESS_BYTES.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is REALM_OVERALL_FAILED_REQUESTS.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is REALM_SDKFNS_FAILED_REQUESTS.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is REALM_SDK_FNS_RESPONSE_MS.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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 the app services.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is REALM_SDK_FUNCTIONS_COMPUTE_MS.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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 the app services.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is REALM_SDK_FUNCTIONS_EGRESS_BYTES.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is REALM_SDK_MQL_COMPUTE_MS.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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 the app services.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is REALM_SDK_MQL_EGRESS_BYTES.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is REALM_SDK_MQL_RESPONSE_MS.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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 the app services.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is REALM_SYNC_CLIENT_BOOTSTRAP_MS.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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 the app services.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is REALM_SYNC_CLIENT_CHANGESETS_INVALID.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is REALM_SYNC_CLIENT_READS_FAILED.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is REALM_SYNC_CLIENT_UPLOADS_FAILED.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is REALM_SYNC_CURRENT_OPLOG_LAG_MS_SUM.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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 the app services.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is REALM_SYNC_EGRESS_BYTES.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is REALM_SYNC_FAILED_REQUESTS.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is REALM_SYNC_NUM_UNSYNCABLE_DOCS_PERCENT.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is REALM_SYNC_SESSIONS_ENDED.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is REALM_TRIGGERS_COMPUTE_MS.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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 the app services.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is REALM_TRIGGERS_CURRENT_OPLOG_LAG_MS_SUM.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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 the app services.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is REALM_TRIGGERS_EGRESS_BYTES.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is REALM_TRIGGERS_FAILED_REQUESTS.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is REALM_TRIGGERS_RESPONSE_MS.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

Element used to express the quantity. This can be an element of time, storage capacity, and the like.

Default value is HOURS.
notifications array[object] Required

List that contains the targets that MongoDB Cloud sends notifications.

One target that MongoDB Cloud sends notifications when an alert triggers.
One target that MongoDB Cloud sends notifications when an alert triggers.
One of:
DatadogNotification object EmailNotification object GroupNotification object HipChatNotification object MicrosoftTeamsNotification object OpsGenieNotification object OrgNotification object PagerDutyNotification object SlackNotification object SMSNotification object TeamNotification object UserNotification object VictorOpsNotification object WebhookNotification object
Datadog notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Hide attributes Show attributes

datadogApiKey string

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.

datadogRegion string

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.

Datadog regions

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailAddress string(email)

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:

specific MongoDB Cloud users ("notifications.[n].typeName" : "USER")

MongoDB Cloud users with specific project roles ("notifications.[n].typeName" : "GROUP")

MongoDB Cloud users with specific organization roles ("notifications.[n].typeName" : "ORG")

MongoDB Cloud teams ("notifications.[n].typeName" : "TEAM")

To send emails to one MongoDB Cloud user or grouping of users, set the notifications.[n].emailEnabled parameter.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailEnabled boolean

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"

intervalMin integer(int32)

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.

notifierId string

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})$.

roles array[string]

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.

Values are GROUP_BACKUP_MANAGER, GROUP_CLUSTER_MANAGER, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_ONLY, GROUP_DATA_ACCESS_READ_WRITE, GROUP_DATABASE_ACCESS_ADMIN, GROUP_OBSERVABILITY_VIEWER, GROUP_OWNER, GROUP_READ_ONLY, GROUP_SEARCH_INDEX_EDITOR, or GROUP_STREAM_PROCESSING_OWNER.

smsEnabled boolean

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"

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notificationToken string

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.

notifierId string

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})$.

roomName string

HipChat API room name to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "HIP_CHAT"".

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

microsoftTeamsWebhookUrl string

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.

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

opsGenieApiKey string

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.

opsGenieRegion string

Opsgenie region that indicates which API Uniform Resource Locator (URL) to use.

Values are US or EU. Default value is US.

typeName string Required

Human-readable label that displays the alert notification type.

Value is OPS_GENIE.
Org notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailEnabled boolean

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"

intervalMin integer(int32)

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.

notifierId string

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})$.

roles array[string]

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.

smsEnabled boolean

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"

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

region string

PagerDuty region that indicates which API Uniform Resource Locator (URL) to use.

Values are US or EU. Default value is US.

serviceKey string

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.

typeName string Required

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.
Hide attributes Show attributes

apiToken string

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.

channelName string

Name of the Slack channel to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SLACK".

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

intervalMin integer(int32)

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.

mobileNumber string

Mobile phone number to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SMS".

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailEnabled boolean

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"

intervalMin integer(int32)

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.

notifierId string

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})$.

smsEnabled boolean

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"

teamId string

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})$.

teamName string

Name of the MongoDB Cloud team that receives this notification. The resource requires this parameter when "notifications.[n].typeName" : "TEAM".

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailEnabled boolean

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"

intervalMin integer(int32)

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.

notifierId string

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})$.

smsEnabled boolean

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"

typeName string Required

Human-readable label that displays the alert notification type.

Value is USER.

username string(email)

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

Human-readable label that displays the alert notification type.

Value is VICTOR_OPS.

victorOpsApiKey string

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.

victorOpsRoutingKey string

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

Human-readable label that displays the alert notification type.

Value is WEBHOOK.

webhookSecret string(password)

Authentication secret for a webhook-based alert.

Atlas returns this value if you set "notifications.[n].typeName" :"WEBHOOK" and either:

You set notification.[n].webhookSecret to a non-empty string

You set a default webhookSecret either on the Integrations page, or with the Integrations API

NOTE: When you view or edit the alert for a webhook notification, the secret appears completely redacted.

Integrations page

webhookUrl string

Target URL for a webhook-based alert.

Atlas returns this value if you set "notifications.[n].typeName" :"WEBHOOK" and either:

You set notification.[n].webhookURL to a non-empty string

You set a default webhookUrl either on the Integrations page, or with the Integrations API

NOTE: When you view or edit the alert for a Webhook URL notification, the URL appears partially redacted.
severityOverride string

Severity of the event.

Values are INFO, WARNING, ERROR, or CRITICAL.

Billing threshold alert configuration allows to select thresholds for bills and invoices which trigger alerts and how users are notified.

enabled boolean

Flag that indicates whether someone enabled this alert configuration for the specified project.

Default value is false.
eventTypeName string Required

Event type that triggers an alert.

Values are PENDING_INVOICE_OVER_THRESHOLD or DAILY_BILL_OVER_THRESHOLD.
matchers array[object]

Matching conditions for target resources.

Rules to apply when comparing an target instance against this alert configuration.
Hide matchers attributes Show matchers attributes object
- fieldName string Required
  
  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.
- operator string Required
  
  Comparison operator to apply when checking the current metric value against matcher[n].value.
  
  Values are EQUALS, CONTAINS, STARTS_WITH, ENDS_WITH, NOT_EQUALS, NOT_CONTAINS, or REGEX.
- value string Required
  
  Value to match or exceed using the specified matchers.operator.
notifications array[object] Required

List that contains the targets that MongoDB Cloud sends notifications.

One target that MongoDB Cloud sends notifications when an alert triggers.
One target that MongoDB Cloud sends notifications when an alert triggers.
One of:
DatadogNotification object EmailNotification object GroupNotification object HipChatNotification object MicrosoftTeamsNotification object OpsGenieNotification object OrgNotification object PagerDutyNotification object SlackNotification object SMSNotification object TeamNotification object UserNotification object VictorOpsNotification object WebhookNotification object
Datadog notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Hide attributes Show attributes

datadogApiKey string

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.

datadogRegion string

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.

Datadog regions

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailAddress string(email)

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:

specific MongoDB Cloud users ("notifications.[n].typeName" : "USER")

MongoDB Cloud users with specific project roles ("notifications.[n].typeName" : "GROUP")

MongoDB Cloud users with specific organization roles ("notifications.[n].typeName" : "ORG")

MongoDB Cloud teams ("notifications.[n].typeName" : "TEAM")

To send emails to one MongoDB Cloud user or grouping of users, set the notifications.[n].emailEnabled parameter.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailEnabled boolean

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"

intervalMin integer(int32)

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.

notifierId string

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})$.

roles array[string]

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.

Values are GROUP_BACKUP_MANAGER, GROUP_CLUSTER_MANAGER, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_ONLY, GROUP_DATA_ACCESS_READ_WRITE, GROUP_DATABASE_ACCESS_ADMIN, GROUP_OBSERVABILITY_VIEWER, GROUP_OWNER, GROUP_READ_ONLY, GROUP_SEARCH_INDEX_EDITOR, or GROUP_STREAM_PROCESSING_OWNER.

smsEnabled boolean

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"

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notificationToken string

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.

notifierId string

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})$.

roomName string

HipChat API room name to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "HIP_CHAT"".

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

microsoftTeamsWebhookUrl string

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.

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

opsGenieApiKey string

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.

opsGenieRegion string

Opsgenie region that indicates which API Uniform Resource Locator (URL) to use.

Values are US or EU. Default value is US.

typeName string Required

Human-readable label that displays the alert notification type.

Value is OPS_GENIE.
Org notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailEnabled boolean

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"

intervalMin integer(int32)

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.

notifierId string

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})$.

roles array[string]

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.

smsEnabled boolean

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"

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

region string

PagerDuty region that indicates which API Uniform Resource Locator (URL) to use.

Values are US or EU. Default value is US.

serviceKey string

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.

typeName string Required

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.
Hide attributes Show attributes

apiToken string

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.

channelName string

Name of the Slack channel to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SLACK".

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

intervalMin integer(int32)

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.

mobileNumber string

Mobile phone number to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SMS".

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailEnabled boolean

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"

intervalMin integer(int32)

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.

notifierId string

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})$.

smsEnabled boolean

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"

teamId string

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})$.

teamName string

Name of the MongoDB Cloud team that receives this notification. The resource requires this parameter when "notifications.[n].typeName" : "TEAM".

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailEnabled boolean

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"

intervalMin integer(int32)

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.

notifierId string

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})$.

smsEnabled boolean

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"

typeName string Required

Human-readable label that displays the alert notification type.

Value is USER.

username string(email)

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

Human-readable label that displays the alert notification type.

Value is VICTOR_OPS.

victorOpsApiKey string

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.

victorOpsRoutingKey string

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

Human-readable label that displays the alert notification type.

Value is WEBHOOK.

webhookSecret string(password)

Authentication secret for a webhook-based alert.

Atlas returns this value if you set "notifications.[n].typeName" :"WEBHOOK" and either:

You set notification.[n].webhookSecret to a non-empty string

You set a default webhookSecret either on the Integrations page, or with the Integrations API

NOTE: When you view or edit the alert for a webhook notification, the secret appears completely redacted.

Integrations page

webhookUrl string

Target URL for a webhook-based alert.

Atlas returns this value if you set "notifications.[n].typeName" :"WEBHOOK" and either:

You set notification.[n].webhookURL to a non-empty string

You set a default webhookUrl either on the Integrations page, or with the Integrations API

NOTE: When you view or edit the alert for a Webhook URL notification, the URL appears partially redacted.
severityOverride string

Severity of the event.

Values are INFO, WARNING, ERROR, or CRITICAL.
threshold object

A Limit that triggers an alert when greater than a number.
Hide threshold attributes Show threshold attributes object
- operator string
  
  Comparison operator to apply when checking the current metric value.
  
  Value is GREATER_THAN.
- threshold integer(int32)
  
  Value of metric that, when exceeded, triggers an alert.
- units string
  
  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.

Cluster alert configuration allows to select which conditions of mongod cluster which trigger alerts and how users are notified.

enabled boolean

Flag that indicates whether someone enabled this alert configuration for the specified project.

Default value is false.
eventTypeName string Required

Event type that triggers an alert.

Value is CLUSTER_MONGOS_IS_MISSING.
matchers array[object]

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.
Hide matchers attributes Show matchers attributes object
- fieldName string Required
  
  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.
- operator string Required
  
  Comparison operator to apply when checking the current metric value against matcher[n].value.
  
  Values are EQUALS, CONTAINS, STARTS_WITH, ENDS_WITH, NOT_EQUALS, NOT_CONTAINS, or REGEX.
- value string Required
  
  Value to match or exceed using the specified matchers.operator.
notifications array[object] Required

List that contains the targets that MongoDB Cloud sends notifications.

One target that MongoDB Cloud sends notifications when an alert triggers.
One target that MongoDB Cloud sends notifications when an alert triggers.
One of:
DatadogNotification object EmailNotification object GroupNotification object HipChatNotification object MicrosoftTeamsNotification object OpsGenieNotification object OrgNotification object PagerDutyNotification object SlackNotification object SMSNotification object TeamNotification object UserNotification object VictorOpsNotification object WebhookNotification object
Datadog notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Hide attributes Show attributes

datadogApiKey string

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.

datadogRegion string

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.

Datadog regions

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailAddress string(email)

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:

specific MongoDB Cloud users ("notifications.[n].typeName" : "USER")

MongoDB Cloud users with specific project roles ("notifications.[n].typeName" : "GROUP")

MongoDB Cloud users with specific organization roles ("notifications.[n].typeName" : "ORG")

MongoDB Cloud teams ("notifications.[n].typeName" : "TEAM")

To send emails to one MongoDB Cloud user or grouping of users, set the notifications.[n].emailEnabled parameter.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailEnabled boolean

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"

intervalMin integer(int32)

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.

notifierId string

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})$.

roles array[string]

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.

Values are GROUP_BACKUP_MANAGER, GROUP_CLUSTER_MANAGER, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_ONLY, GROUP_DATA_ACCESS_READ_WRITE, GROUP_DATABASE_ACCESS_ADMIN, GROUP_OBSERVABILITY_VIEWER, GROUP_OWNER, GROUP_READ_ONLY, GROUP_SEARCH_INDEX_EDITOR, or GROUP_STREAM_PROCESSING_OWNER.

smsEnabled boolean

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"

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notificationToken string

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.

notifierId string

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})$.

roomName string

HipChat API room name to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "HIP_CHAT"".

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

microsoftTeamsWebhookUrl string

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.

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

opsGenieApiKey string

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.

opsGenieRegion string

Opsgenie region that indicates which API Uniform Resource Locator (URL) to use.

Values are US or EU. Default value is US.

typeName string Required

Human-readable label that displays the alert notification type.

Value is OPS_GENIE.
Org notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailEnabled boolean

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"

intervalMin integer(int32)

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.

notifierId string

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})$.

roles array[string]

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.

smsEnabled boolean

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"

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

region string

PagerDuty region that indicates which API Uniform Resource Locator (URL) to use.

Values are US or EU. Default value is US.

serviceKey string

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.

typeName string Required

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.
Hide attributes Show attributes

apiToken string

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.

channelName string

Name of the Slack channel to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SLACK".

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

intervalMin integer(int32)

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.

mobileNumber string

Mobile phone number to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SMS".

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailEnabled boolean

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"

intervalMin integer(int32)

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.

notifierId string

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})$.

smsEnabled boolean

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"

teamId string

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})$.

teamName string

Name of the MongoDB Cloud team that receives this notification. The resource requires this parameter when "notifications.[n].typeName" : "TEAM".

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailEnabled boolean

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"

intervalMin integer(int32)

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.

notifierId string

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})$.

smsEnabled boolean

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"

typeName string Required

Human-readable label that displays the alert notification type.

Value is USER.

username string(email)

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

Human-readable label that displays the alert notification type.

Value is VICTOR_OPS.

victorOpsApiKey string

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.

victorOpsRoutingKey string

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

Human-readable label that displays the alert notification type.

Value is WEBHOOK.

webhookSecret string(password)

Authentication secret for a webhook-based alert.

Atlas returns this value if you set "notifications.[n].typeName" :"WEBHOOK" and either:

You set notification.[n].webhookSecret to a non-empty string

You set a default webhookSecret either on the Integrations page, or with the Integrations API

NOTE: When you view or edit the alert for a webhook notification, the secret appears completely redacted.

Integrations page

webhookUrl string

Target URL for a webhook-based alert.

Atlas returns this value if you set "notifications.[n].typeName" :"WEBHOOK" and either:

You set notification.[n].webhookURL to a non-empty string

You set a default webhookUrl either on the Integrations page, or with the Integrations API

NOTE: When you view or edit the alert for a Webhook URL notification, the URL appears partially redacted.
severityOverride string

Severity of the event.

Values are INFO, WARNING, ERROR, or CRITICAL.

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.

enabled boolean

Flag that indicates whether someone enabled this alert configuration for the specified project.

Default value is false.
eventTypeName string Required

Event type that triggers an alert.

Values are CPS_SNAPSHOT_BEHIND, CPS_PREV_SNAPSHOT_OLD, or CPS_OPLOG_BEHIND.
matchers array[object]

Matching conditions for target resources.

Rules to apply when comparing an target instance against this alert configuration.
Hide matchers attributes Show matchers attributes object
- fieldName string Required
  
  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.
- operator string Required
  
  Comparison operator to apply when checking the current metric value against matcher[n].value.
  
  Values are EQUALS, CONTAINS, STARTS_WITH, ENDS_WITH, NOT_EQUALS, NOT_CONTAINS, or REGEX.
- value string Required
  
  Value to match or exceed using the specified matchers.operator.
notifications array[object] Required

List that contains the targets that MongoDB Cloud sends notifications.

One target that MongoDB Cloud sends notifications when an alert triggers.
One target that MongoDB Cloud sends notifications when an alert triggers.
One of:
DatadogNotification object EmailNotification object GroupNotification object HipChatNotification object MicrosoftTeamsNotification object OpsGenieNotification object OrgNotification object PagerDutyNotification object SlackNotification object SMSNotification object TeamNotification object UserNotification object VictorOpsNotification object WebhookNotification object
Datadog notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Hide attributes Show attributes

datadogApiKey string

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.

datadogRegion string

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.

Datadog regions

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailAddress string(email)

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:

specific MongoDB Cloud users ("notifications.[n].typeName" : "USER")

MongoDB Cloud users with specific project roles ("notifications.[n].typeName" : "GROUP")

MongoDB Cloud users with specific organization roles ("notifications.[n].typeName" : "ORG")

MongoDB Cloud teams ("notifications.[n].typeName" : "TEAM")

To send emails to one MongoDB Cloud user or grouping of users, set the notifications.[n].emailEnabled parameter.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailEnabled boolean

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"

intervalMin integer(int32)

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.

notifierId string

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})$.

roles array[string]

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.

Values are GROUP_BACKUP_MANAGER, GROUP_CLUSTER_MANAGER, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_ONLY, GROUP_DATA_ACCESS_READ_WRITE, GROUP_DATABASE_ACCESS_ADMIN, GROUP_OBSERVABILITY_VIEWER, GROUP_OWNER, GROUP_READ_ONLY, GROUP_SEARCH_INDEX_EDITOR, or GROUP_STREAM_PROCESSING_OWNER.

smsEnabled boolean

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"

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notificationToken string

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.

notifierId string

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})$.

roomName string

HipChat API room name to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "HIP_CHAT"".

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

microsoftTeamsWebhookUrl string

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.

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

opsGenieApiKey string

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.

opsGenieRegion string

Opsgenie region that indicates which API Uniform Resource Locator (URL) to use.

Values are US or EU. Default value is US.

typeName string Required

Human-readable label that displays the alert notification type.

Value is OPS_GENIE.
Org notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailEnabled boolean

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"

intervalMin integer(int32)

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.

notifierId string

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})$.

roles array[string]

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.

smsEnabled boolean

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"

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

region string

PagerDuty region that indicates which API Uniform Resource Locator (URL) to use.

Values are US or EU. Default value is US.

serviceKey string

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.

typeName string Required

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.
Hide attributes Show attributes

apiToken string

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.

channelName string

Name of the Slack channel to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SLACK".

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

intervalMin integer(int32)

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.

mobileNumber string

Mobile phone number to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SMS".

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailEnabled boolean

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"

intervalMin integer(int32)

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.

notifierId string

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})$.

smsEnabled boolean

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"

teamId string

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})$.

teamName string

Name of the MongoDB Cloud team that receives this notification. The resource requires this parameter when "notifications.[n].typeName" : "TEAM".

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailEnabled boolean

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"

intervalMin integer(int32)

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.

notifierId string

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})$.

smsEnabled boolean

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"

typeName string Required

Human-readable label that displays the alert notification type.

Value is USER.

username string(email)

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

Human-readable label that displays the alert notification type.

Value is VICTOR_OPS.

victorOpsApiKey string

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.

victorOpsRoutingKey string

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

Human-readable label that displays the alert notification type.

Value is WEBHOOK.

webhookSecret string(password)

Authentication secret for a webhook-based alert.

Atlas returns this value if you set "notifications.[n].typeName" :"WEBHOOK" and either:

You set notification.[n].webhookSecret to a non-empty string

You set a default webhookSecret either on the Integrations page, or with the Integrations API

NOTE: When you view or edit the alert for a webhook notification, the secret appears completely redacted.

Integrations page

webhookUrl string

Target URL for a webhook-based alert.

Atlas returns this value if you set "notifications.[n].typeName" :"WEBHOOK" and either:

You set notification.[n].webhookURL to a non-empty string

You set a default webhookUrl either on the Integrations page, or with the Integrations API

NOTE: When you view or edit the alert for a Webhook URL notification, the URL appears partially redacted.
severityOverride string

Severity of the event.

Values are INFO, WARNING, ERROR, or CRITICAL.
threshold object

A Limit that triggers an alert when greater than a time period.
Hide threshold attributes Show threshold attributes object
- operator string
  
  Comparison operator to apply when checking the current metric value.
  
  Value is GREATER_THAN.
- threshold integer(int32)
  
  Value of metric that, when exceeded, triggers an alert.
- units string
  
  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.

Encryption key alert configuration allows to select thresholds which trigger alerts and how users are notified.

enabled boolean

Flag that indicates whether someone enabled this alert configuration for the specified project.

Default value is false.
eventTypeName string Required

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.
matchers array[object]

Matching conditions for target resources.

Rules to apply when comparing an target instance against this alert configuration.
Hide matchers attributes Show matchers attributes object
- fieldName string Required
  
  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.
- operator string Required
  
  Comparison operator to apply when checking the current metric value against matcher[n].value.
  
  Values are EQUALS, CONTAINS, STARTS_WITH, ENDS_WITH, NOT_EQUALS, NOT_CONTAINS, or REGEX.
- value string Required
  
  Value to match or exceed using the specified matchers.operator.
notifications array[object] Required

List that contains the targets that MongoDB Cloud sends notifications.

One target that MongoDB Cloud sends notifications when an alert triggers.
One target that MongoDB Cloud sends notifications when an alert triggers.
One of:
DatadogNotification object EmailNotification object GroupNotification object HipChatNotification object MicrosoftTeamsNotification object OpsGenieNotification object OrgNotification object PagerDutyNotification object SlackNotification object SMSNotification object TeamNotification object UserNotification object VictorOpsNotification object WebhookNotification object
Datadog notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Hide attributes Show attributes

datadogApiKey string

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.

datadogRegion string

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.

Datadog regions

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailAddress string(email)

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:

specific MongoDB Cloud users ("notifications.[n].typeName" : "USER")

MongoDB Cloud users with specific project roles ("notifications.[n].typeName" : "GROUP")

MongoDB Cloud users with specific organization roles ("notifications.[n].typeName" : "ORG")

MongoDB Cloud teams ("notifications.[n].typeName" : "TEAM")

To send emails to one MongoDB Cloud user or grouping of users, set the notifications.[n].emailEnabled parameter.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailEnabled boolean

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"

intervalMin integer(int32)

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.

notifierId string

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})$.

roles array[string]

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.

Values are GROUP_BACKUP_MANAGER, GROUP_CLUSTER_MANAGER, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_ONLY, GROUP_DATA_ACCESS_READ_WRITE, GROUP_DATABASE_ACCESS_ADMIN, GROUP_OBSERVABILITY_VIEWER, GROUP_OWNER, GROUP_READ_ONLY, GROUP_SEARCH_INDEX_EDITOR, or GROUP_STREAM_PROCESSING_OWNER.

smsEnabled boolean

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"

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notificationToken string

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.

notifierId string

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})$.

roomName string

HipChat API room name to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "HIP_CHAT"".

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

microsoftTeamsWebhookUrl string

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.

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

opsGenieApiKey string

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.

opsGenieRegion string

Opsgenie region that indicates which API Uniform Resource Locator (URL) to use.

Values are US or EU. Default value is US.

typeName string Required

Human-readable label that displays the alert notification type.

Value is OPS_GENIE.
Org notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailEnabled boolean

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"

intervalMin integer(int32)

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.

notifierId string

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})$.

roles array[string]

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.

smsEnabled boolean

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"

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

region string

PagerDuty region that indicates which API Uniform Resource Locator (URL) to use.

Values are US or EU. Default value is US.

serviceKey string

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.

typeName string Required

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.
Hide attributes Show attributes

apiToken string

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.

channelName string

Name of the Slack channel to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SLACK".

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

intervalMin integer(int32)

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.

mobileNumber string

Mobile phone number to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SMS".

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailEnabled boolean

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"

intervalMin integer(int32)

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.

notifierId string

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})$.

smsEnabled boolean

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"

teamId string

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})$.

teamName string

Name of the MongoDB Cloud team that receives this notification. The resource requires this parameter when "notifications.[n].typeName" : "TEAM".

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailEnabled boolean

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"

intervalMin integer(int32)

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.

notifierId string

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})$.

smsEnabled boolean

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"

typeName string Required

Human-readable label that displays the alert notification type.

Value is USER.

username string(email)

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

Human-readable label that displays the alert notification type.

Value is VICTOR_OPS.

victorOpsApiKey string

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.

victorOpsRoutingKey string

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

Human-readable label that displays the alert notification type.

Value is WEBHOOK.

webhookSecret string(password)

Authentication secret for a webhook-based alert.

Atlas returns this value if you set "notifications.[n].typeName" :"WEBHOOK" and either:

You set notification.[n].webhookSecret to a non-empty string

You set a default webhookSecret either on the Integrations page, or with the Integrations API

NOTE: When you view or edit the alert for a webhook notification, the secret appears completely redacted.

Integrations page

webhookUrl string

Target URL for a webhook-based alert.

Atlas returns this value if you set "notifications.[n].typeName" :"WEBHOOK" and either:

You set notification.[n].webhookURL to a non-empty string

You set a default webhookUrl either on the Integrations page, or with the Integrations API

NOTE: When you view or edit the alert for a Webhook URL notification, the URL appears partially redacted.
severityOverride string

Severity of the event.

Values are INFO, WARNING, ERROR, or CRITICAL.
threshold object

Threshold value that triggers an alert.
Hide threshold attributes Show threshold attributes object
- operator string
  
  Comparison operator to apply when checking the current metric value.
  
  Value is GREATER_THAN.
- threshold integer(int32)
  
  Value of metric that, when exceeded, triggers an alert.
- units string
  
  Element used to express the quantity. This can be an element of time, storage capacity, and the like.
  
  Value is DAYS.

Host alert configuration allows to select which mongod host events trigger alerts and how users are notified.

enabled boolean

Flag that indicates whether someone enabled this alert configuration for the specified project.

Default value is false.
eventTypeName string Required

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_SEARCH_NODE_INDEX_FAILED, 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, or HOST_SECURITY_CHECKUP_NOT_MET.
matchers array[object]

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.
Hide matchers attributes Show matchers attributes object
- fieldName string Required
  
  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.
- operator string Required
  
  Comparison operator to apply when checking the current metric value against matcher[n].value.
  
  Values are EQUALS, CONTAINS, STARTS_WITH, ENDS_WITH, NOT_EQUALS, NOT_CONTAINS, or REGEX.
- value string
  
  Value to match or exceed using the specified matchers.operator.
  
  Values are STANDALONE, PRIMARY, SECONDARY, ARBITER, MONGOS, CONFIG, or MONGOT.
notifications array[object] Required

List that contains the targets that MongoDB Cloud sends notifications.

One target that MongoDB Cloud sends notifications when an alert triggers.
One target that MongoDB Cloud sends notifications when an alert triggers.
One of:
DatadogNotification object EmailNotification object GroupNotification object HipChatNotification object MicrosoftTeamsNotification object OpsGenieNotification object OrgNotification object PagerDutyNotification object SlackNotification object SMSNotification object TeamNotification object UserNotification object VictorOpsNotification object WebhookNotification object
Datadog notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Hide attributes Show attributes

datadogApiKey string

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.

datadogRegion string

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.

Datadog regions

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailAddress string(email)

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:

specific MongoDB Cloud users ("notifications.[n].typeName" : "USER")

MongoDB Cloud users with specific project roles ("notifications.[n].typeName" : "GROUP")

MongoDB Cloud users with specific organization roles ("notifications.[n].typeName" : "ORG")

MongoDB Cloud teams ("notifications.[n].typeName" : "TEAM")

To send emails to one MongoDB Cloud user or grouping of users, set the notifications.[n].emailEnabled parameter.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailEnabled boolean

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"

intervalMin integer(int32)

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.

notifierId string

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})$.

roles array[string]

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.

Values are GROUP_BACKUP_MANAGER, GROUP_CLUSTER_MANAGER, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_ONLY, GROUP_DATA_ACCESS_READ_WRITE, GROUP_DATABASE_ACCESS_ADMIN, GROUP_OBSERVABILITY_VIEWER, GROUP_OWNER, GROUP_READ_ONLY, GROUP_SEARCH_INDEX_EDITOR, or GROUP_STREAM_PROCESSING_OWNER.

smsEnabled boolean

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"

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notificationToken string

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.

notifierId string

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})$.

roomName string

HipChat API room name to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "HIP_CHAT"".

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

microsoftTeamsWebhookUrl string

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.

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

opsGenieApiKey string

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.

opsGenieRegion string

Opsgenie region that indicates which API Uniform Resource Locator (URL) to use.

Values are US or EU. Default value is US.

typeName string Required

Human-readable label that displays the alert notification type.

Value is OPS_GENIE.
Org notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailEnabled boolean

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"

intervalMin integer(int32)

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.

notifierId string

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})$.

roles array[string]

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.

smsEnabled boolean

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"

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

region string

PagerDuty region that indicates which API Uniform Resource Locator (URL) to use.

Values are US or EU. Default value is US.

serviceKey string

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.

typeName string Required

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.
Hide attributes Show attributes

apiToken string

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.

channelName string

Name of the Slack channel to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SLACK".

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

intervalMin integer(int32)

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.

mobileNumber string

Mobile phone number to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SMS".

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailEnabled boolean

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"

intervalMin integer(int32)

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.

notifierId string

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})$.

smsEnabled boolean

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"

teamId string

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})$.

teamName string

Name of the MongoDB Cloud team that receives this notification. The resource requires this parameter when "notifications.[n].typeName" : "TEAM".

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailEnabled boolean

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"

intervalMin integer(int32)

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.

notifierId string

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})$.

smsEnabled boolean

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"

typeName string Required

Human-readable label that displays the alert notification type.

Value is USER.

username string(email)

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

Human-readable label that displays the alert notification type.

Value is VICTOR_OPS.

victorOpsApiKey string

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.

victorOpsRoutingKey string

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

Human-readable label that displays the alert notification type.

Value is WEBHOOK.

webhookSecret string(password)

Authentication secret for a webhook-based alert.

Atlas returns this value if you set "notifications.[n].typeName" :"WEBHOOK" and either:

You set notification.[n].webhookSecret to a non-empty string

You set a default webhookSecret either on the Integrations page, or with the Integrations API

NOTE: When you view or edit the alert for a webhook notification, the secret appears completely redacted.

Integrations page

webhookUrl string

Target URL for a webhook-based alert.

Atlas returns this value if you set "notifications.[n].typeName" :"WEBHOOK" and either:

You set notification.[n].webhookURL to a non-empty string

You set a default webhookUrl either on the Integrations page, or with the Integrations API

NOTE: When you view or edit the alert for a Webhook URL notification, the URL appears partially redacted.
severityOverride string

Severity of the event.

Values are INFO, WARNING, ERROR, or CRITICAL.

Host metric alert configuration allows to select which mongod host metrics trigger alerts and how users are notified.

enabled boolean

Flag that indicates whether someone enabled this alert configuration for the specified project.

Default value is false.
eventTypeName string Required

Event type that triggers an alert.

Value is OUTSIDE_METRIC_THRESHOLD.
matchers array[object]

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.
Hide matchers attributes Show matchers attributes object
- fieldName string Required
  
  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.
- operator string Required
  
  Comparison operator to apply when checking the current metric value against matcher[n].value.
  
  Values are EQUALS, CONTAINS, STARTS_WITH, ENDS_WITH, NOT_EQUALS, NOT_CONTAINS, or REGEX.
- value string
  
  Value to match or exceed using the specified matchers.operator.
  
  Values are STANDALONE, PRIMARY, SECONDARY, ARBITER, MONGOS, CONFIG, or MONGOT.
metricThreshold object
One of:
ASSERT_REGULAR object ASSERT_WARNING object ASSERT_MSG object ASSERT_USER object OPCOUNTER_CMD object OPCOUNTER_QUERY object OPCOUNTER_UPDATE object OPCOUNTER_DELETE object OPCOUNTER_TTL_DELETED object OPCOUNTER_INSERT object OPCOUNTER_GETMORE object OPCOUNTER_REPL_CMD object OPCOUNTER_REPL_UPDATE object OPCOUNTER_REPL_DELETE object OPCOUNTER_REPL_INSERT object FTS_MEMORY_RESIDENT object FTS_MEMORY_VIRTUAL object FTS_MEMORY_MAPPED object FTS_PROCESS_CPU_USER object FTS_PROCESS_CPU_KERNEL object NORMALIZED_FTS_PROCESS_CPU_USER object NORMALIZED_FTS_PROCESS_CPU_KERNEL object SYSTEM_MEMORY_PERCENT_USED object MEMORY_RESIDENT object MEMORY_VIRTUAL object MEMORY_MAPPED object COMPUTED_MEMORY object INDEX_COUNTERS_BTREE_ACCESSES object INDEX_COUNTERS_BTREE_HITS object INDEX_COUNTERS_BTREE_MISSES object INDEX_COUNTERS_BTREE_MISS_RATIO object GLOBAL_LOCK_PERCENTAGE object BACKGROUND_FLUSH_AVG object CONNECTIONS object CONNECTIONS_MAX object CONNECTIONS_PERCENT object GLOBAL_ACCESSES_NOT_IN_MEMORY object GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN object GLOBAL_LOCK_CURRENT_QUEUE_TOTAL object GLOBAL_LOCK_CURRENT_QUEUE_READERS object GLOBAL_LOCK_CURRENT_QUEUE_WRITERS object CURSORS_TOTAL_OPEN object CURSORS_TOTAL_TIMED_OUT object CURSORS_TOTAL_CLIENT_CURSORS_SIZE object NETWORK_BYTES_IN object NETWORK_BYTES_OUT object NETWORK_NUM_REQUESTS object OPLOG_MASTER_TIME object OPLOG_MASTER_TIME_ESTIMATED_TTL object OPLOG_SLAVE_LAG_MASTER_TIME object OPLOG_MASTER_LAG_TIME_DIFF object OPLOG_RATE_GB_PER_HOUR object EXTRA_INFO_PAGE_FAULTS object DB_STORAGE_TOTAL object DB_DATA_SIZE_TOTAL object DB_DATA_SIZE_TOTAL_WO_SYSTEM object DB_INDEX_SIZE_TOTAL object JOURNALING_COMMITS_IN_WRITE_LOCK object JOURNALING_MB object JOURNALING_WRITE_DATA_FILES_MB object TICKETS_AVAILABLE_READS object TICKETS_AVAILABLE_WRITES object CACHE_USAGE_DIRTY object CACHE_USAGE_USED object CACHE_BYTES_READ_INTO object CACHE_BYTES_WRITTEN_FROM object NORMALIZED_SYSTEM_CPU_USER object NORMALIZED_SYSTEM_CPU_STEAL object DISK_PARTITION_SPACE_USED_DATA object DISK_PARTITION_SPACE_USED_INDEX object DISK_PARTITION_SPACE_USED_JOURNAL object DISK_PARTITION_READ_IOPS_DATA object DISK_PARTITION_READ_IOPS_INDEX object DISK_PARTITION_READ_IOPS_JOURNAL object DISK_PARTITION_WRITE_IOPS_DATA object DISK_PARTITION_WRITE_IOPS_INDEX object DISK_PARTITION_WRITE_IOPS_JOURNAL object DISK_PARTITION_READ_LATENCY_DATA object DISK_PARTITION_READ_LATENCY_INDEX object DISK_PARTITION_READ_LATENCY_JOURNAL object DISK_PARTITION_WRITE_LATENCY_DATA object DISK_PARTITION_WRITE_LATENCY_INDEX object DISK_PARTITION_WRITE_LATENCY_JOURNAL object DISK_PARTITION_QUEUE_DEPTH_DATA object DISK_PARTITION_QUEUE_DEPTH_INDEX object DISK_PARTITION_QUEUE_DEPTH_JOURNAL object FTS_DISK_UTILIZATION object MUNIN_CPU_USER object MUNIN_CPU_NICE object MUNIN_CPU_SYSTEM object MUNIN_CPU_IOWAIT object MUNIN_CPU_IRQ object MUNIN_CPU_SOFTIRQ object MUNIN_CPU_STEAL object DOCUMENT_RETURNED object DOCUMENT_INSERTED object DOCUMENT_UPDATED object DOCUMENT_DELETED object OPERATIONS_SCAN_AND_ORDER object QUERY_EXECUTOR_SCANNED object QUERY_EXECUTOR_SCANNED_OBJECTS object OPERATION_THROTTLING_REJECTED_OPERATIONS object QUERY_SPILL_TO_DISK_DURING_SORT object OPERATIONS_QUERIES_KILLED object QUERY_TARGETING_SCANNED_PER_RETURNED object QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED object AVG_READ_EXECUTION_TIME object AVG_WRITE_EXECUTION_TIME object AVG_COMMAND_EXECUTION_TIME object LOGICAL_SIZE object RESTARTS_IN_LAST_HOUR object SYSTEM_MEMORY_USED object SYSTEM_MEMORY_AVAILABLE object SWAP_USAGE_USED object SWAP_USAGE_FREE object SYSTEM_NETWORK_IN object SYSTEM_NETWORK_OUT object MAX_NORMALIZED_SYSTEM_CPU_USER object MAX_NORMALIZED_SYSTEM_CPU_STEAL object MAX_DISK_PARTITION_SPACE_USED_DATA object MAX_DISK_PARTITION_SPACE_USED_INDEX object MAX_DISK_PARTITION_SPACE_USED_JOURNAL object MAX_DISK_PARTITION_READ_IOPS_DATA object MAX_DISK_PARTITION_READ_IOPS_INDEX object MAX_DISK_PARTITION_READ_IOPS_JOURNAL object MAX_DISK_PARTITION_WRITE_IOPS_DATA object MAX_DISK_PARTITION_WRITE_IOPS_INDEX object MAX_DISK_PARTITION_WRITE_IOPS_JOURNAL object MAX_DISK_PARTITION_READ_LATENCY_DATA object MAX_DISK_PARTITION_READ_LATENCY_INDEX object MAX_DISK_PARTITION_READ_LATENCY_JOURNAL object MAX_DISK_PARTITION_WRITE_LATENCY_DATA object MAX_DISK_PARTITION_WRITE_LATENCY_INDEX object MAX_DISK_PARTITION_WRITE_LATENCY_JOURNAL object MAX_DISK_PARTITION_QUEUE_DEPTH_DATA object MAX_DISK_PARTITION_QUEUE_DEPTH_INDEX object MAX_DISK_PARTITION_QUEUE_DEPTH_JOURNAL object MAX_SYSTEM_MEMORY_PERCENT_USED object MAX_SYSTEM_MEMORY_USED object MAX_SYSTEM_MEMORY_AVAILABLE object MAX_SWAP_USAGE_USED object MAX_SWAP_USAGE_FREE object MAX_SYSTEM_NETWORK_IN object MAX_SYSTEM_NETWORK_OUT object SEARCH_INDEX_SIZE object SEARCH_NUMBER_OF_FIELDS_IN_INDEX object SEARCH_REPLICATION_LAG object SEARCH_MAX_NUMBER_OF_LUCENE_DOCS object SEARCH_OPCOUNTER_INSERT object SEARCH_OPCOUNTER_DELETE object SEARCH_OPCOUNTER_UPDATE object SEARCH_OPCOUNTER_GETMORE object SEARCH_NUMBER_OF_QUERIES_TOTAL object SEARCH_NUMBER_OF_QUERIES_ERROR object SEARCH_NUMBER_OF_QUERIES_SUCCESS object FTS_JVM_MAX_MEMORY object FTS_JVM_CURRENT_MEMORY object
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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is ASSERT_REGULAR.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is ASSERT_WARNING.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is ASSERT_MSG.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is ASSERT_USER.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is OPCOUNTER_CMD.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is OPCOUNTER_QUERY.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is OPCOUNTER_UPDATE.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is OPCOUNTER_DELETE.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is OPCOUNTER_TTL_DELETED.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is OPCOUNTER_INSERT.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is OPCOUNTER_GETMORE.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is OPCOUNTER_REPL_CMD.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is OPCOUNTER_REPL_UPDATE.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is OPCOUNTER_REPL_DELETE.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is OPCOUNTER_REPL_INSERT.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is FTS_MEMORY_RESIDENT.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is FTS_MEMORY_VIRTUAL.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is FTS_MEMORY_MAPPED.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is FTS_PROCESS_CPU_USER.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is FTS_PROCESS_CPU_KERNEL.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is NORMALIZED_FTS_PROCESS_CPU_USER.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is NORMALIZED_FTS_PROCESS_CPU_KERNEL.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is SYSTEM_MEMORY_PERCENT_USED.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is MEMORY_RESIDENT.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is MEMORY_VIRTUAL.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is MEMORY_MAPPED.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is COMPUTED_MEMORY.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is INDEX_COUNTERS_BTREE_ACCESSES.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is INDEX_COUNTERS_BTREE_HITS.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is INDEX_COUNTERS_BTREE_MISSES.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is INDEX_COUNTERS_BTREE_MISS_RATIO.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is GLOBAL_LOCK_PERCENTAGE.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is BACKGROUND_FLUSH_AVG.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is CONNECTIONS.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is CONNECTIONS_MAX.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is CONNECTIONS_PERCENT.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is GLOBAL_ACCESSES_NOT_IN_MEMORY.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is GLOBAL_LOCK_CURRENT_QUEUE_TOTAL.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is GLOBAL_LOCK_CURRENT_QUEUE_READERS.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is GLOBAL_LOCK_CURRENT_QUEUE_WRITERS.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is CURSORS_TOTAL_OPEN.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is CURSORS_TOTAL_TIMED_OUT.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is CURSORS_TOTAL_CLIENT_CURSORS_SIZE.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is NETWORK_BYTES_IN.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is NETWORK_BYTES_OUT.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is NETWORK_NUM_REQUESTS.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is OPLOG_MASTER_TIME.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is OPLOG_MASTER_TIME_ESTIMATED_TTL.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is OPLOG_SLAVE_LAG_MASTER_TIME.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is OPLOG_MASTER_LAG_TIME_DIFF.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is OPLOG_RATE_GB_PER_HOUR.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is EXTRA_INFO_PAGE_FAULTS.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is DB_STORAGE_TOTAL.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is DB_DATA_SIZE_TOTAL.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is DB_DATA_SIZE_TOTAL_WO_SYSTEM.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is DB_INDEX_SIZE_TOTAL.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is JOURNALING_COMMITS_IN_WRITE_LOCK.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is JOURNALING_MB.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is JOURNALING_WRITE_DATA_FILES_MB.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is TICKETS_AVAILABLE_READS.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is TICKETS_AVAILABLE_WRITES.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is CACHE_USAGE_DIRTY.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is CACHE_USAGE_USED.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is CACHE_BYTES_READ_INTO.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is CACHE_BYTES_WRITTEN_FROM.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is NORMALIZED_SYSTEM_CPU_USER.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is NORMALIZED_SYSTEM_CPU_STEAL.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is DISK_PARTITION_SPACE_USED_DATA.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is DISK_PARTITION_SPACE_USED_INDEX.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is DISK_PARTITION_SPACE_USED_JOURNAL.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is DISK_PARTITION_READ_IOPS_DATA.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is DISK_PARTITION_READ_IOPS_INDEX.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is DISK_PARTITION_READ_IOPS_JOURNAL.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is DISK_PARTITION_WRITE_IOPS_DATA.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is DISK_PARTITION_WRITE_IOPS_INDEX.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is DISK_PARTITION_WRITE_IOPS_JOURNAL.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is DISK_PARTITION_READ_LATENCY_DATA.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is DISK_PARTITION_READ_LATENCY_INDEX.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is DISK_PARTITION_READ_LATENCY_JOURNAL.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is DISK_PARTITION_WRITE_LATENCY_DATA.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is DISK_PARTITION_WRITE_LATENCY_INDEX.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is DISK_PARTITION_WRITE_LATENCY_JOURNAL.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is DISK_PARTITION_QUEUE_DEPTH_DATA.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is DISK_PARTITION_QUEUE_DEPTH_INDEX.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is DISK_PARTITION_QUEUE_DEPTH_JOURNAL.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is FTS_DISK_UTILIZATION.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is MUNIN_CPU_USER.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is MUNIN_CPU_NICE.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is MUNIN_CPU_SYSTEM.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is MUNIN_CPU_IOWAIT.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is MUNIN_CPU_IRQ.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is MUNIN_CPU_SOFTIRQ.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is MUNIN_CPU_STEAL.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is DOCUMENT_RETURNED.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is DOCUMENT_INSERTED.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is DOCUMENT_UPDATED.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is DOCUMENT_DELETED.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is OPERATIONS_SCAN_AND_ORDER.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is QUERY_EXECUTOR_SCANNED.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is QUERY_EXECUTOR_SCANNED_OBJECTS.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is OPERATION_THROTTLING_REJECTED_OPERATIONS.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is QUERY_SPILL_TO_DISK_DURING_SORT.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is OPERATIONS_QUERIES_KILLED.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is QUERY_TARGETING_SCANNED_PER_RETURNED.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is AVG_READ_EXECUTION_TIME.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is AVG_WRITE_EXECUTION_TIME.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is AVG_COMMAND_EXECUTION_TIME.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is LOGICAL_SIZE.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is RESTARTS_IN_LAST_HOUR.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is SYSTEM_MEMORY_USED.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is SYSTEM_MEMORY_AVAILABLE.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is SWAP_USAGE_USED.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is SWAP_USAGE_FREE.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is SYSTEM_NETWORK_IN.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is SYSTEM_NETWORK_OUT.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is MAX_NORMALIZED_SYSTEM_CPU_USER.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is MAX_NORMALIZED_SYSTEM_CPU_STEAL.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is MAX_DISK_PARTITION_SPACE_USED_DATA.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is MAX_DISK_PARTITION_SPACE_USED_INDEX.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is MAX_DISK_PARTITION_SPACE_USED_JOURNAL.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is MAX_DISK_PARTITION_READ_IOPS_DATA.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is MAX_DISK_PARTITION_READ_IOPS_INDEX.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is MAX_DISK_PARTITION_READ_IOPS_JOURNAL.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is MAX_DISK_PARTITION_WRITE_IOPS_DATA.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is MAX_DISK_PARTITION_WRITE_IOPS_INDEX.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is MAX_DISK_PARTITION_WRITE_IOPS_JOURNAL.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is MAX_DISK_PARTITION_READ_LATENCY_DATA.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is MAX_DISK_PARTITION_READ_LATENCY_INDEX.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is MAX_DISK_PARTITION_READ_LATENCY_JOURNAL.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is MAX_DISK_PARTITION_WRITE_LATENCY_DATA.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is MAX_DISK_PARTITION_WRITE_LATENCY_INDEX.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is MAX_DISK_PARTITION_WRITE_LATENCY_JOURNAL.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is MAX_DISK_PARTITION_QUEUE_DEPTH_DATA.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is MAX_DISK_PARTITION_QUEUE_DEPTH_INDEX.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is MAX_DISK_PARTITION_QUEUE_DEPTH_JOURNAL.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is MAX_SYSTEM_MEMORY_PERCENT_USED.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is MAX_SYSTEM_MEMORY_USED.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is MAX_SYSTEM_MEMORY_AVAILABLE.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is MAX_SWAP_USAGE_USED.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is MAX_SWAP_USAGE_FREE.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is MAX_SYSTEM_NETWORK_IN.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is MAX_SYSTEM_NETWORK_OUT.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is SEARCH_INDEX_SIZE.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is SEARCH_NUMBER_OF_FIELDS_IN_INDEX.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is SEARCH_REPLICATION_LAG.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is SEARCH_MAX_NUMBER_OF_LUCENE_DOCS.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is SEARCH_OPCOUNTER_INSERT.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is SEARCH_OPCOUNTER_DELETE.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is SEARCH_OPCOUNTER_UPDATE.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is SEARCH_OPCOUNTER_GETMORE.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is SEARCH_NUMBER_OF_QUERIES_TOTAL.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is SEARCH_NUMBER_OF_QUERIES_ERROR.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is SEARCH_NUMBER_OF_QUERIES_SUCCESS.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is FTS_JVM_MAX_MEMORY.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is FTS_JVM_CURRENT_MEMORY.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

Element used to express the quantity. This can be an element of time, storage capacity, and the like.
notifications array[object] Required

List that contains the targets that MongoDB Cloud sends notifications.

One target that MongoDB Cloud sends notifications when an alert triggers.
One target that MongoDB Cloud sends notifications when an alert triggers.
One of:
DatadogNotification object EmailNotification object GroupNotification object HipChatNotification object MicrosoftTeamsNotification object OpsGenieNotification object OrgNotification object PagerDutyNotification object SlackNotification object SMSNotification object TeamNotification object UserNotification object VictorOpsNotification object WebhookNotification object
Datadog notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Hide attributes Show attributes

datadogApiKey string

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.

datadogRegion string

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.

Datadog regions

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailAddress string(email)

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:

specific MongoDB Cloud users ("notifications.[n].typeName" : "USER")

MongoDB Cloud users with specific project roles ("notifications.[n].typeName" : "GROUP")

MongoDB Cloud users with specific organization roles ("notifications.[n].typeName" : "ORG")

MongoDB Cloud teams ("notifications.[n].typeName" : "TEAM")

To send emails to one MongoDB Cloud user or grouping of users, set the notifications.[n].emailEnabled parameter.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailEnabled boolean

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"

intervalMin integer(int32)

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.

notifierId string

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})$.

roles array[string]

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.

Values are GROUP_BACKUP_MANAGER, GROUP_CLUSTER_MANAGER, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_ONLY, GROUP_DATA_ACCESS_READ_WRITE, GROUP_DATABASE_ACCESS_ADMIN, GROUP_OBSERVABILITY_VIEWER, GROUP_OWNER, GROUP_READ_ONLY, GROUP_SEARCH_INDEX_EDITOR, or GROUP_STREAM_PROCESSING_OWNER.

smsEnabled boolean

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"

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notificationToken string

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.

notifierId string

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})$.

roomName string

HipChat API room name to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "HIP_CHAT"".

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

microsoftTeamsWebhookUrl string

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.

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

opsGenieApiKey string

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.

opsGenieRegion string

Opsgenie region that indicates which API Uniform Resource Locator (URL) to use.

Values are US or EU. Default value is US.

typeName string Required

Human-readable label that displays the alert notification type.

Value is OPS_GENIE.
Org notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailEnabled boolean

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"

intervalMin integer(int32)

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.

notifierId string

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})$.

roles array[string]

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.

smsEnabled boolean

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"

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

region string

PagerDuty region that indicates which API Uniform Resource Locator (URL) to use.

Values are US or EU. Default value is US.

serviceKey string

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.

typeName string Required

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.
Hide attributes Show attributes

apiToken string

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.

channelName string

Name of the Slack channel to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SLACK".

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

intervalMin integer(int32)

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.

mobileNumber string

Mobile phone number to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SMS".

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailEnabled boolean

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"

intervalMin integer(int32)

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.

notifierId string

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})$.

smsEnabled boolean

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"

teamId string

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})$.

teamName string

Name of the MongoDB Cloud team that receives this notification. The resource requires this parameter when "notifications.[n].typeName" : "TEAM".

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailEnabled boolean

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"

intervalMin integer(int32)

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.

notifierId string

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})$.

smsEnabled boolean

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"

typeName string Required

Human-readable label that displays the alert notification type.

Value is USER.

username string(email)

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

Human-readable label that displays the alert notification type.

Value is VICTOR_OPS.

victorOpsApiKey string

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.

victorOpsRoutingKey string

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

Human-readable label that displays the alert notification type.

Value is WEBHOOK.

webhookSecret string(password)

Authentication secret for a webhook-based alert.

Atlas returns this value if you set "notifications.[n].typeName" :"WEBHOOK" and either:

You set notification.[n].webhookSecret to a non-empty string

You set a default webhookSecret either on the Integrations page, or with the Integrations API

NOTE: When you view or edit the alert for a webhook notification, the secret appears completely redacted.

Integrations page

webhookUrl string

Target URL for a webhook-based alert.

Atlas returns this value if you set "notifications.[n].typeName" :"WEBHOOK" and either:

You set notification.[n].webhookURL to a non-empty string

You set a default webhookUrl either on the Integrations page, or with the Integrations API

NOTE: When you view or edit the alert for a Webhook URL notification, the URL appears partially redacted.
severityOverride string

Severity of the event.

Values are INFO, WARNING, ERROR, or CRITICAL.

NDS 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.

enabled boolean

Flag that indicates whether someone enabled this alert configuration for the specified project.

Default value is false.
eventTypeName string Required

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.
matchers array[object]

Matching conditions for target resources.

Rules to apply when comparing an target instance against this alert configuration.
Hide matchers attributes Show matchers attributes object
- fieldName string Required
  
  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.
- operator string Required
  
  Comparison operator to apply when checking the current metric value against matcher[n].value.
  
  Values are EQUALS, CONTAINS, STARTS_WITH, ENDS_WITH, NOT_EQUALS, NOT_CONTAINS, or REGEX.
- value string Required
  
  Value to match or exceed using the specified matchers.operator.
notifications array[object] Required

List that contains the targets that MongoDB Cloud sends notifications.

One target that MongoDB Cloud sends notifications when an alert triggers.
One target that MongoDB Cloud sends notifications when an alert triggers.
One of:
DatadogNotification object EmailNotification object GroupNotification object HipChatNotification object MicrosoftTeamsNotification object OpsGenieNotification object OrgNotification object PagerDutyNotification object SlackNotification object SMSNotification object TeamNotification object UserNotification object VictorOpsNotification object WebhookNotification object
Datadog notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Hide attributes Show attributes

datadogApiKey string

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.

datadogRegion string

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.

Datadog regions

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailAddress string(email)

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:

specific MongoDB Cloud users ("notifications.[n].typeName" : "USER")

MongoDB Cloud users with specific project roles ("notifications.[n].typeName" : "GROUP")

MongoDB Cloud users with specific organization roles ("notifications.[n].typeName" : "ORG")

MongoDB Cloud teams ("notifications.[n].typeName" : "TEAM")

To send emails to one MongoDB Cloud user or grouping of users, set the notifications.[n].emailEnabled parameter.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailEnabled boolean

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"

intervalMin integer(int32)

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.

notifierId string

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})$.

roles array[string]

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.

Values are GROUP_BACKUP_MANAGER, GROUP_CLUSTER_MANAGER, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_ONLY, GROUP_DATA_ACCESS_READ_WRITE, GROUP_DATABASE_ACCESS_ADMIN, GROUP_OBSERVABILITY_VIEWER, GROUP_OWNER, GROUP_READ_ONLY, GROUP_SEARCH_INDEX_EDITOR, or GROUP_STREAM_PROCESSING_OWNER.

smsEnabled boolean

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"

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notificationToken string

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.

notifierId string

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})$.

roomName string

HipChat API room name to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "HIP_CHAT"".

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

microsoftTeamsWebhookUrl string

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.

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

opsGenieApiKey string

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.

opsGenieRegion string

Opsgenie region that indicates which API Uniform Resource Locator (URL) to use.

Values are US or EU. Default value is US.

typeName string Required

Human-readable label that displays the alert notification type.

Value is OPS_GENIE.
Org notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailEnabled boolean

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"

intervalMin integer(int32)

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.

notifierId string

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})$.

roles array[string]

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.

smsEnabled boolean

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"

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

region string

PagerDuty region that indicates which API Uniform Resource Locator (URL) to use.

Values are US or EU. Default value is US.

serviceKey string

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.

typeName string Required

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.
Hide attributes Show attributes

apiToken string

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.

channelName string

Name of the Slack channel to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SLACK".

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

intervalMin integer(int32)

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.

mobileNumber string

Mobile phone number to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SMS".

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailEnabled boolean

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"

intervalMin integer(int32)

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.

notifierId string

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})$.

smsEnabled boolean

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"

teamId string

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})$.

teamName string

Name of the MongoDB Cloud team that receives this notification. The resource requires this parameter when "notifications.[n].typeName" : "TEAM".

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailEnabled boolean

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"

intervalMin integer(int32)

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.

notifierId string

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})$.

smsEnabled boolean

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"

typeName string Required

Human-readable label that displays the alert notification type.

Value is USER.

username string(email)

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

Human-readable label that displays the alert notification type.

Value is VICTOR_OPS.

victorOpsApiKey string

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.

victorOpsRoutingKey string

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

Human-readable label that displays the alert notification type.

Value is WEBHOOK.

webhookSecret string(password)

Authentication secret for a webhook-based alert.

Atlas returns this value if you set "notifications.[n].typeName" :"WEBHOOK" and either:

You set notification.[n].webhookSecret to a non-empty string

You set a default webhookSecret either on the Integrations page, or with the Integrations API

NOTE: When you view or edit the alert for a webhook notification, the secret appears completely redacted.

Integrations page

webhookUrl string

Target URL for a webhook-based alert.

Atlas returns this value if you set "notifications.[n].typeName" :"WEBHOOK" and either:

You set notification.[n].webhookURL to a non-empty string

You set a default webhookUrl either on the Integrations page, or with the Integrations API

NOTE: When you view or edit the alert for a Webhook URL notification, the URL appears partially redacted.
severityOverride string

Severity of the event.

Values are INFO, WARNING, ERROR, or CRITICAL.
threshold object

Threshold value that triggers an alert.
Hide threshold attributes Show threshold attributes object
- operator string
  
  Comparison operator to apply when checking the current metric value.
  
  Value is LESS_THAN.
- threshold integer(int32)
  
  Value of metric that, when exceeded, triggers an alert.
- units string
  
  Element used to express the quantity. This can be an element of time, storage capacity, and the like.
  
  Value is DAYS.

Replica Set alert configuration allows to select which conditions of mongod replica set trigger alerts and how users are notified.

enabled boolean

Flag that indicates whether someone enabled this alert configuration for the specified project.

Default value is false.
eventTypeName string Required

Event type that triggers an alert.

Values are NO_PRIMARY or PRIMARY_ELECTED.
matchers array[object]

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.
Hide matchers attributes Show matchers attributes object
- fieldName string Required
  
  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.
- operator string Required
  
  Comparison operator to apply when checking the current metric value against matcher[n].value.
  
  Values are EQUALS, CONTAINS, STARTS_WITH, ENDS_WITH, NOT_EQUALS, NOT_CONTAINS, or REGEX.
- value string Required
  
  Value to match or exceed using the specified matchers.operator.
notifications array[object] Required

List that contains the targets that MongoDB Cloud sends notifications.

One target that MongoDB Cloud sends notifications when an alert triggers.
One target that MongoDB Cloud sends notifications when an alert triggers.
One of:
DatadogNotification object EmailNotification object GroupNotification object HipChatNotification object MicrosoftTeamsNotification object OpsGenieNotification object OrgNotification object PagerDutyNotification object SlackNotification object SMSNotification object TeamNotification object UserNotification object VictorOpsNotification object WebhookNotification object
Datadog notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Hide attributes Show attributes

datadogApiKey string

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.

datadogRegion string

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.

Datadog regions

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailAddress string(email)

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:

specific MongoDB Cloud users ("notifications.[n].typeName" : "USER")

MongoDB Cloud users with specific project roles ("notifications.[n].typeName" : "GROUP")

MongoDB Cloud users with specific organization roles ("notifications.[n].typeName" : "ORG")

MongoDB Cloud teams ("notifications.[n].typeName" : "TEAM")

To send emails to one MongoDB Cloud user or grouping of users, set the notifications.[n].emailEnabled parameter.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailEnabled boolean

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"

intervalMin integer(int32)

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.

notifierId string

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})$.

roles array[string]

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.

Values are GROUP_BACKUP_MANAGER, GROUP_CLUSTER_MANAGER, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_ONLY, GROUP_DATA_ACCESS_READ_WRITE, GROUP_DATABASE_ACCESS_ADMIN, GROUP_OBSERVABILITY_VIEWER, GROUP_OWNER, GROUP_READ_ONLY, GROUP_SEARCH_INDEX_EDITOR, or GROUP_STREAM_PROCESSING_OWNER.

smsEnabled boolean

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"

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notificationToken string

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.

notifierId string

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})$.

roomName string

HipChat API room name to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "HIP_CHAT"".

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

microsoftTeamsWebhookUrl string

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.

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

opsGenieApiKey string

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.

opsGenieRegion string

Opsgenie region that indicates which API Uniform Resource Locator (URL) to use.

Values are US or EU. Default value is US.

typeName string Required

Human-readable label that displays the alert notification type.

Value is OPS_GENIE.
Org notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailEnabled boolean

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"

intervalMin integer(int32)

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.

notifierId string

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})$.

roles array[string]

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.

smsEnabled boolean

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"

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

region string

PagerDuty region that indicates which API Uniform Resource Locator (URL) to use.

Values are US or EU. Default value is US.

serviceKey string

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.

typeName string Required

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.
Hide attributes Show attributes

apiToken string

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.

channelName string

Name of the Slack channel to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SLACK".

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

intervalMin integer(int32)

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.

mobileNumber string

Mobile phone number to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SMS".

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailEnabled boolean

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"

intervalMin integer(int32)

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.

notifierId string

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})$.

smsEnabled boolean

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"

teamId string

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})$.

teamName string

Name of the MongoDB Cloud team that receives this notification. The resource requires this parameter when "notifications.[n].typeName" : "TEAM".

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailEnabled boolean

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"

intervalMin integer(int32)

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.

notifierId string

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})$.

smsEnabled boolean

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"

typeName string Required

Human-readable label that displays the alert notification type.

Value is USER.

username string(email)

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

Human-readable label that displays the alert notification type.

Value is VICTOR_OPS.

victorOpsApiKey string

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.

victorOpsRoutingKey string

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

Human-readable label that displays the alert notification type.

Value is WEBHOOK.

webhookSecret string(password)

Authentication secret for a webhook-based alert.

Atlas returns this value if you set "notifications.[n].typeName" :"WEBHOOK" and either:

You set notification.[n].webhookSecret to a non-empty string

You set a default webhookSecret either on the Integrations page, or with the Integrations API

NOTE: When you view or edit the alert for a webhook notification, the secret appears completely redacted.

Integrations page

webhookUrl string

Target URL for a webhook-based alert.

Atlas returns this value if you set "notifications.[n].typeName" :"WEBHOOK" and either:

You set notification.[n].webhookURL to a non-empty string

You set a default webhookUrl either on the Integrations page, or with the Integrations API

NOTE: When you view or edit the alert for a Webhook URL notification, the URL appears partially redacted.
severityOverride string

Severity of the event.

Values are INFO, WARNING, ERROR, or CRITICAL.
threshold object

A Limit that triggers an alert when exceeded. The resource returns this parameter when eventTypeName has not been set to OUTSIDE_METRIC_THRESHOLD.
Hide threshold attributes Show threshold attributes object
- operator string
  
  Comparison operator to apply when checking the current metric value.
  
  Values are < or >.
- threshold integer(int32)
  
  Value of metric that, when exceeded, triggers an alert.
- units string
  
  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, pixels, GB seconds, GB hours, GB days, RPU, thousand RPU, million RPU, WPU, thousand WPU, million WPU, count, thousand, million, or billion.

Replica Set threshold alert configuration allows to select thresholds for conditions of mongod replica set which trigger alerts and how users are notified.

enabled boolean

Flag that indicates whether someone enabled this alert configuration for the specified project.

Default value is false.
eventTypeName string Required Discriminator

Event type that triggers an alert.
matchers array[object]

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.
Hide matchers attributes Show matchers attributes object
- fieldName string Required
  
  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.
- operator string Required
  
  Comparison operator to apply when checking the current metric value against matcher[n].value.
  
  Values are EQUALS, CONTAINS, STARTS_WITH, ENDS_WITH, NOT_EQUALS, NOT_CONTAINS, or REGEX.
- value string Required
  
  Value to match or exceed using the specified matchers.operator.
notifications array[object] Required

List that contains the targets that MongoDB Cloud sends notifications.

One target that MongoDB Cloud sends notifications when an alert triggers.
One target that MongoDB Cloud sends notifications when an alert triggers.
One of:
DatadogNotification object EmailNotification object GroupNotification object HipChatNotification object MicrosoftTeamsNotification object OpsGenieNotification object OrgNotification object PagerDutyNotification object SlackNotification object SMSNotification object TeamNotification object UserNotification object VictorOpsNotification object WebhookNotification object
Datadog notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Hide attributes Show attributes

datadogApiKey string

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.

datadogRegion string

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.

Datadog regions

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailAddress string(email)

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:

specific MongoDB Cloud users ("notifications.[n].typeName" : "USER")

MongoDB Cloud users with specific project roles ("notifications.[n].typeName" : "GROUP")

MongoDB Cloud users with specific organization roles ("notifications.[n].typeName" : "ORG")

MongoDB Cloud teams ("notifications.[n].typeName" : "TEAM")

To send emails to one MongoDB Cloud user or grouping of users, set the notifications.[n].emailEnabled parameter.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailEnabled boolean

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"

intervalMin integer(int32)

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.

notifierId string

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})$.

roles array[string]

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.

Values are GROUP_BACKUP_MANAGER, GROUP_CLUSTER_MANAGER, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_ONLY, GROUP_DATA_ACCESS_READ_WRITE, GROUP_DATABASE_ACCESS_ADMIN, GROUP_OBSERVABILITY_VIEWER, GROUP_OWNER, GROUP_READ_ONLY, GROUP_SEARCH_INDEX_EDITOR, or GROUP_STREAM_PROCESSING_OWNER.

smsEnabled boolean

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"

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notificationToken string

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.

notifierId string

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})$.

roomName string

HipChat API room name to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "HIP_CHAT"".

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

microsoftTeamsWebhookUrl string

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.

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

opsGenieApiKey string

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.

opsGenieRegion string

Opsgenie region that indicates which API Uniform Resource Locator (URL) to use.

Values are US or EU. Default value is US.

typeName string Required

Human-readable label that displays the alert notification type.

Value is OPS_GENIE.
Org notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailEnabled boolean

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"

intervalMin integer(int32)

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.

notifierId string

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})$.

roles array[string]

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.

smsEnabled boolean

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"

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

region string

PagerDuty region that indicates which API Uniform Resource Locator (URL) to use.

Values are US or EU. Default value is US.

serviceKey string

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.

typeName string Required

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.
Hide attributes Show attributes

apiToken string

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.

channelName string

Name of the Slack channel to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SLACK".

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

intervalMin integer(int32)

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.

mobileNumber string

Mobile phone number to which MongoDB Cloud sends alert notifications. The resource requires this parameter when "notifications.[n].typeName" : "SMS".

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailEnabled boolean

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"

intervalMin integer(int32)

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.

notifierId string

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})$.

smsEnabled boolean

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"

teamId string

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})$.

teamName string

Name of the MongoDB Cloud team that receives this notification. The resource requires this parameter when "notifications.[n].typeName" : "TEAM".

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailEnabled boolean

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"

intervalMin integer(int32)

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.

notifierId string

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})$.

smsEnabled boolean

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"

typeName string Required

Human-readable label that displays the alert notification type.

Value is USER.

username string(email)

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

Human-readable label that displays the alert notification type.

Value is VICTOR_OPS.

victorOpsApiKey string

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.

victorOpsRoutingKey string

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

Human-readable label that displays the alert notification type.

Value is WEBHOOK.

webhookSecret string(password)

Authentication secret for a webhook-based alert.

Atlas returns this value if you set "notifications.[n].typeName" :"WEBHOOK" and either:

You set notification.[n].webhookSecret to a non-empty string

You set a default webhookSecret either on the Integrations page, or with the Integrations API

NOTE: When you view or edit the alert for a webhook notification, the secret appears completely redacted.

Integrations page

webhookUrl string

Target URL for a webhook-based alert.

Atlas returns this value if you set "notifications.[n].typeName" :"WEBHOOK" and either:

You set notification.[n].webhookURL to a non-empty string

You set a default webhookUrl either on the Integrations page, or with the Integrations API

NOTE: When you view or edit the alert for a Webhook URL notification, the URL appears partially redacted.
severityOverride string

Severity of the event.

Values are INFO, WARNING, ERROR, or CRITICAL.
threshold object

A Limit that triggers an alert when exceeded. The resource returns this parameter when eventTypeName has not been set to OUTSIDE_METRIC_THRESHOLD.
Hide threshold attributes Show threshold attributes object
- operator string
  
  Comparison operator to apply when checking the current metric value.
  
  Values are < or >.
- threshold integer(int32)
  
  Value of metric that, when exceeded, triggers an alert.
- units string
  
  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, pixels, GB seconds, GB hours, GB days, RPU, thousand RPU, million RPU, WPU, thousand WPU, million WPU, count, thousand, million, or billion.

Serverless metric alert configuration allows to select which serverless database metrics trigger alerts and how users are notified.

enabled boolean

Flag that indicates whether someone enabled this alert configuration for the specified project.

Default value is false.
eventTypeName string Required

Event type that triggers an alert.

Value is OUTSIDE_SERVERLESS_METRIC_THRESHOLD.
matchers array[object]

Matching conditions for target resources.

Rules to apply when comparing an target instance against this alert configuration.
Hide matchers attributes Show matchers attributes object
- fieldName string Required
  
  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.
- operator string Required
  
  Comparison operator to apply when checking the current metric value against matcher[n].value.
  
  Values are EQUALS, CONTAINS, STARTS_WITH, ENDS_WITH, NOT_EQUALS, NOT_CONTAINS, or REGEX.
- value string Required
  
  Value to match or exceed using the specified matchers.operator.
metricThreshold object
One of:
SERVERLESS_AVG_COMMAND_EXECUTION_TIME object SERVERLESS_AVG_WRITE_EXECUTION_TIME object SERVERLESS_AVG_READ_EXECUTION_TIME object SERVERLESS_TOTAL_WRITE_UNITS object SERVERLESS_TOTAL_READ_UNITS object SERVERLESS_OPCOUNTER_UPDATE object SERVERLESS_OPCOUNTER_QUERY object SERVERLESS_OPCOUNTER_INSERT object SERVERLESS_OPCOUNTER_GETMORE object SERVERLESS_OPCOUNTER_DELETE object SERVERLESS_OPCOUNTER_CMD object SERVERLESS_NETWORK_NUM_REQUESTS object SERVERLESS_NETWORK_BYTES_OUT object SERVERLESS_NETWORK_BYTES_IN object SERVERLESS_DATA_SIZE_TOTAL object SERVERLESS_CONNECTIONS_PERCENT object SERVERLESS_CONNECTIONS object
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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is SERVERLESS_AVG_COMMAND_EXECUTION_TIME.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is SERVERLESS_AVG_WRITE_EXECUTION_TIME.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is SERVERLESS_AVG_READ_EXECUTION_TIME.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is SERVERLESS_TOTAL_WRITE_UNITS.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is SERVERLESS_TOTAL_READ_UNITS.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is SERVERLESS_OPCOUNTER_UPDATE.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is SERVERLESS_OPCOUNTER_QUERY.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is SERVERLESS_OPCOUNTER_INSERT.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is SERVERLESS_OPCOUNTER_GETMORE.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is SERVERLESS_OPCOUNTER_DELETE.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is SERVERLESS_OPCOUNTER_CMD.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is SERVERLESS_NETWORK_NUM_REQUESTS.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is SERVERLESS_NETWORK_BYTES_OUT.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is SERVERLESS_NETWORK_BYTES_IN.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is SERVERLESS_DATA_SIZE_TOTAL.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is SERVERLESS_CONNECTIONS_PERCENT.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

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.
Hide attributes Show attributes

metricName string Required Discriminator

Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.

Value is SERVERLESS_CONNECTIONS.

mode string

MongoDB Cloud computes the current metric value as an average.

Value is AVERAGE.

operator string

Comparison operator to apply when checking the current metric value.

Values are LESS_THAN or GREATER_THAN.

threshold number(double)

Value of metric that, when exceeded, triggers an alert.

units string

Element used to express the quantity. This can be an element of time, storage capacity, and the like.

Default value is RAW.
notifications array[object] Required

List that contains the targets that MongoDB Cloud sends notifications.

One target that MongoDB Cloud sends notifications when an alert triggers.
One target that MongoDB Cloud sends notifications when an alert triggers.
One of:
DatadogNotification object EmailNotification object GroupNotification object HipChatNotification object MicrosoftTeamsNotification object OpsGenieNotification object OrgNotification object PagerDutyNotification object SlackNotification object SMSNotification object TeamNotification object UserNotification object VictorOpsNotification object WebhookNotification object
Datadog notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.
Hide attributes Show attributes

datadogApiKey string

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.

datadogRegion string

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.

Datadog regions

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailAddress string(email)

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:

specific MongoDB Cloud users ("notifications.[n].typeName" : "USER")

MongoDB Cloud users with specific project roles ("notifications.[n].typeName" : "GROUP")

MongoDB Cloud users with specific organization roles ("notifications.[n].typeName" : "ORG")

MongoDB Cloud teams ("notifications.[n].typeName" : "TEAM")

To send emails to one MongoDB Cloud user or grouping of users, set the notifications.[n].emailEnabled parameter.

intervalMin integer(int32)

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.

notifierId string

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})$.

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

emailEnabled boolean

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"

intervalMin integer(int32)

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.

notifierId string

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})$.

roles array[string]

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.

Values are GROUP_BACKUP_MANAGER, GROUP_CLUSTER_MANAGER, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_ONLY, GROUP_DATA_ACCESS_READ_WRITE, GROUP_DATABASE_ACCESS_ADMIN, GROUP_OBSERVABILITY_VIEWER, GROUP_OWNER, GROUP_READ_ONLY, GROUP_SEARCH_INDEX_EDITOR, or GROUP_STREAM_PROCESSING_OWNER.

smsEnabled boolean

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"

typeName string Required

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.
Hide attributes Show attributes

delayMin integer(int32)

Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.

integrationId string

The id of the associated integration, the credentials of which to use for requests.

intervalMin integer(int32)

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.

notificationToken string

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.