mongodb · apix-bot · Apr 10, 2025 · Apr 9, 2025
@@ -14,7 +14,7 @@ atlas api accessTracking listAccessLogsByClusterName
 
 `Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns the access logs of one cluster identified by the cluster's name.
 
-Access logs contain a list of authentication requests made against your cluster. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting API Key must have the Project Monitoring Admin role or the Project Database Access Admin role.
+Access logs contain a list of authentication requests made against your cluster. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting Service Account or API Key must have the Project Monitoring Admin role or the Project Database Access Admin role.
 
 This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Access-Tracking/operation/listAccessLogsByClusterName.
 
@@ -86,7 +86,7 @@ Options
    * - --pretty
      - 
      - false
-     - Flag that indicates whether the response body should be in the <a href="https://en.wikipedia.org/wiki/Prettyprint" target="_blank" rel="noopener noreferrer">prettyprint</a> format.
+     - Flag that indicates whether the response body should be in the prettyprint format.
    * - --start
      - int
      - false
@@ -119,7 +119,7 @@ Run the command below.
 
 .. code-block::
 
-   atlas api accessTracking listAccessLogsByClusterName --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false
+   atlas api accessTracking listAccessLogsByClusterName --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8
 
 .. Code end marker, please don't delete this comment
 
@@ -14,7 +14,7 @@ atlas api accessTracking listAccessLogsByHostname
 
 `Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns the access logs of one cluster identified by the cluster's hostname.
 
-Access logs contain a list of authentication requests made against your clusters. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting API Key must have the Project Monitoring Admin role or the Project Database Access Admin role.
+Access logs contain a list of authentication requests made against your clusters. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting Service Account or API Key must have the Project Monitoring Admin role or the Project Database Access Admin role.
 
 This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Access-Tracking/operation/listAccessLogsByHostname.
 
@@ -86,7 +86,7 @@ Options
    * - --pretty
      - 
      - false
-     - Flag that indicates whether the response body should be in the <a href="https://en.wikipedia.org/wiki/Prettyprint" target="_blank" rel="noopener noreferrer">prettyprint</a> format.
+     - Flag that indicates whether the response body should be in the prettyprint format.
    * - --start
      - int
      - false
@@ -119,7 +119,7 @@ Run the command below.
 
 .. code-block::
 
-   atlas api accessTracking listAccessLogsByHostname --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --hostname [hostname] --pretty false
+   atlas api accessTracking listAccessLogsByHostname --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --hostname [hostname]
 
 .. Code end marker, please don't delete this comment
 
@@ -14,7 +14,7 @@ atlas api alertConfigurations createAlertConfiguration
 
 `Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Creates one alert configuration for the specified project.
 
-Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role.
+Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role.
 
 
 This resource remains under revision and may change.
@@ -73,7 +73,7 @@ Options
    * - --pretty
      - 
      - false
-     - Flag that indicates whether the response body should be in the <a href="https://en.wikipedia.org/wiki/Prettyprint" target="_blank" rel="noopener noreferrer">prettyprint</a> format.
+     - Flag that indicates whether the response body should be in the prettyprint format.
    * - --version
      - string
      - false

@@ -14,7 +14,7 @@ atlas api alertConfigurations deleteAlertConfiguration
 
 `Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Removes one alert configuration from the specified project.
 
-To use this resource, the requesting API Key must have the Organization Owner or Project Owner role.
+To use this resource, the requesting Service Account or API Key must have the 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.
@@ -47,7 +47,7 @@ Options
    * - --alertConfigId
      - string
      - true
-     - Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.
+     - Unique 24-hexadecimal digit string that identifies the alert configuration.
    * - --envelope
      - envelope
      - false
@@ -73,7 +73,7 @@ Options
    * - --pretty
      - 
      - false
-     - Flag that indicates whether the response body should be in the <a href="https://en.wikipedia.org/wiki/Prettyprint" target="_blank" rel="noopener noreferrer">prettyprint</a> format.
+     - Flag that indicates whether the response body should be in the prettyprint format.
    * - --version
      - string
      - false
@@ -102,7 +102,7 @@ Run the command below.
 
 .. code-block::
 
-   atlas api alertConfigurations deleteAlertConfiguration --version 2023-01-01 --alertConfigId 32b6e34b3d91647abb20e7b8 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false
+   atlas api alertConfigurations deleteAlertConfiguration --version 2023-01-01 --alertConfigId 32b6e34b3d91647abb20e7b8 --groupId 32b6e34b3d91647abb20e7b8
 
 .. Code end marker, please don't delete this comment
 
