openapi: 3.0.1 info: description: "The MongoDB Atlas Administration API allows developers to manage all components in MongoDB Atlas.\n\nThe Atlas Administration API supports OAuth2 Service Accounts and HTTP Digest-based API keys. Service accounts are the recommended authentication method and API keys are considered a legacy option.\n\nTo authenticate with a Service Account, first exchange its client ID and secret for an access token using the OAuth 2.0 Client Credentials flow. Atlas provides a token endpoint at `POST https://cloud.mongodb.com/api/oauth/token`, which returns a Bearer token that is reusable and valid for 1 hour (3600 seconds).\n\nFor example, to [return a list of your organizations](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listorgs) with [cURL](https://en.wikipedia.org/wiki/CURL), first generate an access token and then use that token to call the same Atlas Administration API endpoint shown in the current example:\n\n```\nACCESS_TOKEN=$(curl -fsS --request POST https://cloud.mongodb.com/api/oauth/token \\\n --header \"Authorization: Basic $(printf '%s' \"${CLIENT_ID}:${CLIENT_SECRET}\" | base64 | tr -d '\\n')\" \\\n --header \"Content-Type: application/x-www-form-urlencoded\" \\\n --header \"Accept: application/json\" \\\n --data \"grant_type=client_credentials\" | jq -r '.access_token')\n\ncurl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs?pretty=true\"\n```\n\nIf your organization requires an IP access list for the Atlas Administration API, the token can be created from any IP address, but the API call that uses the token must originate from an allowed IP.\n\nTo learn more, see [Get Started with the Atlas Administration API](https://www.mongodb.com/docs/atlas/configure-api-access/). For support, see [MongoDB Support](https://www.mongodb.com/support/get-started).\n\nYou can also explore the various endpoints available through the Atlas Administration API in MongoDB's [Postman workspace](https://www.postman.com/mongodb-devrel/workspace/mongodb-atlas-administration-apis/) (requires a Postman account)." license: name: CC BY-NC-SA 3.0 US url: https://creativecommons.org/licenses/by-nc-sa/3.0/us/ termsOfService: https://www.mongodb.com/mongodb-management-service-terms-and-conditions title: MongoDB Atlas Administration Access Tracking Alert Configurations API version: '2.0' x-xgen-sha: 3d70e065843c008b9871ea7836c98c9de6f202f9 servers: - url: https://cloud.mongodb.com security: - ServiceAccounts: [] - DigestAuth: [] tags: - description: Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. This collection remains under revision and may change. name: Alert Configurations paths: /api/atlas/v2/alertConfigs/matchers/fieldNames: get: description: 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. operationId: listAlertConfigMatcherFieldNames parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' responses: '200': content: application/vnd.atlas.2023-01-01+json: schema: items: $ref: '#/components/schemas/MatcherFieldView' type: array x-xgen-version: '2023-01-01' description: OK headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Return All Alert Configuration Matchers Field Names tags: - Alert Configurations x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api alertConfigurations listMatcherFieldNames --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListAlertConfigMatcherFieldNamesApiParams{}\n\tsdkResp, httpResp, err := client.AlertConfigurationsApi.\n\t\tListAlertConfigMatcherFieldNamesWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/alertConfigs/matchers/fieldNames?pretty=true\"" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/alertConfigs/matchers/fieldNames?pretty=true\"" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigMatcherFieldNames x-xgen-operation-id-override: listMatcherFieldNames /api/atlas/v2/groups/{groupId}/alertConfigs: get: description: '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. This resource remains under revision and may change.' operationId: listGroupAlertConfigs parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/includeCount' - $ref: '#/components/parameters/itemsPerPage' - $ref: '#/components/parameters/pageNum' - $ref: '#/components/parameters/pretty' responses: '200': content: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/PaginatedAlertConfigView' x-xgen-version: '2023-01-01' description: OK headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Return All Alert Configurations in One Project tags: - Alert Configurations x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api alertConfigurations listAlertConfigs --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupAlertConfigsApiParams{}\n\tsdkResp, httpResp, err := client.AlertConfigurationsApi.\n\t\tListGroupAlertConfigsWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs?pretty=true\"" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs?pretty=true\"" x-rolesRequirements: - Project Read Only x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listGroupAlertConfigs x-xgen-operation-id-override: listAlertConfigs post: description: '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. This resource remains under revision and may change.' operationId: createGroupAlertConfig parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/pretty' requestBody: content: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/GroupAlertsConfig' description: Creates one alert configuration for the specified project. required: true responses: '200': content: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/GroupAlertsConfig' x-xgen-version: '2023-01-01' description: OK headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Create One Alert Configuration in One Project tags: - Alert Configurations x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api alertConfigurations createAlertConfig --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateGroupAlertConfigApiParams{}\n\tsdkResp, httpResp, err := client.AlertConfigurationsApi.\n\t\tCreateGroupAlertConfigWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs\" \\\n -d '{ }'" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs\" \\\n -d '{ }'" x-rolesRequirements: - Project Alerts Manager x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/createGroupAlertConfig x-xgen-operation-id-override: createAlertConfig /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}: delete: description: '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. This resource remains under revision and may change.' externalDocs: description: Return All Alert Configurations for One Project url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigurations operationId: deleteGroupAlertConfig parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/pretty' - description: Unique 24-hexadecimal digit string that identifies the alert configuration. in: path name: alertConfigId required: true schema: example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ type: string responses: '204': content: application/vnd.atlas.2023-01-01+json: x-xgen-version: '2023-01-01' description: No Content headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Remove One Alert Configuration from One Project tags: - Alert Configurations x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api alertConfigurations deleteAlertConfig --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteGroupAlertConfigApiParams{}\n\thttpResp, err := client.AlertConfigurationsApi.\n\t\tDeleteGroupAlertConfigWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\"" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\"" x-rolesRequirements: - Project Alerts Manager x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/deleteGroupAlertConfig x-xgen-operation-id-override: deleteAlertConfig get: description: '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. This resource remains under revision and may change.' externalDocs: description: Return All Alert Configurations for One Project url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigurations operationId: getGroupAlertConfig parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/pretty' - description: Unique 24-hexadecimal digit string that identifies the alert configuration. in: path name: alertConfigId required: true schema: example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ type: string responses: '200': content: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/GroupAlertsConfig' x-xgen-version: '2023-01-01' description: OK headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Return One Alert Configuration from One Project tags: - Alert Configurations x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api alertConfigurations getAlertConfig --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupAlertConfigApiParams{}\n\tsdkResp, httpResp, err := client.AlertConfigurationsApi.\n\t\tGetGroupAlertConfigWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}?pretty=true\"" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}?pretty=true\"" x-rolesRequirements: - Project Read Only x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/getGroupAlertConfig x-xgen-operation-id-override: getAlertConfig patch: description: '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. **NOTE**: This endpoint updates only the enabled/disabled state for the alert configuration. To update more than just this configuration, see Update One Alert Configuration. This resource remains under revision and may change.' externalDocs: description: Update One Alert Configuration url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/updateAlertConfiguration operationId: toggleGroupAlertConfig parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/pretty' - description: Unique 24-hexadecimal digit string that identifies the alert configuration that triggered this alert. in: path name: alertConfigId required: true schema: example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ type: string requestBody: content: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/AlertsToggle' description: Enables or disables the specified alert configuration in the specified project. required: true responses: '200': content: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/GroupAlertsConfig' x-xgen-version: '2023-01-01' description: OK headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Toggle State of One Alert Configuration in One Project tags: - Alert Configurations x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api alertConfigurations toggleAlertConfig --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ToggleGroupAlertConfigApiParams{}\n\tsdkResp, httpResp, err := client.AlertConfigurationsApi.\n\t\tToggleGroupAlertConfigWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\" \\\n -d '{ }'" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\" \\\n -d '{ }'" x-rolesRequirements: - Project Alerts Manager x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/toggleGroupAlertConfig x-xgen-method-verb-override: customMethod: true verb: toggle x-xgen-operation-id-override: toggleAlertConfig put: description: '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. **NOTE**: To enable or disable the alert configuration, see Toggle One State of One Alert Configuration in One Project. This resource remains under revision and may change.' externalDocs: description: Toggle One State of One Alert Configuration in One Project url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/toggleAlertConfiguration operationId: updateGroupAlertConfig parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/pretty' - description: Unique 24-hexadecimal digit string that identifies the alert configuration. in: path name: alertConfigId required: true schema: example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ type: string requestBody: content: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/GroupAlertsConfig' description: Updates one alert configuration in the specified project. required: true responses: '200': content: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/GroupAlertsConfig' x-xgen-version: '2023-01-01' description: OK headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Update One Alert Configuration in One Project tags: - Alert Configurations x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api alertConfigurations updateAlertConfig --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateGroupAlertConfigApiParams{}\n\tsdkResp, httpResp, err := client.AlertConfigurationsApi.\n\t\tUpdateGroupAlertConfigWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\" \\\n -d '{ }'" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\" \\\n -d '{ }'" x-rolesRequirements: - Project Alerts Manager x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/updateGroupAlertConfig x-xgen-operation-id-override: updateAlertConfig /api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs: get: description: '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.' externalDocs: description: Return All Alerts from One Project url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/listAlerts operationId: getGroupAlertAlertConfigs parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/pretty' - $ref: '#/components/parameters/includeCount' - $ref: '#/components/parameters/itemsPerPage' - $ref: '#/components/parameters/pageNum' - description: Unique 24-hexadecimal digit string that identifies the alert. in: path name: alertId required: true schema: pattern: ^([a-f0-9]{24})$ type: string responses: '200': content: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/PaginatedAlertConfigView' x-xgen-version: '2023-01-01' description: OK headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Return All Alert Configurations Set for One Alert tags: - Alert Configurations x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api alertConfigurations getAlertConfigs --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupAlertAlertConfigsApiParams{}\n\tsdkResp, httpResp, err := client.AlertConfigurationsApi.\n\t\tGetGroupAlertAlertConfigsWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs?pretty=true\"" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs?pretty=true\"" x-rolesRequirements: - Project Read Only x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/getGroupAlertAlertConfigs x-xgen-operation-id-override: getAlertConfigs components: schemas: ServerlessEventTypeViewAlertable: description: Event type that triggers an alert. enum: - OUTSIDE_SERVERLESS_METRIC_THRESHOLD example: OUTSIDE_SERVERLESS_METRIC_THRESHOLD externalDocs: description: Atlas Alert Event Types url: https://www.mongodb.com/docs/atlas/reference/atlas-alert-event-types/ title: Serverless Event Types type: string SystemMemoryUsedDataMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/DataMetricUnits' required: - metricName type: object DocumentInsertedRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object DataMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/DataMetricUnits' required: - metricName type: object FlexOpCounterGetMoreRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object AvgReadExecutionTimeTimeMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/TimeMetricUnits' required: - metricName type: object ServerlessOpCounterGetMoreRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object MaxSystemNetworkInDataMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/DataMetricUnits' required: - metricName type: object MaxDiskPartitionReadIopsIndexRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object AppServiceMetricMatcherField: description: 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. enum: - APPLICATION_ID example: APPLICATION_ID title: App Services Metric Matcher Fields type: string FtsDiskUtilizationDataMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/DataMetricUnits' required: - metricName type: object DiskPartitionSpaceUsedDataRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object SlackNotification: description: Slack notification configuration for MongoDB Cloud to send information when an event triggers an alert condition. properties: apiToken: description: "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. \n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API." example: '**********************************************************************abcd' type: string channelName: description: 'Name of the Slack channel to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `"notifications.[n].typeName" : "SLACK"`.' example: alerts type: string delayMin: description: Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification. format: int32 type: integer integrationId: description: The id of the associated integration, the credentials of which to use for requests. example: 32b6e34b3d91647abb20e7b8 type: string intervalMin: description: '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.' format: int32 minimum: 5 type: integer notifierId: description: 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. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ type: string typeName: description: Human-readable label that displays the alert notification type. enum: - SLACK type: string required: - typeName title: Slack Notification type: object RawMetricUnits: default: RAW description: Element used to express the quantity. This can be an element of time, storage capacity, and the like. enum: - RAW title: Raw Metric Units type: string AlertsToggle: description: Enables or disables the specified alert configuration in the specified project. properties: enabled: description: Flag that indicates whether to enable or disable the specified alert configuration in the specified project. type: boolean title: Toggle Request type: object CacheBytesWrittenFromDataMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/DataMetricUnits' required: - metricName type: object CursorsTotalOpenRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object GlobalPageFaultExceptionsThrownRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object CpsBackupEventTypeViewForNdsGroupAlertableWithThreshold: description: Event type that triggers an alert. enum: - CPS_SNAPSHOT_BEHIND - CPS_PREV_SNAPSHOT_OLD - CPS_OPLOG_BEHIND example: CPS_SNAPSHOT_BEHIND externalDocs: description: Atlas Alert Event Types url: https://www.mongodb.com/docs/atlas/reference/atlas-alert-event-types/ title: Cps Backup Event Type type: string QueryExecutorScannedRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object HostMetricThreshold: description: 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. discriminator: mapping: ASSERT_MSG: '#/components/schemas/AssertMsgRawMetricThresholdView' ASSERT_REGULAR: '#/components/schemas/AssertRegularRawMetricThresholdView' ASSERT_USER: '#/components/schemas/AssertUserRawMetricThresholdView' ASSERT_WARNING: '#/components/schemas/AssertWarningRawMetricThresholdView' AVG_COMMAND_EXECUTION_TIME: '#/components/schemas/AvgCommandExecutionTimeTimeMetricThresholdView' AVG_READ_EXECUTION_TIME: '#/components/schemas/AvgReadExecutionTimeTimeMetricThresholdView' AVG_WRITE_EXECUTION_TIME: '#/components/schemas/AvgWriteExecutionTimeTimeMetricThresholdView' BACKGROUND_FLUSH_AVG: '#/components/schemas/TimeMetricThresholdView' CACHE_BYTES_READ_INTO: '#/components/schemas/CacheBytesReadIntoDataMetricThresholdView' CACHE_BYTES_WRITTEN_FROM: '#/components/schemas/CacheBytesWrittenFromDataMetricThresholdView' CACHE_USAGE_DIRTY: '#/components/schemas/CacheUsageDirtyDataMetricThresholdView' CACHE_USAGE_USED: '#/components/schemas/CacheUsageUsedDataMetricThresholdView' COMPUTED_MEMORY: '#/components/schemas/ComputedMemoryDataMetricThresholdView' CONNECTIONS: '#/components/schemas/ConnectionsRawMetricThresholdView' CONNECTIONS_MAX: '#/components/schemas/ConnectionsMaxRawMetricThresholdView' CONNECTIONS_PERCENT: '#/components/schemas/ConnectionsPercentRawMetricThresholdView' CURSORS_TOTAL_CLIENT_CURSORS_SIZE: '#/components/schemas/CursorsTotalClientCursorsSizeRawMetricThresholdView' CURSORS_TOTAL_OPEN: '#/components/schemas/CursorsTotalOpenRawMetricThresholdView' CURSORS_TOTAL_TIMED_OUT: '#/components/schemas/CursorsTotalTimedOutRawMetricThresholdView' DB_DATA_SIZE_TOTAL: '#/components/schemas/DbDataSizeTotalDataMetricThresholdView' DB_DATA_SIZE_TOTAL_WO_SYSTEM: '#/components/schemas/DbDataSizeTotalWoSystemDataMetricThresholdView' DB_INDEX_SIZE_TOTAL: '#/components/schemas/DbIndexSizeTotalDataMetricThresholdView' DB_STORAGE_TOTAL: '#/components/schemas/DbStorageTotalDataMetricThresholdView' DISK_PARTITION_QUEUE_DEPTH_DATA: '#/components/schemas/DiskPartitionQueueDepthDataRawMetricThresholdView' DISK_PARTITION_QUEUE_DEPTH_INDEX: '#/components/schemas/DiskPartitionQueueDepthIndexRawMetricThresholdView' DISK_PARTITION_QUEUE_DEPTH_JOURNAL: '#/components/schemas/DiskPartitionQueueDepthJournalRawMetricThresholdView' DISK_PARTITION_READ_IOPS_DATA: '#/components/schemas/DiskPartitionReadIopsDataRawMetricThresholdView' DISK_PARTITION_READ_IOPS_INDEX: '#/components/schemas/DiskPartitionReadIopsIndexRawMetricThresholdView' DISK_PARTITION_READ_IOPS_JOURNAL: '#/components/schemas/DiskPartitionReadIopsJournalRawMetricThresholdView' DISK_PARTITION_READ_LATENCY_DATA: '#/components/schemas/DiskPartitionReadLatencyDataTimeMetricThresholdView' DISK_PARTITION_READ_LATENCY_INDEX: '#/components/schemas/DiskPartitionReadLatencyIndexTimeMetricThresholdView' DISK_PARTITION_READ_LATENCY_JOURNAL: '#/components/schemas/DiskPartitionReadLatencyJournalTimeMetricThresholdView' DISK_PARTITION_SPACE_USED_DATA: '#/components/schemas/DiskPartitionSpaceUsedDataRawMetricThresholdView' DISK_PARTITION_SPACE_USED_INDEX: '#/components/schemas/DiskPartitionSpaceUsedIndexRawMetricThresholdView' DISK_PARTITION_SPACE_USED_JOURNAL: '#/components/schemas/DiskPartitionSpaceUsedJournalRawMetricThresholdView' DISK_PARTITION_WRITE_IOPS_DATA: '#/components/schemas/DiskPartitionWriteIopsDataRawMetricThresholdView' DISK_PARTITION_WRITE_IOPS_INDEX: '#/components/schemas/DiskPartitionWriteIopsIndexRawMetricThresholdView' DISK_PARTITION_WRITE_IOPS_JOURNAL: '#/components/schemas/DiskPartitionWriteIopsJournalRawMetricThresholdView' DISK_PARTITION_WRITE_LATENCY_DATA: '#/components/schemas/DiskPartitionWriteLatencyDataTimeMetricThresholdView' DISK_PARTITION_WRITE_LATENCY_INDEX: '#/components/schemas/DiskPartitionWriteLatencyIndexTimeMetricThresholdView' DISK_PARTITION_WRITE_LATENCY_JOURNAL: '#/components/schemas/DiskPartitionWriteLatencyJournalTimeMetricThresholdView' DOCUMENT_DELETED: '#/components/schemas/DocumentDeletedRawMetricThresholdView' DOCUMENT_INSERTED: '#/components/schemas/DocumentInsertedRawMetricThresholdView' DOCUMENT_RETURNED: '#/components/schemas/DocumentReturnedRawMetricThresholdView' DOCUMENT_UPDATED: '#/components/schemas/DocumentUpdatedRawMetricThresholdView' EXTRA_INFO_PAGE_FAULTS: '#/components/schemas/ExtraInfoPageFaultsRawMetricThresholdView' FTS_DISK_UTILIZATION: '#/components/schemas/FtsDiskUtilizationDataMetricThresholdView' FTS_JVM_CURRENT_MEMORY: '#/components/schemas/FtsJvmCurrentMemoryDataMetricThresholdView' FTS_JVM_MAX_MEMORY: '#/components/schemas/FtsJvmMaxMemoryDataMetricThresholdView' FTS_MEMORY_MAPPED: '#/components/schemas/FtsMemoryMappedDataMetricThresholdView' FTS_MEMORY_RESIDENT: '#/components/schemas/FtsMemoryResidentDataMetricThresholdView' FTS_MEMORY_VIRTUAL: '#/components/schemas/FtsMemoryVirtualDataMetricThresholdView' FTS_PROCESS_CPU_KERNEL: '#/components/schemas/FtsProcessCpuKernelRawMetricThresholdView' FTS_PROCESS_CPU_USER: '#/components/schemas/FtsProcessCpuUserRawMetricThresholdView' GLOBAL_ACCESSES_NOT_IN_MEMORY: '#/components/schemas/GlobalAccessesNotInMemoryRawMetricThresholdView' GLOBAL_LOCK_CURRENT_QUEUE_READERS: '#/components/schemas/GlobalLockCurrentQueueReadersRawMetricThresholdView' GLOBAL_LOCK_CURRENT_QUEUE_TOTAL: '#/components/schemas/GlobalLockCurrentQueueTotalRawMetricThresholdView' GLOBAL_LOCK_CURRENT_QUEUE_WRITERS: '#/components/schemas/GlobalLockCurrentQueueWritersRawMetricThresholdView' GLOBAL_LOCK_PERCENTAGE: '#/components/schemas/GlobalLockPercentageRawMetricThresholdView' GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN: '#/components/schemas/GlobalPageFaultExceptionsThrownRawMetricThresholdView' INDEX_COUNTERS_BTREE_ACCESSES: '#/components/schemas/IndexCountersBtreeAccessesRawMetricThresholdView' INDEX_COUNTERS_BTREE_HITS: '#/components/schemas/IndexCountersBtreeHitsRawMetricThresholdView' INDEX_COUNTERS_BTREE_MISSES: '#/components/schemas/IndexCountersBtreeMissesRawMetricThresholdView' INDEX_COUNTERS_BTREE_MISS_RATIO: '#/components/schemas/IndexCountersBtreeMissRatioRawMetricThresholdView' JOURNALING_COMMITS_IN_WRITE_LOCK: '#/components/schemas/JournalingCommitsInWriteLockRawMetricThresholdView' JOURNALING_MB: '#/components/schemas/JournalingMbDataMetricThresholdView' JOURNALING_WRITE_DATA_FILES_MB: '#/components/schemas/JournalingWriteDataFilesMbDataMetricThresholdView' LOGICAL_SIZE: '#/components/schemas/LogicalSizeDataMetricThresholdView' MAX_DISK_PARTITION_QUEUE_DEPTH_DATA: '#/components/schemas/MaxDiskPartitionQueueDepthDataRawMetricThresholdView' MAX_DISK_PARTITION_QUEUE_DEPTH_INDEX: '#/components/schemas/MaxDiskPartitionQueueDepthIndexRawMetricThresholdView' MAX_DISK_PARTITION_QUEUE_DEPTH_JOURNAL: '#/components/schemas/MaxDiskPartitionQueueDepthJournalRawMetricThresholdView' MAX_DISK_PARTITION_READ_IOPS_DATA: '#/components/schemas/MaxDiskPartitionReadIopsDataRawMetricThresholdView' MAX_DISK_PARTITION_READ_IOPS_INDEX: '#/components/schemas/MaxDiskPartitionReadIopsIndexRawMetricThresholdView' MAX_DISK_PARTITION_READ_IOPS_JOURNAL: '#/components/schemas/MaxDiskPartitionReadIopsJournalRawMetricThresholdView' MAX_DISK_PARTITION_READ_LATENCY_DATA: '#/components/schemas/MaxDiskPartitionReadLatencyDataTimeMetricThresholdView' MAX_DISK_PARTITION_READ_LATENCY_INDEX: '#/components/schemas/MaxDiskPartitionReadLatencyIndexTimeMetricThresholdView' MAX_DISK_PARTITION_READ_LATENCY_JOURNAL: '#/components/schemas/MaxDiskPartitionReadLatencyJournalTimeMetricThresholdView' MAX_DISK_PARTITION_SPACE_USED_DATA: '#/components/schemas/MaxDiskPartitionSpaceUsedDataRawMetricThresholdView' MAX_DISK_PARTITION_SPACE_USED_INDEX: '#/components/schemas/MaxDiskPartitionSpaceUsedIndexRawMetricThresholdView' MAX_DISK_PARTITION_SPACE_USED_JOURNAL: '#/components/schemas/MaxDiskPartitionSpaceUsedJournalRawMetricThresholdView' MAX_DISK_PARTITION_WRITE_IOPS_DATA: '#/components/schemas/MaxDiskPartitionWriteIopsDataRawMetricThresholdView' MAX_DISK_PARTITION_WRITE_IOPS_INDEX: '#/components/schemas/MaxDiskPartitionWriteIopsIndexRawMetricThresholdView' MAX_DISK_PARTITION_WRITE_IOPS_JOURNAL: '#/components/schemas/MaxDiskPartitionWriteIopsJournalRawMetricThresholdView' MAX_DISK_PARTITION_WRITE_LATENCY_DATA: '#/components/schemas/MaxDiskPartitionWriteLatencyDataTimeMetricThresholdView' MAX_DISK_PARTITION_WRITE_LATENCY_INDEX: '#/components/schemas/MaxDiskPartitionWriteLatencyIndexTimeMetricThresholdView' MAX_DISK_PARTITION_WRITE_LATENCY_JOURNAL: '#/components/schemas/MaxDiskPartitionWriteLatencyJournalTimeMetricThresholdView' MAX_NORMALIZED_SYSTEM_CPU_STEAL: '#/components/schemas/MaxNormalizedSystemCpuStealRawMetricThresholdView' MAX_NORMALIZED_SYSTEM_CPU_USER: '#/components/schemas/MaxNormalizedSystemCpuUserRawMetricThresholdView' MAX_SWAP_USAGE_FREE: '#/components/schemas/MaxSwapUsageFreeDataMetricThresholdView' MAX_SWAP_USAGE_USED: '#/components/schemas/MaxSwapUsageUsedDataMetricThresholdView' MAX_SYSTEM_MEMORY_AVAILABLE: '#/components/schemas/MaxSystemMemoryAvailableDataMetricThresholdView' MAX_SYSTEM_MEMORY_PERCENT_USED: '#/components/schemas/MaxSystemMemoryPercentUsedRawMetricThresholdView' MAX_SYSTEM_MEMORY_USED: '#/components/schemas/MaxSystemMemoryUsedDataMetricThresholdView' MAX_SYSTEM_NETWORK_IN: '#/components/schemas/MaxSystemNetworkInDataMetricThresholdView' MAX_SYSTEM_NETWORK_OUT: '#/components/schemas/MaxSystemNetworkOutDataMetricThresholdView' MEMORY_MAPPED: '#/components/schemas/MemoryMappedDataMetricThresholdView' MEMORY_RESIDENT: '#/components/schemas/MemoryResidentDataMetricThresholdView' MEMORY_VIRTUAL: '#/components/schemas/MemoryVirtualDataMetricThresholdView' MUNIN_CPU_IOWAIT: '#/components/schemas/MuninCpuIowaitRawMetricThresholdView' MUNIN_CPU_IRQ: '#/components/schemas/MuninCpuIrqRawMetricThresholdView' MUNIN_CPU_NICE: '#/components/schemas/MuninCpuNiceRawMetricThresholdView' MUNIN_CPU_SOFTIRQ: '#/components/schemas/MuninCpuSoftirqRawMetricThresholdView' MUNIN_CPU_STEAL: '#/components/schemas/MuninCpuStealRawMetricThresholdView' MUNIN_CPU_SYSTEM: '#/components/schemas/MuninCpuSystemRawMetricThresholdView' MUNIN_CPU_USER: '#/components/schemas/MuninCpuUserRawMetricThresholdView' NETWORK_BYTES_IN: '#/components/schemas/NetworkBytesInDataMetricThresholdView' NETWORK_BYTES_OUT: '#/components/schemas/NetworkBytesOutDataMetricThresholdView' NETWORK_NUM_REQUESTS: '#/components/schemas/NetworkNumRequestsRawMetricThresholdView' NORMALIZED_FTS_PROCESS_CPU_KERNEL: '#/components/schemas/NormalizedFtsProcessCpuKernelRawMetricThresholdView' NORMALIZED_FTS_PROCESS_CPU_USER: '#/components/schemas/NormalizedFtsProcessCpuUserRawMetricThresholdView' NORMALIZED_SYSTEM_CPU_STEAL: '#/components/schemas/NormalizedSystemCpuStealRawMetricThresholdView' NORMALIZED_SYSTEM_CPU_USER: '#/components/schemas/NormalizedSystemCpuUserRawMetricThresholdView' OPCOUNTER_CMD: '#/components/schemas/OpCounterCmdRawMetricThresholdView' OPCOUNTER_DELETE: '#/components/schemas/OpCounterDeleteRawMetricThresholdView' OPCOUNTER_GETMORE: '#/components/schemas/OpCounterGetMoreRawMetricThresholdView' OPCOUNTER_INSERT: '#/components/schemas/OpCounterInsertRawMetricThresholdView' OPCOUNTER_QUERY: '#/components/schemas/OpCounterQueryRawMetricThresholdView' OPCOUNTER_REPL_CMD: '#/components/schemas/OpCounterReplCmdRawMetricThresholdView' OPCOUNTER_REPL_DELETE: '#/components/schemas/OpCounterReplDeleteRawMetricThresholdView' OPCOUNTER_REPL_INSERT: '#/components/schemas/OpCounterReplInsertRawMetricThresholdView' OPCOUNTER_REPL_UPDATE: '#/components/schemas/OpCounterReplUpdateRawMetricThresholdView' OPCOUNTER_TTL_DELETED: '#/components/schemas/OpCounterTtlDeletedRawMetricThresholdView' OPCOUNTER_UPDATE: '#/components/schemas/OpCounterUpdateRawMetricThresholdView' OPERATIONS_QUERIES_KILLED: '#/components/schemas/OperationsQueriesKilledRawMetricThresholdView' OPERATIONS_SCAN_AND_ORDER: '#/components/schemas/OperationsScanAndOrderRawMetricThresholdView' OPERATION_THROTTLING_REJECTED_OPERATIONS: '#/components/schemas/OperationThrottlingRejectedOperationsRawMetricThresholdView' OPLOG_MASTER_LAG_TIME_DIFF: '#/components/schemas/OplogMasterLagTimeDiffTimeMetricThresholdView' OPLOG_MASTER_TIME: '#/components/schemas/OplogMasterTimeTimeMetricThresholdView' OPLOG_MASTER_TIME_ESTIMATED_TTL: '#/components/schemas/OplogMasterTimeEstimatedTtlTimeMetricThresholdView' OPLOG_RATE_GB_PER_HOUR: '#/components/schemas/OplogRateGbPerHourDataMetricThresholdView' OPLOG_SLAVE_LAG_MASTER_TIME: '#/components/schemas/OplogSlaveLagMasterTimeTimeMetricThresholdView' QUERY_EXECUTOR_SCANNED: '#/components/schemas/QueryExecutorScannedRawMetricThresholdView' QUERY_EXECUTOR_SCANNED_OBJECTS: '#/components/schemas/QueryExecutorScannedObjectsRawMetricThresholdView' QUERY_SPILL_TO_DISK_DURING_SORT: '#/components/schemas/QuerySpillToDiskDuringSortRawMetricThresholdView' QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED: '#/components/schemas/QueryTargetingScannedObjectsPerReturnedRawMetricThresholdView' QUERY_TARGETING_SCANNED_PER_RETURNED: '#/components/schemas/QueryTargetingScannedPerReturnedRawMetricThresholdView' RESTARTS_IN_LAST_HOUR: '#/components/schemas/RestartsInLastHourRawMetricThresholdView' SEARCH_INDEX_SIZE: '#/components/schemas/SearchIndexSizeDataMetricThresholdView' SEARCH_MAX_FIELDS_INDEXED: '#/components/schemas/SearchMaxFieldsIndexedRawMetricThresholdView' SEARCH_MAX_NGRAM_FIELDS_INDEXED: '#/components/schemas/SearchMaxNgramFieldsIndexedRawMetricThresholdView' SEARCH_MAX_NUMBER_OF_LUCENE_DOCS: '#/components/schemas/NumberMetricThresholdView' SEARCH_NUMBER_OF_FIELDS_IN_INDEX: '#/components/schemas/SearchNumberOfFieldsInIndexRawMetricThresholdView' SEARCH_NUMBER_OF_QUERIES_ERROR: '#/components/schemas/SearchNumberOfQueriesErrorRawMetricThresholdView' SEARCH_NUMBER_OF_QUERIES_SUCCESS: '#/components/schemas/SearchNumberOfQueriesSuccessRawMetricThresholdView' SEARCH_NUMBER_OF_QUERIES_TOTAL: '#/components/schemas/SearchNumberOfQueriesTotalRawMetricThresholdView' SEARCH_OPCOUNTER_DELETE: '#/components/schemas/SearchOpCounterDeleteRawMetricThresholdView' SEARCH_OPCOUNTER_GETMORE: '#/components/schemas/SearchOpCounterGetMoreRawMetricThresholdView' SEARCH_OPCOUNTER_INSERT: '#/components/schemas/SearchOpCounterInsertRawMetricThresholdView' SEARCH_OPCOUNTER_UPDATE: '#/components/schemas/SearchOpCounterUpdateRawMetricThresholdView' SEARCH_PROCESS_THROTTLING: '#/components/schemas/SearchProcessThrottlingRawMetricThresholdView' SEARCH_REPLICATION_LAG: '#/components/schemas/SearchReplicationLagTimeMetricThresholdView' SWAP_USAGE_FREE: '#/components/schemas/SwapUsageFreeDataMetricThresholdView' SWAP_USAGE_USED: '#/components/schemas/SwapUsageUsedDataMetricThresholdView' SYSTEM_MEMORY_AVAILABLE: '#/components/schemas/SystemMemoryAvailableDataMetricThresholdView' SYSTEM_MEMORY_PERCENT_USED: '#/components/schemas/SystemMemoryPercentUsedRawMetricThresholdView' SYSTEM_MEMORY_USED: '#/components/schemas/SystemMemoryUsedDataMetricThresholdView' SYSTEM_NETWORK_IN: '#/components/schemas/SystemNetworkInDataMetricThresholdView' SYSTEM_NETWORK_OUT: '#/components/schemas/SystemNetworkOutDataMetricThresholdView' TICKETS_AVAILABLE_READS: '#/components/schemas/TicketsAvailableReadsRawMetricThresholdView' TICKETS_AVAILABLE_WRITES: '#/components/schemas/TicketsAvailableWritesRawMetricThresholdView' propertyName: metricName oneOf: - $ref: '#/components/schemas/AssertRegularRawMetricThresholdView' - $ref: '#/components/schemas/AssertWarningRawMetricThresholdView' - $ref: '#/components/schemas/AssertMsgRawMetricThresholdView' - $ref: '#/components/schemas/AssertUserRawMetricThresholdView' - $ref: '#/components/schemas/OpCounterCmdRawMetricThresholdView' - $ref: '#/components/schemas/OpCounterQueryRawMetricThresholdView' - $ref: '#/components/schemas/OpCounterUpdateRawMetricThresholdView' - $ref: '#/components/schemas/OpCounterDeleteRawMetricThresholdView' - $ref: '#/components/schemas/OpCounterTtlDeletedRawMetricThresholdView' - $ref: '#/components/schemas/OpCounterInsertRawMetricThresholdView' - $ref: '#/components/schemas/OpCounterGetMoreRawMetricThresholdView' - $ref: '#/components/schemas/OpCounterReplCmdRawMetricThresholdView' - $ref: '#/components/schemas/OpCounterReplUpdateRawMetricThresholdView' - $ref: '#/components/schemas/OpCounterReplDeleteRawMetricThresholdView' - $ref: '#/components/schemas/OpCounterReplInsertRawMetricThresholdView' - $ref: '#/components/schemas/FtsMemoryResidentDataMetricThresholdView' - $ref: '#/components/schemas/FtsMemoryVirtualDataMetricThresholdView' - $ref: '#/components/schemas/FtsMemoryMappedDataMetricThresholdView' - $ref: '#/components/schemas/FtsProcessCpuUserRawMetricThresholdView' - $ref: '#/components/schemas/FtsProcessCpuKernelRawMetricThresholdView' - $ref: '#/components/schemas/NormalizedFtsProcessCpuUserRawMetricThresholdView' - $ref: '#/components/schemas/NormalizedFtsProcessCpuKernelRawMetricThresholdView' - $ref: '#/components/schemas/SystemMemoryPercentUsedRawMetricThresholdView' - $ref: '#/components/schemas/MemoryResidentDataMetricThresholdView' - $ref: '#/components/schemas/MemoryVirtualDataMetricThresholdView' - $ref: '#/components/schemas/MemoryMappedDataMetricThresholdView' - $ref: '#/components/schemas/ComputedMemoryDataMetricThresholdView' - $ref: '#/components/schemas/IndexCountersBtreeAccessesRawMetricThresholdView' - $ref: '#/components/schemas/IndexCountersBtreeHitsRawMetricThresholdView' - $ref: '#/components/schemas/IndexCountersBtreeMissesRawMetricThresholdView' - $ref: '#/components/schemas/IndexCountersBtreeMissRatioRawMetricThresholdView' - $ref: '#/components/schemas/GlobalLockPercentageRawMetricThresholdView' - $ref: '#/components/schemas/TimeMetricThresholdView' - $ref: '#/components/schemas/ConnectionsRawMetricThresholdView' - $ref: '#/components/schemas/ConnectionsMaxRawMetricThresholdView' - $ref: '#/components/schemas/ConnectionsPercentRawMetricThresholdView' - $ref: '#/components/schemas/GlobalAccessesNotInMemoryRawMetricThresholdView' - $ref: '#/components/schemas/GlobalPageFaultExceptionsThrownRawMetricThresholdView' - $ref: '#/components/schemas/GlobalLockCurrentQueueTotalRawMetricThresholdView' - $ref: '#/components/schemas/GlobalLockCurrentQueueReadersRawMetricThresholdView' - $ref: '#/components/schemas/GlobalLockCurrentQueueWritersRawMetricThresholdView' - $ref: '#/components/schemas/CursorsTotalOpenRawMetricThresholdView' - $ref: '#/components/schemas/CursorsTotalTimedOutRawMetricThresholdView' - $ref: '#/components/schemas/CursorsTotalClientCursorsSizeRawMetricThresholdView' - $ref: '#/components/schemas/NetworkBytesInDataMetricThresholdView' - $ref: '#/components/schemas/NetworkBytesOutDataMetricThresholdView' - $ref: '#/components/schemas/NetworkNumRequestsRawMetricThresholdView' - $ref: '#/components/schemas/OplogMasterTimeTimeMetricThresholdView' - $ref: '#/components/schemas/OplogMasterTimeEstimatedTtlTimeMetricThresholdView' - $ref: '#/components/schemas/OplogSlaveLagMasterTimeTimeMetricThresholdView' - $ref: '#/components/schemas/OplogMasterLagTimeDiffTimeMetricThresholdView' - $ref: '#/components/schemas/OplogRateGbPerHourDataMetricThresholdView' - $ref: '#/components/schemas/ExtraInfoPageFaultsRawMetricThresholdView' - $ref: '#/components/schemas/DbStorageTotalDataMetricThresholdView' - $ref: '#/components/schemas/DbDataSizeTotalDataMetricThresholdView' - $ref: '#/components/schemas/DbDataSizeTotalWoSystemDataMetricThresholdView' - $ref: '#/components/schemas/DbIndexSizeTotalDataMetricThresholdView' - $ref: '#/components/schemas/JournalingCommitsInWriteLockRawMetricThresholdView' - $ref: '#/components/schemas/JournalingMbDataMetricThresholdView' - $ref: '#/components/schemas/JournalingWriteDataFilesMbDataMetricThresholdView' - $ref: '#/components/schemas/TicketsAvailableReadsRawMetricThresholdView' - $ref: '#/components/schemas/TicketsAvailableWritesRawMetricThresholdView' - $ref: '#/components/schemas/CacheUsageDirtyDataMetricThresholdView' - $ref: '#/components/schemas/CacheUsageUsedDataMetricThresholdView' - $ref: '#/components/schemas/CacheBytesReadIntoDataMetricThresholdView' - $ref: '#/components/schemas/CacheBytesWrittenFromDataMetricThresholdView' - $ref: '#/components/schemas/NormalizedSystemCpuUserRawMetricThresholdView' - $ref: '#/components/schemas/NormalizedSystemCpuStealRawMetricThresholdView' - $ref: '#/components/schemas/DiskPartitionSpaceUsedDataRawMetricThresholdView' - $ref: '#/components/schemas/DiskPartitionSpaceUsedIndexRawMetricThresholdView' - $ref: '#/components/schemas/DiskPartitionSpaceUsedJournalRawMetricThresholdView' - $ref: '#/components/schemas/DiskPartitionReadIopsDataRawMetricThresholdView' - $ref: '#/components/schemas/DiskPartitionReadIopsIndexRawMetricThresholdView' - $ref: '#/components/schemas/DiskPartitionReadIopsJournalRawMetricThresholdView' - $ref: '#/components/schemas/DiskPartitionWriteIopsDataRawMetricThresholdView' - $ref: '#/components/schemas/DiskPartitionWriteIopsIndexRawMetricThresholdView' - $ref: '#/components/schemas/DiskPartitionWriteIopsJournalRawMetricThresholdView' - $ref: '#/components/schemas/DiskPartitionReadLatencyDataTimeMetricThresholdView' - $ref: '#/components/schemas/DiskPartitionReadLatencyIndexTimeMetricThresholdView' - $ref: '#/components/schemas/DiskPartitionReadLatencyJournalTimeMetricThresholdView' - $ref: '#/components/schemas/DiskPartitionWriteLatencyDataTimeMetricThresholdView' - $ref: '#/components/schemas/DiskPartitionWriteLatencyIndexTimeMetricThresholdView' - $ref: '#/components/schemas/DiskPartitionWriteLatencyJournalTimeMetricThresholdView' - $ref: '#/components/schemas/DiskPartitionQueueDepthDataRawMetricThresholdView' - $ref: '#/components/schemas/DiskPartitionQueueDepthIndexRawMetricThresholdView' - $ref: '#/components/schemas/DiskPartitionQueueDepthJournalRawMetricThresholdView' - $ref: '#/components/schemas/FtsDiskUtilizationDataMetricThresholdView' - $ref: '#/components/schemas/MuninCpuUserRawMetricThresholdView' - $ref: '#/components/schemas/MuninCpuNiceRawMetricThresholdView' - $ref: '#/components/schemas/MuninCpuSystemRawMetricThresholdView' - $ref: '#/components/schemas/MuninCpuIowaitRawMetricThresholdView' - $ref: '#/components/schemas/MuninCpuIrqRawMetricThresholdView' - $ref: '#/components/schemas/MuninCpuSoftirqRawMetricThresholdView' - $ref: '#/components/schemas/MuninCpuStealRawMetricThresholdView' - $ref: '#/components/schemas/DocumentReturnedRawMetricThresholdView' - $ref: '#/components/schemas/DocumentInsertedRawMetricThresholdView' - $ref: '#/components/schemas/DocumentUpdatedRawMetricThresholdView' - $ref: '#/components/schemas/DocumentDeletedRawMetricThresholdView' - $ref: '#/components/schemas/OperationsScanAndOrderRawMetricThresholdView' - $ref: '#/components/schemas/QueryExecutorScannedRawMetricThresholdView' - $ref: '#/components/schemas/QueryExecutorScannedObjectsRawMetricThresholdView' - $ref: '#/components/schemas/OperationThrottlingRejectedOperationsRawMetricThresholdView' - $ref: '#/components/schemas/QuerySpillToDiskDuringSortRawMetricThresholdView' - $ref: '#/components/schemas/OperationsQueriesKilledRawMetricThresholdView' - $ref: '#/components/schemas/QueryTargetingScannedPerReturnedRawMetricThresholdView' - $ref: '#/components/schemas/QueryTargetingScannedObjectsPerReturnedRawMetricThresholdView' - $ref: '#/components/schemas/AvgReadExecutionTimeTimeMetricThresholdView' - $ref: '#/components/schemas/AvgWriteExecutionTimeTimeMetricThresholdView' - $ref: '#/components/schemas/AvgCommandExecutionTimeTimeMetricThresholdView' - $ref: '#/components/schemas/LogicalSizeDataMetricThresholdView' - $ref: '#/components/schemas/RestartsInLastHourRawMetricThresholdView' - $ref: '#/components/schemas/SystemMemoryUsedDataMetricThresholdView' - $ref: '#/components/schemas/SystemMemoryAvailableDataMetricThresholdView' - $ref: '#/components/schemas/SwapUsageUsedDataMetricThresholdView' - $ref: '#/components/schemas/SwapUsageFreeDataMetricThresholdView' - $ref: '#/components/schemas/SystemNetworkInDataMetricThresholdView' - $ref: '#/components/schemas/SystemNetworkOutDataMetricThresholdView' - $ref: '#/components/schemas/MaxNormalizedSystemCpuUserRawMetricThresholdView' - $ref: '#/components/schemas/MaxNormalizedSystemCpuStealRawMetricThresholdView' - $ref: '#/components/schemas/MaxDiskPartitionSpaceUsedDataRawMetricThresholdView' - $ref: '#/components/schemas/MaxDiskPartitionSpaceUsedIndexRawMetricThresholdView' - $ref: '#/components/schemas/MaxDiskPartitionSpaceUsedJournalRawMetricThresholdView' - $ref: '#/components/schemas/MaxDiskPartitionReadIopsDataRawMetricThresholdView' - $ref: '#/components/schemas/MaxDiskPartitionReadIopsIndexRawMetricThresholdView' - $ref: '#/components/schemas/MaxDiskPartitionReadIopsJournalRawMetricThresholdView' - $ref: '#/components/schemas/MaxDiskPartitionWriteIopsDataRawMetricThresholdView' - $ref: '#/components/schemas/MaxDiskPartitionWriteIopsIndexRawMetricThresholdView' - $ref: '#/components/schemas/MaxDiskPartitionWriteIopsJournalRawMetricThresholdView' - $ref: '#/components/schemas/MaxDiskPartitionReadLatencyDataTimeMetricThresholdView' - $ref: '#/components/schemas/MaxDiskPartitionReadLatencyIndexTimeMetricThresholdView' - $ref: '#/components/schemas/MaxDiskPartitionReadLatencyJournalTimeMetricThresholdView' - $ref: '#/components/schemas/MaxDiskPartitionWriteLatencyDataTimeMetricThresholdView' - $ref: '#/components/schemas/MaxDiskPartitionWriteLatencyIndexTimeMetricThresholdView' - $ref: '#/components/schemas/MaxDiskPartitionWriteLatencyJournalTimeMetricThresholdView' - $ref: '#/components/schemas/MaxDiskPartitionQueueDepthDataRawMetricThresholdView' - $ref: '#/components/schemas/MaxDiskPartitionQueueDepthIndexRawMetricThresholdView' - $ref: '#/components/schemas/MaxDiskPartitionQueueDepthJournalRawMetricThresholdView' - $ref: '#/components/schemas/MaxSystemMemoryPercentUsedRawMetricThresholdView' - $ref: '#/components/schemas/MaxSystemMemoryUsedDataMetricThresholdView' - $ref: '#/components/schemas/MaxSystemMemoryAvailableDataMetricThresholdView' - $ref: '#/components/schemas/MaxSwapUsageUsedDataMetricThresholdView' - $ref: '#/components/schemas/MaxSwapUsageFreeDataMetricThresholdView' - $ref: '#/components/schemas/MaxSystemNetworkInDataMetricThresholdView' - $ref: '#/components/schemas/MaxSystemNetworkOutDataMetricThresholdView' - $ref: '#/components/schemas/SearchIndexSizeDataMetricThresholdView' - $ref: '#/components/schemas/SearchMaxFieldsIndexedRawMetricThresholdView' - $ref: '#/components/schemas/SearchProcessThrottlingRawMetricThresholdView' - $ref: '#/components/schemas/SearchNumberOfFieldsInIndexRawMetricThresholdView' - $ref: '#/components/schemas/SearchMaxNgramFieldsIndexedRawMetricThresholdView' - $ref: '#/components/schemas/SearchReplicationLagTimeMetricThresholdView' - $ref: '#/components/schemas/NumberMetricThresholdView' - $ref: '#/components/schemas/SearchOpCounterInsertRawMetricThresholdView' - $ref: '#/components/schemas/SearchOpCounterDeleteRawMetricThresholdView' - $ref: '#/components/schemas/SearchOpCounterUpdateRawMetricThresholdView' - $ref: '#/components/schemas/SearchOpCounterGetMoreRawMetricThresholdView' - $ref: '#/components/schemas/SearchNumberOfQueriesTotalRawMetricThresholdView' - $ref: '#/components/schemas/SearchNumberOfQueriesErrorRawMetricThresholdView' - $ref: '#/components/schemas/SearchNumberOfQueriesSuccessRawMetricThresholdView' - $ref: '#/components/schemas/FtsJvmMaxMemoryDataMetricThresholdView' - $ref: '#/components/schemas/FtsJvmCurrentMemoryDataMetricThresholdView' properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: description: Element used to express the quantity. This can be an element of time, storage capacity, and the like. enum: - 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 - billion type: string required: - metricName title: Host Metric Threshold type: object ClusterMatcher: description: Rules to apply when comparing an cluster against this alert configuration. properties: fieldName: $ref: '#/components/schemas/ClusterMatcherField' operator: description: Comparison operator to apply when checking the current metric value against **matcher[n].value**. The `REGEX` operator only supports inclusive matches. Use the `NOT_CONTAINS` operator to exclude values. enum: - EQUALS - CONTAINS - STARTS_WITH - ENDS_WITH - NOT_EQUALS - NOT_CONTAINS - REGEX type: string value: description: Value to match or exceed using the specified `matchers.operator`. example: event-replica-set type: string required: - fieldName - operator - value title: Matchers type: object MaxSwapUsageUsedDataMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/DataMetricUnits' required: - metricName type: object ServerlessConnectionPercentageRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object VictorOpsNotification: description: VictorOps notification configuration for MongoDB Cloud to send information when an event triggers an alert condition. properties: delayMin: description: Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification. format: int32 type: integer integrationId: description: The id of the associated integration, the credentials of which to use for requests. example: 32b6e34b3d91647abb20e7b8 type: string intervalMin: description: '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.' format: int32 minimum: 5 type: integer notifierId: description: 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. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ type: string typeName: description: Human-readable label that displays the alert notification type. enum: - VICTOR_OPS type: string victorOpsApiKey: description: '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.' example: '********************************9abc' type: string victorOpsRoutingKey: description: '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.' example: test routing type: string required: - typeName title: VictorOps Notification type: object MaxDiskPartitionWriteLatencyIndexTimeMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/TimeMetricUnits' required: - metricName type: object FlexOpCounterInsertRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object ClusterMatcherField: description: 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. enum: - CLUSTER_NAME example: CLUSTER_NAME title: Cluster Matcher Fields type: string AssertRegularRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object HostMatcherField: description: 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. enum: - TYPE_NAME - HOSTNAME - PORT - HOSTNAME_AND_PORT - REPLICA_SET_NAME - ATLAS_NODE_TYPE example: HOSTNAME title: Host Matcher Fields type: string OpCounterReplInsertRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object SearchMaxNgramFieldsIndexedRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object MaxSystemMemoryPercentUsedRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object DocumentDeletedRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object CacheUsageDirtyDataMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/DataMetricUnits' required: - metricName type: object DeprecatedStreamProcessorMetricThreshold: deprecated: true description: 'Threshold value that triggers an alert. Deprecated: use `metricThreshold` instead.' discriminator: mapping: STREAM_PROCESSOR_CHANGE_STREAM_LAG: '#/components/schemas/TimeMetricThresholdView' STREAM_PROCESSOR_DLQ_MESSAGE_COUNT: '#/components/schemas/DLQRawMetricThresholdView' STREAM_PROCESSOR_KAFKA_LAG: '#/components/schemas/KafkaRawMetricThresholdView' STREAM_PROCESSOR_OUTPUT_MESSAGE_COUNT: '#/components/schemas/RawMetricThresholdView' propertyName: metricName oneOf: - $ref: '#/components/schemas/KafkaRawMetricThresholdView' - $ref: '#/components/schemas/TimeMetricThresholdView' - $ref: '#/components/schemas/DLQRawMetricThresholdView' - $ref: '#/components/schemas/RawMetricThresholdView' properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: description: Element used to express the quantity. This can be an element of time, storage capacity, and the like. enum: - 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 - billion type: string required: - metricName type: object OplogSlaveLagMasterTimeTimeMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/TimeMetricUnits' required: - metricName type: object AppServiceEventTypeViewAlertableNoThreshold: description: Event type that triggers an alert. enum: - URL_CONFIRMATION - SUCCESSFUL_DEPLOY - DEPLOYMENT_FAILURE - REQUEST_RATE_LIMIT - LOG_FORWARDER_FAILURE - SYNC_FAILURE - TRIGGER_FAILURE - TRIGGER_AUTO_RESUMED - DEPLOYMENT_MODEL_CHANGE_SUCCESS - DEPLOYMENT_MODEL_CHANGE_FAILURE example: DEPLOYMENT_FAILURE externalDocs: description: Atlas Alert Event Types url: https://www.mongodb.com/docs/atlas/reference/atlas-alert-event-types/ title: App Services Event Types type: string DocumentUpdatedRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object DiskPartitionSpaceUsedIndexRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object GlobalLockCurrentQueueTotalRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object GlobalAccessesNotInMemoryRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object OpCounterUpdateRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object SearchOpCounterUpdateRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object DiskPartitionReadIopsJournalRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object DbDataSizeTotalDataMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/DataMetricUnits' required: - metricName type: object OplogMasterTimeEstimatedTtlTimeMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/TimeMetricUnits' required: - metricName type: object CursorsTotalTimedOutRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object DiskPartitionQueueDepthIndexRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object AssertWarningRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object SearchOpCounterGetMoreRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object StreamsMatcher: description: Rules to apply when comparing a stream processing workspace or stream processor against this alert configuration. properties: fieldName: $ref: '#/components/schemas/StreamsMatcherField' operator: description: Comparison operator to apply when checking the current metric value against **matcher[n].value**. The `REGEX` operator only supports inclusive matches. Use the `NOT_CONTAINS` operator to exclude values. enum: - EQUALS - CONTAINS - STARTS_WITH - ENDS_WITH - NOT_EQUALS - NOT_CONTAINS - REGEX type: string value: description: Value to match or exceed using the specified `matchers.operator`. example: event-replica-set type: string required: - fieldName - operator - value title: Matchers type: object MuninCpuSoftirqRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object TimeMetricUnits: default: HOURS description: Element used to express the quantity. This can be an element of time, storage capacity, and the like. enum: - NANOSECONDS - MILLISECONDS - MILLION_MINUTES - SECONDS - MINUTES - HOURS - DAYS title: Time Metric Units type: string SystemNetworkOutDataMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/DataMetricUnits' required: - metricName type: object ConnectionsMaxRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object MaxSystemMemoryUsedDataMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/DataMetricUnits' required: - metricName type: object OperationsScanAndOrderRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object OpCounterDeleteRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object RPUMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/ServerlessMetricUnits' required: - metricName type: object HostMetricAlertConfigViewForNdsGroup: description: Host metric alert configuration allows to select which mongod host metrics trigger alerts and how users are notified. properties: created: description: Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 format: date-time readOnly: true type: string enabled: default: false description: Flag that indicates whether someone enabled this alert configuration for the specified project. type: boolean eventTypeName: $ref: '#/components/schemas/HostMetricEventTypeViewAlertable' groupId: description: Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string id: description: Unique 24-hexadecimal digit string that identifies this alert configuration. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string links: description: 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. externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: $ref: '#/components/schemas/Link' readOnly: true type: array matchers: description: 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. items: $ref: '#/components/schemas/HostMatcher' type: array metricThreshold: $ref: '#/components/schemas/HostMetricThreshold' notifications: description: List that contains the targets that MongoDB Cloud sends notifications. items: $ref: '#/components/schemas/AlertsNotificationRootForGroup' maxItems: 25 minItems: 1 type: array severityOverride: $ref: '#/components/schemas/EventSeverity' updated: description: Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 format: date-time readOnly: true type: string required: - eventTypeName - notifications title: Host Metric Alert Configuration type: object AppServiceEventTypeViewAlertableWithThreshold: description: Event type that triggers an alert. enum: - OUTSIDE_REALM_METRIC_THRESHOLD example: OUTSIDE_REALM_METRIC_THRESHOLD externalDocs: description: Atlas Alert Event Types url: https://www.mongodb.com/docs/atlas/reference/atlas-alert-event-types/ title: App Services Event Types type: string SystemMemoryAvailableDataMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/DataMetricUnits' required: - metricName type: object OplogMasterLagTimeDiffTimeMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/TimeMetricUnits' required: - metricName type: object StreamProcessorAlertConfigViewForNdsGroup: description: Host metric alert configuration allows to select which Atlas streams processors trigger alerts and how users are notified. properties: created: description: Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 format: date-time readOnly: true type: string enabled: default: false description: Flag that indicates whether someone enabled this alert configuration for the specified project. type: boolean eventTypeName: $ref: '#/components/schemas/StreamProcessorEventTypeViewAlertableNoThreshold' groupId: description: Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string id: description: Unique 24-hexadecimal digit string that identifies this alert configuration. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string links: description: 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. externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: $ref: '#/components/schemas/Link' readOnly: true type: array matchers: description: List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. items: $ref: '#/components/schemas/StreamsMatcher' type: array notifications: description: List that contains the targets that MongoDB Cloud sends notifications. items: $ref: '#/components/schemas/AlertsNotificationRootForGroup' maxItems: 25 minItems: 1 type: array severityOverride: $ref: '#/components/schemas/EventSeverity' updated: description: Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 format: date-time readOnly: true type: string required: - eventTypeName - notifications title: Stream Processor Alert Configuration type: object DiskPartitionQueueDepthJournalRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object CacheUsageUsedDataMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/DataMetricUnits' required: - metricName type: object MaxDiskPartitionWriteLatencyDataTimeMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/TimeMetricUnits' required: - metricName type: object OpCounterTtlDeletedRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object FlexNetworkNumRequestsRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object MuninCpuStealRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object FtsProcessCpuUserRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object ServerlessOpCounterDeleteRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object DiskPartitionSpaceUsedJournalRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object AlertMatcher: description: Rules to apply when comparing an target instance against this alert configuration. properties: fieldName: description: 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. type: string operator: description: Comparison operator to apply when checking the current metric value against **matcher[n].value**. The `REGEX` operator only supports inclusive matches. Use the `NOT_CONTAINS` operator to exclude values. enum: - EQUALS - CONTAINS - STARTS_WITH - ENDS_WITH - NOT_EQUALS - NOT_CONTAINS - REGEX type: string value: description: Value to match or exceed using the specified `matchers.operator`. example: event-replica-set type: string required: - fieldName - operator - value title: Matchers type: object TimeMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/TimeMetricUnits' required: - metricName type: object DocumentReturnedRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object OpCounterQueryRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object ServerlessNetworkBytesOutDataMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/DataMetricUnits' required: - metricName type: object DiskPartitionQueueDepthDataRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold: description: Event type that triggers an alert. enum: - TOO_MANY_ELECTIONS - REPLICATION_OPLOG_WINDOW_RUNNING_OUT - TOO_FEW_HEALTHY_MEMBERS - TOO_MANY_UNHEALTHY_MEMBERS example: TOO_MANY_ELECTIONS externalDocs: description: Atlas Alert Event Types url: https://www.mongodb.com/docs/atlas/reference/atlas-alert-event-types/ title: ReplicaSet Event Types type: string ServerlessMetricAlertConfigViewForNdsGroup: description: Serverless metric alert configuration allows to select which serverless database metrics trigger alerts and how users are notified. properties: created: description: Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 format: date-time readOnly: true type: string enabled: default: false description: Flag that indicates whether someone enabled this alert configuration for the specified project. type: boolean eventTypeName: $ref: '#/components/schemas/ServerlessEventTypeViewAlertable' groupId: description: Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string id: description: Unique 24-hexadecimal digit string that identifies this alert configuration. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string links: description: 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. externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: $ref: '#/components/schemas/Link' readOnly: true type: array matchers: description: Matching conditions for target resources. items: $ref: '#/components/schemas/AlertMatcher' type: array metricThreshold: $ref: '#/components/schemas/ServerlessMetricThreshold' notifications: description: List that contains the targets that MongoDB Cloud sends notifications. items: $ref: '#/components/schemas/AlertsNotificationRootForGroup' maxItems: 25 minItems: 1 type: array severityOverride: $ref: '#/components/schemas/EventSeverity' updated: description: Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 format: date-time readOnly: true type: string required: - eventTypeName - notifications title: Serverless Alert Configuration type: object ServerlessMetricThreshold: description: 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. discriminator: mapping: SERVERLESS_AVG_COMMAND_EXECUTION_TIME: '#/components/schemas/ServerlessAVGCommandExecutionTimeMetricThresholdView' SERVERLESS_AVG_READ_EXECUTION_TIME: '#/components/schemas/TimeMetricThresholdView' SERVERLESS_AVG_WRITE_EXECUTION_TIME: '#/components/schemas/ServerlessAVGWriteExecutionTimeMetricThresholdView' SERVERLESS_CONNECTIONS: '#/components/schemas/RawMetricThresholdView' SERVERLESS_CONNECTIONS_PERCENT: '#/components/schemas/ServerlessConnectionPercentageRawMetricThresholdView' SERVERLESS_DATA_SIZE_TOTAL: '#/components/schemas/DataMetricThresholdView' SERVERLESS_NETWORK_BYTES_IN: '#/components/schemas/ServerlessNetworkBytesInDataMetricThresholdView' SERVERLESS_NETWORK_BYTES_OUT: '#/components/schemas/ServerlessNetworkBytesOutDataMetricThresholdView' SERVERLESS_NETWORK_NUM_REQUESTS: '#/components/schemas/ServerlessNetworkNumRequestRawMetricThresholdView' SERVERLESS_OPCOUNTER_CMD: '#/components/schemas/ServerlessOpCounterCDMRawMetricThresholdView' SERVERLESS_OPCOUNTER_DELETE: '#/components/schemas/ServerlessOpCounterDeleteRawMetricThresholdView' SERVERLESS_OPCOUNTER_GETMORE: '#/components/schemas/ServerlessOpCounterGetMoreRawMetricThresholdView' SERVERLESS_OPCOUNTER_INSERT: '#/components/schemas/ServerlessOpCounterInsertRawMetricThresholdView' SERVERLESS_OPCOUNTER_QUERY: '#/components/schemas/ServerlessOpCounterQueryRawMetricThresholdView' SERVERLESS_OPCOUNTER_UPDATE: '#/components/schemas/ServerlessOpCounterUpdateRawMetricThresholdView' SERVERLESS_TOTAL_READ_UNITS: '#/components/schemas/RPUMetricThresholdView' SERVERLESS_TOTAL_WRITE_UNITS: '#/components/schemas/ServerlessTotalWriteUnitsRPUMetricThresholdView' propertyName: metricName oneOf: - $ref: '#/components/schemas/ServerlessAVGCommandExecutionTimeMetricThresholdView' - $ref: '#/components/schemas/ServerlessAVGWriteExecutionTimeMetricThresholdView' - $ref: '#/components/schemas/TimeMetricThresholdView' - $ref: '#/components/schemas/ServerlessTotalWriteUnitsRPUMetricThresholdView' - $ref: '#/components/schemas/RPUMetricThresholdView' - $ref: '#/components/schemas/ServerlessOpCounterUpdateRawMetricThresholdView' - $ref: '#/components/schemas/ServerlessOpCounterQueryRawMetricThresholdView' - $ref: '#/components/schemas/ServerlessOpCounterInsertRawMetricThresholdView' - $ref: '#/components/schemas/ServerlessOpCounterGetMoreRawMetricThresholdView' - $ref: '#/components/schemas/ServerlessOpCounterDeleteRawMetricThresholdView' - $ref: '#/components/schemas/ServerlessOpCounterCDMRawMetricThresholdView' - $ref: '#/components/schemas/ServerlessNetworkNumRequestRawMetricThresholdView' - $ref: '#/components/schemas/ServerlessNetworkBytesOutDataMetricThresholdView' - $ref: '#/components/schemas/ServerlessNetworkBytesInDataMetricThresholdView' - $ref: '#/components/schemas/DataMetricThresholdView' - $ref: '#/components/schemas/ServerlessConnectionPercentageRawMetricThresholdView' - $ref: '#/components/schemas/RawMetricThresholdView' properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: description: Element used to express the quantity. This can be an element of time, storage capacity, and the like. enum: - 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 - billion type: string required: - metricName title: Serverless Metric Threshold type: object SearchNumberOfFieldsInIndexRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object ReplicaSetEventTypeViewForNdsGroupAlertableNoThreshold: description: Event type that triggers an alert. enum: - NO_PRIMARY - PRIMARY_ELECTED example: NO_PRIMARY externalDocs: description: Atlas Alert Event Types url: https://www.mongodb.com/docs/atlas/reference/atlas-alert-event-types/ title: ReplicaSet Event Types type: string LogicalSizeDataMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/DataMetricUnits' required: - metricName type: object JournalingMbDataMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/DataMetricUnits' required: - metricName type: object ReplicaSetAlertConfigViewForNdsGroup: description: Replica Set alert configuration allows to select which conditions of mongod replica set trigger alerts and how users are notified. properties: created: description: Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 format: date-time readOnly: true type: string enabled: default: false description: Flag that indicates whether someone enabled this alert configuration for the specified project. type: boolean eventTypeName: $ref: '#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableNoThreshold' groupId: description: Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string id: description: Unique 24-hexadecimal digit string that identifies this alert configuration. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string links: description: 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. externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: $ref: '#/components/schemas/Link' readOnly: true type: array matchers: description: 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. items: $ref: '#/components/schemas/ReplicaSetMatcher' type: array notifications: description: List that contains the targets that MongoDB Cloud sends notifications. items: $ref: '#/components/schemas/AlertsNotificationRootForGroup' maxItems: 25 minItems: 1 type: array severityOverride: $ref: '#/components/schemas/EventSeverity' threshold: $ref: '#/components/schemas/AlertsThresholdInteger' updated: description: Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 format: date-time readOnly: true type: string required: - eventTypeName - notifications title: Replica Set Alert Configuration type: object GlobalLockCurrentQueueReadersRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object QueryExecutorScannedObjectsRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object BillingEventTypeViewAlertableWithThreshold: description: Event type that triggers an alert. enum: - PENDING_INVOICE_OVER_THRESHOLD - DAILY_BILL_OVER_THRESHOLD - DAILY_BILLING_CHANGE_OVER_THRESHOLD - WEEKLY_BILLING_CHANGE_OVER_THRESHOLD - MONTHLY_BILLING_CHANGE_OVER_THRESHOLD example: PENDING_INVOICE_OVER_THRESHOLD externalDocs: description: Atlas Alert Event Types url: https://www.mongodb.com/docs/atlas/reference/atlas-alert-event-types/ title: Billing Event Type type: string FlexOpCounterUpdateRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object HostAlertConfigViewForNdsGroup: description: Host alert configuration allows to select which mongod host events trigger alerts and how users are notified. properties: created: description: Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 format: date-time readOnly: true type: string enabled: default: false description: Flag that indicates whether someone enabled this alert configuration for the specified project. type: boolean eventTypeName: $ref: '#/components/schemas/HostEventTypeViewForNdsGroupAlertable' groupId: description: Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string id: description: Unique 24-hexadecimal digit string that identifies this alert configuration. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string links: description: 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. externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: $ref: '#/components/schemas/Link' readOnly: true type: array matchers: description: 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. items: $ref: '#/components/schemas/HostMatcher' type: array notifications: description: List that contains the targets that MongoDB Cloud sends notifications. items: $ref: '#/components/schemas/AlertsNotificationRootForGroup' maxItems: 25 minItems: 1 type: array severityOverride: $ref: '#/components/schemas/EventSeverity' updated: description: Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 format: date-time readOnly: true type: string required: - eventTypeName - notifications title: Host Alert Configuration type: object RawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object SearchOpCounterInsertRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object MemoryResidentDataMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/DataMetricUnits' required: - metricName type: object FtsMemoryMappedDataMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/DataMetricUnits' required: - metricName type: object QuerySpillToDiskDuringSortRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object UserNotification: description: User notification configuration for MongoDB Cloud to send information when an event triggers an alert condition. properties: delayMin: description: Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification. format: int32 type: integer emailEnabled: description: '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"`' type: boolean intervalMin: description: '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.' format: int32 minimum: 5 type: integer notifierId: description: 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. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ type: string smsEnabled: description: '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"`' type: boolean typeName: description: Human-readable label that displays the alert notification type. enum: - USER type: string username: description: '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"`.' format: email type: string required: - typeName title: User Notification type: object FlexClusterMetricThreshold: description: 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. discriminator: mapping: FLEX_AVG_COMMAND_EXECUTION_TIME: '#/components/schemas/FlexAVGCommandExecutionTimeMetricThresholdView' FLEX_AVG_READ_EXECUTION_TIME: '#/components/schemas/TimeMetricThresholdView' FLEX_AVG_WRITE_EXECUTION_TIME: '#/components/schemas/FlexAVGWriteExecutionTimeMetricThresholdView' FLEX_CONNECTIONS: '#/components/schemas/RawMetricThresholdView' FLEX_CONNECTIONS_PERCENT: '#/components/schemas/FlexConnectionPercentRawMetricThresholdView' FLEX_DATA_SIZE_TOTAL: '#/components/schemas/DataMetricThresholdView' FLEX_NETWORK_BYTES_IN: '#/components/schemas/FlexNetworkBytesInDataMetricThresholdView' FLEX_NETWORK_BYTES_OUT: '#/components/schemas/FlexNetworkBytesOutDataMetricThresholdView' FLEX_NETWORK_NUM_REQUESTS: '#/components/schemas/FlexNetworkNumRequestsRawMetricThresholdView' FLEX_OPCOUNTER_CMD: '#/components/schemas/FlexOpCounterCMDRawMetricThresholdView' FLEX_OPCOUNTER_DELETE: '#/components/schemas/FlexOpCounterDeleteRawMetricThresholdView' FLEX_OPCOUNTER_GETMORE: '#/components/schemas/FlexOpCounterGetMoreRawMetricThresholdView' FLEX_OPCOUNTER_INSERT: '#/components/schemas/FlexOpCounterInsertRawMetricThresholdView' FLEX_OPCOUNTER_QUERY: '#/components/schemas/FlexOpCounterQueryRawMetricThresholdView' FLEX_OPCOUNTER_UPDATE: '#/components/schemas/FlexOpCounterUpdateRawMetricThresholdView' propertyName: metricName oneOf: - $ref: '#/components/schemas/RawMetricThresholdView' - $ref: '#/components/schemas/FlexConnectionPercentRawMetricThresholdView' - $ref: '#/components/schemas/DataMetricThresholdView' - $ref: '#/components/schemas/FlexNetworkBytesInDataMetricThresholdView' - $ref: '#/components/schemas/FlexNetworkBytesOutDataMetricThresholdView' - $ref: '#/components/schemas/FlexNetworkNumRequestsRawMetricThresholdView' - $ref: '#/components/schemas/FlexOpCounterCMDRawMetricThresholdView' - $ref: '#/components/schemas/FlexOpCounterDeleteRawMetricThresholdView' - $ref: '#/components/schemas/FlexOpCounterInsertRawMetricThresholdView' - $ref: '#/components/schemas/FlexOpCounterQueryRawMetricThresholdView' - $ref: '#/components/schemas/FlexOpCounterUpdateRawMetricThresholdView' - $ref: '#/components/schemas/FlexOpCounterGetMoreRawMetricThresholdView' - $ref: '#/components/schemas/TimeMetricThresholdView' - $ref: '#/components/schemas/FlexAVGWriteExecutionTimeMetricThresholdView' - $ref: '#/components/schemas/FlexAVGCommandExecutionTimeMetricThresholdView' properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: description: Element used to express the quantity. This can be an element of time, storage capacity, and the like. enum: - 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 - billion type: string required: - metricName title: Flex Cluster Metric Threshold type: object ServerlessTotalWriteUnitsRPUMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/ServerlessMetricUnits' required: - metricName type: object WebhookNotification: description: Webhook notification configuration for MongoDB Cloud to send information when an event triggers an alert condition. properties: delayMin: description: Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification. format: int32 type: integer integrationId: description: The id of the associated integration, the credentials of which to use for requests. example: 32b6e34b3d91647abb20e7b8 type: string intervalMin: description: '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.' format: int32 minimum: 5 type: integer notifierId: description: 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. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ type: string typeName: description: Human-readable label that displays the alert notification type. enum: - WEBHOOK type: string webhookSecret: description: '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 webhook secret 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.' externalDocs: description: Integrations page url: https://www.mongodb.com/docs/atlas/tutorial/third-party-service-integrations/#std-label-third-party-integrations format: password type: string webhookUrl: description: '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 webhook URL 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.' example: https://webhook.com/**** externalDocs: description: Integrations page url: https://www.mongodb.com/docs/atlas/tutorial/third-party-service-integrations/#std-label-third-party-integrations type: string required: - typeName title: Webhook Notification type: object GreaterThanTimeThreshold: description: A Limit that triggers an alert when greater than a time period. properties: operator: description: Comparison operator to apply when checking the current metric value. enum: - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: int32 type: integer units: $ref: '#/components/schemas/TimeMetricUnits' title: Greater Than Time Threshold type: object OpCounterReplCmdRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object OrgNotification: description: Organization notification configuration for MongoDB Cloud to send information when an event triggers an alert condition. properties: delayMin: description: Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification. format: int32 type: integer emailEnabled: description: '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"`' type: boolean intervalMin: description: '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.' format: int32 minimum: 5 type: integer notifierId: description: 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. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ type: string roles: description: '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.' externalDocs: description: Organization Roles url: https://dochub.mongodb.org/core/atlas-org-roles items: description: One or more organization roles that receive the configured alert. enum: - ORG_OWNER - ORG_MEMBER - ORG_GROUP_CREATOR - ORG_BILLING_ADMIN - ORG_BILLING_READ_ONLY - ORG_READ_ONLY type: string type: array smsEnabled: description: '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"`' type: boolean typeName: description: Human-readable label that displays the alert notification type. enum: - ORG type: string required: - typeName title: Organization Notification type: object OpCounterCmdRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object MaxSwapUsageFreeDataMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/DataMetricUnits' required: - metricName type: object ServerlessMetricUnits: description: Element used to express the quantity. This can be an element of time, storage capacity, and the like. enum: - RPU - THOUSAND_RPU - MILLION_RPU - WPU - THOUSAND_WPU - MILLION_WPU example: RPU title: Serverless Metric Units type: string IndexCountersBtreeHitsRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object SMSNotification: description: SMS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition. properties: delayMin: description: Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification. format: int32 type: integer intervalMin: description: '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.' format: int32 minimum: 5 type: integer mobileNumber: description: 'Mobile phone number to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `"notifications.[n].typeName" : "SMS"`.' example: '1233337892' type: string notifierId: description: 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. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ type: string typeName: description: Human-readable label that displays the alert notification type. enum: - SMS type: string required: - typeName title: SMS Notification type: object AvgWriteExecutionTimeTimeMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/TimeMetricUnits' required: - metricName type: object MuninCpuIrqRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object OpCounterGetMoreRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object MemoryMappedDataMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/DataMetricUnits' required: - metricName type: object LessThanDaysThresholdView: description: Threshold value that triggers an alert. properties: operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: int32 type: integer units: description: Element used to express the quantity. This can be an element of time, storage capacity, and the like. enum: - DAYS type: string type: object HostMatcher: description: Rules to apply when comparing an host against this alert configuration. properties: fieldName: $ref: '#/components/schemas/HostMatcherField' operator: description: Comparison operator to apply when checking the current metric value against **matcher[n].value**. The `REGEX` operator only supports inclusive matches. Use the `NOT_CONTAINS` operator to exclude values. enum: - EQUALS - CONTAINS - STARTS_WITH - ENDS_WITH - NOT_EQUALS - NOT_CONTAINS - REGEX type: string value: $ref: '#/components/schemas/MatcherHostType' required: - fieldName - operator title: Matchers type: object QueryTargetingScannedPerReturnedRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object ReplicaSetMatcher: description: Rules to apply when comparing an replica set against this alert configuration. properties: fieldName: $ref: '#/components/schemas/ReplicaSetMatcherField' operator: description: Comparison operator to apply when checking the current metric value against **matcher[n].value**. The `REGEX` operator only supports inclusive matches. Use the `NOT_CONTAINS` operator to exclude values. enum: - EQUALS - CONTAINS - STARTS_WITH - ENDS_WITH - NOT_EQUALS - NOT_CONTAINS - REGEX type: string value: description: Value to match or exceed using the specified `matchers.operator`. example: event-replica-set type: string required: - fieldName - operator - value title: Matchers type: object SearchNumberOfQueriesSuccessRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object DbDataSizeTotalWoSystemDataMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/DataMetricUnits' required: - metricName type: object DiskPartitionWriteIopsDataRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object TicketsAvailableWritesRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object StreamProcessorEventTypeViewAlertableNoThreshold: description: Event type that triggers an alert. enum: - STREAM_PROCESSOR_STATE_IS_FAILED example: STREAM_PROCESSOR_STATE_IS_FAILED externalDocs: description: Atlas Alert Event Types url: https://www.mongodb.com/docs/atlas/reference/atlas-alert-event-types/ title: Stream Processor Event Types type: string AssertUserRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object ClusterAlertConfigViewForNdsGroup: description: Cluster alert configuration allows to select which conditions of mongod cluster which trigger alerts and how users are notified. properties: created: description: Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 format: date-time readOnly: true type: string enabled: default: false description: Flag that indicates whether someone enabled this alert configuration for the specified project. type: boolean eventTypeName: $ref: '#/components/schemas/ClusterEventTypeViewForNdsGroupAlertable' groupId: description: Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string id: description: Unique 24-hexadecimal digit string that identifies this alert configuration. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string links: description: 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. externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: $ref: '#/components/schemas/Link' readOnly: true type: array matchers: description: 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. items: $ref: '#/components/schemas/ClusterMatcher' type: array notifications: description: List that contains the targets that MongoDB Cloud sends notifications. items: $ref: '#/components/schemas/AlertsNotificationRootForGroup' maxItems: 25 minItems: 1 type: array severityOverride: $ref: '#/components/schemas/EventSeverity' updated: description: Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 format: date-time readOnly: true type: string required: - eventTypeName - notifications title: Cluster Alert Configuration type: object MatcherHostType: description: Value to match or exceed using the specified `matchers.operator`. enum: - STANDALONE - PRIMARY - SECONDARY - ARBITER - MONGOS - CONFIG - MONGOT example: STANDALONE title: Matcher Host Types type: string AppServiceMetricThreshold: description: 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. discriminator: mapping: REALM_AUTH_LOGIN_FAIL: '#/components/schemas/RawMetricThresholdView' REALM_ENDPOINTS_COMPUTE_MS: '#/components/schemas/TimeMetricThresholdView' REALM_ENDPOINTS_EGRESS_BYTES: '#/components/schemas/DataMetricThresholdView' REALM_ENDPOINTS_FAILED_REQUESTS: '#/components/schemas/RawMetricThresholdView' REALM_ENDPOINTS_RESPONSE_MS: '#/components/schemas/TimeMetricThresholdView' REALM_GQL_COMPUTE_MS: '#/components/schemas/TimeMetricThresholdView' REALM_GQL_EGRESS_BYTES: '#/components/schemas/DataMetricThresholdView' REALM_GQL_FAILED_REQUESTS: '#/components/schemas/RawMetricThresholdView' REALM_GQL_RESPONSE_MS: '#/components/schemas/TimeMetricThresholdView' REALM_OVERALL_COMPUTE_MS: '#/components/schemas/TimeMetricThresholdView' REALM_OVERALL_EGRESS_BYTES: '#/components/schemas/DataMetricThresholdView' REALM_OVERALL_FAILED_REQUESTS: '#/components/schemas/RawMetricThresholdView' REALM_SDKFNS_FAILED_REQUESTS: '#/components/schemas/RawMetricThresholdView' REALM_SDK_FNS_RESPONSE_MS: '#/components/schemas/TimeMetricThresholdView' REALM_SDK_FUNCTIONS_COMPUTE_MS: '#/components/schemas/TimeMetricThresholdView' REALM_SDK_FUNCTIONS_EGRESS_BYTES: '#/components/schemas/DataMetricThresholdView' REALM_SDK_MQL_COMPUTE_MS: '#/components/schemas/TimeMetricThresholdView' REALM_SDK_MQL_EGRESS_BYTES: '#/components/schemas/DataMetricThresholdView' REALM_SDK_MQL_RESPONSE_MS: '#/components/schemas/TimeMetricThresholdView' REALM_SYNC_CLIENT_BOOTSTRAP_MS: '#/components/schemas/TimeMetricThresholdView' REALM_SYNC_CLIENT_CHANGESETS_INVALID: '#/components/schemas/DataMetricThresholdView' REALM_SYNC_CLIENT_READS_FAILED: '#/components/schemas/DataMetricThresholdView' REALM_SYNC_CLIENT_UPLOADS_FAILED: '#/components/schemas/DataMetricThresholdView' REALM_SYNC_CURRENT_OPLOG_LAG_MS_SUM: '#/components/schemas/TimeMetricThresholdView' REALM_SYNC_EGRESS_BYTES: '#/components/schemas/DataMetricThresholdView' REALM_SYNC_FAILED_REQUESTS: '#/components/schemas/DataMetricThresholdView' REALM_SYNC_NUM_UNSYNCABLE_DOCS_PERCENT: '#/components/schemas/RawMetricThresholdView' REALM_SYNC_SESSIONS_ENDED: '#/components/schemas/DataMetricThresholdView' REALM_TRIGGERS_COMPUTE_MS: '#/components/schemas/TimeMetricThresholdView' REALM_TRIGGERS_CURRENT_OPLOG_LAG_MS_SUM: '#/components/schemas/TimeMetricThresholdView' REALM_TRIGGERS_EGRESS_BYTES: '#/components/schemas/DataMetricThresholdView' REALM_TRIGGERS_FAILED_REQUESTS: '#/components/schemas/RawMetricThresholdView' REALM_TRIGGERS_RESPONSE_MS: '#/components/schemas/TimeMetricThresholdView' propertyName: metricName oneOf: - $ref: '#/components/schemas/RawMetricThresholdView' - $ref: '#/components/schemas/DataMetricThresholdView' - $ref: '#/components/schemas/TimeMetricThresholdView' properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: description: Element used to express the quantity. This can be an element of time, storage capacity, and the like. enum: - 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 - billion type: string required: - metricName title: App Services Metric Threshold type: object ReplicaSetThresholdAlertConfigViewForNdsGroup: description: Replica Set threshold alert configuration allows to select thresholds for conditions of mongod replica set which trigger alerts and how users are notified. discriminator: mapping: REPLICATION_OPLOG_WINDOW_RUNNING_OUT: '#/components/schemas/LessThanTimeThresholdAlertConfigViewForNdsGroup' TOO_MANY_ELECTIONS: '#/components/schemas/GreaterThanRawThresholdAlertConfigViewForNdsGroup' propertyName: eventTypeName properties: created: description: Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 format: date-time readOnly: true type: string enabled: default: false description: Flag that indicates whether someone enabled this alert configuration for the specified project. type: boolean eventTypeName: $ref: '#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold' groupId: description: Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string id: description: Unique 24-hexadecimal digit string that identifies this alert configuration. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string links: description: 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. externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: $ref: '#/components/schemas/Link' readOnly: true type: array matchers: description: 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. items: $ref: '#/components/schemas/ReplicaSetMatcher' type: array notifications: description: List that contains the targets that MongoDB Cloud sends notifications. items: $ref: '#/components/schemas/AlertsNotificationRootForGroup' maxItems: 25 minItems: 1 type: array severityOverride: $ref: '#/components/schemas/EventSeverity' threshold: $ref: '#/components/schemas/AlertsThresholdInteger' updated: description: Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 format: date-time readOnly: true type: string required: - eventTypeName - notifications title: Replica Set Threshold Alert Configuration type: object AlertsNotificationRootForGroup: description: One target that MongoDB Cloud sends notifications when an alert triggers. oneOf: - $ref: '#/components/schemas/DatadogNotification' - $ref: '#/components/schemas/EmailNotification' - $ref: '#/components/schemas/GroupNotification' - $ref: '#/components/schemas/HipChatNotification' - $ref: '#/components/schemas/MicrosoftTeamsNotification' - $ref: '#/components/schemas/OpsGenieNotification' - $ref: '#/components/schemas/OrgNotification' - $ref: '#/components/schemas/PagerDutyNotification' - $ref: '#/components/schemas/SlackNotification' - $ref: '#/components/schemas/SMSNotification' - $ref: '#/components/schemas/TeamNotification' - $ref: '#/components/schemas/UserNotification' - $ref: '#/components/schemas/VictorOpsNotification' - $ref: '#/components/schemas/WebhookNotification' type: object FlexConnectionPercentRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object FlexNetworkBytesInDataMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/DataMetricUnits' required: - metricName type: object OplogRateGbPerHourDataMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/DataMetricUnits' required: - metricName type: object JournalingCommitsInWriteLockRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object NormalizedFtsProcessCpuUserRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object DiskPartitionReadIopsIndexRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object MaxDiskPartitionReadIopsJournalRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object ServerlessNetworkBytesInDataMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/DataMetricUnits' required: - metricName type: object NormalizedSystemCpuStealRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object AlertsThresholdInteger: description: A Limit that triggers an alert when exceeded. The resource returns this parameter when `eventTypeName` has not been set to `OUTSIDE_METRIC_THRESHOLD`. properties: operator: $ref: '#/components/schemas/Operator' threshold: description: Value of metric that, when exceeded, triggers an alert. format: int32 type: integer units: description: Element used to express the quantity. This can be an element of time, storage capacity, and the like. enum: - 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 - billion type: string title: Threshold type: object StreamProcessorMetricThreshold: description: 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 stream processors. discriminator: mapping: STREAM_PROCESSOR_CHANGE_STREAM_LAG: '#/components/schemas/TimeMetricThresholdView' STREAM_PROCESSOR_DLQ_MESSAGE_COUNT: '#/components/schemas/DLQRawMetricThresholdView' STREAM_PROCESSOR_KAFKA_LAG: '#/components/schemas/KafkaRawMetricThresholdView' STREAM_PROCESSOR_OUTPUT_MESSAGE_COUNT: '#/components/schemas/RawMetricThresholdView' propertyName: metricName oneOf: - $ref: '#/components/schemas/KafkaRawMetricThresholdView' - $ref: '#/components/schemas/TimeMetricThresholdView' - $ref: '#/components/schemas/DLQRawMetricThresholdView' - $ref: '#/components/schemas/RawMetricThresholdView' properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: description: Element used to express the quantity. This can be an element of time, storage capacity, and the like. enum: - 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 - billion type: string required: - metricName title: Stream Processor Metric Threshold type: object CursorsTotalClientCursorsSizeRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object StreamProcessorMetricAlertConfigViewForNdsGroup: description: Stream Processor threshold alert configuration allows to select thresholds on metrics which trigger alerts and how users are notified. properties: created: description: Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 format: date-time readOnly: true type: string enabled: default: false description: Flag that indicates whether someone enabled this alert configuration for the specified project. type: boolean eventTypeName: $ref: '#/components/schemas/StreamProcessorEventTypeViewAlertableWithThreshold' groupId: description: Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string id: description: Unique 24-hexadecimal digit string that identifies this alert configuration. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string links: description: 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. externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: $ref: '#/components/schemas/Link' readOnly: true type: array matchers: description: List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. items: $ref: '#/components/schemas/StreamsMatcher' type: array metricThreshold: $ref: '#/components/schemas/StreamProcessorMetricThreshold' notifications: description: List that contains the targets that MongoDB Cloud sends notifications. items: $ref: '#/components/schemas/AlertsNotificationRootForGroup' maxItems: 25 minItems: 1 type: array severityOverride: $ref: '#/components/schemas/EventSeverity' threshold: $ref: '#/components/schemas/DeprecatedStreamProcessorMetricThreshold' updated: description: Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 format: date-time readOnly: true type: string required: - eventTypeName - notifications title: Stream Processor Metric Alert Configuration type: object MaxDiskPartitionWriteIopsJournalRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object RestartsInLastHourRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object ApiError: properties: badRequestDetail: $ref: '#/components/schemas/BadRequestDetail' detail: description: Describes the specific conditions or reasons that cause each type of error. type: string error: description: HTTP status code returned with this error. externalDocs: url: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status format: int32 readOnly: true type: integer errorCode: description: Application error code returned with this error. readOnly: true type: string parameters: description: Parameters used to give more information about the error. items: type: object readOnly: true type: array reason: description: Application error message returned with this error. readOnly: true type: string required: - error - errorCode type: object NetworkBytesOutDataMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/DataMetricUnits' required: - metricName type: object StreamProcessorEventTypeViewAlertableWithThreshold: description: Event type that triggers an alert. enum: - OUTSIDE_STREAM_PROCESSOR_METRIC_THRESHOLD example: OUTSIDE_STREAM_PROCESSOR_METRIC_THRESHOLD externalDocs: description: Atlas Alert Event Types url: https://www.mongodb.com/docs/atlas/reference/atlas-alert-event-types/ title: Stream Processor Event Types type: string NumberMetricUnits: description: Element used to express the quantity. This can be an element of time, storage capacity, and the like. enum: - COUNT - THOUSAND - MILLION - BILLION example: COUNT title: Number Metric Units type: string FlexAVGWriteExecutionTimeMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/TimeMetricUnits' required: - metricName type: object SearchProcessThrottlingRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object MaxNormalizedSystemCpuUserRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object MaxDiskPartitionSpaceUsedJournalRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object NDSX509UserAuthenticationAlertConfigViewForNdsGroup: description: 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. properties: created: description: Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 format: date-time readOnly: true type: string enabled: default: false description: Flag that indicates whether someone enabled this alert configuration for the specified project. type: boolean eventTypeName: $ref: '#/components/schemas/NDSX509UserAuthenticationEventTypeViewAlertable' groupId: description: Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string id: description: Unique 24-hexadecimal digit string that identifies this alert configuration. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string links: description: 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. externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: $ref: '#/components/schemas/Link' readOnly: true type: array matchers: description: Matching conditions for target resources. items: $ref: '#/components/schemas/AlertMatcher' type: array notifications: description: List that contains the targets that MongoDB Cloud sends notifications. items: $ref: '#/components/schemas/AlertsNotificationRootForGroup' maxItems: 25 minItems: 1 type: array severityOverride: $ref: '#/components/schemas/EventSeverity' threshold: $ref: '#/components/schemas/LessThanDaysThresholdView' updated: description: Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 format: date-time readOnly: true type: string required: - eventTypeName - notifications title: X509 User Authentication Alert Configuration type: object NumberMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/NumberMetricUnits' required: - metricName type: object FlexOpCounterQueryRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object TicketsAvailableReadsRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object SearchOpCounterDeleteRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object MuninCpuIowaitRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object MaxDiskPartitionQueueDepthDataRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object DiskPartitionReadIopsDataRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object TeamNotification: description: Team notification configuration for MongoDB Cloud to send information when an event triggers an alert condition. properties: delayMin: description: Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification. format: int32 type: integer emailEnabled: description: '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"`' type: boolean intervalMin: description: '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.' format: int32 minimum: 5 type: integer notifierId: description: 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. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ type: string smsEnabled: description: '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"`' type: boolean teamId: description: 'Unique 24-hexadecimal digit string that identifies one MongoDB Cloud team. The resource requires this parameter when `"notifications.[n].typeName" : "TEAM"`.' example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ type: string teamName: description: 'Name of the MongoDB Cloud team that receives this notification. The resource requires this parameter when `"notifications.[n].typeName" : "TEAM"`.' example: Atlas type: string typeName: description: Human-readable label that displays the alert notification type. enum: - TEAM type: string required: - typeName title: Team Notification type: object AppServiceAlertConfigViewForNdsGroup: description: App Services metric alert configuration allows to select which app service conditions and events trigger alerts and how users are notified. properties: created: description: Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 format: date-time readOnly: true type: string enabled: default: false description: Flag that indicates whether someone enabled this alert configuration for the specified project. type: boolean eventTypeName: $ref: '#/components/schemas/AppServiceEventTypeViewAlertableNoThreshold' groupId: description: Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string id: description: Unique 24-hexadecimal digit string that identifies this alert configuration. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string links: description: 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. externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: $ref: '#/components/schemas/Link' readOnly: true type: array matchers: description: 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. items: $ref: '#/components/schemas/AppServiceMetricMatcher' type: array notifications: description: List that contains the targets that MongoDB Cloud sends notifications. items: $ref: '#/components/schemas/AlertsNotificationRootForGroup' maxItems: 25 minItems: 1 type: array severityOverride: $ref: '#/components/schemas/EventSeverity' updated: description: Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 format: date-time readOnly: true type: string required: - eventTypeName - notifications title: App Services Alert Configuration type: object ExtraInfoPageFaultsRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object ClusterEventTypeViewForNdsGroupAlertable: description: Event type that triggers an alert. enum: - CLUSTER_MONGOS_IS_MISSING example: CLUSTER_MONGOS_IS_MISSING externalDocs: description: Atlas Alert Event Types url: https://www.mongodb.com/docs/atlas/reference/atlas-alert-event-types/ title: Cluster Event Types type: string DiskPartitionWriteLatencyJournalTimeMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/TimeMetricUnits' required: - metricName type: object SearchIndexSizeDataMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/DataMetricUnits' required: - metricName type: object FtsProcessCpuKernelRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object OpCounterInsertRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object AvgCommandExecutionTimeTimeMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/TimeMetricUnits' required: - metricName type: object DatadogNotification: description: Datadog notification configuration for MongoDB Cloud to send information when an event triggers an alert condition. properties: datadogApiKey: description: '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.' example: '****************************a23c' type: string datadogRegion: default: US description: 'Datadog region that indicates which API Uniform Resource Locator (URL) to use. The resource requires this parameter when `"notifications.[n].typeName" : "DATADOG"`.' enum: - US - EU - US3 - US5 - AP1 - US1_FED externalDocs: description: Datadog regions url: https://docs.datadoghq.com/getting_started/site/ type: string delayMin: description: Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification. format: int32 type: integer integrationId: description: The id of the associated integration, the credentials of which to use for requests. example: 32b6e34b3d91647abb20e7b8 type: string intervalMin: description: '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.' format: int32 minimum: 5 type: integer notifierId: description: 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. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ type: string typeName: description: Human-readable label that displays the alert notification type. enum: - DATADOG type: string required: - typeName title: Datadog Notification type: object ServerlessNetworkNumRequestRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object FlexMetricEventTypeViewAlertable: description: Event type that triggers an alert. enum: - OUTSIDE_FLEX_METRIC_THRESHOLD example: OUTSIDE_FLEX_METRIC_THRESHOLD externalDocs: description: Atlas Alert Event Types url: https://www.mongodb.com/docs/atlas/reference/atlas-alert-event-types/ title: Flex Metric Event Types type: string MaxSystemNetworkOutDataMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/DataMetricUnits' required: - metricName type: object ServerlessOpCounterQueryRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object NormalizedSystemCpuUserRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object FieldViolation: properties: description: description: A description of why the request element is bad. type: string field: description: A path that leads to a field in the request body. type: string required: - description - field type: object MaxDiskPartitionQueueDepthJournalRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object ServerlessOpCounterCDMRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object OperationsQueriesKilledRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object DbStorageTotalDataMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/DataMetricUnits' required: - metricName type: object StreamsMatcherField: description: 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. enum: - INSTANCE_NAME - PROCESSOR_NAME example: INSTANCE_NAME title: Streams Matcher Fields type: string MicrosoftTeamsNotification: description: Microsoft Teams notification configuration for MongoDB Cloud to send information when an event triggers an alert condition. properties: delayMin: description: Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification. format: int32 type: integer integrationId: description: The id of the associated integration, the credentials of which to use for requests. example: 32b6e34b3d91647abb20e7b8 type: string intervalMin: description: '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.' format: int32 minimum: 5 type: integer microsoftTeamsWebhookUrl: description: '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.' example: https://webhook.com/**** type: string notifierId: description: 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. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ type: string typeName: description: Human-readable label that displays the alert notification type. enum: - MICROSOFT_TEAMS type: string required: - typeName title: Microsoft Teams Notification type: object AppServiceMetricAlertConfigViewForNdsGroup: description: App Services metric alert configuration allows to select which app service metrics trigger alerts and how users are notified. properties: created: description: Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 format: date-time readOnly: true type: string enabled: default: false description: Flag that indicates whether someone enabled this alert configuration for the specified project. type: boolean eventTypeName: $ref: '#/components/schemas/AppServiceEventTypeViewAlertableWithThreshold' groupId: description: Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string id: description: Unique 24-hexadecimal digit string that identifies this alert configuration. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string links: description: 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. externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: $ref: '#/components/schemas/Link' readOnly: true type: array matchers: description: 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. items: $ref: '#/components/schemas/AppServiceMetricMatcher' type: array metricThreshold: $ref: '#/components/schemas/AppServiceMetricThreshold' notifications: description: List that contains the targets that MongoDB Cloud sends notifications. items: $ref: '#/components/schemas/AlertsNotificationRootForGroup' maxItems: 25 minItems: 1 type: array severityOverride: $ref: '#/components/schemas/EventSeverity' updated: description: Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 format: date-time readOnly: true type: string required: - eventTypeName - notifications title: App Services Metric Alert Configuration type: object DLQRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object NetworkNumRequestsRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object SystemNetworkInDataMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/DataMetricUnits' required: - metricName type: object FlexAVGCommandExecutionTimeMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/TimeMetricUnits' required: - metricName type: object SystemMemoryPercentUsedRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object OperationThrottlingRejectedOperationsRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object MaxDiskPartitionSpaceUsedDataRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object GreaterThanDaysThresholdView: description: Threshold value that triggers an alert. properties: operator: description: Comparison operator to apply when checking the current metric value. enum: - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: int32 type: integer units: description: Element used to express the quantity. This can be an element of time, storage capacity, and the like. enum: - DAYS type: string type: object ServerlessOpCounterUpdateRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object MaxDiskPartitionReadLatencyJournalTimeMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/TimeMetricUnits' required: - metricName type: object DiskPartitionReadLatencyIndexTimeMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/TimeMetricUnits' required: - metricName type: object MaxDiskPartitionReadLatencyDataTimeMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/TimeMetricUnits' required: - metricName type: object CacheBytesReadIntoDataMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/DataMetricUnits' required: - metricName type: object GlobalLockCurrentQueueWritersRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object FlexNetworkBytesOutDataMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/DataMetricUnits' required: - metricName type: object MaxDiskPartitionQueueDepthIndexRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object MaxDiskPartitionWriteIopsDataRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object ConnectionsRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object OpsGenieNotification: description: OpsGenie notification configuration for MongoDB Cloud to send information when an event triggers an alert condition. properties: delayMin: description: Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification. format: int32 type: integer integrationId: description: The id of the associated integration, the credentials of which to use for requests. example: 32b6e34b3d91647abb20e7b8 type: string intervalMin: description: '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.' format: int32 minimum: 5 type: integer notifierId: description: 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. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ type: string opsGenieApiKey: description: '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.' example: '********************************a111' type: string opsGenieRegion: default: US description: OpsGenie region that indicates which API Uniform Resource Locator (URL) to use. enum: - US - EU type: string typeName: description: Human-readable label that displays the alert notification type. enum: - OPS_GENIE type: string required: - typeName title: OpsGenie Notification type: object MongotuneEventTypeViewAlertable: description: Event type that triggers an alert. enum: - MONGOTUNE_ALERT example: MONGOTUNE_ALERT externalDocs: description: Atlas Alert Event Types url: https://www.mongodb.com/docs/atlas/reference/atlas-alert-event-types/ title: Mongotune Event Types type: string DbIndexSizeTotalDataMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/DataMetricUnits' required: - metricName type: object DiskPartitionWriteIopsJournalRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object IndexCountersBtreeMissRatioRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object MaxDiskPartitionReadIopsDataRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object DataMetricUnits: description: Element used to express the quantity. This can be an element of time, storage capacity, and the like. enum: - BITS - KILOBITS - MEGABITS - GIGABITS - BYTES - KILOBYTES - MEGABYTES - GIGABYTES - TERABYTES - PETABYTES example: BYTES title: Data Metric Units type: string DiskPartitionWriteLatencyIndexTimeMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/TimeMetricUnits' required: - metricName type: object HostEventTypeViewForNdsGroupAlertable: description: Event type that triggers an alert. enum: - 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_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 - PROFILER_CONFIGURED_TOO_WIDELY example: HOST_DOWN externalDocs: description: Atlas Alert Event Types url: https://www.mongodb.com/docs/atlas/reference/atlas-alert-event-types/ title: Host Event Types type: string MaxSystemMemoryAvailableDataMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/DataMetricUnits' required: - metricName type: object Link: properties: href: description: 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`. example: https://cloud.mongodb.com/api/atlas type: string rel: description: 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`. example: self type: string type: object GroupAlertsConfig: oneOf: - $ref: '#/components/schemas/DefaultAlertConfigViewForNdsGroup' - $ref: '#/components/schemas/AppServiceAlertConfigViewForNdsGroup' - $ref: '#/components/schemas/AppServiceMetricAlertConfigViewForNdsGroup' - $ref: '#/components/schemas/BillingThresholdAlertConfigViewForNdsGroup' - $ref: '#/components/schemas/ClusterAlertConfigViewForNdsGroup' - $ref: '#/components/schemas/CpsBackupThresholdAlertConfigViewForNdsGroup' - $ref: '#/components/schemas/EncryptionKeyAlertConfigViewForNdsGroup' - $ref: '#/components/schemas/HostAlertConfigViewForNdsGroup' - $ref: '#/components/schemas/HostMetricAlertConfigViewForNdsGroup' - $ref: '#/components/schemas/MongotuneAlertConfigViewForNdsGroup' - $ref: '#/components/schemas/NDSX509UserAuthenticationAlertConfigViewForNdsGroup' - $ref: '#/components/schemas/ReplicaSetAlertConfigViewForNdsGroup' - $ref: '#/components/schemas/ReplicaSetThresholdAlertConfigViewForNdsGroup' - $ref: '#/components/schemas/ServerlessMetricAlertConfigViewForNdsGroup' - $ref: '#/components/schemas/FlexMetricAlertConfigViewForNdsGroup' - $ref: '#/components/schemas/StreamProcessorAlertConfigViewForNdsGroup' - $ref: '#/components/schemas/StreamProcessorMetricAlertConfigViewForNdsGroup' type: object PagerDutyNotification: description: PagerDuty notification configuration for MongoDB Cloud to send information when an event triggers an alert condition. properties: delayMin: description: Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification. format: int32 type: integer integrationId: description: The id of the associated integration, the credentials of which to use for requests. example: 32b6e34b3d91647abb20e7b8 type: string intervalMin: description: '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.' format: int32 minimum: 5 type: integer notifierId: description: 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. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ type: string region: default: US description: PagerDuty region that indicates which API Uniform Resource Locator (URL) to use. enum: - US - EU type: string serviceKey: description: '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.' example: '****************************7890' type: string typeName: description: Human-readable label that displays the alert notification type. enum: - PAGER_DUTY type: string required: - typeName title: PagerDuty Notification type: object FtsJvmCurrentMemoryDataMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/DataMetricUnits' required: - metricName type: object AssertMsgRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object OplogMasterTimeTimeMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/TimeMetricUnits' required: - metricName type: object ServerlessAVGWriteExecutionTimeMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/TimeMetricUnits' required: - metricName type: object FtsJvmMaxMemoryDataMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/DataMetricUnits' required: - metricName type: object NDSX509UserAuthenticationEventTypeViewAlertable: description: Event type that triggers an alert. enum: - NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK - NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK - NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK example: NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK externalDocs: description: Atlas Alert Event Types url: https://www.mongodb.com/docs/atlas/reference/atlas-alert-event-types/ title: x509 User Auth Event Types type: string MaxDiskPartitionWriteIopsIndexRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object MaxNormalizedSystemCpuStealRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object HipChatNotification: description: HipChat notification configuration for MongoDB Cloud to send information when an event triggers an alert condition. properties: delayMin: description: Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification. format: int32 type: integer integrationId: description: The id of the associated integration, the credentials of which to use for requests. example: 32b6e34b3d91647abb20e7b8 type: string intervalMin: description: '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.' format: int32 minimum: 5 type: integer notificationToken: description: '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.' example: '************************************1234' type: string notifierId: description: 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. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ type: string roomName: description: 'HipChat API room name to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `"notifications.[n].typeName" : "HIP_CHAT"`".' example: test room type: string typeName: description: Human-readable label that displays the alert notification type. enum: - HIP_CHAT type: string required: - typeName title: HipChat Notification type: object MatcherFieldView: oneOf: - enum: - APPLICATION_ID title: App Services Metric Matcher Fields type: string - enum: - CLUSTER_NAME title: Cluster Matcher Fields type: string - enum: - TYPE_NAME - HOSTNAME - PORT - HOSTNAME_AND_PORT - REPLICA_SET_NAME - ATLAS_NODE_TYPE title: Host Matcher Fields type: string - enum: - REPLICA_SET_NAME - SHARD_NAME - CLUSTER_NAME title: Replica Set Matcher Fields type: string - enum: - INSTANCE_NAME - PROCESSOR_NAME title: Streams Matcher Fields type: string - enum: - RULE_ID title: Log Ingestion Matcher Fields type: string - enum: - SOFTWARE_TYPE title: Global Software Type Matcher Fields type: string type: object ServerlessOpCounterInsertRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object DiskPartitionReadLatencyDataTimeMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/TimeMetricUnits' required: - metricName type: object FtsMemoryVirtualDataMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/DataMetricUnits' required: - metricName type: object IndexCountersBtreeAccessesRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object ReplicaSetMatcherField: description: 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. enum: - REPLICA_SET_NAME - SHARD_NAME - CLUSTER_NAME example: REPLICA_SET_NAME title: Replica Set Matcher Fields type: string SearchReplicationLagTimeMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/TimeMetricUnits' required: - metricName type: object MaxDiskPartitionWriteLatencyJournalTimeMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/TimeMetricUnits' required: - metricName type: object ComputedMemoryDataMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/DataMetricUnits' required: - metricName type: object MuninCpuNiceRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object OpCounterReplDeleteRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object CpsBackupThresholdAlertConfigViewForNdsGroup: description: 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. properties: created: description: Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 format: date-time readOnly: true type: string enabled: default: false description: Flag that indicates whether someone enabled this alert configuration for the specified project. type: boolean eventTypeName: $ref: '#/components/schemas/CpsBackupEventTypeViewForNdsGroupAlertableWithThreshold' groupId: description: Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string id: description: Unique 24-hexadecimal digit string that identifies this alert configuration. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string links: description: 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. externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: $ref: '#/components/schemas/Link' readOnly: true type: array matchers: description: Matching conditions for target resources. items: $ref: '#/components/schemas/AlertMatcher' type: array notifications: description: List that contains the targets that MongoDB Cloud sends notifications. items: $ref: '#/components/schemas/AlertsNotificationRootForGroup' maxItems: 25 minItems: 1 type: array severityOverride: $ref: '#/components/schemas/EventSeverity' threshold: $ref: '#/components/schemas/GreaterThanTimeThreshold' updated: description: Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 format: date-time readOnly: true type: string required: - eventTypeName - notifications title: Cps Backup Threshold Alert Configuration type: object SearchNumberOfQueriesTotalRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object OpCounterReplUpdateRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object DiskPartitionWriteIopsIndexRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object BadRequestDetail: description: Bad request detail. properties: fields: description: Describes all violations in a client request. items: $ref: '#/components/schemas/FieldViolation' type: array readOnly: true type: object SearchMaxFieldsIndexedRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object EventSeverity: description: Severity of the event. enum: - INFO - WARNING - ERROR - CRITICAL type: string SwapUsageUsedDataMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/DataMetricUnits' required: - metricName type: object SwapUsageFreeDataMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/DataMetricUnits' required: - metricName type: object MaxDiskPartitionSpaceUsedIndexRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object QueryTargetingScannedObjectsPerReturnedRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object BillingThresholdAlertConfigViewForNdsGroup: description: Billing threshold alert configuration allows to select thresholds for bills and invoices which trigger alerts and how users are notified. properties: created: description: Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 format: date-time readOnly: true type: string enabled: default: false description: Flag that indicates whether someone enabled this alert configuration for the specified project. type: boolean eventTypeName: $ref: '#/components/schemas/BillingEventTypeViewAlertableWithThreshold' groupId: description: Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string id: description: Unique 24-hexadecimal digit string that identifies this alert configuration. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string links: description: 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. externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: $ref: '#/components/schemas/Link' readOnly: true type: array matchers: description: Matching conditions for target resources. items: $ref: '#/components/schemas/AlertMatcher' type: array notifications: description: List that contains the targets that MongoDB Cloud sends notifications. items: $ref: '#/components/schemas/AlertsNotificationRootForGroup' maxItems: 25 minItems: 1 type: array severityOverride: $ref: '#/components/schemas/EventSeverity' threshold: $ref: '#/components/schemas/GreaterThanRawThreshold' updated: description: Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 format: date-time readOnly: true type: string required: - eventTypeName - notifications title: Billing Threshold Alert Configuration type: object GlobalLockPercentageRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object ConnectionsPercentRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object MemoryVirtualDataMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/DataMetricUnits' required: - metricName type: object DiskPartitionWriteLatencyDataTimeMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/TimeMetricUnits' required: - metricName type: object MuninCpuUserRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object FlexMetricAlertConfigViewForNdsGroup: description: Flex metric alert configuration allows to select which Flex database metrics trigger alerts and how users are notified. properties: created: description: Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 format: date-time readOnly: true type: string enabled: default: false description: Flag that indicates whether someone enabled this alert configuration for the specified project. type: boolean eventTypeName: $ref: '#/components/schemas/FlexMetricEventTypeViewAlertable' groupId: description: Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string id: description: Unique 24-hexadecimal digit string that identifies this alert configuration. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string links: description: 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. externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: $ref: '#/components/schemas/Link' readOnly: true type: array matchers: description: Matching conditions for target resources. items: $ref: '#/components/schemas/AlertMatcher' type: array metricThreshold: $ref: '#/components/schemas/FlexClusterMetricThreshold' notifications: description: List that contains the targets that MongoDB Cloud sends notifications. items: $ref: '#/components/schemas/AlertsNotificationRootForGroup' maxItems: 25 minItems: 1 type: array severityOverride: $ref: '#/components/schemas/EventSeverity' updated: description: Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 format: date-time readOnly: true type: string required: - eventTypeName - notifications title: Flex Alert Configuration type: object PaginatedAlertConfigView: properties: links: description: 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. externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: $ref: '#/components/schemas/Link' readOnly: true type: array results: description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: '#/components/schemas/GroupAlertsConfig' readOnly: true type: array totalCount: description: 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. format: int32 minimum: 0 readOnly: true type: integer required: - results type: object ServerlessAVGCommandExecutionTimeMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/TimeMetricUnits' required: - metricName type: object EncryptionKeyEventTypeViewAlertable: description: Event type that triggers an alert. enum: - AWS_ENCRYPTION_KEY_NEEDS_ROTATION - AZURE_ENCRYPTION_KEY_NEEDS_ROTATION - GCP_ENCRYPTION_KEY_NEEDS_ROTATION - AWS_ENCRYPTION_KEY_INVALID - AZURE_ENCRYPTION_KEY_INVALID - GCP_ENCRYPTION_KEY_INVALID example: AWS_ENCRYPTION_KEY_NEEDS_ROTATION externalDocs: description: Atlas Alert Event Types url: https://www.mongodb.com/docs/atlas/reference/atlas-alert-event-types/ title: Encryption Event Types type: string Operator: description: Comparison operator to apply when checking the current metric value. enum: - < - '>' type: string GroupNotification: description: Group notification configuration for MongoDB Cloud to send information when an event triggers an alert condition. properties: delayMin: description: Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification. format: int32 type: integer emailEnabled: description: '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"`' type: boolean intervalMin: description: '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.' format: int32 minimum: 5 type: integer notifierId: description: 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. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ type: string roles: description: '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.' externalDocs: description: Project Roles url: https://dochub.mongodb.org/core/atlas-proj-roles items: description: One or more project roles that receive the configured alert. type: string type: array smsEnabled: description: '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"`' type: boolean typeName: description: Human-readable label that displays the alert notification type. enum: - GROUP type: string required: - typeName title: Group Notification type: object MaxDiskPartitionReadLatencyIndexTimeMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/TimeMetricUnits' required: - metricName type: object IndexCountersBtreeMissesRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object DiskPartitionReadLatencyJournalTimeMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/TimeMetricUnits' required: - metricName type: object DefaultAlertConfigViewForNdsGroup: description: Other alerts which don't have extra details beside of basic one. properties: created: description: Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 format: date-time readOnly: true type: string enabled: default: false description: Flag that indicates whether someone enabled this alert configuration for the specified project. type: boolean eventTypeName: description: Incident that triggered this alert. externalDocs: description: Atlas Alert Event Types url: https://www.mongodb.com/docs/atlas/reference/atlas-alert-event-types/ oneOf: - enum: - CREDIT_CARD_ABOUT_TO_EXPIRE title: Billing Event Types type: string - enum: - 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 - CPS_OPLOG_CAUGHT_UP title: Cps Backup Event Types type: string - enum: - 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 - CPS_DATA_PROTECTION_APPROVED_FOR_DISABLEMENT title: Data Protection Event Types type: string - enum: - FTS_INDEX_DELETION_FAILED - FTS_INDEX_BUILD_COMPLETE - FTS_INDEX_BUILD_FAILED - FTS_INDEX_CLEANED_UP - FTS_INDEX_STALE - FTS_INDEXES_RESTORE_FAILED - FTS_INDEXES_SYNONYM_MAPPING_INVALID title: FTS Index Audit Types type: string - enum: - 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 - ACTIVE_LEGACY_TLS_CONNECTIONS title: Group Event Types type: string - enum: - MONGOTUNE_ALERT title: Mongotune Event Types type: string - enum: - 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 title: Atlas Audit Types type: string - enum: - MAINTENANCE_IN_ADVANCED - MAINTENANCE_AUTO_DEFERRED - MAINTENANCE_STARTED - MAINTENANCE_COMPLETED - MAINTENANCE_NO_LONGER_NEEDED title: Maintenance Window Audit Types type: string - enum: - ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK - ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK title: Online Archive Event Types type: string - enum: - JOINED_GROUP - REMOVED_FROM_GROUP - USER_ROLES_CHANGED_AUDIT title: User Event Types type: string - enum: - TAGS_MODIFIED - CLUSTER_TAGS_MODIFIED - GROUP_TAGS_MODIFIED title: Resource Event Types type: string - enum: - STREAM_PROCESSOR_STATE_IS_FAILED - OUTSIDE_STREAM_PROCESSOR_METRIC_THRESHOLD title: Stream Processor Event Types type: string - enum: - 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_DOWNSCALE_SKIPPED_FALLBACK_BASE - COMPUTE_AUTO_SCALE_DOWNSCALE_SKIPPED_FALLBACK_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 title: Auto Scaling Audit Types type: string - enum: - RESOURCE_POLICY_VIOLATED title: Atlas Resource Policy Audit Types type: string - enum: - 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_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 - PROFILER_CONFIGURED_TOO_WIDELY title: Host Event Types type: string type: object groupId: description: Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string id: description: Unique 24-hexadecimal digit string that identifies this alert configuration. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string links: description: 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. externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: $ref: '#/components/schemas/Link' readOnly: true type: array matchers: description: Matching conditions for target resources. items: $ref: '#/components/schemas/AlertMatcher' type: array notifications: description: List that contains the targets that MongoDB Cloud sends notifications. items: $ref: '#/components/schemas/AlertsNotificationRootForGroup' maxItems: 25 minItems: 1 type: array severityOverride: $ref: '#/components/schemas/EventSeverity' updated: description: Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 format: date-time readOnly: true type: string required: - eventTypeName - notifications title: Any Other Alert Configurations type: object HostMetricEventTypeViewAlertable: description: Event type that triggers an alert. enum: - OUTSIDE_METRIC_THRESHOLD example: OUTSIDE_METRIC_THRESHOLD externalDocs: description: Atlas Alert Event Types url: https://www.mongodb.com/docs/atlas/reference/atlas-alert-event-types/ title: Host Metric Event Types type: string NetworkBytesInDataMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/DataMetricUnits' required: - metricName type: object MuninCpuSystemRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object NormalizedFtsProcessCpuKernelRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object GreaterThanRawThreshold: description: A Limit that triggers an alert when greater than a number. properties: operator: description: Comparison operator to apply when checking the current metric value. enum: - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: int32 type: integer units: $ref: '#/components/schemas/RawMetricUnits' title: Greater Than Raw Threshold type: object FlexOpCounterDeleteRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object MongotuneAlertConfigViewForNdsGroup: description: Intelligent Workload Management alert configuration allows to select which Intelligent Workload Management events trigger alerts and how users are notified. properties: created: description: Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 format: date-time readOnly: true type: string enabled: default: false description: Flag that indicates whether someone enabled this alert configuration for the specified project. type: boolean eventTypeName: $ref: '#/components/schemas/MongotuneEventTypeViewAlertable' groupId: description: Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string id: description: Unique 24-hexadecimal digit string that identifies this alert configuration. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string links: description: 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. externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: $ref: '#/components/schemas/Link' readOnly: true type: array matchers: description: Matching conditions for target resources. items: $ref: '#/components/schemas/AlertMatcher' type: array notifications: description: List that contains the targets that MongoDB Cloud sends notifications. items: $ref: '#/components/schemas/AlertsNotificationRootForGroup' maxItems: 25 minItems: 1 type: array severityOverride: $ref: '#/components/schemas/EventSeverity' updated: description: Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 format: date-time readOnly: true type: string required: - eventTypeName - notifications title: Intelligent Workload Management Alert Configuration type: object SearchNumberOfQueriesErrorRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object FlexOpCounterCMDRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object JournalingWriteDataFilesMbDataMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/DataMetricUnits' required: - metricName type: object EmailNotification: description: Email notification configuration for MongoDB Cloud to send information when an event triggers an alert condition. properties: delayMin: description: Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification. format: int32 type: integer emailAddress: description: '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.' format: email type: string intervalMin: description: '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.' format: int32 minimum: 5 type: integer notifierId: description: 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. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ type: string typeName: description: Human-readable label that displays the alert notification type. enum: - EMAIL type: string required: - typeName title: Email Notification type: object FtsMemoryResidentDataMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/DataMetricUnits' required: - metricName type: object AppServiceMetricMatcher: description: Rules to apply when comparing an app service metric against this alert configuration. properties: fieldName: $ref: '#/components/schemas/AppServiceMetricMatcherField' operator: description: Comparison operator to apply when checking the current metric value against **matcher[n].value**. The `REGEX` operator only supports inclusive matches. Use the `NOT_CONTAINS` operator to exclude values. enum: - EQUALS - CONTAINS - STARTS_WITH - ENDS_WITH - NOT_EQUALS - NOT_CONTAINS - REGEX type: string value: description: Value to match or exceed using the specified `matchers.operator`. example: event-replica-set type: string required: - fieldName - operator - value title: Matchers type: object KafkaRawMetricThresholdView: properties: metricName: description: Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`. type: string mode: description: MongoDB Cloud computes the current metric value as an average. enum: - AVERAGE type: string operator: description: Comparison operator to apply when checking the current metric value. enum: - LESS_THAN - GREATER_THAN type: string threshold: description: Value of metric that, when exceeded, triggers an alert. format: double type: number units: $ref: '#/components/schemas/RawMetricUnits' required: - metricName type: object EncryptionKeyAlertConfigViewForNdsGroup: description: Encryption key alert configuration allows to select thresholds which trigger alerts and how users are notified. properties: created: description: Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 format: date-time readOnly: true type: string enabled: default: false description: Flag that indicates whether someone enabled this alert configuration for the specified project. type: boolean eventTypeName: $ref: '#/components/schemas/EncryptionKeyEventTypeViewAlertable' groupId: description: Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string id: description: Unique 24-hexadecimal digit string that identifies this alert configuration. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string links: description: 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. externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: $ref: '#/components/schemas/Link' readOnly: true type: array matchers: description: Matching conditions for target resources. items: $ref: '#/components/schemas/AlertMatcher' type: array notifications: description: List that contains the targets that MongoDB Cloud sends notifications. items: $ref: '#/components/schemas/AlertsNotificationRootForGroup' maxItems: 25 minItems: 1 type: array severityOverride: $ref: '#/components/schemas/EventSeverity' threshold: $ref: '#/components/schemas/GreaterThanDaysThresholdView' updated: description: Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC. externalDocs: description: ISO 8601 url: https://en.wikipedia.org/wiki/ISO_8601 format: date-time readOnly: true type: string required: - eventTypeName - notifications title: Encryption Key Alert Configuration type: object parameters: envelope: 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. in: query name: envelope schema: default: false type: boolean pretty: description: Flag that indicates whether the response body should be in the prettyprint format. in: query name: pretty schema: default: false externalDocs: description: Prettyprint url: https://en.wikipedia.org/wiki/Prettyprint type: boolean itemsPerPage: description: Number of items that the response returns per page. in: query name: itemsPerPage schema: default: 100 maximum: 500 minimum: 1 type: integer groupId: 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. **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.' in: path name: groupId required: true schema: example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ type: string includeCount: description: Flag that indicates whether the response returns the total number of items (`totalCount`) in the response. in: query name: includeCount schema: default: true type: boolean pageNum: description: Number of the page that displays the current set of the total objects that the response returns. in: query name: pageNum schema: default: 1 minimum: 1 type: integer responses: unauthorized: content: application/json: example: detail: (This is just an example, the exception may not be related to this endpoint) error: 401 errorCode: NOT_ORG_GROUP_CREATOR reason: Unauthorized schema: $ref: '#/components/schemas/ApiError' description: Unauthorized. notFound: content: application/json: example: 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 schema: $ref: '#/components/schemas/ApiError' description: Not Found. forbidden: content: application/json: example: detail: (This is just an example, the exception may not be related to this endpoint) error: 403 errorCode: CANNOT_CHANGE_GROUP_NAME reason: Forbidden schema: $ref: '#/components/schemas/ApiError' description: Forbidden. tooManyRequests: content: application/json: example: detail: (This is just an example, the exception may not be related to this endpoint) error: 429 errorCode: RATE_LIMITED reason: Too Many Requests schema: $ref: '#/components/schemas/ApiError' description: Too Many Requests. headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' Retry-After: $ref: '#/components/headers/HeaderRetryAfter' internalServerError: content: application/json: example: detail: (This is just an example, the exception may not be related to this endpoint) error: 500 errorCode: UNEXPECTED_ERROR reason: Internal Server Error schema: $ref: '#/components/schemas/ApiError' description: Internal Server Error. badRequest: content: application/json: example: 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 schema: $ref: '#/components/schemas/ApiError' description: Bad Request. headers: HeaderRetryAfter: description: The minimum time you should wait, in seconds, before retrying the API request. This header might be returned for 429 or 503 error responses. schema: type: integer HeaderRateLimitRemaining: description: The number of requests remaining in the current rate limit window before the limit is reached. schema: type: integer HeaderRateLimitLimit: description: The maximum number of requests that a user can make within a specific time window. schema: type: integer securitySchemes: DigestAuth: scheme: digest type: http ServiceAccounts: description: Learn more about [Service Accounts](https://www.mongodb.com/docs/atlas/api/service-accounts-overview). flows: clientCredentials: scopes: {} tokenUrl: https://cloud.mongodb.com/api/oauth/token type: oauth2 x-externalLinks: - label: Back to Atlas Docs url: https://www.mongodb.com/docs/atlas/ - label: API Changelog url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/changelog/ x-topics: - content: The MongoDB Atlas Administration API is rate limited. To learn more about rate limiting, see the [Atlas Documentation on Rate Limiting](http://dochub.mongodb.org/core/atlas-api-rate-limit) title: Rate Limiting