{
  "opencollection": "1.0.0",
  "info": {
    "name": "MongoDB Atlas Administration Access Tracking Alert Configurations API",
    "version": "2.0"
  },
  "request": {
    "auth": {
      "type": "oauth2",
      "flow": "client_credentials",
      "accessTokenUrl": "https://cloud.mongodb.com/api/oauth/token",
      "credentials": {
        "clientId": "{{clientId}}",
        "clientSecret": "{{clientSecret}}"
      }
    }
  },
  "items": [
    {
      "info": {
        "name": "Alert Configurations",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Return All Alert Configuration Matchers Field Names",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://cloud.mongodb.com/api/atlas/v2/alertConfigs/matchers/fieldNames",
            "params": [
              {
                "name": "envelope",
                "value": "",
                "type": "query",
                "description": "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."
              },
              {
                "name": "pretty",
                "value": "",
                "type": "query",
                "description": "Flag that indicates whether the response body should be in the prettyprint format."
              }
            ]
          },
          "docs": "Get all field names that the `matchers.fieldName` parameter accepts when you create or update an Alert Configuration. You can successfully call this endpoint with any assigned role."
        },
        {
          "info": {
            "name": "Return All Alert Configurations in One Project",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://cloud.mongodb.com/api/atlas/v2/groups/:groupId/alertConfigs",
            "params": [
              {
                "name": "envelope",
                "value": "",
                "type": "query",
                "description": "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."
              },
              {
                "name": "groupId",
                "value": "",
                "type": "path",
                "description": "Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.\n\n**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."
              },
              {
                "name": "includeCount",
                "value": "",
                "type": "query",
                "description": "Flag that indicates whether the response returns the total number of items (`totalCount`) in the response."
              },
              {
                "name": "itemsPerPage",
                "value": "",
                "type": "query",
                "description": "Number of items that the response returns per page."
              },
              {
                "name": "pageNum",
                "value": "",
                "type": "query",
                "description": "Number of the page that displays the current set of the total objects that the response returns."
              },
              {
                "name": "pretty",
                "value": "",
                "type": "query",
                "description": "Flag that indicates whether the response body should be in the prettyprint format."
              }
            ]
          },
          "docs": "Returns all alert configurations for one project. These alert configurations apply to any component in the 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 Project Read Only role.\n\nThis resource remains under revision and may change."
        },
        {
          "info": {
            "name": "Create One Alert Configuration in One Project",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://cloud.mongodb.com/api/atlas/v2/groups/:groupId/alertConfigs",
            "params": [
              {
                "name": "envelope",
                "value": "",
                "type": "query",
                "description": "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."
              },
              {
                "name": "groupId",
                "value": "",
                "type": "path",
                "description": "Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.\n\n**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."
              },
              {
                "name": "pretty",
                "value": "",
                "type": "query",
                "description": "Flag that indicates whether the response body should be in the prettyprint format."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "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 Project Alerts Manager, Project Monitoring Admin, Organization Owner, or Project Owner role.\n\nThis resource remains under revision and may change."
        },
        {
          "info": {
            "name": "Return One Alert Configuration from One Project",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://cloud.mongodb.com/api/atlas/v2/groups/:groupId/alertConfigs/:alertConfigId",
            "params": [
              {
                "name": "envelope",
                "value": "",
                "type": "query",
                "description": "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."
              },
              {
                "name": "groupId",
                "value": "",
                "type": "path",
                "description": "Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.\n\n**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."
              },
              {
                "name": "pretty",
                "value": "",
                "type": "query",
                "description": "Flag that indicates whether the response body should be in the prettyprint format."
              },
              {
                "name": "alertConfigId",
                "value": "",
                "type": "path",
                "description": "Unique 24-hexadecimal digit string that identifies the alert configuration."
              }
            ]
          },
          "docs": "Returns the specified alert configuration from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Use the Return All Alert Configurations for One Project endpoint to retrieve all alert configurations to which the authenticated user has access.\n\nThis resource remains under revision and may change."
        },
        {
          "info": {
            "name": "Update One Alert Configuration in One Project",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://cloud.mongodb.com/api/atlas/v2/groups/:groupId/alertConfigs/:alertConfigId",
            "params": [
              {
                "name": "envelope",
                "value": "",
                "type": "query",
                "description": "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."
              },
              {
                "name": "groupId",
                "value": "",
                "type": "path",
                "description": "Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.\n\n**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."
              },
              {
                "name": "pretty",
                "value": "",
                "type": "query",
                "description": "Flag that indicates whether the response body should be in the prettyprint format."
              },
              {
                "name": "alertConfigId",
                "value": "",
                "type": "path",
                "description": "Unique 24-hexadecimal digit string that identifies the alert configuration."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates one alert configuration in 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 Project Alerts Manager, Project Monitoring Admin, Organization Owner, or Project Owner role.\n\n**NOTE**: To enable or disable the alert configuration, see Toggle One State of One Alert Configuration in One Project.\n\nThis resource remains under revision and may change."
        },
        {
          "info": {
            "name": "Toggle State of One Alert Configuration in One Project",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://cloud.mongodb.com/api/atlas/v2/groups/:groupId/alertConfigs/:alertConfigId",
            "params": [
              {
                "name": "envelope",
                "value": "",
                "type": "query",
                "description": "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."
              },
              {
                "name": "groupId",
                "value": "",
                "type": "path",
                "description": "Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.\n\n**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."
              },
              {
                "name": "pretty",
                "value": "",
                "type": "query",
                "description": "Flag that indicates whether the response body should be in the prettyprint format."
              },
              {
                "name": "alertConfigId",
                "value": "",
                "type": "path",
                "description": "Unique 24-hexadecimal digit string that identifies the alert configuration that triggered this alert."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Enables or disables the specified alert configuration in the specified project. The resource enables the specified alert configuration if currently enabled. The resource disables the specified alert configuration if currently disabled. To use this resource, the requesting Service Account or API Key must have the Project Alerts Manager, Project Monitoring Admin, Organization Owner, or Project Owner role.\n\n**NOTE**: This endpoint updates only the enabled/disabled state for the alert configuration."
        },
        {
          "info": {
            "name": "Remove One Alert Configuration from One Project",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://cloud.mongodb.com/api/atlas/v2/groups/:groupId/alertConfigs/:alertConfigId",
            "params": [
              {
                "name": "envelope",
                "value": "",
                "type": "query",
                "description": "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."
              },
              {
                "name": "groupId",
                "value": "",
                "type": "path",
                "description": "Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.\n\n**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."
              },
              {
                "name": "pretty",
                "value": "",
                "type": "query",
                "description": "Flag that indicates whether the response body should be in the prettyprint format."
              },
              {
                "name": "alertConfigId",
                "value": "",
                "type": "path",
                "description": "Unique 24-hexadecimal digit string that identifies the alert configuration."
              }
            ]
          },
          "docs": "Removes one alert configuration from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Alerts Manager, Project Monitoring Admin, Organization Owner, or Project Owner role. Use the Return All Alert Configurations for One Project endpoint to retrieve all alert configurations to which the authenticated user has access.\n\nThis resource remains under revision and may change."
        },
        {
          "info": {
            "name": "Return All Alert Configurations Set for One Alert",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://cloud.mongodb.com/api/atlas/v2/groups/:groupId/alerts/:alertId/alertConfigs",
            "params": [
              {
                "name": "envelope",
                "value": "",
                "type": "query",
                "description": "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."
              },
              {
                "name": "groupId",
                "value": "",
                "type": "path",
                "description": "Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.\n\n**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."
              },
              {
                "name": "pretty",
                "value": "",
                "type": "query",
                "description": "Flag that indicates whether the response body should be in the prettyprint format."
              },
              {
                "name": "includeCount",
                "value": "",
                "type": "query",
                "description": "Flag that indicates whether the response returns the total number of items (`totalCount`) in the response."
              },
              {
                "name": "itemsPerPage",
                "value": "",
                "type": "query",
                "description": "Number of items that the response returns per page."
              },
              {
                "name": "pageNum",
                "value": "",
                "type": "query",
                "description": "Number of the page that displays the current set of the total objects that the response returns."
              },
              {
                "name": "alertId",
                "value": "",
                "type": "path",
                "description": "Unique 24-hexadecimal digit string that identifies the alert."
              }
            ]
          },
          "docs": "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.\n\nThis resource remains under revision and may change."
        }
      ]
    }
  ],
  "bundled": true
}