Project import generated by Copybara. (#957)

GitOrigin-RevId: c626b7201d50dbb27d127a5e432ae9f6b2e3955d

Co-authored-by: apix-bot[bot] <168195273+apix-bot[bot]@users.noreply.github.com>

Author: apix-bot[bot]

source/command/atlas-api-accessTracking-listAccessLogsByClusterName.txt

@@ -12,7 +12,7 @@ atlas api accessTracking listAccessLogsByClusterName
    :depth: 1
    :class: singlecol
 
-`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Returns the access logs of one cluster identified by the cluster's name.
+`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.
 
@@ -44,35 +44,37 @@ Options
    * - --authResult
      - 
      - false
-     - flag that indicates whether the response returns the successful authentication attempts only
+     - Flag that indicates whether the response returns the successful authentication attempts only.
    * - --clusterName
      - string
      - true
-     - human-readable label that identifies the cluster
+     - Human-readable label that identifies the cluster.
    * - --end
      - int
      - false
-     - date and time when to stop retrieving database history
+     - Date and time when to stop retrieving database history. If you specify **end**, you must also specify **start**. This parameter uses UNIX epoch time in milliseconds.
    * - --envelope
-     - 
+     - envelope
      - false
-     - flag that indicates whether Application wraps the response in an envelope JSON object
+     - 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.
    * - --groupId
      - string
      - true
-     - unique 24-hexadecimal digit string that identifies your project
+     - 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.
    * - -h, --help
      - 
      - false
      - help for listAccessLogsByClusterName
    * - --ipAddress
      - string
      - false
-     - one Internet Protocol address that attempted to authenticate with the database
+     - One Internet Protocol address that attempted to authenticate with the database.
    * - --nLogs
      - int
      - false
-     - maximum number of lines from the log to return
+     - Maximum number of lines from the log to return.
    * - --output
      - string
      - false
@@ -84,11 +86,11 @@ Options
    * - --pretty
      - 
      - false
-     - flag that indicates whether the response body should be in the prettyprint format
+     - 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.
    * - --start
      - int
      - false
-     - date and time when MongoDB Cloud begins retrieving database history
+     - Date and time when MongoDB Cloud begins retrieving database history. If you specify **start**, you must also specify **end**. This parameter uses UNIX epoch time in milliseconds.
    * - --version
      - string
      - false
@@ -110,3 +112,14 @@ 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 accessTracking listAccessLogsByClusterName --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false
+
+.. Code end marker, please don't delete this comment
+

source/command/atlas-api-accessTracking-listAccessLogsByHostname.txt

@@ -12,7 +12,7 @@ atlas api accessTracking listAccessLogsByHostname
    :depth: 1
    :class: singlecol
 
-`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Returns the access logs of one cluster identified by the cluster's hostname.
+`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.
 
@@ -44,35 +44,37 @@ Options
    * - --authResult
      - 
      - false
-     - flag that indicates whether the response returns the successful authentication attempts only
+     - Flag that indicates whether the response returns the successful authentication attempts only.
    * - --end
      - int
      - false
-     - date and time when to stop retrieving database history
+     - Date and time when to stop retrieving database history. If you specify **end**, you must also specify **start**. This parameter uses UNIX epoch time in milliseconds.
    * - --envelope
-     - 
+     - envelope
      - false
-     - flag that indicates whether Application wraps the response in an envelope JSON object
+     - 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.
    * - --groupId
      - string
      - true
-     - unique 24-hexadecimal digit string that identifies your project
+     - 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.
    * - -h, --help
      - 
      - false
      - help for listAccessLogsByHostname
    * - --hostname
      - string
      - true
-     - fully qualified domain name or IP address of the MongoDB host that stores the log files that you want to download
+     - Fully qualified domain name or IP address of the MongoDB host that stores the log files that you want to download.
    * - --ipAddress
      - string
      - false
-     - one Internet Protocol address that attempted to authenticate with the database
+     - One Internet Protocol address that attempted to authenticate with the database.
    * - --nLogs
      - int
      - false
-     - maximum number of lines from the log to return
+     - Maximum number of lines from the log to return.
    * - --output
      - string
      - false
@@ -84,11 +86,11 @@ Options
    * - --pretty
      - 
      - false
-     - flag that indicates whether the response body should be in the prettyprint format
+     - 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.
    * - --start
      - int
      - false
-     - date and time when MongoDB Cloud begins retrieving database history
+     - Date and time when MongoDB Cloud begins retrieving database history. If you specify **start**, you must also specify **end**. This parameter uses UNIX epoch time in milliseconds.
    * - --version
      - string
      - false
@@ -110,3 +112,14 @@ 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 accessTracking listAccessLogsByHostname --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --hostname [hostname] --pretty false
+
+.. Code end marker, please don't delete this comment
+

source/command/atlas-api-accessTracking.txt

@@ -12,7 +12,7 @@ atlas api accessTracking
    :depth: 1
    :class: singlecol
 
-`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Returns access logs for authentication attempts made to Atlas database deployments.
+`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns access logs for authentication attempts made to Atlas database deployments.
 
 To view database access history, you must have either the Project Owner or Organization Owner role.
 
@@ -51,8 +51,8 @@ Inherited Options
 Related Commands
 ----------------
 
-* :ref:`atlas-api-accessTracking-listAccessLogsByClusterName` - `experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Returns the access logs of one cluster identified by the cluster's name.
-* :ref:`atlas-api-accessTracking-listAccessLogsByHostname` - `experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Returns the access logs of one cluster identified by the cluster's hostname.
+* :ref:`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.
+* :ref:`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.
 
 
 .. toctree::

source/command/atlas-api-alertConfigurations-createAlertConfiguration.txt

@@ -12,7 +12,7 @@ atlas api alertConfigurations createAlertConfiguration
    :depth: 1
    :class: singlecol
 
-`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Creates one alert configuration for the specified project.
+`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.
 
@@ -45,17 +45,19 @@ Options
      - Required
      - Description
    * - --envelope
-     - 
+     - envelope
      - false
-     - flag that indicates whether Application wraps the response in an envelope JSON object
+     - 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.
    * - --file
      - string
      - false
      - path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both.
    * - --groupId
      - string
      - true
-     - unique 24-hexadecimal digit string that identifies your project
+     - 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.
    * - -h, --help
      - 
      - false
@@ -71,7 +73,7 @@ Options
    * - --pretty
      - 
      - false
-     - flag that indicates whether the response body should be in the prettyprint format
+     - 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.
    * - --version
      - string
      - false

source/command/atlas-api-alertConfigurations-deleteAlertConfiguration.txt

@@ -12,7 +12,7 @@ atlas api alertConfigurations deleteAlertConfiguration
    :depth: 1
    :class: singlecol
 
-`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Removes one alert configuration from the specified project.
+`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.
 
@@ -47,15 +47,17 @@ Options
    * - --alertConfigId
      - string
      - true
-     - unique 24-hexadecimal digit string that identifies the alert configuration
+     - 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.
    * - --envelope
-     - 
+     - envelope
      - false
-     - flag that indicates whether Application wraps the response in an envelope JSON object
+     - 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.
    * - --groupId
      - string
      - true
-     - unique 24-hexadecimal digit string that identifies your project
+     - 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.
    * - -h, --help
      - 
      - false
@@ -71,7 +73,7 @@ Options
    * - --pretty
      - 
      - false
-     - flag that indicates whether the response body should be in the prettyprint format
+     - 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.
    * - --version
      - string
      - false
@@ -93,3 +95,14 @@ 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 deleteAlertConfiguration --version 2023-01-01 --alertConfigId 32b6e34b3d91647abb20e7b8 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false
+
+.. Code end marker, please don't delete this comment
+

source/command/atlas-api-alertConfigurations-getAlertConfiguration.txt

@@ -12,7 +12,7 @@ atlas api alertConfigurations getAlertConfiguration
    :depth: 1
    :class: singlecol
 
-`experimental <https://www.mongodb.com/docs/atlas/cli/current/command/atlas-api/>`_: Returns the specified alert configuration from the specified project.
+`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.
 
@@ -47,15 +47,17 @@ Options
    * - --alertConfigId
      - string
      - true
-     - unique 24-hexadecimal digit string that identifies the alert configuration
+     - 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.
    * - --envelope
-     - 
+     - envelope
      - false
-     - flag that indicates whether Application wraps the response in an envelope JSON object
+     - 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.
    * - --groupId
      - string
      - true
-     - unique 24-hexadecimal digit string that identifies your project
+     - 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.
    * - -h, --help
      - 
      - false
@@ -71,7 +73,7 @@ Options
    * - --pretty
      - 
      - false
-     - flag that indicates whether the response body should be in the prettyprint format
+     - 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.
    * - --version
      - string
      - false
@@ -93,3 +95,14 @@ 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 getAlertConfiguration --version 2023-01-01 --alertConfigId 32b6e34b3d91647abb20e7b8 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false
+
+.. Code end marker, please don't delete this comment
+