@@ -14,7 +14,7 @@ atlas api alertConfigurations getAlertConfiguration
 
 `Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns the specified alert configuration from the specified project.
 
-To use this resource, the requesting API Key must have the Project Read Only role.
+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.
@@ -47,7 +47,7 @@ Options
    * - --alertConfigId
      - string
      - true
-     - Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.
+     - Unique 24-hexadecimal digit string that identifies the alert configuration.
    * - --envelope
      - envelope
      - false
@@ -73,7 +73,7 @@ Options
    * - --pretty
      - 
      - false
-     - Flag that indicates whether the response body should be in the <a href="https://en.wikipedia.org/wiki/Prettyprint" target="_blank" rel="noopener noreferrer">prettyprint</a> format.
+     - Flag that indicates whether the response body should be in the prettyprint format.
    * - --version
      - string
      - false
@@ -102,7 +102,7 @@ Run the command below.
 
 .. code-block::
 
-   atlas api alertConfigurations getAlertConfiguration --version 2023-01-01 --alertConfigId 32b6e34b3d91647abb20e7b8 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false
+   atlas api alertConfigurations getAlertConfiguration --version 2023-01-01 --alertConfigId 32b6e34b3d91647abb20e7b8 --groupId 32b6e34b3d91647abb20e7b8
 
 .. Code end marker, please don't delete this comment
 
@@ -60,7 +60,7 @@ Options
    * - --pretty
      - 
      - false
-     - Flag that indicates whether the response body should be in the <a href="https://en.wikipedia.org/wiki/Prettyprint" target="_blank" rel="noopener noreferrer">prettyprint</a> format.
+     - Flag that indicates whether the response body should be in the prettyprint format.
    * - --version
      - string
      - false
@@ -82,14 +82,3 @@ Inherited Options
      - false
      - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.
 
-Examples
------------------
-
-Run the command below.
-
-.. code-block::
-
-   atlas api alertConfigurations listAlertConfigurationMatchersFieldNames --version 2023-01-01 --envelope false --pretty false
-
-.. Code end marker, please don't delete this comment
-
@@ -14,7 +14,7 @@ atlas api alertConfigurations listAlertConfigurations
 
 `Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: 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 API Key must have the Project Read Only role.
+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.
@@ -81,7 +81,7 @@ Options
    * - --pretty
      - 
      - false
-     - Flag that indicates whether the response body should be in the <a href="https://en.wikipedia.org/wiki/Prettyprint" target="_blank" rel="noopener noreferrer">prettyprint</a> format.
+     - Flag that indicates whether the response body should be in the prettyprint format.
    * - --version
      - string
      - false
@@ -110,7 +110,7 @@ Run the command below.
 
 .. code-block::
 
-   atlas api alertConfigurations listAlertConfigurations --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false
+   atlas api alertConfigurations listAlertConfigurations --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8
 
 .. Code end marker, please don't delete this comment
 
@@ -14,7 +14,7 @@ atlas api alertConfigurations listAlertConfigurationsByAlertId
 
 `Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns all alert configurations set for the specified alert.
 
-To use this resource, the requesting API Key must have the Project Read Only role.
+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.
@@ -47,7 +47,7 @@ Options
    * - --alertId
      - string
      - true
-     - Unique 24-hexadecimal digit string that identifies the alert. Use the [/alerts](#tag/Alerts/operation/listAlerts) endpoint to retrieve all alerts to which the authenticated user has access.
+     - Unique 24-hexadecimal digit string that identifies the alert.
    * - --envelope
      - envelope
      - false
@@ -85,7 +85,7 @@ Options
    * - --pretty
      - 
      - false
-     - Flag that indicates whether the response body should be in the <a href="https://en.wikipedia.org/wiki/Prettyprint" target="_blank" rel="noopener noreferrer">prettyprint</a> format.
+     - Flag that indicates whether the response body should be in the prettyprint format.
    * - --version
      - string
      - false
@@ -114,7 +114,7 @@ Run the command below.
 
 .. code-block::
 
-   atlas api alertConfigurations listAlertConfigurationsByAlertId --version 2023-01-01 --alertId [alertId] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false
+   atlas api alertConfigurations listAlertConfigurationsByAlertId --version 2023-01-01 --alertId [alertId] --groupId 32b6e34b3d91647abb20e7b8
 
 .. Code end marker, please don't delete this comment
 
@@ -14,7 +14,7 @@ atlas api alertConfigurations toggleAlertConfiguration
 
 `Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: 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 API Key must have the Organization Owner or Project Owner role.
