Andrea Test

Return All Alert Configurations Set for One Alert

GET /api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs
Service accounts Digest auth

Returns all alert configurations set for the specified alert. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Use the Return All Alerts from One Project endpoint to retrieve all alerts to which the authenticated user has access.

This resource remains under revision and may change.

Return All Alerts from One Project

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

  • alertId string Required

    Unique 24-hexadecimal digit string that identifies the alert.

    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
  • includeCount boolean

    Flag that indicates whether the response returns the total number of items (totalCount) in the response.

    Default value is true.

  • itemsPerPage integer

    Number of items that the response returns per page.

    Minimum value is 1, maximum value is 500. Default value is 100.

  • pageNum integer

    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.

Responses

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

    OK

    Hide response attributes Show response attributes object
    • links array[object]

      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.

      Web Linking Specification (RFC 5988)
      Hide links attributes Show links attributes object
      • href string

        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.

      • rel string

        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.

    • results array[object]

      List of returned documents that MongoDB Cloud provides when completing this request.

      One of:
      DefaultAlertConfigViewForNdsGroup object AppServiceAlertConfigViewForNdsGroup object AppServiceMetricAlertConfigViewForNdsGroup object BillingThresholdAlertConfigViewForNdsGroup object ClusterAlertConfigViewForNdsGroup object CpsBackupThresholdAlertConfigViewForNdsGroup object EncryptionKeyAlertConfigViewForNdsGroup object HostAlertConfigViewForNdsGroup object HostMetricAlertConfigViewForNdsGroup object NDSX509UserAuthenticationAlertConfigViewForNdsGroup object ReplicaSetAlertConfigViewForNdsGroup object ReplicaSetThresholdAlertConfigViewForNdsGroup object ServerlessMetricAlertConfigViewForNdsGroup object FlexMetricAlertConfigViewForNdsGroup object StreamProcessorAlertConfigViewForNdsGroup object StreamProcessorMetricAlertConfigViewForNdsGroup object

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

      Hide attributes Show attributes
      • created string(date-time)

        Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

        ISO 8601
      • 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.

      • groupId string

        Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.

        Format should match the following pattern: ^([a-f0-9]{24})$.

      • id string

        Unique 24-hexadecimal digit string that identifies this alert configuration.

        Format should match the following pattern: ^([a-f0-9]{24})$.

      • links array[object]

        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.

        Web Linking Specification (RFC 5988)
        Hide links attributes Show links attributes object
        • href string

          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.

        • rel string

          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.

      • 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.

      • severityOverride string

        Severity of the event.

        Values are INFO, WARNING, ERROR, or CRITICAL.

      • updated string(date-time)

        Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

        ISO 8601
    • totalCount integer(int32)

      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.
  • 401 application/json

    Unauthorized.

    Hide response attributes Show response attributes object
    • badRequestDetail object

      Bad request detail.

      Hide badRequestDetail attribute Show badRequestDetail attribute object
      • fields array[object]

        Describes all violations in a client request.

        Hide fields attributes Show fields attributes object
        • description string Required

          A description of why the request element is bad.

        • field string Required

          A path that leads to a field in the request body.

    • detail string

      Describes the specific conditions or reasons that cause each type of error.

    • error integer(int32) Required

      HTTP status code returned with this error.

      External documentation
    • errorCode string Required

      Application error code returned with this error.

    • parameters array[object]

      Parameters used to give more information about the error.

    • reason string

      Application error message returned with this error.
  • 403 application/json

    Forbidden.

    Hide response attributes Show response attributes object
    • badRequestDetail object

      Bad request detail.

      Hide badRequestDetail attribute Show badRequestDetail attribute object
      • fields array[object]

        Describes all violations in a client request.

        Hide fields attributes Show fields attributes object
        • description string Required

          A description of why the request element is bad.

        • field string Required

          A path that leads to a field in the request body.

    • detail string

      Describes the specific conditions or reasons that cause each type of error.

    • error integer(int32) Required

      HTTP status code returned with this error.

      External documentation
    • errorCode string Required

      Application error code returned with this error.

    • parameters array[object]

      Parameters used to give more information about the error.

    • reason string

      Application error message returned with this error.
  • 404 application/json

    Not Found.

    Hide response attributes Show response attributes object
    • badRequestDetail object

      Bad request detail.

      Hide badRequestDetail attribute Show badRequestDetail attribute object
      • fields array[object]

        Describes all violations in a client request.

        Hide fields attributes Show fields attributes object
        • description string Required

          A description of why the request element is bad.

        • field string Required

          A path that leads to a field in the request body.

    • detail string

      Describes the specific conditions or reasons that cause each type of error.

    • error integer(int32) Required

      HTTP status code returned with this error.

      External documentation
    • errorCode string Required

      Application error code returned with this error.

    • parameters array[object]

      Parameters used to give more information about the error.

    • reason string

      Application error message returned with this error.
  • 500 application/json

    Internal Server Error.

    Hide response attributes Show response attributes object
    • badRequestDetail object

      Bad request detail.

      Hide badRequestDetail attribute Show badRequestDetail attribute object
      • fields array[object]

        Describes all violations in a client request.

        Hide fields attributes Show fields attributes object
        • description string Required

          A description of why the request element is bad.

        • field string Required

          A path that leads to a field in the request body.

    • detail string

      Describes the specific conditions or reasons that cause each type of error.

    • error integer(int32) Required

      HTTP status code returned with this error.

      External documentation
    • errorCode string Required

      Application error code returned with this error.

    • parameters array[object]

      Parameters used to give more information about the error.

    • reason string

      Application error message returned with this error.
GET /api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs 
curl \
 --request GET 'https://cloud.mongodb.com/api/atlas/v2/groups/32b6e34b3d91647abb20e7b8/alerts/{alertId}/alertConfigs' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "results": [
    {
      "created": "2025-05-04T09:42:00Z",
      "enabled": false,
      "eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
      "groupId": "32b6e34b3d91647abb20e7b8",
      "id": "32b6e34b3d91647abb20e7b8",
      "links": [
        {
          "href": "https://cloud.mongodb.com/api/atlas",
          "rel": "self"
        }
      ],
      "matchers": [
        {
          "fieldName": "string",
          "operator": "EQUALS",
          "value": "event-replica-set"
        }
      ],
      "notifications": [
        {
          "datadogApiKey": "****************************a23c",
          "datadogRegion": "US",
          "delayMin": 42,
          "integrationId": "32b6e34b3d91647abb20e7b8",
          "intervalMin": 42,
          "notifierId": "32b6e34b3d91647abb20e7b8",
          "typeName": "DATADOG"
        }
      ],
      "severityOverride": "INFO",
      "updated": "2025-05-04T09:42:00Z"
    }
  ],
  "totalCount": 42
}
Response examples (401) 
{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}
Response examples (403) 
{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}
Response examples (404) 
{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}
Response examples (500) 
{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}