Skip to content

CLOUDP-313028: Improve atlas api command docs to indicate only the commands are in public preview, not the features #3908

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
May 23, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
5 changes: 5 additions & 0 deletions docs/command/atlas-accessLists-create.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@ atlas accessLists create

Create an IP access list entry for your project.

Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.



The access list can contain trusted IP addresses, AWS security group IDs, and entries in Classless Inter-Domain Routing (CIDR) notation. You can add only one access list entry at a time. You can create one access list per project.

The command doesn't overwrite existing entries in the access list. Instead, it adds the new entries to the list of entries.
Expand Down
5 changes: 5 additions & 0 deletions docs/command/atlas-accessLists-delete.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@ atlas accessLists delete

Remove the specified IP access list entry from your project.

Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.



The command, when run without the force option, prompts you to confirm the operation.

To use this command, you must authenticate with a user account or an API key with the Read Write role.
Expand Down
5 changes: 5 additions & 0 deletions docs/command/atlas-accessLists-describe.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@ atlas accessLists describe

Return the details for the specified IP access list entry.

Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.



To use this command, you must authenticate with a user account or an API key with the Organization Member role.

Syntax
Expand Down
5 changes: 5 additions & 0 deletions docs/command/atlas-accessLists-list.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@ atlas accessLists list

Return all IP access list entries for your project.

Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.



To use this command, you must authenticate with a user account or an API key with the Organization Member role.

Syntax
Expand Down
7 changes: 7 additions & 0 deletions docs/command/atlas-accessLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,13 @@ atlas accessLists

Manage the list of IP addresses that can access your Atlas project.

Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.





Options
-------

Expand Down
5 changes: 5 additions & 0 deletions docs/command/atlas-accessLogs-list.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@ atlas accessLogs list

Retrieve the access logs of a cluster identified by the cluster's name or hostname.

Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.



To use this command, you must authenticate with a user account or an API key with the Project Monitoring Admin role.

Syntax
Expand Down
7 changes: 7 additions & 0 deletions docs/command/atlas-accessLogs.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,13 @@ atlas accessLogs

Return the access logs for a cluster.

Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.





Options
-------

Expand Down
5 changes: 5 additions & 0 deletions docs/command/atlas-alerts-acknowledge.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@ atlas alerts acknowledge

Acknowledges the specified alert for your project.

Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.



To use this command, you must authenticate with a user account or an API key with the Project Owner role.

Syntax
Expand Down
5 changes: 5 additions & 0 deletions docs/command/atlas-alerts-describe.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@ atlas alerts describe

Return the details for the specified alert for your project.

Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.



To use this command, you must authenticate with a user account or an API key with the Project Read Only role.

Syntax
Expand Down
5 changes: 5 additions & 0 deletions docs/command/atlas-alerts-list.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@ atlas alerts list

Return all alerts for your project.

Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.



To use this command, you must authenticate with a user account or an API key with the Project Read Only role.

Syntax
Expand Down
5 changes: 5 additions & 0 deletions docs/command/atlas-alerts-settings-create.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@ atlas alerts settings create

Create an alert configuration for your project.

Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.



To use this command, you must authenticate with a user account or an API key with the Project Owner role.

Syntax
Expand Down
5 changes: 5 additions & 0 deletions docs/command/atlas-alerts-settings-delete.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@ atlas alerts settings delete

Remove the specified alert configuration for your project.

Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.



To use this command, you must authenticate with a user account or an API key with the Project Owner role.

Syntax
Expand Down
5 changes: 5 additions & 0 deletions docs/command/atlas-alerts-settings-describe.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@ atlas alerts settings describe

Return the details for the specified alert settings for your project.

Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.



To use this command, you must authenticate with a user account or an API key with the Project Read Only role.

Syntax
Expand Down
7 changes: 7 additions & 0 deletions docs/command/atlas-alerts-settings-disable.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,13 @@ atlas alerts settings disable

Disables one alert configuration for the specified project.

Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.





Syntax
------

Expand Down
7 changes: 7 additions & 0 deletions docs/command/atlas-alerts-settings-enable.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,13 @@ atlas alerts settings enable

Enables one alert configuration for the specified project.

Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.





Syntax
------

Expand Down
5 changes: 5 additions & 0 deletions docs/command/atlas-alerts-settings-fields-type.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@ atlas alerts settings fields type

Return all available field types that the matcherFieldName option accepts when you create or update an alert configuration.

Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.



To use this command, you must authenticate with a user account or an API key with the Project Read Only role.

Syntax
Expand Down
7 changes: 7 additions & 0 deletions docs/command/atlas-alerts-settings-fields.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,13 @@ atlas alerts settings fields

Manages alert configuration fields for your project.

Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.





Options
-------

Expand Down
5 changes: 5 additions & 0 deletions docs/command/atlas-alerts-settings-list.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@ atlas alerts settings list

Returns all alert configurations for your project.

Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.



To use this command, you must authenticate with a user account or an API key with the Project Read Only role.

Syntax
Expand Down
5 changes: 5 additions & 0 deletions docs/command/atlas-alerts-settings-update.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@ atlas alerts settings update

Modify the details of the specified alert configuration for your project.

Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.



To use this command, you must authenticate with a user account or an API key with the Project Owner role.

Syntax
Expand Down
5 changes: 5 additions & 0 deletions docs/command/atlas-alerts-settings.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@ atlas alerts settings

Manages alerts configuration for your project.

Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.



Use this command to list, create, edit, delete, enable and disable alert configurations.

Options
Expand Down
5 changes: 5 additions & 0 deletions docs/command/atlas-alerts-unacknowledge.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@ atlas alerts unacknowledge

Unacknowledge the specified alert for your project.

Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.



To use this command, you must authenticate with a user account or an API key with the Project Owner role.

Syntax
Expand Down
7 changes: 7 additions & 0 deletions docs/command/atlas-alerts.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,13 @@ atlas alerts

Manage alerts for your project.

Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.





Options
-------

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,12 @@ atlas api accessTracking listAccessLogsByClusterName
:depth: 1
:class: singlecol

`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.
`Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns the access logs of one cluster identified by the cluster's name.

Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.



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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,12 @@ atlas api accessTracking listAccessLogsByHostname
:depth: 1
:class: singlecol

`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.
`Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns the access logs of one cluster identified by the cluster's hostname.

Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.



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.

Expand Down
11 changes: 8 additions & 3 deletions docs/command/atlas-api-accessTracking.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,12 @@ atlas api accessTracking
:depth: 1
:class: singlecol

`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.
`Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns access logs for authentication attempts made to Atlas database deployments.

Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.



To view database access history, you must have either the Project Owner or Organization Owner role.

Expand Down Expand Up @@ -51,8 +56,8 @@ Inherited Options
Related Commands
----------------

* :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.
* :ref:`atlas-api-accessTracking-listAccessLogsByClusterName` - `Public Preview: please provide feedback <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 <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns the access logs of one cluster identified by the cluster's hostname.


.. toctree::
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,12 @@ atlas api alertConfigurations createAlertConfiguration
:depth: 1
:class: singlecol

`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Creates one alert configuration for the specified project.
`Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Creates one alert configuration for the specified project.

Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.



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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,12 @@ atlas api alertConfigurations deleteAlertConfiguration
:depth: 1
:class: singlecol

`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Removes one alert configuration from the specified project.
`Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Removes one alert configuration from the specified project.

Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.



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.

Expand Down
Loading
Loading