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

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