+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 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.
@@ -50,7 +50,7 @@ Options
    * - --alertConfigId
      - string
      - true
-     - Unique 24-hexadecimal digit string that identifies the alert configuration that triggered this alert. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.
+     - Unique 24-hexadecimal digit string that identifies the alert configuration that triggered this alert.
    * - --envelope
      - envelope
      - false
@@ -80,7 +80,7 @@ Options
    * - --pretty
      - 
      - false
-     - Flag that indicates whether the response body should be in the <a href="https://en.wikipedia.org/wiki/Prettyprint" target="_blank" rel="noopener noreferrer">prettyprint</a> format.
+     - Flag that indicates whether the response body should be in the prettyprint format.
    * - --version
      - string
      - false

@@ -14,7 +14,7 @@ atlas api alertConfigurations updateAlertConfiguration
 
 `Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Updates one alert configuration in the specified project.
 
-Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role.
+Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting Service Account or API Key must have the 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.
@@ -50,7 +50,7 @@ Options
    * - --alertConfigId
      - string
      - true
-     - Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.
+     - Unique 24-hexadecimal digit string that identifies the alert configuration.
    * - --envelope
      - envelope
      - false
@@ -80,7 +80,7 @@ Options
    * - --pretty
      - 
      - false
-     - Flag that indicates whether the response body should be in the <a href="https://en.wikipedia.org/wiki/Prettyprint" target="_blank" rel="noopener noreferrer">prettyprint</a> format.
+     - Flag that indicates whether the response body should be in the prettyprint format.
    * - --version
      - string
      - false

@@ -14,7 +14,7 @@ atlas api alerts acknowledgeAlert
 
 `Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Confirms receipt of one existing alert.
 
-This alert applies to any component in one project. Acknowledging an alert prevents successive notifications. You receive an alert when a monitored component meets or exceeds a value you set until you acknowledge the alert. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role.
+This alert applies to any component in one project. Acknowledging an alert prevents successive notifications. You receive an alert when a monitored component meets or exceeds a value you set until you acknowledge the alert. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner 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.
@@ -47,7 +47,7 @@ Options
    * - --alertId
      - string
      - true
-     - Unique 24-hexadecimal digit string that identifies the alert. Use the [/alerts](#tag/Alerts/operation/listAlerts) endpoint to retrieve all alerts to which the authenticated user has access.
+     - Unique 24-hexadecimal digit string that identifies the alert.
    * - --envelope
      - envelope
      - false
@@ -77,7 +77,7 @@ Options
    * - --pretty
      - 
      - false
-     - Flag that indicates whether the response body should be in the <a href="https://en.wikipedia.org/wiki/Prettyprint" target="_blank" rel="noopener noreferrer">prettyprint</a> format.
+     - Flag that indicates whether the response body should be in the prettyprint format.
    * - --version
      - string
      - false

@@ -14,7 +14,7 @@ atlas api alerts getAlert
 
 `Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns one alert.
 
-This alert applies to any component in one project. You receive an alert when a monitored component meets or exceeds a value you set. To use this resource, the requesting API Key must have the Project Read Only role.
+This alert applies to any component in one project. You receive an alert when a monitored component meets or exceeds a value you set. 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.
@@ -47,7 +47,7 @@ Options
    * - --alertId
      - string
      - true
-     - Unique 24-hexadecimal digit string that identifies the alert. Use the [/alerts](#tag/Alerts/operation/listAlerts) endpoint to retrieve all alerts to which the authenticated user has access.
+     - Unique 24-hexadecimal digit string that identifies the alert.
    * - --envelope
      - envelope
      - false
@@ -73,7 +73,7 @@ Options
    * - --pretty
      - 
      - false
-     - Flag that indicates whether the response body should be in the <a href="https://en.wikipedia.org/wiki/Prettyprint" target="_blank" rel="noopener noreferrer">prettyprint</a> format.
+     - Flag that indicates whether the response body should be in the prettyprint format.
    * - --version
      - string
      - false
@@ -102,7 +102,7 @@ Run the command below.
 
 .. code-block::
 
-   atlas api alerts getAlert --version 2023-01-01 --alertId [alertId] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false
+   atlas api alerts getAlert --version 2023-01-01 --alertId [alertId] --groupId 32b6e34b3d91647abb20e7b8
 
 .. Code end marker, please don't delete this comment