Returns all alerts. These alerts apply to all components in one project. You receive an alert when a monitored component meets or exceeds a value you set.
This resource remains under revision and may change.
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.
NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
Format should match the following pattern: ^([a-f0-9]{24})$.
Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
Default value is false.
Flag that indicates whether the response returns the total number of items (totalCount) in the response.
Default value is true.
Number of items that the response returns per page.
Minimum value is 1, maximum value is 500. Default value is 100.
Number of the page that displays the current set of the total objects that the response returns.
Minimum value is 1. Default value is 1.
Flag that indicates whether the response body should be in the prettyprint format.
Default value is false.
Status of the alerts to return. Omit this parameter to return all alerts in all statuses. TRACKING indicates the alert condition exists but has not persisted for the minimum notification delay. OPEN indicates the alert condition currently exists. CLOSED indicates the alert condition has been resolved.
Values are OPEN, TRACKING, or CLOSED.
OK
List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.
Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.
Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.
List of returned documents that MongoDB Cloud provides when completing this request.
App Services alert notifies different activities about a BAAS application.
Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.
To acknowledge this alert forever, set the parameter value to 100 years in the future.
To unacknowledge a previously acknowledged alert, do not set this parameter value.
Comment that a MongoDB Cloud user submitted when acknowledging the alert.
Maximum length is 200.
MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.
Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.
Format should match the following pattern: ^([a-f0-9]{24})$.
Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
Incident that triggered this alert.
Values are URL_CONFIRMATION, SUCCESSFUL_DEPLOY, DEPLOYMENT_FAILURE, DEPLOYMENT_MODEL_CHANGE_SUCCESS, DEPLOYMENT_MODEL_CHANGE_FAILURE, REQUEST_RATE_LIMIT, LOG_FORWARDER_FAILURE, OUTSIDE_REALM_METRIC_THRESHOLD, SYNC_FAILURE, TRIGGER_FAILURE, or TRIGGER_AUTO_RESUMED.
Unique 24-hexadecimal digit string that identifies the project that owns this alert.
Format should match the following pattern: ^([a-f0-9]{24})$.
Unique 24-hexadecimal digit string that identifies this alert.
Format should match the following pattern: ^([a-f0-9]{24})$.
Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.
List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.
Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.
Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.
Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.
Format should match the following pattern: ^([a-f0-9]{24})$.
Date and time that this alert changed to "status" : "CLOSED". This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once "status" : "CLOSED".
State of this alert at the time you requested its details. TRACKING indicates the alert condition exists but has not persisted for the minimum notification delay. OPEN indicates the alert condition currently exists. CLOSED indicates the alert condition has been resolved.
Values are CANCELLED, CLOSED, OPEN, or TRACKING.
Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
Cluster alert notifies different activities and conditions about cluster of mongod hosts.
Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.
To acknowledge this alert forever, set the parameter value to 100 years in the future.
To unacknowledge a previously acknowledged alert, do not set this parameter value.
Comment that a MongoDB Cloud user submitted when acknowledging the alert.
Maximum length is 200.
MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.
Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.
Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$.
Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
Event type that triggers an alert.
Value is CLUSTER_MONGOS_IS_MISSING.
Unique 24-hexadecimal digit string that identifies the project that owns this alert.
Format should match the following pattern: ^([a-f0-9]{24})$.
Unique 24-hexadecimal digit string that identifies this alert.
Format should match the following pattern: ^([a-f0-9]{24})$.
Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.
List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.
Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.
Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.
Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.
Format should match the following pattern: ^([a-f0-9]{24})$.
Date and time that this alert changed to "status" : "CLOSED". This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once "status" : "CLOSED".
State of this alert at the time you requested its details. TRACKING indicates the alert condition exists but has not persisted for the minimum notification delay. OPEN indicates the alert condition currently exists. CLOSED indicates the alert condition has been resolved.
Values are CANCELLED, CLOSED, OPEN, or TRACKING.
Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
Host alert notifies about activities on mongod host.
Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.
To acknowledge this alert forever, set the parameter value to 100 years in the future.
To unacknowledge a previously acknowledged alert, do not set this parameter value.
Comment that a MongoDB Cloud user submitted when acknowledging the alert.
Maximum length is 200.
MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.
Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.
Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$.
Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
Event type that triggers an alert.
Values are HOST_DOWN, HOST_HAS_INDEX_SUGGESTIONS, HOST_MONGOT_CRASHING_OOM, HOST_MONGOT_STOP_REPLICATION, HOST_MONGOT_APPROACHING_STOP_REPLICATION, HOST_MONGOT_PAUSE_INITIAL_SYNC, HOST_SEARCH_NODE_INDEX_FAILED, HOST_SEARCH_PROCESS_THROTTLING, HOST_EXTERNAL_LOG_SINK_EXPORT_DOWN, HOST_NOT_ENOUGH_DISK_SPACE, SSH_KEY_NDS_HOST_ACCESS_REQUESTED, SSH_KEY_NDS_HOST_ACCESS_REFRESHED, PUSH_BASED_LOG_EXPORT_STOPPED, PUSH_BASED_LOG_EXPORT_DROPPED_LOG, HOST_VERSION_BEHIND, VERSION_BEHIND, HOST_EXPOSED, HOST_SSL_CERTIFICATE_STALE, HOST_SECURITY_CHECKUP_NOT_MET, ALERT_HOST_SSH_SESSION_STARTED, or PROFILER_CONFIGURED_TOO_WIDELY.
Unique 24-hexadecimal digit string that identifies the project that owns this alert.
Format should match the following pattern: ^([a-f0-9]{24})$.
Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.
Unique 24-hexadecimal digit string that identifies this alert.
Format should match the following pattern: ^([a-f0-9]{24})$.
Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.
List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.
Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.
Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.
Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.
Format should match the following pattern: ^([a-f0-9]{24})$.
Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.
Date and time that this alert changed to "status" : "CLOSED". This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once "status" : "CLOSED".
State of this alert at the time you requested its details. TRACKING indicates the alert condition exists but has not persisted for the minimum notification delay. OPEN indicates the alert condition currently exists. CLOSED indicates the alert condition has been resolved.
Values are CANCELLED, CLOSED, OPEN, or TRACKING.
Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
Flex Metric Alert notifies about changes of measurements or metrics for a Flex cluster.
Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.
To acknowledge this alert forever, set the parameter value to 100 years in the future.
To unacknowledge a previously acknowledged alert, do not set this parameter value.
Comment that a MongoDB Cloud user submitted when acknowledging the alert.
Maximum length is 200.
MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.
Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that identifies the cluster to which this alert applies.
Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$.
Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
Value of the metric that triggered the alert. The resource returns this parameter for alerts of events impacting hosts.
Amount of the metricName recorded at the time of the event. This value triggered the alert.
Element used to express the quantity in currentValue.number. This can be an element of time, storage capacity, and the like. This metric triggered the alert.
Values are bits, Kbits, Mbits, Gbits, bytes, KB, MB, GB, TB, PB, nsec, msec, sec, min, hours, million minutes, days, requests, 1000 requests, tokens, million tokens, pixels, billion pixels, GB seconds, GB hours, GB days, RPU, thousand RPU, million RPU, WPU, thousand WPU, million WPU, count, thousand, million, or billion.
Event type that triggers an alert.
Value is OUTSIDE_FLEX_METRIC_THRESHOLD.
Unique 24-hexadecimal digit string that identifies the project that owns this alert.
Format should match the following pattern: ^([a-f0-9]{24})$.
Unique 24-hexadecimal digit string that identifies this alert.
Format should match the following pattern: ^([a-f0-9]{24})$.
Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.
List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.
Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.
Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.
Name of the metric against which Atlas checks the configured alert condition.
Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.
Format should match the following pattern: ^([a-f0-9]{24})$.
Date and time that this alert changed to "status" : "CLOSED". This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once "status" : "CLOSED".
State of this alert at the time you requested its details. TRACKING indicates the alert condition exists but has not persisted for the minimum notification delay. OPEN indicates the alert condition currently exists. CLOSED indicates the alert condition has been resolved.
Values are CANCELLED, CLOSED, OPEN, or TRACKING.
Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
Host Metric Alert notifies about changes of measurements or metrics for mongod host.
Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.
To acknowledge this alert forever, set the parameter value to 100 years in the future.
To unacknowledge a previously acknowledged alert, do not set this parameter value.
Comment that a MongoDB Cloud user submitted when acknowledging the alert.
Maximum length is 200.
MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.
Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.
Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$.
Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
Value of the metric that triggered the alert. The resource returns this parameter for alerts of events impacting hosts.
Amount of the metricName recorded at the time of the event. This value triggered the alert.
Element used to express the quantity in currentValue.number. This can be an element of time, storage capacity, and the like. This metric triggered the alert.
Values are bits, Kbits, Mbits, Gbits, bytes, KB, MB, GB, TB, PB, nsec, msec, sec, min, hours, million minutes, days, requests, 1000 requests, tokens, million tokens, pixels, billion pixels, GB seconds, GB hours, GB days, RPU, thousand RPU, million RPU, WPU, thousand WPU, million WPU, count, thousand, million, or billion.
Event type that triggers an alert.
Value is OUTSIDE_METRIC_THRESHOLD.
Unique 24-hexadecimal digit string that identifies the project that owns this alert.
Format should match the following pattern: ^([a-f0-9]{24})$.
Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.
Unique 24-hexadecimal digit string that identifies this alert.
Format should match the following pattern: ^([a-f0-9]{24})$.
Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.
List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.
Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.
Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.
Name of the metric against which Atlas checks the configured metricThreshold.threshold.
To learn more about the available metrics, see Host Metrics.
NOTE: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.
Value is HostMetricAlert.
Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.
Format should match the following pattern: ^([a-f0-9]{24})$.
Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.
Date and time that this alert changed to "status" : "CLOSED". This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once "status" : "CLOSED".
State of this alert at the time you requested its details. TRACKING indicates the alert condition exists but has not persisted for the minimum notification delay. OPEN indicates the alert condition currently exists. CLOSED indicates the alert condition has been resolved.
Values are CANCELLED, CLOSED, OPEN, or TRACKING.
Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
Replica Set alert notifies about different activities on replica set of mongod instances.
Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.
To acknowledge this alert forever, set the parameter value to 100 years in the future.
To unacknowledge a previously acknowledged alert, do not set this parameter value.
Comment that a MongoDB Cloud user submitted when acknowledging the alert.
Maximum length is 200.
MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.
Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.
Format should match the following pattern: ^([a-f0-9]{24})$.
Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.
Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$.
Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
Incident that triggered this alert.
Values are REPLICATION_OPLOG_WINDOW_RUNNING_OUT, NO_PRIMARY, PRIMARY_ELECTED, TOO_MANY_ELECTIONS, TOO_FEW_HEALTHY_MEMBERS, or TOO_MANY_UNHEALTHY_MEMBERS.
Unique 24-hexadecimal digit string that identifies the project that owns this alert.
Format should match the following pattern: ^([a-f0-9]{24})$.
Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.
Unique 24-hexadecimal digit string that identifies this alert.
Format should match the following pattern: ^([a-f0-9]{24})$.
Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.
List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.
Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.
Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.
List of unique 24-hexadecimal character strings that identify the replica set members that are not in PRIMARY nor SECONDARY state.
Format of each should match the following pattern: ^([a-f0-9]{8,32})$.
Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.
Format should match the following pattern: ^([a-f0-9]{24})$.
Unique 24-hexadecimal character string that identifies the parent cluster to which this alert applies. The parent cluster contains the sharded nodes. MongoDB Cloud returns this parameter only for alerts of events impacting sharded clusters.
Format should match the following pattern: ^([a-f0-9]{24})$.
Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.
Date and time that this alert changed to "status" : "CLOSED". This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once "status" : "CLOSED".
State of this alert at the time you requested its details. TRACKING indicates the alert condition exists but has not persisted for the minimum notification delay. OPEN indicates the alert condition currently exists. CLOSED indicates the alert condition has been resolved.
Values are CANCELLED, CLOSED, OPEN, or TRACKING.
Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
Stream Processor alert notifies about activities on Stream Processor in Atlas Streams.
Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.
To acknowledge this alert forever, set the parameter value to 100 years in the future.
To unacknowledge a previously acknowledged alert, do not set this parameter value.
Comment that a MongoDB Cloud user submitted when acknowledging the alert.
Maximum length is 200.
MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.
Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.
Format should match the following pattern: ^([a-f0-9]{24})$.
Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
Event type that triggers an alert.
Values are HOST_DOWN, HOST_HAS_INDEX_SUGGESTIONS, HOST_MONGOT_CRASHING_OOM, HOST_MONGOT_STOP_REPLICATION, HOST_MONGOT_APPROACHING_STOP_REPLICATION, HOST_MONGOT_PAUSE_INITIAL_SYNC, HOST_SEARCH_NODE_INDEX_FAILED, HOST_SEARCH_PROCESS_THROTTLING, HOST_EXTERNAL_LOG_SINK_EXPORT_DOWN, HOST_NOT_ENOUGH_DISK_SPACE, SSH_KEY_NDS_HOST_ACCESS_REQUESTED, SSH_KEY_NDS_HOST_ACCESS_REFRESHED, PUSH_BASED_LOG_EXPORT_STOPPED, PUSH_BASED_LOG_EXPORT_DROPPED_LOG, HOST_VERSION_BEHIND, VERSION_BEHIND, HOST_EXPOSED, HOST_SSL_CERTIFICATE_STALE, HOST_SECURITY_CHECKUP_NOT_MET, ALERT_HOST_SSH_SESSION_STARTED, or PROFILER_CONFIGURED_TOO_WIDELY.
Unique 24-hexadecimal digit string that identifies the project that owns this alert.
Format should match the following pattern: ^([a-f0-9]{24})$.
Unique 24-hexadecimal digit string that identifies this alert.
Format should match the following pattern: ^([a-f0-9]{24})$.
The name of the Stream Processing Workspace to which this alert applies. The resource returns this parameter for alerts of events impacting Stream Processing Workspaces.
Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.
List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.
Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.
Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.
Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.
Format should match the following pattern: ^([a-f0-9]{24})$.
The error message associated with the Stream Processor to which this alert applies.
The name of the Stream Processor to which this alert applies. The resource returns this parameter for alerts of events impacting Stream Processors.
The state of the Stream Processor to which this alert applies. The resource returns this parameter for alerts of events impacting Stream Processors.
Date and time that this alert changed to "status" : "CLOSED". This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once "status" : "CLOSED".
State of this alert at the time you requested its details. TRACKING indicates the alert condition exists but has not persisted for the minimum notification delay. OPEN indicates the alert condition currently exists. CLOSED indicates the alert condition has been resolved.
Values are CANCELLED, CLOSED, OPEN, or TRACKING.
Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
Other alerts which don't have extra details beside of basic one.
Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.
To acknowledge this alert forever, set the parameter value to 100 years in the future.
To unacknowledge a previously acknowledged alert, do not set this parameter value.
Comment that a MongoDB Cloud user submitted when acknowledging the alert.
Maximum length is 200.
MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.
Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.
Format should match the following pattern: ^([a-f0-9]{24})$.
Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
Incident that triggered this alert.
Values are CREDIT_CARD_ABOUT_TO_EXPIRE, PENDING_INVOICE_OVER_THRESHOLD, DAILY_BILL_OVER_THRESHOLD, DAILY_BILLING_CHANGE_OVER_THRESHOLD, WEEKLY_BILLING_CHANGE_OVER_THRESHOLD, or MONTHLY_BILLING_CHANGE_OVER_THRESHOLD.
Values are CPS_SNAPSHOT_STARTED, CPS_SNAPSHOT_SUCCESSFUL, CPS_SNAPSHOT_FAILED, CPS_CONCURRENT_SNAPSHOT_FAILED_WILL_RETRY, CPS_SNAPSHOT_BEHIND, CPS_COPY_SNAPSHOT_STARTED, CPS_COPY_SNAPSHOT_FAILED, CPS_COPY_SNAPSHOT_FAILED_WILL_RETRY, CPS_COPY_SNAPSHOT_SUCCESSFUL, CPS_PREV_SNAPSHOT_OLD, CPS_SNAPSHOT_FALLBACK_SUCCESSFUL, CPS_SNAPSHOT_FALLBACK_FAILED, 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, CPS_OPLOG_BEHIND, or CPS_OPLOG_CAUGHT_UP.
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.
Values are FTS_INDEX_DELETION_FAILED, FTS_INDEX_BUILD_COMPLETE, FTS_INDEX_BUILD_FAILED, FTS_INDEX_CLEANED_UP, FTS_INDEX_STALE, FTS_INDEXES_RESTORE_FAILED, or FTS_INDEXES_SYNONYM_MAPPING_INVALID.
Values are USERS_WITHOUT_MULTI_FACTOR_AUTH, ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED, ENCRYPTION_AT_REST_CONFIG_NO_LONGER_VALID, GROUP_SERVICE_ACCOUNT_SECRETS_EXPIRING, GROUP_SERVICE_ACCOUNT_SECRETS_EXPIRED, or ACTIVE_LEGACY_TLS_CONNECTIONS.
Value is MONGOTUNE_ALERT.
Values are CLUSTER_INSTANCE_STOP_START, CLUSTER_INSTANCE_RESYNC_REQUESTED, CLUSTER_INSTANCE_UPDATE_REQUESTED, SAMPLE_DATASET_LOAD_REQUESTED, TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL, TENANT_UPGRADE_TO_SERVERLESS_FAILED, NETWORK_PERMISSION_ENTRY_ADDED, NETWORK_PERMISSION_ENTRY_REMOVED, NETWORK_PERMISSION_ENTRY_UPDATED, CLUSTER_BLOCK_WRITE, CLUSTER_UNBLOCK_WRITE, LOG_STREAMING_EXPORT_FAILED_NONRETRYABLE, or LOG_STREAMING_EXPORT_FAILED_RETRIES_EXHAUSTED.
Values are MAINTENANCE_IN_ADVANCED, MAINTENANCE_AUTO_DEFERRED, MAINTENANCE_STARTED, MAINTENANCE_COMPLETED, or MAINTENANCE_NO_LONGER_NEEDED.
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.
Values are ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK or ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK.
Value is OUTSIDE_SERVERLESS_METRIC_THRESHOLD.
Value is OUTSIDE_FLEX_METRIC_THRESHOLD.
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, CLUSTER_AUTO_SHARDING_INITIATED, CLUSTER_RESHARDING_COMPLETED, COMPUTE_AUTO_SCALE_DOWNSCALE_SKIPPED_FALLBACK_BASE, or COMPUTE_AUTO_SCALE_DOWNSCALE_SKIPPED_FALLBACK_ANALYTICS.
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.
Value is RESOURCE_POLICY_VIOLATED.
Values are HOST_DOWN, HOST_HAS_INDEX_SUGGESTIONS, HOST_MONGOT_CRASHING_OOM, HOST_MONGOT_STOP_REPLICATION, HOST_MONGOT_APPROACHING_STOP_REPLICATION, HOST_MONGOT_PAUSE_INITIAL_SYNC, HOST_SEARCH_NODE_INDEX_FAILED, HOST_SEARCH_PROCESS_THROTTLING, HOST_EXTERNAL_LOG_SINK_EXPORT_DOWN, HOST_NOT_ENOUGH_DISK_SPACE, SSH_KEY_NDS_HOST_ACCESS_REQUESTED, SSH_KEY_NDS_HOST_ACCESS_REFRESHED, PUSH_BASED_LOG_EXPORT_STOPPED, PUSH_BASED_LOG_EXPORT_DROPPED_LOG, HOST_VERSION_BEHIND, VERSION_BEHIND, HOST_EXPOSED, HOST_SSL_CERTIFICATE_STALE, HOST_SECURITY_CHECKUP_NOT_MET, ALERT_HOST_SSH_SESSION_STARTED, or PROFILER_CONFIGURED_TOO_WIDELY.
Unique 24-hexadecimal digit string that identifies the project that owns this alert.
Format should match the following pattern: ^([a-f0-9]{24})$.
Unique 24-hexadecimal digit string that identifies this alert.
Format should match the following pattern: ^([a-f0-9]{24})$.
Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.
List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.
Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.
Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.
Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.
Format should match the following pattern: ^([a-f0-9]{24})$.
Date and time that this alert changed to "status" : "CLOSED". This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once "status" : "CLOSED".
State of this alert at the time you requested its details. TRACKING indicates the alert condition exists but has not persisted for the minimum notification delay. OPEN indicates the alert condition currently exists. CLOSED indicates the alert condition has been resolved.
Values are CANCELLED, CLOSED, OPEN, or TRACKING.
Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
Total number of documents available. MongoDB Cloud omits this value if includeCount is set to false. The total number is an estimate and may not be exact.
Minimum value is 0.
Bad Request.
Bad request detail.
Describes the specific conditions or reasons that cause each type of error.
HTTP status code returned with this error.
Application error code returned with this error.
Parameters used to give more information about the error.
Application error message returned with this error.
Unauthorized.
Bad request detail.
Describes the specific conditions or reasons that cause each type of error.
HTTP status code returned with this error.
Application error code returned with this error.
Parameters used to give more information about the error.
Application error message returned with this error.
Forbidden.
Bad request detail.
Describes the specific conditions or reasons that cause each type of error.
HTTP status code returned with this error.
Application error code returned with this error.
Parameters used to give more information about the error.
Application error message returned with this error.
Not Found.
Bad request detail.
Describes the specific conditions or reasons that cause each type of error.
HTTP status code returned with this error.
Application error code returned with this error.
Parameters used to give more information about the error.
Application error message returned with this error.
Too Many Requests.
The maximum number of requests that a user can make within a specific time window.
The number of requests remaining in the current rate limit window before the limit is reached.
The minimum time you should wait, in seconds, before retrying the API request. This header might be returned for 429 or 503 error responses.
Bad request detail.
Describes the specific conditions or reasons that cause each type of error.
HTTP status code returned with this error.
Application error code returned with this error.
Parameters used to give more information about the error.
Application error message returned with this error.
Internal Server Error.
Bad request detail.
Describes the specific conditions or reasons that cause each type of error.
HTTP status code returned with this error.
Application error code returned with this error.
Parameters used to give more information about the error.
Application error message returned with this error.
atlas api alerts listAlerts --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)
func main() {
ctx := context.Background()
clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")
// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))
if err != nil {
log.Fatalf("Error: %v", err)
}
params = &sdk.ListGroupAlertsApiParams{}
sdkResp, httpResp, err := client.AlertsApi.
ListGroupAlertsWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2025-03-12+json" \
-X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts?pretty=true"curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2025-03-12+json" \
-X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts?pretty=true"# Headers
# Payload
{
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [
{
"acknowledgedUntil": "2026-05-04T09:42:00Z",
"acknowledgementComment": "Expiration on 3/19. Silencing for 7 days.",
"acknowledgingUsername": "hello@example.com",
"alertConfigId": "32b6e34b3d91647abb20e7b8",
"created": "2026-05-04T09:42:00Z",
"eventTypeName": "DEPLOYMENT_FAILURE",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"lastNotified": "2026-05-04T09:42:00Z",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"orgId": "32b6e34b3d91647abb20e7b8",
"resolved": "2026-05-04T09:42:00Z",
"status": "OPEN",
"updated": "2026-05-04T09:42:00Z"
}
],
"totalCount": 42
}{
"detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
"error": 400,
"errorCode": "VALIDATION_ERROR",
"reason": "Bad Request"
}{
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"error": 401,
"errorCode": "NOT_ORG_GROUP_CREATOR",
"reason": "Unauthorized"
}{
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"error": 403,
"errorCode": "CANNOT_CHANGE_GROUP_NAME",
"reason": "Forbidden"
}{
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
"error": 404,
"errorCode": "RESOURCE_NOT_FOUND",
"reason": "Not Found"
}{
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"error": 429,
"errorCode": "RATE_LIMITED",
"reason": "Too Many Requests"
}{
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"error": 500,
"errorCode": "UNEXPECTED_ERROR",
"reason": "Internal Server Error"
}